🐍 Python Bindings for AMDSMI

Important

This used to be a community-maintained Python binding package for AMDSMI. Now, upon AMD's request, we have transferred ownership of the PyPI project amdsmi to AMD. This repository is archived and any issues for the Python package amdsmi should be directed to the offical ROCm/amdsmi repository.

Original REAMDE

Community-maintained Python bindings for AMDSMI.

Whenever a new release is published to the official AMDSMI repository, we run a simple script to checkout the py-interface directory of the tag and push it to this repository and PyPI. For the source code and API documentation, please see py-interface.

Note

At this time, there are no official Python bindings for AMDSMI on PyPI. Rather, bindings are distributed together with ROCm, which complicates dependency management and installation. Thus, we created this community-maintained binding package.

When AMD intends to officially maintain the amdsmi package on PyPI, we are happy to transfer ownership. Please contact the current maintainers Parth Raut (praut@umich.edu) and Jae-Won Chung (jwnchung@umich.edu).

🚀 Installation

pip install amdsmi

Important

1. Ensure your ROCm version matches the amdsmi package version. For instance, if you are using ROCm 6.2.1, run pip install amdsmi==6.2.1. (See Versioning for detais.)
2. Ensure you have libamd_smi.so in your system. It's shipped together with ROCm. Search order:
   1. site-packages/amdsmi/libamd_smi.so (inside the amdsmi installation directory; useful for debugging/dev)
   2. If environment variable ROCM_PATH is set, $ROCM_PATH/lib/libamd_smi.so
   3. (Since 6.2.3) If environment variable ROCM_PATH is not set, /opt/rocm/lib/libamd_smi.so

📦 Versioning

AMDSMI seems to have two parallel release strategies:

1. AMDSMI package releases, based on year, month, and revision (e.g., 24.5.0).
2. ROCm-based releases, which is released whenever a new ROCm version is released (e.g., 6.2.2).

At the moment, we adopt the second ROCm-based versioning strategy. So, the amdsmi package version is identical to the ROCm version the bindings are released against.

See here for a full list of releases.

❗ Bug Reports

Most issues would be better off reported directly to ROCm/amdsmi. If you believe the bug is specific to the bindings package, please file an issue on this repository.