Skip to content

Commit 3ebb872

Browse files
committed
Updated NVIDIA documentation
1 parent 199719a commit 3ebb872

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

content/en/docs/measuring/metric-providers/gpu-energy-nvidia-smi-component.md renamed to content/en/docs/measuring/metric-providers/gpu-energy-nvidia-nvml-component.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "GPU energy - NVIDIA SMI - Component"
3-
description: "Documentation for GpuEnergyNvidiaSmiComponentProvider of the Green Metrics Tool"
2+
title: "GPU energy - NVIDIA NVML - Component"
3+
description: "Documentation for GpuEnergyNvidiaNvmlComponentProvider of the Green Metrics Tool"
44
lead: ""
55
date: 2024-01-06T08:49:15+00:00
66
draft: false
@@ -14,27 +14,25 @@ This metric provider gets the current GPU power draw from the NVIDIA SMI softwar
1414

1515
### Classname
1616

17-
- `GpuEnergyNvidiaSmiComponentProvider`
17+
- `GpuEnergyNvidiaNvmlComponentProvider`
1818

1919
### Metric Name
2020

21-
- `gpu_energy_nvidia_smi_component`
21+
- `gpu_energy_nvidia_nvml_component`
2222

2323
### Prerequisites & Installation
2424

25-
You first must install the *CUDA Toolkit* from *NVIDIA* for the metric provider to have the needed libraries and binars. The URL at the time of writing is here: [https://developer.nvidia.com/cuda-downloads](https://developer.nvidia.com/cuda-downloads)
25+
We assume that the NVIDIA graphics card and the associated drivers are installed on your system.
2626

27-
You need both:
28-
- Base Installer
29-
- Driver Installer
27+
Please resort to [NVIDIA Docs](https://developer.nvidia.com) for installation if you still need to install.
3028

31-
To check if the installation has succeeded you can run:
32-
```console
33-
$ nvidia-smi -q
34-
```
29+
GMT will try to install the needed C header and development files for the *Metrics Provider* to compile.
30+
31+
You can trigger this by adding `--nvidia-gpu` to the install script. If the installation fails, please resort to your OS documentation. e.g.: [NVIDIA Linux docs](https://docs.nvidia.com/cuda/cuda-installation-guide-linux)
3532

36-
After the installation you system can use language bindings for your matching *CUDA* version.
37-
Please check on our [Measurement Cluster]({{< relref "/docs/measuring/measurement-cluster" >}}) page which *CUDA* version is installed.
33+
### Running your code on our hosted service
34+
35+
Please check on our [Measurement Cluster]({{< relref "/docs/measuring/measurement-cluster" >}}) page which *CUDA* version is installed. You must use the same CUDA version if you have compiled artifacts in your containers.
3836

3937
#### Debugging
4038

@@ -61,7 +59,7 @@ Check in `sudo dmesg` if the kernel module could correctly be lodaded and then v
6159
By default the measurement interval is 100 ms.
6260

6361
```bash
64-
./metric-provider-nvidia-smi-wrapper.sh -i 100
62+
./metric-provider-binary -i 100
6563
```
6664

6765
### Output
@@ -73,10 +71,15 @@ This metric provider prints to Stdout a continuous stream of data. The format of
7371
Where:
7472
- `TIMESTAMP`: Unix timestamp, in microseconds
7573
- `READING`: The energy used by the GPU in milliWatts (Ex: 12230 for 12.23 Watts)
74+
- `CARD NAME`: The name of the graphics card as reported by the driver
7675

7776
Any errors are printed to Stderr.
7877

78+
Example:
79+
```console
80+
1748166115636640 17757 "NVIDIA GeForce GTX 1080-0"
81+
```
7982

8083
### How it works
8184

82-
The provider uses the `nvidia-smi` tool to read the data.
85+
The provider uses the *NVIDIA* native C libraries to read directly from a syscall.

0 commit comments

Comments
 (0)