rocm-systems/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.

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} Tutorials

• AMD SMI examples (GitHub)
• ROCm SMI examples (GitHub) ::: ::::

To contribute to the documentation, refer to {doc}Contributing to ROCm <rocm:contribute/contributing>.

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

<style> #disclaimer { font-size: 0.8rem; } </style>

The information contained herein is for informational purposes only, and is subject to change without notice. While every precaution has been taken in the preparation of this document, it may contain technical inaccuracies, omissions and typographical errors, and AMD is under no obligation to update or otherwise correct this information. Advanced Micro Devices, Inc. makes no representations or warranties with respect to the accuracy or completeness of the contents of this document, and assumes no liability of any kind, including the implied warranties of noninfringement, merchantability or fitness for particular purposes, with respect to the operation or use of AMD hardware, software or other products described herein.

AMD, the AMD Arrow logo, and combinations thereof are trademarks of Advanced Micro Devices, Inc. Other product names used in this publication are for identification purposes only and may be trademarks of their respective companies.

Copyright (c) 2014-2024 Advanced Micro Devices, Inc. All rights reserved.