From fd5eb4e9639eeff8eb9c9eee1fbe002f248ea856 Mon Sep 17 00:00:00 2001 From: "Arif, Maisam" Date: Tue, 9 Sep 2025 16:05:01 -0500 Subject: [PATCH] [SWDEV-550075] Updated README to link to amd-smi virtualization repo (#664) Co-authored-by: Peter Park --- README.md | 9 +++++---- docs/install/install.md | 33 +++++++++++++++++---------------- 2 files changed, 22 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 1913f76f49..a5a8d0b032 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,14 @@ documentation at [rocm.docs.amd.com/projects/amdsmi](https://rocm.docs.amd.com/p >[!NOTE] >This project is a successor to [rocm_smi_lib](https://github.com/ROCm/rocm_smi_lib) ->and [esmi_ib_library](https://github.com/amd/esmi_ib_library). +>and [esmi_ib_library](https://github.com/amd/esmi_ib_library). +>This project is applicable to Linux Baremetal and Linux VM(Guest). To use AMD SMI for Virtualization, please refer to [AMD-SMI Virtualization](https://github.com/amd/MxGPU-Virtualization/tree/mainline/smi-lib). ## Supported platforms -At initial release, the AMD SMI library will support Linux bare metal and Linux -virtual machine guest for AMD GPUs. In a future release, the library will be -extended to support AMD EPYC™ CPUs. +The AMD SMI library supports Linux bare metal and Linux virtual machine guest +for AMD GPUs and AMD EPYC™ CPUs via +[esmi_ib_library](https://github.com/amd/esmi_ib_library). AMD SMI library can run on AMD ROCm supported platforms, refer to [System requirements (Linux)](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/system-requirements.html) diff --git a/docs/install/install.md b/docs/install/install.md index c6bf85bb26..0a1faad31c 100644 --- a/docs/install/install.md +++ b/docs/install/install.md @@ -5,7 +5,7 @@ myst: "keywords": "system, management, interface, cpu, gpu, hsmp, versions" --- -# AMD SMI library and CLI tool +# Install the AMD SMI library and CLI tool This section describes how to install the AMD SMI library, Python interface, and command line tool either as part of the @@ -24,6 +24,22 @@ The following are required to install and use the AMD SMI library through its la export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/opt/rocm/lib:/opt/rocm/lib64 ``` +### Supported platforms + +The AMD SMI library supports Linux bare metal and Linux virtual machine guest +for AMD GPUs and AMD EPYC™ CPUs via +[esmi_ib_lirary](https://github.com/amd/esmi_ib_library). To use AMD SMI for virtualization, refer to +the [AMD SMI for Virtualization documentation](https://instinct.docs.amd.com/projects/amd-smi-virt/en/latest/index.html). + +AMD SMI library can run on AMD ROCm supported platforms. Refer to +{doc}`System requirements (Linux) ` +for more information. + + +To run the AMD SMI library, the `amdgpu` driver and the `amd_hsmp` driver need +to be installed. Optionally, `libdrm` can be installed to query firmware +information and hardware IPs. + ### Python interface and CLI tool prerequisites * Python version 3.6.8 or greater (64-bit) @@ -38,21 +54,6 @@ sudo python3 -m pip install more_itertools * Go version 1.20 or greater -### Supported platforms - -At initial release, the AMD SMI library will support Linux bare metal and Linux -virtual machine guest for AMD GPUs. In a future release, the library will be -extended to support AMD EPYC™ CPUs. - -AMD SMI library can run on AMD ROCm supported platforms, refer to -{doc}`System requirements (Linux) ` -for more information. - - -To run the AMD SMI library, the `amdgpu` driver and the `amd_hsmp` driver need -to be installed. Optionally, `libdrm` can be installed to query firmware -information and hardware IPs. - (install_amdgpu_rocm)= ## Install amdgpu driver and AMD SMI with ROCm