rocm-systems/projects/amdsmi/docs/index.md

myst

myst
html_meta description lang=en keywords AMD SMI documentation and API reference. amdsmi, lib, cli, system, management, interface, amdgpu, admin, sys

AMD SMI documentation

The AMD System Management Interface (AMD SMI) library offers a unified tool for managing and monitoring GPUs, particularly in high-performance computing environments. It provides a user-space interface that allows applications to control GPU operations, monitor performance, and retrieve information about the system's drivers and GPUs.

Find the source code at https://github.com/ROCm/amdsmi.

This AMD SMI project supports Linux bare metal and Linux virtual machine guest
environments. For documentation regarding virtualization on SR-IOV Linux hosts,
refer to the [AMD SMI for Virtualization
documentation](https://instinct.docs.amd.com/projects/amd-smi-virt/en/latest/).

AMD SMI is the successor to <https://github.com/ROCm/rocm_smi_lib>.

::::{grid} 2 :gutter: 3

:::{grid-item-card} Install

• Library and CLI tool installation
• Build from source :::

:::{grid-item-card} How to

• C++ library usage
• Python library usage
• Go library usage
• CLI tool usage
• Use AMD SMI in a Docker container :::

:::{grid-item-card} Reference

• C++ API
  • Modules
  • Files
  • Globals
  • Data structures
  • Data fields
• Python API
• Go API :::

:::{grid-item-card} Conceptual

• Performance determinism
• Reliability, availability, serviceability :::

:::{grid-item-card} Tutorials

• AMD SMI examples (GitHub)
• AMD SMI CLI walkthrough ::: ::::

To learn about contributing to AMD SMI, see Contibuting to AMD SMI. To contribute to the documentation, see {doc}Contributing to ROCm documentation <rocm:contribute/contributing>.

Find ROCm licensing information on the {doc}Licensing <rocm:about/license> page.