derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
77 lines
2.8 KiB
Markdown
77 lines
2.8 KiB
Markdown
---
|
|
myst:
|
|
html_meta:
|
|
"description lang=en": "AMD SMI documentation and API reference."
|
|
"keywords": "amdsmi, lib, cli, system, management, interface, amdgpu, admin, sys"
|
|
---
|
|
|
|
# AMD SMI {{ AMDSMI_VERSION }}
|
|
|
|
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/rocm-systems/tree/develop/projects/amdsmi>.
|
|
|
|
```{important}
|
|
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/).
|
|
```
|
|
|
|
```{note}
|
|
AMD SMI is the successor to [ROCm SMI](https://github.com/ROCm/rocm-systems/tree/develop/projects/rocm-smi-lib).
|
|
```
|
|
|
|
::::{grid} 2
|
|
:gutter: 3
|
|
|
|
:::{grid-item-card} Install
|
|
* [Library and CLI tool installation](./install/install.md)
|
|
* [Build from source](./install/build.md)
|
|
:::
|
|
|
|
:::{grid-item-card} How to
|
|
* [C++ library usage](./how-to/amdsmi-cpp-lib.md)
|
|
* [Python library usage](./how-to/amdsmi-py-lib.md)
|
|
* [Go library usage](./how-to/amdsmi-go-lib.md)
|
|
* [CLI tool usage](./how-to/amdsmi-cli-tool.md)
|
|
* [AI NIC integration](./how-to/amdsmi-nic-integration.md)
|
|
* [Use AMD SMI in a Docker container](./how-to/setup-docker-container.md)
|
|
:::
|
|
|
|
:::{grid-item-card} Reference
|
|
* [C++ API](./reference/amdsmi-cpp-api/index.md)
|
|
* [Functions](./reference/amdsmi-cpp-api/functions.md)
|
|
* [Types](./reference/amdsmi-cpp-api/types.md)
|
|
* [Defines](./reference/amdsmi-cpp-api/defines.md)
|
|
* [Python API](./reference/amdsmi-py-api.md)
|
|
* [Go API](./reference/amdsmi-go-api.md)
|
|
:::
|
|
|
|
:::{grid-item-card} Conceptual
|
|
* [GPU partitioning](./conceptual/partition.md)
|
|
* [GPU reset behavior](./conceptual/gpu-reset-behavior.md)
|
|
* [GPU violations](./conceptual/gpu-violations.md)
|
|
* [Performance determinism](./conceptual/perf-determinism.md)
|
|
* [Reliability, availability, serviceability](./conceptual/ras.md)
|
|
* [Test suite design](./conceptual/test-design.md)
|
|
:::
|
|
|
|
:::{grid-item-card} Tutorials
|
|
* [AMD SMI examples (GitHub)](https://github.com/ROCm/rocm-systems/tree/develop/projects/amdsmi/example)
|
|
* [AMD SMI CLI walkthrough](https://rocm.blogs.amd.com/software-tools-optimization/amd-smi-overview/README.html)
|
|
:::
|
|
::::
|
|
|
|
To learn about contributing to AMD SMI, see [Contributing to ROCm
|
|
Systems](https://github.com/ROCm/rocm-systems/blob/develop/CONTRIBUTING.md).
|
|
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.
|