AMD SMI library and CLI tool

AMD SMI library and CLI tool#

This section describes how to install the AMD SMI library, Python interface, and command line tool either as part of the ROCm software stack – or manually.

Requirements#

The following are required to install and use the AMD SMI library through its language interfaces and CLI.

The amdgpu driver must be loaded for AMD SMI initialization to work.

Export LD_LIBRARY_PATH to the amdsmi installation directory.

export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/opt/rocm/lib:/opt/rocm/lib64

Python interface and CLI tool prerequisites#

Python version 3.6.8 or greater (64-bit)
Modules:
- python3-wheel
- python3-setuptools

Go interface prerequisites#

Go version 1.20 or greater

Supported platforms#

At initial release, the AMD SMI library will support Linux bare metal and Linux virtual machine guest for AMD GPUs. In a future release, the library will be extended to support AMD EPYC™ CPUs.

AMD SMI library can run on AMD ROCm supported platforms, refer to System requirements (Linux) for more information.

To run the AMD SMI library, the amdgpu driver and the amd_hsmp driver need to be installed. Optionally, libdrm can be installed to query firmware information and hardware IPs.

Install amdgpu driver and AMD SMI with ROCm#

Get the amdgpu-install installer following the instructions for your Linux distribution at Installation via AMDGPU installer.

See the following example; your desired ROCm release and install URL may be different.
```
sudo apt update
wget https://repo.radeon.com/amdgpu-install/6.2.2/ubuntu/noble/amdgpu-install_6.2.60202-1_all.deb
sudo apt install ./amdgpu-install_6.2.60202-1_all.deb
```
Use amdgpu-install to install the amdgpu driver and ROCm packages with AMD SMI included.
```
sudo amdgpu-install --usecase=rocm
```
The amdgpu-install --usecase=rocm option triggers both an amdgpu driver update and AMD SMI packages to be installed on your device.
Verify your installation.
```
amd-smi --help
```

Install AMD SMI without ROCm#

The following are example steps to install the AMD SMI libraries and CLI tool on Ubuntu 22.04.

Install the library.
```
sudo apt install amd-smi-lib
```
Add the installation directory to your PATH. If installed with ROCm, ignore this step.
```
export PATH="${PATH:+${PATH}:}~/opt/rocm/bin"
```
Verify your installation.
```
amd-smi --help
```

Optionally enable CLI autocompletion#

The amd-smi CLI application supports autocompletion. If argcomplete is not installed and enabled already, do so using the following commands.

python3 -m pip install argcomplete
activate-global-python-argcomplete --user
# restart shell to enable

Install the Python library for multiple ROCm instances#

If multiple ROCm versions are installed and you are not using pyenv, uninstall previous versions of AMD SMI before installing the desired version from your ROCm instance.

Manually install the Python library#

The following are example AMD SMI installation steps on Ubuntu 22.04 without ROCm.

Remove previous AMD SMI installation.

python3 -m pip list | grep amd
python3 -m pip uninstall amdsmi

Install the AMD SMI Python library from your target ROCm instance.

apt install amd-smi-lib
cd /opt/rocm/share/amd_smi
python3 -m pip install --upgrade pip
python3 -m pip install --user .

You should now have the AMD SMI Python library in your Python path:

~$ python3
Python 3.8.10 (default, May 26 2023, 14:05:08)
[GCC 9.4.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import amdsmi
>>>