Install the AMD SMI library and CLI tool

Install the 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. See Install the amdgpu driver.

  • Export LD_LIBRARY_PATH to the amdsmi installation directory.

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

Supported platforms#

The AMD SMI library supports Linux bare metal and Linux virtual machine guest for AMD GPUs and AMD EPYC™ CPUs via esmi_ib_lirary. To use AMD SMI for virtualization, refer to the AMD SMI for Virtualization documentation.

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.

Python interface and CLI tool prerequisites#

  • Python version 3.6.8 or greater (64-bit)

Note

During the driver installation process on Azure Linux 3, you might encounter the ModuleNotFoundError: No module named 'more_itertools' warning. This warning is a result of the reintroduction of python3-wheel and python3-setuptools dependencies in the CMake of AMD SMI, which requires more_itertools to build these Python libraries. This issue will be fixed in a future ROCm release. As a workaround, use the following command before installation:

sudo python3 -m pip install more_itertools

Go interface prerequisites#

  • Go version 1.20 or greater

Install the amdgpu driver#

Note

As of ROCm 7.0.0, the amdgpu driver is distributed separately from the ROCm software stack. See User and AMD GPU Driver (amdgpu) support matrix for driver to ROCm user space compatibility information.

Confirm that your Linux kernel version matches the system requirements described in Supported operating systems.

For up-to-date installation instructions, see the AMD GPU Driver (amdgpu) documentation.

Install AMD SMI with ROCm#

AMD SMI is included as a core package in the ROCm software stack as part of the rocm-developer-tools meta package. See ROCm runtime packages for more information.

Note

The amdgpu-install script is no longer the recommended way to install ROCm. Install using your supported Linux distribution’s package manager instead.

For up-to-date installation instructions via package manager, see ROCm installation for Linux.

After installing the amdgpu driver and ROCm, verify your AMD SMI installation:

amd-smi

Install AMD SMI without ROCm#

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

  1. Install the library.

    sudo apt install amd-smi-lib

  2. Add the installation directory to your PATH. If installed with ROCm, ignore this step.

    export PATH="${PATH:+${PATH}:}~/opt/rocm/bin"

  3. 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.

  1. Remove previous AMD SMI installation.

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

  2. 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 .

  3. 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
>>>