Files
rocm-systems/docs/index.rst
T
Roopa Malavally af225a6deb Amdsmidocs reorg
Change-Id: I836fc341d2a3567f531ba753463e57cd4b9b6495
Signed-off-by: Galantsev, Dmitrii <dmitrii.galantsev@amd.com>
2024-05-15 04:26:41 -04:00

51 lines
1.8 KiB
ReStructuredText

.. meta::
:description: AMDSMI documentation and API reference library
:keywords: amdsmi, ROCm, API, documentation
********************************************************************
AMD SMI documentation
********************************************************************
The AMD System Management Interface (SMI) Library, or AMD SMI library, is a C library for Linux that provides a user space interface for applications to monitor and control AMD devices.
You can access the AMD SMI code on the `GitHub repository <https://github.com/ROCm/amdsmi>`_.
.. Note::
This project is a successor to `rocm_smi_lib. <https://github.com/RadeonOpenCompute/rocm_smi_lib>`_
.. grid:: 2
:gutter: 3
.. grid-item-card:: Install
* :doc:`AMD SMI installation <./install/install>`
.. grid-item-card:: API reference
* :doc:`Files <../doxygen/docBin/html/files>`
* :doc:`Globals <../doxygen/docBin/html/globals>`
* :doc:`Data structures <../doxygen/docBin/html/annotated>`
* :doc:`Modules <../doxygen/docBin/html/modules>`
* :doc:`Data fields <../doxygen/docBin/html/functions_data_fields>`
.. grid-item-card:: How to
* :doc:`Use AMD SMI for C++ library <how-to/using-amdsmi-for-C++>`
* :doc:`Use AMD SMI for Python library <how-to/using-amdsmi-for-python>`
* :doc:`Use AMD SMI CLI tool <how-to/using-AMD-SMI-CLI-tool>`
.. grid-item-card:: Tutorials
* `AMD SMI GitHub samples <https://github.com/ROCm/amdsmi/tree/develop/example>`_
* `ROCm SMI Github samples <https://github.com/ROCm/rocm_smi_lib/tree/develop/docs>`_
To contribute to the documentation, refer to
`Contributing to ROCm <https://rocm.docs.amd.com/en/latest/contribute/contributing.html>`_.
You can find licensing information on the
`Licensing <https://rocm.docs.amd.com/en/latest/about/license.html>`_ page.