> For clean Markdown content of this page, append .md to this URL.

# aitune.utils.monitoring.hardware_metrics.metrics

Metrics providers for hardware metrics.

## Module Contents

### Classes

| Name                                                                                                                 | Description                                        |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
| [`AbstractHardwareMetricProvider`](#aitune-utils-monitoring-hardware_metrics-metrics-AbstractHardwareMetricProvider) | Abstract base class for hardware metric providers. |
| [`HostMetricProvider`](#aitune-utils-monitoring-hardware_metrics-metrics-HostMetricProvider)                         | Host metric provider.                              |
| [`NvmlMetricProvider`](#aitune-utils-monitoring-hardware_metrics-metrics-NvmlMetricProvider)                         | Nvml metric provider.                              |
| [`TorchMetricProvider`](#aitune-utils-monitoring-hardware_metrics-metrics-TorchMetricProvider)                       | Torch metric provider.                             |

### API

```python
class aitune.utils.monitoring.hardware_metrics.metrics.AbstractHardwareMetricProvider()
```

Abstract

Abstract base class for hardware metric providers.

```python
aitune.utils.monitoring.hardware_metrics.metrics.AbstractHardwareMetricProvider.get_metrics() -> dict[str, typing.Any]
```

abstract

Gets the metrics.

```python
class aitune.utils.monitoring.hardware_metrics.metrics.HostMetricProvider()
```

**Bases:** [AbstractHardwareMetricProvider](#aitune-utils-monitoring-hardware_metrics-metrics-AbstractHardwareMetricProvider)

Host metric provider.

```python
aitune.utils.monitoring.hardware_metrics.metrics.HostMetricProvider.get_metrics() -> dict[str, typing.Any]
```

Gets the metrics.

```python
class aitune.utils.monitoring.hardware_metrics.metrics.NvmlMetricProvider()
```

**Bases:** [AbstractHardwareMetricProvider](#aitune-utils-monitoring-hardware_metrics-metrics-AbstractHardwareMetricProvider)

Nvml metric provider.

**`handles`**

---

```python
aitune.utils.monitoring.hardware_metrics.metrics.NvmlMetricProvider.close()
```

Closes the NvmlMetricProvider.

```python
aitune.utils.monitoring.hardware_metrics.metrics.NvmlMetricProvider.get_metrics() -> dict[str, typing.Any]
```

Gets the metrics.

```python
class aitune.utils.monitoring.hardware_metrics.metrics.TorchMetricProvider()
```

**Bases:** [AbstractHardwareMetricProvider](#aitune-utils-monitoring-hardware_metrics-metrics-AbstractHardwareMetricProvider)

Torch metric provider.

```python
aitune.utils.monitoring.hardware_metrics.metrics.TorchMetricProvider.get_metrics() -> dict[str, typing.Any]
```

Gets the metrics.