2024-10-02 14:42:34 -04:00
|
|
|
# AMD SMI CLI tool
|
2023-05-18 16:00:45 -05:00
|
|
|
|
2024-10-02 14:42:34 -04:00
|
|
|
A command line tool for manipulating and monitoring the `amdgpu` kernel;
|
|
|
|
|
`amd-smi` is intended to replace and deprecate the existing
|
|
|
|
|
[`rocm-smi`](https://github.com/rocm/rocm_smi_lib) CLI tool.
|
2024-08-09 13:07:02 -05:00
|
|
|
|
2024-10-02 14:42:34 -04:00
|
|
|
When using the CLI tool, you should have at least one AMD GPU and the driver
|
|
|
|
|
installed.
|
2023-04-24 21:34:44 -05:00
|
|
|
|
2024-10-02 14:42:34 -04:00
|
|
|
>[!NOTE]
|
|
|
|
|
>The AMD SMI CLI tool is provided as an example code to aid the development of
|
|
|
|
|
>telemetry tools. The Python or C++ library is recommended as a robust data
|
|
|
|
|
>source.
|
2023-09-24 19:08:37 -05:00
|
|
|
|
2024-10-02 14:42:34 -04:00
|
|
|
Find the documentation in the `docs/` directory.
|
2023-05-18 16:00:45 -05:00
|
|
|
|
2024-10-02 14:42:34 -04:00
|
|
|
- [Install AMD SMI](../docs/install/install.md)
|
|
|
|
|
- [About the tool and how to get started](../docs/how-to/amdsmi-cli-tool.md)
|
2023-09-24 19:08:37 -05:00
|
|
|
|
2024-10-02 14:42:34 -04:00
|
|
|
## Online documentation
|
2023-09-24 19:08:37 -05:00
|
|
|
|
2024-10-02 14:42:34 -04:00
|
|
|
Explore the latest documentation on the [ROCm documentation
|
|
|
|
|
portal](https://rocm.docs.amd.com/projects/en/latest/index.html).
|
2023-09-24 19:08:37 -05:00
|
|
|
|
2024-10-02 14:42:34 -04:00
|
|
|
- [Install AMD SMI](https://rocm.docs.amd.com/projects/en/latest/install/install.html)
|
2023-09-24 19:08:37 -05:00
|
|
|
|
2024-10-02 14:42:34 -04:00
|
|
|
- [CLI tool usage](https://rocm.docs.amd.com/projects/en/latest/how-to/amdsmi-cli-tool.html).
|
2023-09-24 19:08:37 -05:00
|
|
|
|
