github/ROCm
1
1
Fork 0
mirror of https://github.com/ROCm/ROCm.git synced 2026-02-12 07:25:22 -05:00
Code Issues Packages Projects Releases Wiki Activity

[docs/7.11.0] Update docs for 7.11

Browse Source 
update ROCM_VERSION in conf

7.11 known issues added

Minor change

docs(RELEASE): supported OSes and hw

docs(release.md): update hw support and os support

js(selector-toc): remove unused code

docs(index): update rocm ontology diagram

add TM symbols

docs(RELEASE): complete virtualization support tbl

docs(toc): add rocm-examples to toc

chore: bump rocm-docs-core to 1.31.3

chore: update version histor page

docs(RELEASE): add oses

docs(RELEASE): add virtu sup

fix

docs: update RELEASE.md

docs(RELEASE): clean up

py(selector): allow percentage widths

docs(compat): update system-instinct table

docs: finalize components lists

docs(compat): update system-radeon-pro

docs(compat): update system-radeon

docs: compat

docs(RELEASE): clean up

docs(RELEASE): update tables

docs(compat): add virtu sup and fix stuff

docs(RELEASE): update AMD GPU Driver vers

dcos(compat): add missing mi2xx options

docs(RELEASE): update firmware for instinct

docs(RELEASE): fix xref and fmt

docs(rocm-ontology diagram): fix sideways tm

fix

oops, fix

docs: remove ROCgdb

docs(compat): add rhel 8.10 to mi35x

docs: clean up some wording

docs(install): update selector

docs(install/compat): fix selector data

docs: fix

js: fix reconcile selections

wip: install

wip: install

js: add URLSearchParams

wip: install

js: inline page-specific js

docs(compat): add missing rocky linux to mi300x

docs(install): windows adrenalin prereq

wip: install

docs(compat): virtu sup link

docs: windows tar

docs(compat/install): add missing gfx120x, gfx103x, and gfx110x gpus

docs(RELEASE): add missing gfx120x, gfx103x, and gfx110x gpus

docs(install): fix selected content

docs(install): windows tar

rm jira notes

docs(comfyui): update

docs(comfyui): update path

docs: remove hipDNN

chore(conf.py): exclude `**/includes/**` to build only when included

docs(index): fix diagram colors

Update RELEASE.md

remove fn

docs: remove gfx1030 cards

docs: remove windows for gfx12

js: add localStorage to selector for persistence

docs(RELEASE): fix gpu list in tables

js(primary toc install headings): don't reload page if already on the
install page

docs(img): add oses to ontology diagram

docs(rocgdb): add it back + document known issue

docs(comfyui): update selector

docs(RELEASE): fix

docs(compat): fix - add rocky linux for mi300a

docs(install): sles - remove --gpg-auto-import-keys

py(selector): add static assets only if exists

js(selector): clear URLSearchParams if page doesn't have selector

docs: note GIM driver 8.7.0K for virtualization on instinct

add link to gim docs

docs: reorder list of components

docs(install): add oem kernel prereq

docs: clean up diagrams

fix link

docs(RELEASE): update firmware explanation

docs: update

chore: clean up extra files

chore: linting errors

docs(compat): add iGPU to ryzen cards in compat matrix

docs(install): add install libatomic1

docs(install): clean up

fix

docs(install): add meta packages table

docs(compat): remove amdgpu 7.0.3 and 6.4.2

docs(install): uninstall add meta package note

blurb

docs(RELEASE): apex known issue

docs: update components lists in RELEASE and compat matrix

docs(install): clean up meta packages sections

docs(compat): update fw version for mi300x

update known issues

docs: remove minor version from OL and Rocky

docs: fix windows whl urls

docs(install): update rocminfo and amd-smi version example outputs

docs(RELEASE): add known issues

docs: fix linux components list

docs(compat): make igpu heading consistent

Add rocm-examples known issue

Co-authored-by: Istvan Kiss <istvan.kiss@amd.com>

docs(conf): update release date

docs(install): update windows install instructions

update

docs(RELEASE): update known issues

hipblaslt matmul known issue

update known issues

add hipify-clang known issue

js(selector): fix syncStateToURL

update amdgpu driver versions and known issues

update known issues

fix

fix

fix install urls

update RELEASE.md

fix

update for consistency

add known issue

add rccl known issue

update components table

fix amdgpu versions

update prereqs intro
This commit is contained in:
Peter Park
2026-01-21 14:27:03 -05:00
parent ffa6360979
commit 5ac64b9f6b
35 changed files with 5092 additions and 1723 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/compatibility/compatibility-matrix.rst
View File

@@ -19,22 +19,22 @@ space components. Maintaining version alignment between these layers ensures
expected GPU operation and performance, especially for AMD data center products.
Future preview releases will expand hardware and operating system coverage.
ROCm 7.10.0 enables support for primarily compute workloads. Future releases
ROCm 7.11.0 enables support for primarily compute workloads. Future releases
will support mixed workloads (compute and graphics).
.. selected:: os=ubuntu os=rhel os=sles
.. selected:: fam=radeon-pro fam=radeon
If you’re interested in testing AMD Radeon™ GPUs with preview support for
graphics use cases with AMD ROCm 7.10.0, install Radeon Software for Linux
version 25.30.1 from `Linux Drivers for AMD Radeon and Radeon PRO
If you’re interested in testing AMD Radeon GPUs with preview support for
graphics use cases with AMD ROCm 7.11.0, install Radeon Software for Linux
version 25.35 from `Linux Drivers for AMD Radeon and Radeon PRO
Graphics <https://www.amd.com/en/support/download/linux-drivers.html>`__.
.. selected:: fam=ryzen
If you're interested in testing AMD Ryzen™ APUs with preview support for
graphics use cases with AMD ROCm 7.10.0, use the inbox graphics drivers of
If you're interested in testing AMD Ryzen APUs with preview support for
graphics use cases with AMD ROCm 7.11.0, use the inbox graphics drivers of
Ubuntu 24.04.3.
.. include:: ./includes/system-instinct.rst
@@ -76,7 +76,7 @@ versions.
.. matrix-cell:: PyTorch
.. matrix-cell:: 2.9.1, 2.8.0, 2.7.1
:show-when: os=ubuntu os=rhel os=sles
:show-when: os=ubuntu os=debian os=rhel os=oracle-linux os=rocky-linux os=sles
.. matrix-cell:: 2.9.1
:show-when: os=windows
@@ -94,8 +94,8 @@ For installation instructions, see :ref:`pip-install-pytorch`.
.. note::
ROCm |ROCM_VERSION| is compatible with Python versions **3.11**, **3.12**,
and **3.13**.
ROCm |ROCM_VERSION| is compatible with Python versions 3.11, 3.12, and
3.13.
----
@@ -109,3 +109,7 @@ components.
.. include:: ./includes/core-sdk-components-linux.rst
.. include:: ./includes/core-sdk-components-windows.rst
----
.. include:: ./includes/virtualization-instinct.rst

245
docs/compatibility/includes/core-sdk-components-linux.rst
View File

@@ -1,5 +1,5 @@
.. matrix::
:show-when: os=ubuntu os=rhel os=sles
:show-when: os=ubuntu os=debian os=rhel os=oracle-linux os=rocky-linux os=sles
.. matrix-head::
@@ -10,193 +10,116 @@
.. matrix-cell:: Component name
.. matrix-row::
.. matrix-cell:: Runtimes and compilers
:rowspan: 5
.. matrix-cell::
`HIP <https://github.com/ROCm/rocm-systems/tree/therock-7.10/projects/hip>`__
.. matrix-row::
.. matrix-cell::
`HIPIFY <https://github.com/ROCm/HIPIFY/tree/therock-7.10>`__
.. matrix-row::
.. matrix-cell::
`LLVM <https://github.com/ROCm/llvm-project/tree/therock-7.10>`__
.. matrix-row::
.. matrix-cell::
`ROCr Runtime <https://github.com/ROCm/rocm-systems/tree/therock-7.10/projects/rocr-runtime>`__
.. matrix-row::
.. matrix-cell::
`SPIRV-LLVM-Translator <https://github.com/ROCm/SPIRV-LLVM-Translator/tree/therock-7.10>`__
.. matrix-row::
.. matrix-cell:: Control and monitoring tools
:rowspan: 2
.. matrix-cell::
`AMD SMI <https://github.com/ROCm/amdsmi/tree/release/therock-7.10>`__
.. matrix-row::
.. matrix-cell::
`rocminfo <https://github.com/ROCm/rocm-systems/tree/therock-7.10/projects/rocminfo>`__
.. matrix-row::
.. matrix-cell:: Profiling and debugging tools
:rowspan: 3
:show-when: fam=instinct
.. matrix-cell:: Profiling and debugging tools
:rowspan: 2
:show-when: fam=radeon-pro fam=radeon fam=ryzen
.. matrix-row::
.. matrix-cell::
`ROCm Compute Profiler (rocprofiler-compute) <https://github.com/ROCm/rocm-systems/tree/therock-7.10/projects/rocprofiler-compute>`__
.. matrix-row::
:show-when: fam=instinct
.. matrix-cell::
`ROCprofiler-SDK <https://github.com/ROCm/rocm-systems/tree/therock-7.10/projects/rocprofiler-sdk>`__
.. matrix-row::
.. matrix-cell:: Math and compute libraries
:rowspan: 18
:show-when: fam=instinct
.. matrix-cell:: Math and compute libraries
:rowspan: 17
:show-when: fam=radeon-pro fam=radeon fam=ryzen
.. matrix-cell::
`rocBLAS <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/rocblas>`__
`Composable Kernel <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/composablekernel>`__
.. matrix-row::
.. matrix-cell::
`hipBLAS <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/hipblas>`__
`hipBLAS <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/hipblas>`__
.. matrix-row::
.. matrix-cell::
`hipBLASLt <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/hipblaslt>`__
`hipBLASLt <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/hipblaslt>`__
.. matrix-row::
.. matrix-cell::
`rocFFT <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/rocfft>`__
`hipCUB <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/hipcub>`__
.. matrix-row::
.. matrix-cell::
`hipFFT <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/hipfft>`__
`hipFFT <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/hipfft>`__
.. matrix-row::
.. matrix-cell::
`rocRAND <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/rocrand>`__
`hipRAND <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/hiprand>`__
.. matrix-row::
.. matrix-cell::
`hipRAND <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/hiprand>`__
`hipSOLVER <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/hipsolver>`__
.. matrix-row::
.. matrix-cell::
`rocSOLVER <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/rocsolver>`__
`hipSPARSE <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/hipsparse>`__
.. matrix-row::
.. matrix-cell::
`hipSOLVER <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/hipsolver>`__
`hipSPARSELt <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/hipsparselt>`__
.. matrix-row::
.. matrix-cell::
`rocSPARSE <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/rocsparse>`__
`MIOpen <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/miopen>`__
.. matrix-row::
.. matrix-cell::
`hipSPARSE <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/hipsparse>`__
`rocBLAS <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/rocblas>`__
.. matrix-row::
.. matrix-cell::
`hipSPARSELt <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/hipsparselt>`__
`rocFFT <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/rocfft>`__
.. matrix-row::
.. matrix-cell::
`rocPRIM <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/rocprim>`__
`rocPRIM <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/rocprim>`__
.. matrix-row::
.. matrix-cell::
`rocThrust <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/rocthrust>`__
`rocRAND <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/rocrand>`__
.. matrix-row::
.. matrix-cell::
`hipCUB <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/hipcub>`__
`rocSOLVER <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/rocsolver>`__
.. matrix-row::
.. matrix-cell::
`rocWMMA <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/rocwmma>`__
`rocSPARSE <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/rocsparse>`__
.. matrix-row::
.. matrix-cell::
`Composable Kernel <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/composablekernel>`__ (partial, limited support)
`rocThrust <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/rocthrust>`__
.. matrix-row::
:show-when: fam=instinct
.. matrix-cell::
`MIOpen <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/miopen>`__
`rocWMMA <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/rocwmma>`__
.. matrix-row::
@@ -204,11 +127,137 @@
.. matrix-cell::
`RCCL <https://github.com/ROCm/rccl/tree/release/therock-7.10>`__
`RCCL <https://github.com/ROCm/rccl/tree/release/release/therock-7.11>`__
.. matrix-row::
.. matrix-cell:: Support libraries
.. matrix-cell::
`ROCm CMake <https://github.com/ROCm/rocm-cmake/tree/therock-7.10>`__
`ROCm CMake <https://github.com/ROCm/rocm-cmake/tree/release/therock-7.11>`__
.. matrix-row::
.. matrix-cell:: Runtimes and compilers
:rowspan: 5
:show-when: fam=instinct fam=radeon-pro fam=radeon
.. matrix-cell:: Runtimes and compilers
:rowspan: 4
:show-when: fam=ryzen
.. matrix-cell::
`HIP <https://github.com/ROCm/rocm-systems/tree/release/therock-7.11/projects/hip>`__
.. matrix-row::
.. matrix-cell::
`HIPIFY <https://github.com/ROCm/HIPIFY/tree/release/therock-7.11>`__
.. matrix-row::
.. matrix-cell::
`LLVM <https://github.com/ROCm/llvm-project/tree/release/therock-7.11>`__
.. matrix-row::
:show-when: fam=instinct fam=radeon-pro fam=radeon
.. matrix-cell::
`ROCr Runtime <https://github.com/ROCm/rocm-systems/tree/release/therock-7.11/projects/rocr-runtime>`__
.. matrix-row::
.. matrix-cell::
`SPIRV-LLVM-Translator <https://github.com/ROCm/SPIRV-LLVM-Translator/tree/release/therock-7.11>`__
.. matrix-row::
.. matrix-cell:: Profiling and debugging tools
:rowspan: 6
:show-when: fam=instinct
.. matrix-cell:: Profiling and debugging tools
:rowspan: 4
:show-when: fam=radeon-pro fam=radeon
.. matrix-cell::
:show-when: fam=instinct
`ROCm Compute Profiler (rocprofiler-compute) <https://github.com/ROCm/rocm-systems/tree/release/therock-7.11/projects/rocprofiler-compute>`__
.. matrix-cell::
:show-when: fam=radeon-pro fam=radeon
`ROCprofiler-SDK <https://github.com/ROCm/rocm-systems/tree/release/therock-7.11/projects/rocprofiler-sdk>`__
.. matrix-row::
:show-when: fam=instinct
.. matrix-cell::
`ROCm Systems Profiler (rocprofiler-systems) <https://github.com/ROCm/rocm-systems/tree/release/therock-7.11/projects/rocprofiler-systems>`__
.. matrix-row::
:show-when: fam=instinct
.. matrix-cell::
`ROCprofiler-SDK <https://github.com/ROCm/rocm-systems/tree/release/therock-7.11/projects/rocprofiler-sdk>`__
.. matrix-row::
:show-when: fam=instinct fam=radeon-pro fam=radeon
.. matrix-cell::
`ROCdbgapi <https://github.com/ROCm/ROCdbgapi/tree/release/therock-7.11>`__
.. matrix-row::
:show-when: fam=instinct fam=radeon-pro fam=radeon
.. matrix-cell::
`ROCm Debugger (ROCgdb) <https://github.com/ROCm/ROCgdb/tree/release/therock-7.11>`__
.. matrix-row::
:show-when: fam=instinct fam=radeon-pro fam=radeon
.. matrix-cell::
`ROCr Debug Agent <https://github.com/ROCm/rocr_debug_agent/tree/release/therock-7.11>`__
.. matrix-row::
.. matrix-cell:: Control and monitoring tools
:rowspan: 2
.. matrix-cell::
:show-when: fam=instinct fam=radeon-pro fam=radeon
`AMD SMI <https://github.com/ROCm/rocm-systems/tree/release/therock-7.11/projects/amdsmi>`__
.. matrix-row::
.. matrix-cell::
`rocminfo <https://github.com/ROCm/rocm-systems/tree/release/therock-7.11/projects/rocminfo>`__
.. matrix-row::
.. matrix-cell:: System validation tools
:rowspan: 2
.. matrix-cell::
`ROCm Bandwidth Test <https://github.com/ROCm/rocm_bandwidth_test>`__
.. matrix-row::
.. matrix-cell::
`TransferBench <https://github.com/ROCm/TransferBench>`__

138
docs/compatibility/includes/core-sdk-components-windows.rst
View File

@@ -10,77 +10,86 @@
.. matrix-cell:: Component name
.. matrix-row::
.. matrix-cell:: Runtimes and compilers
:rowspan: 3
.. matrix-cell::
`HIP <https://github.com/ROCm/rocm-systems/tree/therock-7.10/projects/hip>`__
.. matrix-row::
.. matrix-cell::
`HIPIFY <https://github.com/ROCm/HIPIFY/tree/therock-7.10>`__
.. matrix-row::
.. matrix-cell::
`LLVM <https://github.com/ROCm/llvm-project/tree/therock-7.10>`__
.. matrix-row::
.. matrix-cell:: Control and monitoring tools
.. matrix-cell:: hipinfo
.. matrix-row::
.. matrix-cell:: Math and compute libraries
:rowspan: 15
:rowspan: 17
.. matrix-cell::
`rocBLAS <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/rocblas>`__
`Composable Kernel <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/composablekernel>`__
.. matrix-row::
.. matrix-cell::
`hipBLAS <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/hipblas>`__
`hipBLAS <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/hipblas>`__
.. matrix-row::
.. matrix-cell::
`hipBLASLt <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/hipblaslt>`__
`hipBLASLt <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/hipblaslt>`__
.. matrix-row::
.. matrix-cell::
`rocFFT <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/rocfft>`__
`hipCUB <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/hipcub>`__
.. matrix-row::
.. matrix-cell::
`hipFFT <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/hipfft>`__
`hipFFT <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/hipfft>`__
.. matrix-row::
.. matrix-cell::
`rocRAND <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/rocrand>`__
`hipRAND <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/rocsolver>`__
.. matrix-row::
.. matrix-cell::
`hipRAND <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/rocsolver>`__
`hipSOLVER <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/hipsolver>`__
.. matrix-row::
.. matrix-cell::
`hipSPARSE <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/hipsparse>`__
.. matrix-row::
.. matrix-cell::
`MIOpen <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/miopen>`__
.. matrix-row::
.. matrix-cell::
`rocBLAS <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/rocblas>`__
.. matrix-row::
.. matrix-cell::
`rocFFT <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/rocfft>`__
.. matrix-row::
.. matrix-cell::
`rocPRIM <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/rocprim>`__
.. matrix-row::
.. matrix-cell::
`rocRAND <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/rocrand>`__
.. matrix-row::
@@ -92,43 +101,19 @@
.. matrix-cell::
`hipSOLVER <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/hipsolver>`__
`rocSPARSE <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/rocsparse>`__
.. matrix-row::
.. matrix-cell::
`rocSPARSE <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/rocsparse>`__
`rocThrust <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/rocthrust>`__
.. matrix-row::
.. matrix-cell::
`hipSPARSE <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/hipsparse>`__
.. matrix-row::
.. matrix-cell::
`rocPRIM <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/rocprim>`__
.. matrix-row::
.. matrix-cell::
`rocThrust <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/rocthrust>`__
.. matrix-row::
.. matrix-cell::
`hipCUB <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/hipcub>`__
.. matrix-row::
.. matrix-cell::
`rocWMMA <https://github.com/ROCm/rocm-libraries/tree/therock-7.10/projects/rocwmma>`__
`rocWMMA <https://github.com/ROCm/rocm-libraries/tree/release/therock-7.11/projects/rocwmma>`__
.. matrix-row::
@@ -136,4 +121,31 @@
.. matrix-cell::
`ROCm CMake <https://github.com/ROCm/rocm-cmake/tree/therock-7.10>`__
`ROCm CMake <https://github.com/ROCm/rocm-cmake/tree/release/therock-7.11>`__
.. matrix-row::
.. matrix-cell:: Runtimes and compilers
:rowspan: 3
.. matrix-cell::
`HIP <https://github.com/ROCm/rocm-systems/tree/release/therock-7.11/projects/hip>`__
.. matrix-row::
.. matrix-cell::
`HIPIFY <https://github.com/ROCm/HIPIFY/tree/release/therock-7.11>`__
.. matrix-row::
.. matrix-cell::
`LLVM <https://github.com/ROCm/llvm-project/tree/release/therock-7.11>`__
.. matrix-row::
.. matrix-cell:: Control and monitoring tools
.. matrix-cell:: hipinfo

355
docs/compatibility/includes/selector.rst
View File

@@ -1,3 +1,5 @@
.. =========================================================== GPU/APU FAMILY ==
.. selector:: AMD device family
:key: fam
@@ -9,7 +11,7 @@
:value: radeon-pro
:width: 3
.. selector-option:: Radeon RX
.. selector-option:: Radeon
:value: radeon
:width: 3
@@ -17,101 +19,330 @@
:value: ryzen
:width: 3
.. ================================================================ GPU / APU ==
.. selector:: Instinct GPU
:key: gfx
:key: gpu
:show-when: fam=instinct
.. selector-info:: https://www.amd.com/en/products/accelerators/instinct.html
.. selector-option:: Instinct MI355X<br>Instinct MI350X
:value: 950
:width: 4
.. selector-option:: MI355X
:width: 3
.. selector-option:: Instinct MI325X<br>Instinct MI300X<br>Instinct MI300A
:value: 942
:width: 4
.. selector-option:: MI350X
:width: 3
.. selector-option:: Instinct MI250X<br>Instinct MI250<br>Instinct MI210
:value: 90a
:width: 4
.. selector-option:: MI325X
:width: 3
.. selector-option:: MI300X
:width: 3
.. selector-option:: MI300A
:width: 3
.. selector-option:: MI250X
:width: 3
.. selector-option:: MI250
:width: 3
.. selector-option:: MI210
:width: 3
.. selector:: Radeon PRO GPU
:key: gfx
:key: gpu
:show-when: fam=radeon-pro
.. selector-info:: https://www.amd.com/en/products/graphics/workstations.html
.. selector-option:: Radeon PRO W7900D<br>Radeon PRO W7900<br>Radeon PRO W7800 48GB<br>Radeon PRO W7800
:value: 1100
:width: 6
.. selector-option:: AI PRO R9700
:value: ai-r9700
:width: 3
.. selector-option:: Radeon PRO W7700
:value: 1101
:width: 6
.. selector-option:: AI PRO R9600D
:value: ai-r9600d
:width: 3
.. selector:: Radeon RX GPU
:key: gfx
.. selector-option:: W7900 Dual Slot
:value: w7900-dual-slot
:width: 3
.. selector-option:: W7900
:value: w7900
:width: 3
.. selector-option:: W7800 48GB
:value: w7800-48gb
:width: 3
.. selector-option:: W7800
:value: w7800
:width: 3
.. selector-option:: W7700
:value: w7700
:width: 3
.. selector-option:: V710
:value: v710
:width: 3
.. selector:: Radeon GPU
:key: gpu
:show-when: fam=radeon
.. selector-info:: https://www.amd.com/en/products/graphics/desktops/radeon.html
.. selector-option:: Radeon RX 7900 XTX<br>Radeon RX 7900 XT<br>Radeon RX 7900 GRE
:value: 1100
.. selector-option:: RX 9070 XT
:value: rx-9070-xt
:width: 3
.. selector-option:: Radeon RX 7800 XT<br>Radeon RX 7700 XT
:value: 1101
.. selector-option:: RX 9070 GRE
:value: rx-9070-gre
:width: 3
.. selector-option:: RX 9070
:value: rx-9070
:width: 3
.. selector-option:: RX 9060 XT LP
:value: rx-9060-xt-lp
:width: 3
.. selector-option:: RX 9060 XT
:value: rx-9060-xt
:width: 3
.. selector-option:: RX 9060
:value: rx-9060
:width: 3
.. selector-option:: RX 7900 XTX
:value: rx-7900-xtx
:width: 3
.. selector-option:: RX 7900 XT
:value: rx-7900-xt
:width: 3
.. selector-option:: RX 7900 GRE
:value: rx-7900-gre
:width: 3
.. selector-option:: RX 7800 XT
:value: rx-7800-xt
:width: 3
.. selector-option:: RX 7700 XT
:value: rx-7700-xt
:width: 3
.. selector-option:: RX 7700
:value: rx-7700
:width: 3
.. selector:: Ryzen AI APU
:key: gfx
:key: gpu
:show-when: fam=ryzen
.. selector-info:: https://www.amd.com/en/products/processors/workstations/mobile.html
.. selector-option:: Ryzen AI Max+ PRO 395<br>Ryzen AI Max PRO 390, 385, 380<br>Ryzen AI Max+ 395<br>Ryzen AI Max 390, 385
:value: 1151
:width: 6
.. selector-option:: Max+ PRO 395
:value: max-pro-395
:width: 3
.. selector-option:: Ryzen AI 9 HX 375<br>Ryzen AI 9 HX 370<br>Ryzen AI 9 365
:value: 1150
:width: 6
.. selector-option:: Max PRO 390
:value: max-pro-390
:width: 3
.. selector:: Operating system
:key: os
:show-when: fam=instinct
.. selector-option:: Max PRO 385
:value: max-pro-385
:width: 3
.. selector-option:: Ubuntu
:value: ubuntu
:icon: fab fa-ubuntu fa-lg
:width: 4
.. selector-option:: Max PRO 380
:value: max-pro-380
:width: 3
.. selector-option:: RHEL
:value: rhel
:icon: fab fa-redhat fa-lg
:width: 4
.. selector-option:: Max+ 395
:value: max-395
:width: 2
.. selector-option:: SLES
:value: sles
:icon: fab fa-suse fa-lg
:width: 4
.. selector-option:: Max 390
:value: max-390
:width: 2
.. selector:: Operating system
:key: os
:show-when: fam=radeon-pro fam=radeon
.. selector-option:: Max 385
:value: max-385
:width: 2
.. selector-option:: Ubuntu
:value: ubuntu
:icon: fab fa-ubuntu fa-lg
:width: 4
.. selector-option:: 9 HX 375
:value: 9-hx-375
:width: 2
.. selector-option:: RHEL
:value: rhel
:icon: fab fa-redhat fa-lg
:width: 4
.. selector-option:: 9 HX 370
:value: 9-hx-370
:width: 2
.. selector-option:: Windows
:value: windows
:icon: fab fa-windows fa-lg
:width: 4
.. selector-option:: 9 365
:value: 9-365
:width: 2
.. ========================================================= OPERATING SYSTEM ==
.. selected:: fam=instinct
.. selector:: Linux distribution
:key: os
:show-when: gpu=mi355x gpu=mi350x gpu=mi325x
.. selector-option:: Ubuntu
:value: ubuntu
:width: 20%
.. selector-option:: Debian
:value: debian
:width: 20%
:show-when: gpu=mi355x gpu=mi350x gpu=mi325x
.. selector-option:: RHEL
:value: rhel
:width: 20%
.. selector-option:: Oracle Linux
:value: oracle-linux
:width: 20%
.. selector-option:: SLES
:value: sles
:width: 20%
.. selector:: Linux distribution
:key: os
:show-when: gpu=mi300x
.. selector-option:: Ubuntu
:value: ubuntu
:width: 4
.. selector-option:: Debian
:value: debian
:width: 4
.. selector-option:: RHEL
:value: rhel
:width: 4
.. selector-option:: Oracle Linux
:value: oracle-linux
:width: 4
.. selector-option:: Rocky Linux
:value: rocky-linux
:width: 4
.. selector-option:: SLES
:value: sles
:width: 4
.. selector:: Linux distribution
:key: os
:show-when: gpu=mi300a
.. selector-option:: Ubuntu
:value: ubuntu
:width: 3
.. selector-option:: RHEL
:value: rhel
:width: 3
.. selector-option:: Rocky Linux
:value: rocky-linux
:width: 3
.. selector-option:: SLES
:value: sles
:width: 3
.. selector:: Linux distribution
:key: os
:show-when: gpu=mi250x gpu=mi250 gpu=mi210
.. selector-option:: Ubuntu
:value: ubuntu
:width: 4
.. selector-option:: RHEL
:value: rhel
:width: 4
.. selector-option:: SLES
:value: sles
:width: 4
.. selected:: fam=radeon-pro
.. selector:: Operating system
:key: os
:show-when: gpu=ai-r9700 gpu=w7900-dual-slot gpu=w7900 gpu=w7800-48gb gpu=w7800 gpu=w7700 gpu=w6800
.. selector-option:: Ubuntu
:value: ubuntu
:width: 4
.. selector-option:: RHEL
:value: rhel
:width: 4
.. selector-option:: Windows
:value: windows
:width: 4
.. selector:: Linux distribution
:key: os
:show-when: gpu=v710 gpu=ai-r9600d
.. selector-option:: Ubuntu
:value: ubuntu
:width: 6
.. selector-option:: RHEL
:value: rhel
:width: 6
.. selected:: fam=radeon
.. selector:: Linux distribution
:key: os
:show-when: gpu=rx-9070-xt gpu=rx-9070-gre gpu=rx-9070 gpu=rx-9060-xt-lp gpu=rx-9060-xt gpu=rx-9060
.. selector-option:: Ubuntu
:value: ubuntu
:width: 6
.. selector-option:: RHEL
:value: rhel
:width: 6
.. selector:: Operating system
:key: os
:show-when: gpu=rx-7900-xtx gpu=rx-7900-xt gpu=rx-7900-gre gpu=rx-7800-xt gpu=rx-7700-xt gpu=rx-7700
.. selector-option:: Ubuntu
:value: ubuntu
:width: 4
.. selector-option:: RHEL
:value: rhel
:width: 4
.. selector-option:: Windows
:value: windows
:width: 4
.. selector:: Operating system
:key: os
@@ -119,10 +350,8 @@
.. selector-option:: Ubuntu
:value: ubuntu
:icon: fab fa-ubuntu fa-lg
:width: 6
.. selector-option:: Windows
:value: windows
:icon: fab fa-windows fa-lg
:width: 6

178
docs/compatibility/includes/system-instinct.rst
View File

@@ -1,45 +1,31 @@
.. matrix::
:show-when: fam=instinct
.. matrix-row::
:show-when: gfx=950
.. matrix-head::
.. matrix-cell:: AMD Instinct MI350 Series
.. raw:: html
<colgroup style="width: 50%;">
.. matrix-row::
.. matrix-cell:: AMD GPU series
:header:
.. matrix-cell::
:show-when: gpu=mi355x gpu=mi350x
`Instinct MI355X <https://www.amd.com/en/products/accelerators/instinct/mi350/mi355x.html>`__
`Instinct MI350X <https://www.amd.com/en/products/accelerators/instinct/mi350/mi350x.html>`__
.. matrix-row::
:show-when: gfx=942
.. matrix-cell:: AMD Instinct MI300 Series
:header:
`AMD Instinct MI350 Series <https://www.amd.com/en/products/accelerators/instinct/mi350.html>`__
.. matrix-cell::
:show-when: gpu=mi325x gpu=mi300x gpu=mi300a
`Instinct MI325X <https://www.amd.com/en/products/accelerators/instinct/mi300/mi325x.html>`__
`Instinct MI300X <https://www.amd.com/en/products/accelerators/instinct/mi300/mi300x.html>`__
`Instinct MI300A <https://www.amd.com/en/products/accelerators/instinct/mi300/mi300a.html>`__
.. matrix-row::
:show-when: gfx=90a
.. matrix-cell:: AMD Instinct MI200 Series
:header:
`AMD Instinct MI300 Series <https://www.amd.com/en/products/accelerators/instinct/mi300.html>`__
.. matrix-cell::
:show-when: gpu=mi250x gpu=mi250 gpu=mi210
`Instinct MI250X <https://www.amd.com/en/products/accelerators/instinct/mi200/mi250x.html>`__
`Instinct MI250 <https://www.amd.com/en/products/accelerators/instinct/mi200/mi250.html>`__
`Instinct MI210 <https://www.amd.com/en/products/accelerators/instinct/mi200/mi210.html>`__
`AMD Instinct MI200 Series <https://www.amd.com/en/products/accelerators/instinct/mi200.html>`__
.. matrix-row::
@@ -47,13 +33,13 @@
:header:
.. matrix-cell:: CDNA 4
:show-when: gfx=950
:show-when: gpu=mi355x gpu=mi350x
.. matrix-cell:: CDNA 3
:show-when: gfx=942
:show-when: gpu=mi325x gpu=mi300x gpu=mi300a
.. matrix-cell:: CDNA 2
:show-when: gfx=90a
:show-when: gpu=mi250x gpu=mi250 gpu=mi210
.. matrix-row::
@@ -61,13 +47,13 @@
:header:
.. matrix-cell:: gfx950
:show-when: gfx=950
:show-when: gpu=mi355x gpu=mi350x
.. matrix-cell:: gfx942
:show-when: gfx=942
:show-when: gpu=mi325x gpu=mi300x gpu=mi300a
.. matrix-cell:: gfx90a
:show-when: gfx=90a
:show-when: gpu=mi250x gpu=mi250 gpu=mi210
.. matrix-row::
:show-when: os=ubuntu
@@ -88,60 +74,136 @@
:header:
.. matrix-cell::
:show-when: gpu=mi325x
RHEL 10.1 (kernel: 6.12.0-124)
RHEL 10.1 (kernel: 6.12.0-124)
RHEL 10.0 (kernel: 6.12.0-55)
RHEL 10.0 (kernel: 6.12.0-55)
RHEL 9.7 (kernel: 5.14.0-611)
RHEL 9.7 (kernel: 5.14.0-611)
RHEL 9.6 (kernel: 5.14.0-570)
RHEL 9.6 (kernel: 5.14.0-570)
RHEL 8.10 (kernel: 4.18.0-553)
RHEL 9.4 (kernel: 5.14.0-427)
.. matrix-cell::
:show-when: gpu=mi355x gpu=mi350x gpu=mi300x gpu=mi300a gpu=mi250x gpu=mi250 gpu=mi210
RHEL 10.1 (kernel: 6.12.0-124)
RHEL 10.0 (kernel: 6.12.0-55)
RHEL 9.7 (kernel: 5.14.0-611)
RHEL 9.6 (kernel: 5.14.0-570)
RHEL 9.4 (kernel: 5.14.0-427)
RHEL 8.10 (kernel: 4.18.0-553)
.. matrix-row::
:show-when: os=debian
.. matrix-cell:: Supported Debian version
:header:
.. matrix-cell:: Debian 13 (kernel: 6.12)
.. matrix-row::
:show-when: os=oracle-linux
.. matrix-cell:: Supported Oracle Linux versions
:header:
.. matrix-cell::
:show-when: gpu=mi355x gpu=mi350x gpu=mi325x gpu=mi300a gpu=mi250x gpu=mi250 gpu=mi210
Oracle Linux 10 (kernel: UEK 8.1)
Oracle Linux 9 (kernel: UEK 8)
.. matrix-cell::
:show-when: gpu=mi300x
Oracle Linux 10 (kernel: UEK 8.1)
Oracle Linux 9 (kernel: UEK 8)
Oracle Linux 8 (kernel: UEK 7)
.. matrix-row::
:show-when: os=rocky-linux
.. matrix-cell:: Supported Rocky Linux versions
:header:
.. matrix-cell::
:show-when: gpu=mi300x gpu=mi300a
Rocky Linux 9 (kernel: 5.14.0-570)
.. matrix-row::
:show-when: os=sles
.. matrix-cell:: Supported SUSE Linux Enterprise Server version
.. matrix-cell:: Supported SUSE Linux Enterprise Server versions
:header:
.. matrix-cell:: SLES 15.7 (kernel: 6.4.0-150700.51)
.. matrix-cell::
SLES 16.0 (kernel: 6.12)
SLES 15.7 (kernel: 6.4.0-150700.51)
.. matrix-row::
.. matrix-cell:: Supported AMD GPU Driver (amdgpu) versions
:header:
.. matrix-cell::
.. matrix-cell::
`30.20.0 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.20.0/>`__,
`30.10.2 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.10.2/>`__,
`30.10.1 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.10.1/>`__,
`30.10.0 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.10/>`__
`31.10.0 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-31.10.0/documentation/release-notes.html>`__
`30.20.1 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.20.1/documentation/release-notes.html>`__
`30.20.0 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.20.0/documentation/release-notes.html>`__
`30.10.2 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.10.2/documentation/release-notes.html>`__
`30.10.1 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.10.1/documentation/release-notes.html>`__
`30.10.0 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.10/documentation/release-notes.html>`__
.. matrix-row::
.. matrix-cell:: Supported PLDM bundle (firmware) versions
:header:
.. matrix-cell:: 01.25.15.04, 01.25.13.09
:show-when: gfx=950
.. matrix-cell::
:show-when: gpu=mi355x gpu=mi350x
01.25.16.03
.. matrix-cell::
:show-when: gfx=942
:show-when: gpu=mi325x
**MI325X** 01.25.04.02, 01.25.03.03
**MI300X** 01.25.05.00 (or later), 01.25.03.12
**MI300A** BKC 26, 25
01.25.04.02
.. matrix-cell::
:show-when: gfx=90a
:show-when: gpu=mi300x
**MI250X** IFWI 47 (or later)
01.25.03.12
**MI250** Maintenance update 5 with IFWI 75 (or later)
.. matrix-cell::
:show-when: gpu=mi300a
**MI210** Maintenance update 5 with IFWI 75 (or later)
BKC 26.1
.. matrix-cell::
:show-when: gpu=mi250x
IFWI 75 (or later)
.. matrix-cell::
:show-when: gpu=mi250 gpu=mi210
Maintenance update 5 with IFWI 75 (or later)

94
docs/compatibility/includes/system-radeon-pro.rst
View File

@@ -1,49 +1,64 @@
.. matrix::
:show-when: fam=radeon-pro
.. matrix-row::
:show-when: gfx=1100
.. matrix-head::
.. matrix-cell:: AMD Radeon PRO W7000 Series
.. raw:: html
<colgroup style="width: 50%;">
.. matrix-row::
.. matrix-cell:: AMD GPU series
:header:
.. matrix-cell::
:show-when: gpu=ai-r9700 gpu=ai-r9600d
`Radeon PRO W7900D <https://www.amd.com/en/support/downloads/drivers.html/graphics/radeon-pro/radeon-pro-w7000-series/amd-radeon-pro-w7900d.html>`__
`Radeon PRO W7900 <https://www.amd.com/en/products/graphics/workstations/radeon-pro/w7900.html>`__
`Radeon PRO W7800 48GB <https://www.amd.com/en/products/graphics/workstations/radeon-pro/w7800-48gb.html>`__
`Radeon PRO W7800 <https://www.amd.com/en/products/graphics/workstations/radeon-pro/w7800.html>`__
.. matrix-row::
:show-when: gfx=1101
.. matrix-cell:: AMD Radeon PRO W7000 Series
:header:
`AMD Radeon AI PRO R9000 Series <https://www.amd.com/en/products/graphics/workstations/radeon-ai-pro.html#tabs-95fa144b96-item-b95ec9e1ca-tab>`__
.. matrix-cell::
:show-when: gpu=w7900-dual-slot gpu=w7900 gpu=w7800-48gb gpu=w7800 gpu=w7700
`Radeon PRO W7700 <https://www.amd.com/en/products/graphics/workstations/radeon-pro/w7700.html>`__
`AMD Radeon PRO W7000 Series <https://www.amd.com/en/products/graphics/workstations/radeon-pro.html#tabs-990fdead92-item-20daa37284-tab>`__
.. matrix-cell::
:show-when: gpu=w6800
`AMD Radeon PRO W6000 Series <https://www.amd.com/en/products/graphics/workstations/radeon-pro/w6800.html>`__
.. matrix-cell::
:show-when: gpu=v710 gpu=v620
`AMD Radeon PRO V Series <https://www.amd.com/en/products/accelerators/radeon-pro.html>`__
.. matrix-row::
.. matrix-cell:: Architecture
:header:
.. matrix-cell:: RDNA 4
:show-when: gpu=ai-r9700 gpu=ai-r9600d
.. matrix-cell:: RDNA 3
:show-when: gpu=w7900-dual-slot gpu=w7900 gpu=w7800-48gb gpu=w7800 gpu=w7700 gpu=v710 gpu=w6800 gpu=v620
.. matrix-row::
.. matrix-cell:: LLVM target
:header:
.. matrix-cell:: gfx1101
:show-when: gfx=1101
.. matrix-cell:: gfx1201
:show-when: gpu=ai-r9700 gpu=ai-r9600d
.. matrix-cell:: gfx1100
:show-when: gfx=1100
:show-when: gpu=w7900-dual-slot gpu=w7900 gpu=w7800-48gb gpu=w7800
.. matrix-cell:: gfx1101
:show-when: gpu=w7700 gpu=v710
.. matrix-cell:: gfx1030
:show-when: gpu=w6800 gpu=v620
.. matrix-row::
:show-when: os=ubuntu
@@ -63,7 +78,11 @@
.. matrix-cell:: Supported RHEL versions
:header:
.. matrix-cell:: 10.1, 10.0
.. matrix-cell::
10.1 (kernel: 6.12.0-124)
9.7 (kernel: 5.14.0-427)
.. matrix-row::
:show-when: os=windows
@@ -74,26 +93,24 @@
.. matrix-cell:: Windows 11 25H2
.. matrix-row::
:show-when: os=ubuntu os=rhel
.. matrix-cell:: Supported AMD GPU Driver (amdgpu) versions
:header:
.. matrix-cell::
`30.20.0 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.20.0/>`__,
`30.10.2 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.10.2/>`__,
`30.10.1 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.10.1/>`__,
`30.10.0 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.10/>`__
.. matrix-row::
:show-when: os=ubuntu os=rhel os=sles
.. matrix-cell:: Supported Radeon Software for Linux version
:header:
.. matrix-cell::
`25.30.1 <https://www.amd.com/en/support/download/linux-drivers.html#linux-for-radeon-pro>`__
`31.10.0 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-31.10.0/documentation/release-notes.html>`__
`30.20.1 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.20.1/documentation/release-notes.html>`__
`30.20.0 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.20.0/documentation/release-notes.html>`__
`30.10.2 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.10.2/documentation/release-notes.html>`__
`30.10.1 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.10.1/documentation/release-notes.html>`__
`30.10.0 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.10/documentation/release-notes.html>`__
.. matrix-row::
:show-when: os=windows
@@ -103,9 +120,4 @@
.. matrix-cell::
`25.11.1 <https://www.amd.com/en/resources/support-articles/release-notes/RN-RAD-WIN-25-11-1.html>`__
(generally recommended)
`25.20.01.17 <https://www.amd.com/en/resources/support-articles/release-notes/RN-AMDGPU-WINDOWS-PYTORCH-7-1-1.html>`__
(recommended for ComfyUI)
`26.1.1 <https://www.amd.com/en/resources/support-articles/release-notes/RN-RAD-WIN-26-1-1.html>`__

83
docs/compatibility/includes/system-radeon.rst
View File

@@ -1,50 +1,54 @@
.. matrix::
:show-when: fam=radeon
.. matrix-row::
:show-when: gfx=1100
.. matrix-head::
.. matrix-cell:: AMD Radeon RX 7000 Series
.. raw:: html
<colgroup style="width: 50%;">
.. matrix-row::
.. matrix-cell:: AMD GPU series
:header:
.. matrix-cell::
:show-when: gpu=rx-9070 gpu=rx-9070-gre gpu=rx-9070-xt gpu=rx-9060 gpu=rx-9060-xt gpu=rx-9060-xt-lp
`Radeon RX 7900 XTX <https://www.amd.com/en/products/graphics/desktops/radeon/7000-series/amd-radeon-rx-7900xtx.html>`__
`Radeon RX 7900 XT <https://www.amd.com/en/products/graphics/desktops/radeon/7000-series/amd-radeon-rx-7900xt.html>`__
`Radeon RX 7900 GRE <https://www.amd.com/en/products/graphics/desktops/radeon/7000-series/amd-radeon-rx-7900-gre.html>`__
.. matrix-row::
:show-when: gfx=1101
.. matrix-cell:: AMD Radeon RX 7000 Series
:header:
`AMD Radeon RX 9000 Series <https://www.amd.com/en/products/graphics/desktops/radeon.html#tabs-ff9c5c3863-item-37fb38a236-tab>`__
.. matrix-cell::
:show-when: gpu=rx-7900-xtx gpu=rx-7900-xt gpu=rx-7900-gre gpu=rx-7800-xt gpu=rx-7700-xt gpu=rx-7700
`Radeon RX 7800 XT <https://www.amd.com/en/products/graphics/desktops/radeon/7000-series/amd-radeon-rx-7800-xt.html>`__
`Radeon RX 7700 XT <https://www.amd.com/en/products/graphics/desktops/radeon/7000-series/amd-radeon-rx-7700-xt.html>`__
`AMD Radeon RX 7000 Series <https://www.amd.com/en/products/graphics/desktops/radeon/7000-series.html>`__
.. matrix-row::
.. matrix-cell:: Architecture
:header:
.. matrix-cell:: RDNA 4
:show-when: gpu=rx-9070-xt gpu=rx-9070-gre gpu=rx-9070 gpu=rx-9060-xt-lp gpu=rx-9060-xt gpu=rx-9060
.. matrix-cell:: RDNA 3
:show-when: gfx=1101 gfx=1100
:show-when: gpu=rx-7900-xtx gpu=rx-7900-xt gpu=rx-7900-gre gpu=rx-7800-xt gpu=rx-7700-xt gpu=rx-7700
.. matrix-row::
.. matrix-cell:: LLVM target
:header:
.. matrix-cell:: gfx1201
:show-when: gpu=rx-9070 gpu=rx-9070-gre gpu=rx-9070-xt
.. matrix-cell:: gfx1200
:show-when: gpu=rx-9060 gpu=rx-9060-xt gpu=rx-9060-xt-lp
.. matrix-cell:: gfx1100
:show-when: gfx=1100
:show-when: gpu=rx-7900-xtx gpu=rx-7900-xt gpu=rx-7900-gre
.. matrix-cell:: gfx1101
:show-when: gfx=1101
:show-when: gpu=rx-7800-xt gpu=rx-7700-xt gpu=rx-7700
.. matrix-row::
:show-when: os=ubuntu
@@ -64,7 +68,11 @@
.. matrix-cell:: Supported RHEL versions
:header:
.. matrix-cell:: 10.1, 10.0
.. matrix-cell::
10.1 (kernel: 6.12.0-124)
9.7 (kernel: 5.14.0-427)
.. matrix-row::
:show-when: os=windows
@@ -75,26 +83,24 @@
.. matrix-cell:: Windows 11 25H2
.. matrix-row::
:show-when: os=ubuntu os=rhel
.. matrix-cell:: Supported AMD GPU Driver (amdgpu) versions
:header:
.. matrix-cell::
`30.20.0 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.20.0/>`__,
`30.10.2 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.10.2/>`__,
`30.10.1 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.10.1/>`__,
`30.10.0 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.10/>`__
.. matrix-row::
:show-when: os=ubuntu os=rhel os=sles
.. matrix-cell:: Supported Radeon Software for Linux version
:header:
.. matrix-cell::
`25.30.1 <https://www.amd.com/en/support/download/linux-drivers.html#linux-for-radeon-pro>`__
`31.10.0 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-31.10.0/documentation/release-notes.html>`__
`30.20.1 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.20.1/documentation/release-notes.html>`__
`30.20.0 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.20.0/documentation/release-notes.html>`__
`30.10.2 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.10.2/documentation/release-notes.html>`__
`30.10.1 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.10.1/documentation/release-notes.html>`__
`30.10.0 <https://instinct.docs.amd.com/projects/amdgpu-docs/en/docs-30.10/documentation/release-notes.html>`__
.. matrix-row::
:show-when: os=windows
@@ -104,9 +110,4 @@
.. matrix-cell::
`25.11.1 <https://www.amd.com/en/resources/support-articles/release-notes/RN-RAD-WIN-25-11-1.html>`__
(generally recommended)
`25.20.01.17 <https://www.amd.com/en/resources/support-articles/release-notes/RN-AMDGPU-WINDOWS-PYTORCH-7-1-1.html>`__
(recommended for ComfyUI)
`26.1.1 <https://www.amd.com/en/resources/support-articles/release-notes/RN-RAD-WIN-26-1-1.html>`__

73
docs/compatibility/includes/system-ryzen.rst
View File

@@ -1,49 +1,51 @@
.. matrix::
:show-when: fam=ryzen
.. matrix-row::
:show-when: gfx=1151
.. matrix-head::
.. matrix-cell:: AMD Ryzen AI Max PRO 300 Series
.. raw:: html
<colgroup style="width: 50%;">
.. matrix-row::
.. matrix-cell:: AMD APU series
:header:
.. matrix-cell::
:show-when: gpu=max-pro-395 gpu=max-pro-390 gpu=max-pro-385 gpu=max-pro-380
`Ryzen AI Max+ PRO 395 <https://www.amd.com/en/products/processors/laptop/ryzen-pro/ai-max-pro-300-series/amd-ryzen-ai-max-plus-pro-395.html>`__
`Ryzen AI Max PRO 390 <https://www.amd.com/en/products/processors/laptop/ryzen-pro/ai-max-pro-300-series/amd-ryzen-ai-max-pro-390.html>`__
`Ryzen AI Max PRO 385 <https://www.amd.com/en/products/processors/laptop/ryzen-pro/ai-max-pro-300-series/amd-ryzen-ai-max-pro-385.html>`__
`Ryzen AI Max PRO 380 <https://www.amd.com/en/products/processors/laptop/ryzen-pro/ai-max-pro-300-series/amd-ryzen-ai-max-pro-380.html>`__
.. matrix-row::
:show-when: gfx=1151
.. matrix-cell:: AMD Ryzen AI Max 300 Series
:header:
`AMD Ryzen AI Max PRO 300 Series <https://www.amd.com/en/products/processors/workstations/mobile.html#tabs-7f0c432fb2-item-5116ab7a74-tab>`__
.. matrix-cell::
:show-when: gpu=max-395 gpu=max-390 gpu=max-385
`Ryzen AI Max+ 395 <https://www.amd.com/en/products/processors/laptop/ryzen/ai-300-series/amd-ryzen-ai-max-plus-395.html>`__
`Ryzen AI Max 390 <https://www.amd.com/en/products/processors/laptop/ryzen/ai-300-series/amd-ryzen-ai-max-390.html>`__
`Ryzen AI Max 385 <https://www.amd.com/en/products/processors/laptop/ryzen/ai-300-series/amd-ryzen-ai-max-385.html>`__
.. matrix-row::
:show-when: gfx=1150
.. matrix-cell:: AMD Ryzen AI 300 Series
:header:
`AMD Ryzen AI Max 300 Series <https://www.amd.com/en/products/processors/laptop/ryzen.html#tabs-1181ea0b44-item-6ccfea5f65-tab>`__
.. matrix-cell::
:show-when: gpu=9-hx-375 gpu=9-hx-370 gpu=9-365
`Ryzen AI 9 HX 375 <https://www.amd.com/en/products/processors/laptop/ryzen/ai-300-series/amd-ryzen-ai-9-hx-375.html>`__
`AMD Ryzen AI 300 Series <https://www.amd.com/en/products/processors/consumer/ryzen-ai.html#tabs-f556098628-item-54e149d850-tab>`__
`Ryzen AI 9 HX 370 <https://www.amd.com/en/products/processors/laptop/ryzen/ai-300-series/amd-ryzen-ai-9-hx-370.html>`__
.. matrix-row::
`Ryzen AI 9 365 <https://www.amd.com/en/products/processors/laptop/ryzen/ai-300-series/amd-ryzen-ai-9-365.html>`__
.. matrix-cell:: Graphics model (iGPU)
:header:
.. matrix-cell:: Radeon 8060S
:show-when: gpu=max-pro-395 gpu=max-395
.. matrix-cell:: Radeon 8050S
:show-when: gpu=max-pro-390 gpu=max-pro-385 gpu=max-390 gpu=max-385
.. matrix-cell:: Radeon 8040S
:show-when: gpu=max-pro-380
.. matrix-cell:: Radeon 890M
:show-when: gpu=9-hx-375 gpu=9-hx-370
.. matrix-cell:: Radeon 880M
:show-when: gpu=9-365
.. matrix-row::
@@ -58,10 +60,10 @@
:header:
.. matrix-cell:: gfx1151
:show-when: gfx=1151
:show-when: gpu=max-pro-395 gpu=max-pro-390 gpu=max-pro-385 gpu=max-pro-380 gpu=max-395 gpu=max-390 gpu=max-385
.. matrix-cell:: gfx1150
:show-when: gfx=1150
:show-when: gpu=9-hx-375 gpu=9-hx-370 gpu=9-365
.. matrix-row::
:show-when: os=ubuntu
@@ -95,9 +97,4 @@
.. matrix-cell::
`25.11.1 <https://www.amd.com/en/resources/support-articles/release-notes/RN-RAD-WIN-25-11-1.html>`__
(generally recommended)
`25.20.01.17 <https://www.amd.com/en/resources/support-articles/release-notes/RN-AMDGPU-WINDOWS-PYTORCH-7-1-1.html>`__
(recommended for ComfyUI)
`26.1.1 <https://www.amd.com/en/resources/support-articles/release-notes/RN-RAD-WIN-26-1-1.html>`__

113
docs/compatibility/includes/virtualization-instinct.rst Normal file
View File

@@ -0,0 +1,113 @@
.. selected:: gpu=mi355x gpu=mi350x gpu=mi325x gpu=mi300x
:heading: GPU virtualization support
.. selected:: gpu=mi355x
AMD Instinct MI355X GPUs support the following virtualization
configurations.
Supported SR-IOV configurations require the GPU-IOV Module (GIM) driver
8.7.0K -- see the `AMD Instinct Virtualization Driver documentation
<https://instinct.docs.amd.com/projects/virt-drv/en/mainline-8.7.0.k/>`__ to
get started.
.. selected:: gpu=mi350x
AMD Instinct MI350X GPUs support the following virtualization
configurations.
Supported SR-IOV configurations require the GPU-IOV Module (GIM) driver
8.7.0K -- see the `AMD Instinct Virtualization Driver documentation
<https://instinct.docs.amd.com/projects/virt-drv/en/mainline-8.7.0.k/>`__ to
get started.
.. selected:: gpu=mi325x
AMD Instinct MI325X GPUs support the following virtualization
configurations.
Supported SR-IOV configurations require the GPU-IOV Module (GIM) driver
8.7.0K -- see the `AMD Instinct Virtualization Driver documentation
<https://instinct.docs.amd.com/projects/virt-drv/en/mainline-8.7.0.k/>`__ to
get started.
.. selected:: gpu=mi300x
AMD Instinct MI300X GPUs support the following virtualization
configurations.
Supported SR-IOV configurations require the GPU-IOV Module (GIM) driver
8.7.0K -- see the `AMD Instinct Virtualization Driver documentation
<https://instinct.docs.amd.com/projects/virt-drv/en/mainline-8.7.0.k/>`__ to
get started.
.. matrix::
.. matrix-row::
:header:
.. matrix-cell:: Hypervisor
.. matrix-cell:: Virtualization technology
.. matrix-cell:: Virtualization driver
.. matrix-cell:: Host OS
.. matrix-cell:: Guest OS
.. matrix-row::
:show-when: gpu=mi355x gpu=mi350x
.. matrix-cell:: KVM
:rowspan: 2
.. matrix-cell:: Passthrough
.. matrix-cell:: —
.. matrix-cell:: Ubuntu 24.04
:rowspan: 2
.. matrix-cell:: Ubuntu 24.04
:rowspan: 2
.. matrix-row::
:show-when: gpu=mi325x
.. matrix-cell:: KVM
.. matrix-cell:: SR-IOV
.. matrix-cell::
`GIM 8.7.0K <https://github.com/amd/MxGPU-Virtualization/releases/tag/8.7.0.K>`__
.. matrix-cell:: Ubuntu 22.04
.. matrix-cell:: Ubuntu 22.04
.. matrix-row::
:show-when: gpu=mi300x
.. matrix-cell:: KVM
:rowspan: 2
.. matrix-cell:: Passthrough
.. matrix-cell:: —
.. matrix-cell:: Ubuntu 22.04
:rowspan: 2
.. matrix-cell:: Ubuntu 22.04
:rowspan: 2
.. matrix-row::
:show-when: gpu=mi355x gpu=mi350x gpu=mi300x
.. matrix-cell:: SR-IOV
.. matrix-cell::
`GIM 8.7.0K <https://github.com/amd/MxGPU-Virtualization/releases/tag/8.7.0.K>`__
See the :ref:`release notes <release-virtualization-support>`
for the full list of supported configurations.

9
docs/conf.py
View File

@@ -9,8 +9,8 @@ import shutil
import sys
from pathlib import Path
ROCM_VERSION = "7.10.0"
GA_DATE = "2025-12-11"
ROCM_VERSION = "7.11.0"
GA_DATE = "2025-02-11"
DOCS_DIR = Path(__file__).parent.resolve()
ROOT_DIR = DOCS_DIR.parent
@@ -171,6 +171,7 @@ rst_prolog = f"""
.. |ROCM_VERSION| replace:: {ROCM_VERSION}
"""
exclude_patterns = ["**/includes/**"]
suppress_warnings = ["autosectionlabel.*"]
# html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "https://rocm-stg.amd.com/")
@@ -198,5 +199,5 @@ if os.environ.get("READTHEDOCS", "") == "True":
html_context["READTHEDOCS"] = True
# temporary settings to speed up docs build for faster iteration
# external_projects_remote_repository = ""
# external_toc_exclude_missing = True
external_projects_remote_repository = ""
external_toc_exclude_missing = True

562
docs/data/rocm-ontology.html Normal file
View File

@@ -0,0 +1,562 @@
<p>
<div class="rocm-docs-ontology-diagram container-fluid p-1 pl-3 text-white">
<div class="row g-1">
<div class="col-1"></div>
<div class="col-11">
<div class="row g-1">
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-grey h-100 d-flex align-items-center small fw-bold"
>
Enterprise applications
</div>
</div>
<div class="col-9">
<div class="row g-1">
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-grey small h-100"
>
Customer service
</div>
</div>
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-grey small h-100"
>
Sales assistant
</div>
</div>
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-grey small h-100"
>
Human resources
</div>
</div>
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-grey small h-100"
>
Marketing
</div>
</div>
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-grey small h-100"
>
Personal assistant
</div>
</div>
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-grey small h-100"
>
Coding assistant
</div>
</div>
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-grey small h-100"
>
Drug discovery
</div>
</div>
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-grey small h-100"
>
Material science
</div>
</div>
</div>
</div>
</div>
</div>
<div
class="col-1 d-flex align-items-center justify-content-center bg-amd-grey fw-bold vertical-text"
>
AMD ROCm<span class="trademark">&trade;</span> software ecosystem
</div>
<div class="col-11">
<div class="row g-1">
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-teal h-100 d-flex align-items-center small fw-bold"
>
AMD enterprise AI
</div>
</div>
<div class="col-9">
<div class="row g-1 h-100">
<div class="col-6">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-teal small h-100"
>
AMD Resource Manager
</div>
</div>
<div class="col-6">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-teal small h-100"
>
AMD Solution Blueprints
</div>
</div>
<div class="col-6">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-teal small h-100"
>
AMD Developer Console
</div>
</div>
<div class="col-6">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-teal small h-100"
>
AMD Inference Microservices
</div>
</div>
</div>
</div>
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-gold h-100 d-flex align-items-center small fw-bold"
>
AI ecosystem
</div>
</div>
<div class="col-9">
<div class="row g-1 h-100">
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-gold small h-100"
>
Hugging Face
</div>
</div>
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-gold small h-100"
>
PyTorch
</div>
</div>
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-gold small h-100"
>
JAX
</div>
</div>
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-gold small h-100"
>
TensorFlow
</div>
</div>
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-gold small h-100"
>
ONNX
</div>
</div>
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-gold small h-100"
>
Triton
</div>
</div>
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-gold small h-100"
>
DeepSpeed
</div>
</div>
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-gold small h-100"
>
OpenXLA
</div>
</div>
</div>
</div>
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-red h-100 d-flex align-items-center small fw-bold"
>
Cluster operations
</div>
</div>
<div class="col-9">
<div class="row g-1">
<div class="col-4">
<div class="rocm-docs-ontology-tile p-2 bg-amd-red small h-100">
Monitoring:
<ul>
<li>Prometheus</li>
<li>Grafana</li>
</ul>
</div>
</div>
<div class="col-4">
<div class="rocm-docs-ontology-tile p-2 bg-amd-red small h-100">
MLOps platforms:
<ul>
<li>mlflow</li>
<li>Kubeflow</li>
</ul>
</div>
</div>
<div class="col-4">
<div class="rocm-docs-ontology-tile p-2 bg-amd-red small h-100">
Model serving runtimes:
<ul>
<li>vLLM</li>
<li>PyTorch</li>
</ul>
</div>
</div>
</div>
</div>
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-orange h-100 d-flex align-items-center small fw-bold"
>
Vertical SDKs
</div>
</div>
<div class="col-9">
<div class="row g-1">
<div class="col">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-orange small h-100"
>
ROCm-DS
</div>
</div>
<div class="col">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-orange small h-100"
>
ROCm-LS
</div>
</div>
<div class="col">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-orange small h-100"
>
ROCm-Finance
</div>
</div>
<div class="col">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-orange small h-100"
>
ROCm-Simulation
</div>
</div>
</div>
</div>
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-teal h-100 d-flex align-items-center small fw-bold"
>
ROCm Core SDK
</div>
</div>
<div class="col-9">
<div class="row g-1">
<div class="col-6">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-teal small h-100"
>
Math and compute libraries
</div>
</div>
<div class="col-6">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-teal small h-100"
>
Communication libraries
</div>
</div>
<div class="col-6">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-teal small h-100"
>
Support libraries
</div>
</div>
<div class="col-6">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-teal small h-100"
>
Media libraries
</div>
</div>
<div class="col-6">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-teal small h-100"
>
Storage
</div>
</div>
<div class="col-6">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-teal small h-100"
>
Runtimes and compilers
</div>
</div>
<div class="col-6">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-teal small h-100"
>
Profiling and debugging tools
</div>
</div>
<div class="col-6">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-teal small h-100"
>
Control and monitoring tools
</div>
</div>
</div>
</div>
<div class="col-3 d-flex align-items-center">
<div
class="
rocm-docs-ontology-tile p-2 bg-amd-gold h-100 w-100
d-flex align-items-center
small fw-bold
"
>
Systems and infrastructure
</div>
</div>
<div class="col-9">
<div class="row g-1">
<div class="col-6">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-gold small h-100"
>
Kubernetes:
<ul>
<li>GPU Operator</li>
<li>Device Plugin</li>
<li>Container Toolkit</li>
<li>Device Metrics Exporter</li>
<li>Device Plugin</li>
</ul>
</div>
</div>
<div class="col-6">
<div class="row h-100">
<div class="col-12 d-flex flex-grow-1">
<div
class="
rocm-docs-ontology-tile p-2 bg-amd-gold small w-100
d-flex align-items-center mb-1
"
>
AMD GPU Driver and runtime firmware
</div>
</div>
<div class="col-12 d-flex flex-grow-1">
<div
class="
rocm-docs-ontology-tile p-2 bg-amd-gold small w-100
d-flex align-items-center mb-1
"
>
AMD Virtualization Driver
</div>
</div>
<div class="col-12 d-flex flex-grow-1">
<div
class="
rocm-docs-ontology-tile p-2 bg-amd-gold small w-100
d-flex align-items-center mb-1
"
>
AMD Instinct<span class="trademark">&trade;</span> Fabric
Manager
</div>
</div>
<div class="col-12 d-flex flex-grow-1">
<div
class="
rocm-docs-ontology-tile p-2 bg-amd-gold small w-100
d-flex align-items-center
"
>
Management tools
</div>
</div>
</div>
</div>
</div>
</div>
<div class="col-3 d-flex align-items-center">
<div
class="
rocm-docs-ontology-tile p-2 bg-amd-red h-100 w-100
d-flex align-items-center
small fw-bold
"
>
Supported OSes
</div>
</div>
<div class="col-9">
<div class="row g-1">
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-red small h-100"
>
Ubuntu
</div>
</div>
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-red small h-100"
>
Debian
</div>
</div>
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-red small h-100"
>
RHEL
</div>
</div>
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-red small h-100"
>
Oracle Linux
</div>
</div>
<div class="col-4">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-red small h-100"
>
Rocky Linux
</div>
</div>
<div class="col-4">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-red small h-100"
>
SLES
</div>
</div>
<div class="col-4">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-red small h-100"
>
Windows
</div>
</div>
</div>
</div>
<div class="col-3">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-orange h-100 d-flex align-items-center small fw-bold"
>
OEM/ODM firmware
</div>
</div>
<div class="col-9">
<div class="row g-1">
<div class="col">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-orange small h-100"
>
Baseboard and GPU firmware (platform-optimized firmware)
</div>
</div>
</div>
</div>
</div>
</div>
<div class="col-1"></div>
<div class="col-11">
<div class="row g-1">
<div class="col-12">
<div
class="rocm-docs-ontology-tile p-2 bg-amd-grey h-100 d-flex justify-content-center align-items-center small fw-bold"
>
AMD GPUs and APUs
</div>
</div>
</div>
</div>
</div>
</div>
</p>
<style>
.rocm-docs-ontology-diagram {
background-color: #1b1b1b;
.bg-amd-grey {
background-color: #6e6e6e;
}
.bg-amd-gold {
background-color: #b08a3a;
}
.bg-amd-orange {
background-color: #3a5f4b;
}
.bg-amd-red {
background-color: #2f4d69;
}
.bg-amd-teal {
background-color: #007c97;
}
.rocm-docs-ontology-tile:not(.vertical-text) {
transition: transform 0.25s ease, box-shadow 0.25s ease;
will-change: transform;
cursor: pointer;
}
.rocm-docs-ontology-tile:hover {
transform: scale(1.02);
box-shadow: 0 0.5rem 1rem rgba(0, 0, 0, 0.25);
z-index: 1;
}
/* Rotates the text for the sidebar */
.vertical-text {
writing-mode: vertical-rl;
transform: rotate(180deg);
}
.vertical-text .trademark {
display: inline-block;
transform: rotate(90deg);
}
.row {
display: flex;
}
}
</style>

BIN
docs/data/rocm-ontology.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 1.2 MiB

211
docs/data/rocm-sdk-arch.html Normal file
View File

@@ -0,0 +1,211 @@
<p>
<div class="rocm-docs-core-sdk-diagram container-fluid p-1 pl-3 text-white">
<div class="row g-1">
<div
class="col-1 d-flex align-items-center justify-content-center bg-amd-grey fw-bold vertical-text"
>
ROCm<span class="trademark">&trade;</span> Core SDK
</div>
<div class="col-11">
<div class="row g-1">
<div class="col-4">
<div
class="rocm-docs-core-sdk-tile bg-amd-blue p-2 h-100 d-flex align-items-center small fw-bold"
>
Math and compute libraries
</div>
</div>
<div class="col-8">
<div class="row g-1">
<div class="col-12">
<div
class="rocm-docs-core-sdk-tile p-2 small h-100"
>
<strong>Deep learning and GPU compute kernels</strong>:<br>
Composable Kernel, MIOpen, rocWMMA, hipDNN (coming soon)
</div>
</div>
<div class="col-12">
<div
class="rocm-docs-core-sdk-tile p-2 small h-100"
>
<strong>BLAS dense and sparse libraries</strong>:<br>
hipBLAS, hipBLASLt, hipSOLVER, hipSPARSE, hipSPARSELt
</div>
</div>
<div class="col-12">
<div
class="rocm-docs-core-sdk-tile p-2 small h-100"
>
<strong>Kernel primitives</strong>:<br>
hipCUB, rocPRIM, rocThrust
</div>
</div>
<div class="col-12">
<div
class="rocm-docs-core-sdk-tile p-2 small h-100"
>
<strong>Other math</strong>:<br>
hipRAND, hipFFT
</div>
</div>
</div>
</div>
<div class="col-4">
<div
class="rocm-docs-core-sdk-tile bg-amd-blue p-2 h-100 d-flex align-items-center small fw-bold"
>
Communication libraries
</div>
</div>
<div class="col-8">
<div class="row g-1">
<div class="col">
<div
class="rocm-docs-core-sdk-tile p-2 small h-100"
>
RCCL, rocSHMEM
</div>
</div>
</div>
</div>
<div class="col-4">
<div
class="rocm-docs-core-sdk-tile bg-amd-blue p-2 h-100 d-flex align-items-center small fw-bold"
>
Storage
</div>
</div>
<div class="col-8">
<div class="row g-1">
<div class="col">
<div
class="rocm-docs-core-sdk-tile p-2 small h-100"
>
hipFile (coming soon)
</div>
</div>
</div>
</div>
<div class="col-4">
<div
class="rocm-docs-core-sdk-tile bg-amd-blue p-2 h-100 d-flex align-items-center small fw-bold"
>
Runtimes and compilers
</div>
</div>
<div class="col-8">
<div class="row g-1">
<div class="col">
<div
class="rocm-docs-core-sdk-tile p-2 small h-100"
>
HIP, HIPIFY, LLVM, ROCr Runtime, SPIRV-LLVM-Translator
</div>
</div>
</div>
</div>
<div class="col-4">
<div
class="rocm-docs-core-sdk-tile bg-amd-blue p-2 h-100 d-flex align-items-center small fw-bold"
>
Profiling and debugging tools
</div>
</div>
<div class="col-8">
<div class="row g-1">
<div class="col-12">
<div
class="rocm-docs-core-sdk-tile p-2 small h-100"
>
<strong>ROCprofiler family</strong>:<br>ROCm Compute Profiler
(rocprofiler-compute), ROCm Systems Profiler
(rocprofiler-systems), ROCprofiler-SDK and rocprofv3 CLI
</div>
</div>
<div class="col-12">
<div
class="rocm-docs-core-sdk-tile p-2 small h-100"
>
<strong>ROCm Debugger family</strong>:<br>ROCm Debugger
(ROCgdb), ROCdbgapi, ROCr Debug Agent
</div>
</div>
</div>
</div>
<div class="col-4">
<div
class="
rocm-docs-core-sdk-tile bg-amd-blue p-2 h-100 w-100
d-flex align-items-center
small fw-bold
"
>
Control and monitoring tools
</div>
</div>
<div class="col-8">
<div class="row g-1">
<div class="col">
<div
class="rocm-docs-core-sdk-tile p-2 small h-100"
>
AMD SMI, hipinfo, rocminfo
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</p>
<style>
.rocm-docs-core-sdk-diagram {
background-color: #1b1b1b;
.rocm-docs-core-sdk-tile {
background-color: #007c97;
}
.bg-amd-grey {
background-color: #6e6e6e;
}
.bg-amd-blue {
opacity: 90%;
}
.rocm-docs-core-sdk-tile:not(.vertical-text) {
transition: transform 0.25s ease, box-shadow 0.25s ease;
will-change: transform;
cursor: pointer;
}
.rocm-docs-core-sdk-tile:hover {
transform: scale(1.02);
box-shadow: 0 0.5rem 1rem rgba(0, 0, 0, 0.25);
z-index: 1;
}
/* Rotates the text for the sidebar */
.vertical-text {
writing-mode: vertical-rl;
transform: rotate(180deg);
}
.vertical-text .trademark {
display: inline-block;
transform: rotate(90deg);
}
.row {
display: flex;
}
}
</style>

BIN
docs/data/rocm-sdk-arch.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 46 KiB

68
docs/extension/rocm_docs_custom/selector.py
View File

@@ -72,6 +72,18 @@ class SelectorGroupDirective(SphinxDirective):
}
def run(self):
env = self.state.document.settings.env
app = env.app
# Add required JS and CSS if selector exists
if not hasattr(env, '_selector_js_added'):
static_assets_dir = Path(__file__).parent / "static" / "selector"
app.config.html_static_path.append(str(static_assets_dir))
app.add_js_file("selector.js", type="module", defer="defer")
app.add_css_file("selector.css")
env._selector_js_added = True
label = self.arguments[0]
node = SelectorGroup()
node["label"] = label
@@ -168,10 +180,19 @@ class SelectorOption(nodes.General, nodes.Element):
return
default_class = "rocm-docs-selector-option-default" if default else ""
# Handle width: either bootstrap col-N or percentage
if isinstance(width, str) and width.endswith("%"):
width_class = ""
width_style = f' style="width: {width}"'
else:
width_class = f"col-{width}"
width_style = ""
translator.body.append(
"<!-- start selector-option tile -->"
f"""
<div class="rocm-docs-selector-option {default_class} col-{width} px-2"
<div class="rocm-docs-selector-option {default_class} {width_class} px-2"
data-selector-key="{node.get('group_key', '')}"
data-selector-value="{value}"
{show_when_attr}
@@ -179,6 +200,7 @@ class SelectorOption(nodes.General, nodes.Element):
tabindex="0"
role="radio"
aria-checked="false"
{width_style}
>
<span>{label}</span>
""".strip()
@@ -203,7 +225,7 @@ class SelectorOptionDirective(SphinxDirective):
"show-when": directives.unchanged,
"disable-when": directives.unchanged,
"default": directives.flag,
"width": directives.nonnegative_int,
"width": directives.unchanged,
"icon": directives.unchanged,
}
has_content = True
@@ -216,14 +238,35 @@ class SelectorOptionDirective(SphinxDirective):
node["show-when"] = self.options.get("show-when", "")
node["disable-when"] = self.options.get("disable-when", "")
node["default"] = self.options.get("default", False) is not False
node["width"] = self.options.get("width", 6)
node["icon"] = self.options.get("icon")
# Content replaces label if provided
# if self.content:
# self.state.nested_parse(self.content, self.content_offset, node)
# else:
# node += nodes.Text(label)
# Parse width - supports bootstrap (1-12) or percentage (like "25%")
width_value = self.options.get("width", "6")
if isinstance(width_value, str) and width_value.endswith("%"):
try:
pct = float(width_value[:-1])
if pct <= 0 or pct > 100:
raise ValueError("must be between 0 and 100")
node["width"] = width_value
except ValueError as e:
logger.warning(
f"Invalid percentage width '{width_value}' ({e}), using default",
location=(self.env.docname, self.lineno),
)
node["width"] = 6
else:
try:
col_num = int(width_value)
if col_num < 1 or col_num > 12:
raise ValueError("must be between 1 and 12")
node["width"] = col_num
except ValueError as e:
logger.warning(
f"Invalid width '{width_value}' ({e}), using default",
location=(self.env.docname, self.lineno),
)
node["width"] = 6
node["icon"] = self.options.get("icon")
parent = getattr(self.state, "parent", None)
if not parent or not any(isinstance(p, SelectorGroup) for p in parent.traverse(include_self=True)):
@@ -346,9 +389,4 @@ def setup(app):
app.add_directive("selected-content", SelectedContentDirective)
app.add_directive("selected", SelectedContentDirective)
static_assets_dir = Path(__file__).parent / "static" / "selector"
app.config.html_static_path.append(str(static_assets_dir))
app.add_css_file("selector.css")
app.add_js_file("selector.js", type="module", defer="defer")
return {"version": "1.1", "parallel_read_safe": True}
return {"version": "1.2", "parallel_read_safe": True}

55
docs/extension/rocm_docs_custom/static/selector/selector-toc.js
View File

@@ -7,8 +7,6 @@ const HEADING_QUERY = ".rocm-docs-selected-content h1,h2,h3,h4,h5,h6";
const TOC_ITEM_CLASS = "rocm-docs-selector-toc2-item";
const EMPTY_ITEM_CLASS = "empty";
let optionsTocInitialized = false;
function isVisible(el) {
return !!(el && el.offsetParent !== null);
}
@@ -31,59 +29,6 @@ function getUniqueGroups(groups) {
});
}
function initTOC2OptionsList() {
const tocOptionsList = document.querySelector(TOC2_OPTIONS_LIST_QUERY);
if (!tocOptionsList) return;
tocOptionsList.innerHTML = "";
let groups = Array.from(document.querySelectorAll(GROUP_QUERY)).filter(isVisible);
groups = getUniqueGroups(groups);
if (groups.length === 0) {
const li = document.createElement("li");
li.className = `nav-item toc-entry toc-h3 ${TOC_ITEM_CLASS} ${EMPTY_ITEM_CLASS}`;
const span = document.createElement("span");
span.textContent = "(no visible selectors)";
li.appendChild(span);
tocOptionsList.appendChild(li);
optionsTocInitialized = true;
return;
}
groups.forEach((group) => {
const headingSpan = group.querySelector(
".rocm-docs-selector-group-heading-text"
);
const headingText = headingSpan
? headingSpan.textContent.trim()
: "(Unnamed Selector)";
const li = document.createElement("li");
li.className = `nav-item toc-entry toc-h3 ${TOC_ITEM_CLASS}`;
li.dataset.groupId = group.id || "";
const link = document.createElement("a");
link.className = "nav-link";
link.href = group.id ? `#${group.id}` : "#";
link.dataset.headingText = headingText;
const selectedOption = group.querySelector(`.${SELECTED_CLASS}`);
let optionText = "(none selected)";
if (selectedOption) {
const clone = selectedOption.cloneNode(true);
clone.querySelectorAll("i, svg").forEach((el) => el.remove());
optionText = clone.innerHTML.trim();
}
link.innerHTML = `<strong>${headingText}</strong>: ${optionText}`;
li.appendChild(link);
tocOptionsList.appendChild(li);
});
optionsTocInitialized = true;
}
export function updateTOC2OptionsList() {
const tocOptionsList = document.querySelector(TOC2_OPTIONS_LIST_QUERY);
if (!tocOptionsList) return;

138
docs/extension/rocm_docs_custom/static/selector/selector.js
View File

@@ -13,6 +13,8 @@ const DISABLED_CLASS = "rocm-docs-disabled";
const HIDDEN_CLASS = "rocm-docs-hidden";
const SELECTED_CLASS = "rocm-docs-selected";
const STORAGE_KEY = "rocm-docs-selector-state";
// Toggle helpers -------------------------------------------------------------
const isDefaultOption = (elem) => elem.classList.contains(DEFAULT_OPTION_CLASS);
@@ -49,6 +51,62 @@ const deselect = (elem) => {
elem.setAttribute("aria-checked", "false");
};
// URL synchronization --------------------------------------------------------
function syncStateToURL() {
const params = new URLSearchParams();
for (const [key, value] of Object.entries(state)) {
params.set(key, value);
}
const newURL = params.toString()
? `${window.location.pathname}?${params.toString()}${window.location.hash}`
: `${window.location.pathname}${window.location.hash}`;
window.history.replaceState({}, "", newURL);
logDebug("URL updated:", newURL);
}
function getStateFromURL() {
const params = new URLSearchParams(window.location.search);
const urlState = {};
for (const [key, value] of params) {
urlState[key] = value;
}
return urlState;
}
// localStorage synchronization -----------------------------------------------
function syncStateToLocalStorage() {
try {
localStorage.setItem(STORAGE_KEY, JSON.stringify(state));
logDebug("localStorage updated:", state);
} catch (err) {
console.warn("[ROCmDocsSelector] Failed to save to localStorage:", err);
}
}
function getStateFromLocalStorage() {
try {
const stored = localStorage.getItem(STORAGE_KEY);
if (!stored) return {};
const parsed = JSON.parse(stored);
logDebug("localStorage loaded:", parsed);
return parsed;
} catch (err) {
console.warn(
"[ROCmDocsSelector] Failed to read from localStorage:",
err,
);
return {};
}
}
// Global selector state ------------------------------------------------------
const state = {};
@@ -60,6 +118,8 @@ function getState() {
function setState(updates) {
Object.assign(state, updates);
logDebug("State updated:", state);
syncStateToURL();
syncStateToLocalStorage();
}
// Condition handling ---------------------------------------------------------
@@ -119,8 +179,7 @@ function shouldBeDisabled(elem) {
const conditions = parseConditions("disable-when", raw);
if (!conditions) {
console.warn(
"[ROCmDocsSelector] Invalid 'show-when' conditions; " +
"hiding affected element.",
"[ROCmDocsSelector] Invalid 'disable-when' conditions; not disabling affected element.",
);
return false;
}
@@ -181,7 +240,7 @@ function handleOptionKeydown(e) {
}
}
// Visibility / enablement update --------------------------------------------
// Visibility / enablement update ---------------------------------------------
// Ensure each selector group always has a valid selected option.
// If the current selection becomes disabled/hidden due to another selector's
@@ -191,8 +250,13 @@ function reconcileGroupSelections() {
const updates = {};
document.querySelectorAll(GROUP_QUERY).forEach((group) => {
// Skip groups that are themselves hidden
if (group.classList.contains(HIDDEN_CLASS)) return;
// Skip groups that are hidden OR inside a hidden parent
if (
group.classList.contains(HIDDEN_CLASS) ||
group.closest(`.${HIDDEN_CLASS}`)
) {
return;
}
const options = Array.from(group.querySelectorAll(OPTION_QUERY));
if (!options.length) return;
@@ -229,10 +293,27 @@ function reconcileGroupSelections() {
return;
}
// Need a new selection: prefer a default option, otherwise the first
// enabled+visible option in DOM order.
const replacement = enabledVisible.find(isDefaultOption) ||
enabledVisible[0];
// Need a new selection: prioritize current state value
let replacement;
// 1. Try to match the current global state value (if exists)
const stateValue = currentState[groupKey];
if (stateValue) {
replacement = enabledVisible.find(
(opt) => opt.dataset.selectorValue === stateValue,
);
}
// 2. If no match, prefer a default option
if (!replacement) {
replacement = enabledVisible.find(isDefaultOption);
}
// 3. Otherwise use the first enabled+visible option
if (!replacement) {
replacement = enabledVisible[0];
}
if (!replacement) return;
options.forEach(deselect);
@@ -303,7 +384,17 @@ function updateVisibility() {
domReady(() => {
const selectorOptions = document.querySelectorAll(OPTION_QUERY);
const initialState = {};
if (!selectorOptions?.length) {
// Clear URLSearchParams if page does not have selector
const url = new URL(window.location);
url.search = "";
window.history.replaceState({}, "", url);
return;
}
const defaultState = {};
const localStorageState = getStateFromLocalStorage();
const urlState = getStateFromURL();
// Attach listeners and gather defaults
selectorOptions.forEach((option) => {
@@ -311,14 +402,35 @@ domReady(() => {
option.addEventListener("keydown", handleOptionKeydown);
if (isDefaultOption(option)) {
select(option);
const { selectorKey: key, selectorValue: value } = option.dataset;
if (key && value && initialState[key] === undefined) {
initialState[key] = value;
if (key && value && defaultState[key] === undefined) {
defaultState[key] = value;
}
}
});
// Merge with priority: URL > localStorage > defaults
const initialState = {
...defaultState,
...localStorageState,
...urlState,
};
// Apply initial selections from merged state
for (const [key, value] of Object.entries(initialState)) {
const allOptions = document.querySelectorAll(
`${OPTION_QUERY}[data-selector-key="${key}"]`,
);
allOptions.forEach((opt) => {
if (opt.dataset.selectorValue === value) {
select(opt);
} else {
deselect(opt);
}
});
}
setState(initialState);
updateVisibility();

5
docs/extension/rocm_docs_custom/static/table.css
View File

@@ -29,7 +29,12 @@ html[data-theme="dark"] {
background-color: var(--rocm-docs-table-head-bg-color);
border: 2px solid var(--rocm-docs-table-border-color);
}
.rocm-docs-table td {
background-color: var(--rocm-docs-table-bg-color);
border: 2px solid var(--rocm-docs-table-border-color) !important;
}
.rocm-docs-table p:not(:last-child) {
margin-bottom: 0.3rem;
}

14
docs/index.rst
View File

@@ -36,13 +36,11 @@ frameworks such as PyTorch.
* **Comprehensive** -- End‑to‑end toolchain from compilers to libraries
* **Performance‑focused** -- Tuned for AMD Instinct™, AMD Radeon™, and AMD Ryzen™ devices
.. image:: data/rocm-ontology.png
:align: center
:alt: ROCm software ecosystem and components illustration
:width: 1000
.. raw:: html
:file: data/rocm-ontology.html
ROCm supports AMD GPU architectures spanning data center, workstation, and APU
categories. TheRock enables a unified ROCm user‑space experience across
product lines. TheRock enables a unified ROCm user‑space experience across
devices.
* **AMD Instinct GPUs** -- Purpose‑built for large‑scale compute, AI training, and HPC workloads.
@@ -74,10 +72,8 @@ The ROCm Core SDK provides the foundational components that power the ROCm
ecosystem — runtimes, compilers, math libraries, and system utilities for GPGPU
computing.
.. image:: data/rocm-sdk-arch.png
:align: center
:alt: ROCm Core SDK internal architecture illustration
:width: 1000
.. raw:: html
:file: data/rocm-sdk-arch.html
The TheRock infrastructure keeps these components modular, consistent, and easy
to integrate across configurations.

842
docs/install/includes/install.rst
View File

File diff suppressed because it is too large Load Diff

39
docs/install/includes/post-install.rst
View File

@@ -8,13 +8,13 @@ Post-installation
.. include:: ./includes/selector.rst
After installing the ROCm Core SDK |ROCM_VERSION| -- see :ref:`rocm-install` --
complete these post-installation steps to complete your system configuration
and validate the installation.
After installing the ROCm Core SDK |ROCM_VERSION|, complete these
post-installation steps to complete your system configuration and validate the
installation.
.. selected:: i=tar
.. selected:: os=ubuntu os=rhel os=sles
.. selected:: os=ubuntu os=debian os=rhel os=oracle-linux os=rocky-linux os=sles
:heading: Configure your environment
:heading-level: 3
@@ -84,21 +84,21 @@ and validate the installation.
Configure environment variables so that ROCm libraries and tools are
available on your Windows system.
1. Set the following environment variables using the command
prompt as an administrator:
1. **Run command prompt as an administrator** and set the following environment variables.
.. code-block:: bat
.. code-block:: cmd
setx HIP_DEVICE_LIB_PATH “C:\TheRock\build\lib\llvm\amdgcn\bitcode” /M
setx HIP_PATH “C:\TheRock\build” /M
setx HIP_PLATFORM “amd” /M
setx LLVM_PATH “C:\TheRock\build\lib\llvm” /M
2. Add the following paths into PATH environment variable using your system settings GUI.
2. Add the following paths into the PATH environment variable.
- ``C:\TheRock\build\bin``
.. code-block:: cmd
- ``C:\TheRock\build\lib\llvm\bin``
setx PATH "%PATH%;C:\TheRock\build\bin" /M
setx PATH "%PATH%;C:\TheRock\build\lib\llvm\bin" /M
3. Open a new command prompt window for the environment variables to take effect. Run ``set``
to see the list of active variables.
@@ -107,12 +107,12 @@ and validate the installation.
set
.. selected:: os=ubuntu os=rhel os=sles
.. selected:: os=ubuntu os=debian os=rhel os=oracle-linux os=rocky-linux os=sles
:heading: Verify your installation
:heading-level: 3
Use the following ROCm tools to verify that the ROCm stack is correctly
installed and that your AMD GPU is visible to the system.
Use the following ROCm tools to verify that the ROCm Core SDK is correctly
installed and that your AMD devices are visible to the system.
1. Use ``rocminfo`` to list detected AMD GPUs and confirm that the ROCm
runtimes and drivers are correctly installed and loaded.
@@ -129,7 +129,7 @@ and validate the installation.
.. code-block:: shell-session
ROCk module is loaded
ROCk module version 6.18.4 is loaded
=====================
HSA System Attributes
=====================
@@ -171,7 +171,7 @@ and validate the installation.
.. code-block:: shell-session
AMDSMI Tool: 26.1.0+cd50d9e0 | AMDSMI Library version: 26.1.0 | ROCm version: 7.10.0 | amdgpu version: 6.16.6 | amd_hsmp version: N/A
AMDSMI Tool: 26.2.1+7b886380f9 | AMDSMI Library version: 26.2.1 | ROCm version: 7.11.0 | amdgpu version: 6.18.4 | hsmp version: N/A
.. selected:: i=pip
@@ -188,8 +188,8 @@ and validate the installation.
:heading: Verify your installation
:heading-level: 3
Use the following ROCm tools to verify that the ROCm stack is correctly
installed and that your AMD GPU is visible to the system.
Use the following ROCm tools to verify that the ROCm Core SDK is correctly
installed and that your AMD devices are visible to the system.
.. selected:: i=pip
@@ -254,7 +254,7 @@ and validate the installation.
... [output truncated]
.. selected:: os=ubuntu os=rhel os=sles
.. selected:: os=ubuntu os=debian os=rhel os=oracle-linux os=rocky-linux os=sles
.. selected:: i=pip
:heading: Test your installation
@@ -270,6 +270,7 @@ and validate the installation.
rocm-sdk path --cmake
rocm-sdk path --bin
rocm-sdk path --root
rocm-sdk test
To learn more about the ``rocm-sdk`` tool and to see example expected
outputs, see `Using ROCm Python packages (TheRock)
@@ -310,7 +311,7 @@ and validate the installation.
If you need to deactivate your Python virtual environment when finished, run:
.. code-block::
.. code-block:: bash
deactivate

354
docs/install/includes/prerequisites.rst
View File

@@ -1,72 +1,100 @@
Prerequisites
=============
Before installing the ROCm Core SDK |ROCM_VERSION|, ensure your system meets
all prerequisites. This includes installing the required dependencies and
configuring permissions for GPU access. To confirm that your system is
supported, see the :doc:`Compatibility matrix
</compatibility/compatibility-matrix>`.
.. selected:: os=ubuntu os=debian os=rhel os=oracle-linux os=rocky-linux os=sles
.. selected:: os=ubuntu os=rhel os=sles
Before installing the ROCm Core SDK |ROCM_VERSION|, ensure your system meets
all prerequisites. This includes installing the required dependencies and
configuring permissions for GPU access. To confirm that your system is
supported, see the :doc:`Compatibility matrix
</compatibility/compatibility-matrix>`.
.. dropdown:: Install essential packages for Docker containers
:animate: fade-in-slide-down
:color: info
:icon: tools
:chevron: down-up
.. selected:: os=windows
Docker images often include only a minimal set of installations, so some
essential packages might be missing. When installing ROCm within a Docker
container, you might need to install additional packages for a successful
installation.
Before installing the ROCm Core SDK |ROCM_VERSION|, ensure your system meets
all prerequisites. To confirm that your system is supported, see the
:doc:`Compatibility matrix </compatibility/compatibility-matrix>`.
If applicable, run the following command to install essential packages:
.. ====================================================== DOCKER REQUIREMENTS ==
.. selected:: os=ubuntu
.. selected:: i=pip i=tar i=pkgman
.. code-block:: bash
.. selected:: os=ubuntu os=debian os=rhel os=rocky-linux os=oracle-linux os=sles
apt update
apt install sudo wget python3 libatomic1
.. dropdown:: Install essential packages for Docker containers
:animate: fade-in-slide-down
:color: info
:icon: tools
:chevron: down-up
.. selected:: os=rhel
Docker images often include only a minimal set of installations, so some
essential packages might be missing. When installing ROCm within a Docker
container, you might need to install additional packages for a successful
installation.
.. selected:: os-version=10.1 os-version=10.0 os-version=9.7 os-version=9.6
If applicable, run the following command to install essential packages:
.. selected:: os=ubuntu os=debian
.. selected:: i=pkgman
.. code-block:: bash
apt update
apt install sudo wget
.. selected:: i=pip
.. code-block:: bash
apt update
apt install sudo cmake libgfortran5
.. selected:: i=tar
.. code-block:: bash
apt update
apt install sudo wget python3
.. selected:: os=rhel os=rocky-linux os=oracle-linux
.. code-block:: bash
dnf install sudo wget libatomic
dnf install sudo wget
.. selected:: os-version=8
.. selected:: os=sles
.. code-block:: bash
.. selected:: i=pkgman
dnf install sudo wget libatomic python3
.. code-block:: bash
.. selected:: os=sles
zypper install sudo wget SUSEConnect
.. code-block:: bash
.. selected:: i=pip
zypper install sudo libatomic1 libgfortran5 wget SUSEConnect python3
.. code-block:: bash
zypper install sudo wget cmake libgfortran5
.. selected:: i=tar
.. code-block:: bash
zypper install sudo wget
.. selected:: os=windows
1. Remove any existing HIP SDK for Windows installations and other
conflicting AMD graphics software.
conflicting AMD graphics software. To uninstall the HIP SDK using the
GUI, navigate to the following screen:
2. Install the Adrenalin Driver for Windows.
* Control Panel > Programs > Uninstall a program
* For general use cases, use the Adrenalin Driver version 25.11.1. For
details and the download link, see `AMD Software: Adrenalin
Edition 25.11.1
<https://www.amd.com/en/resources/support-articles/release-notes/RN-RAD-WIN-25-11-1.html>`__.
* If you intend to run :ref:`ComfyUI workloads
<install-comfyui-windows>`, use driver version 25.20.01.17. For
details and the download link, see `AMD Software: PyTorch on Windows
Edition 7.1.1
<https://www.amd.com/en/resources/support-articles/release-notes/RN-AMDGPU-WINDOWS-PYTORCH-7-1-1.html>`__.
2. Install AMD Software: Adrenalin Edition for Windows. For details and the
download link, see `AMD Software: Adrenalin Edition 26.1.1
<https://www.amd.com/en/resources/support-articles/release-notes/RN-RAD-WIN-26-1-1.html#Downloads>`__.
3. Disable the following Windows security features as they can interfere
with ROCm functionality:
@@ -82,6 +110,27 @@ supported, see the :doc:`Compatibility matrix
* Settings > Privacy & security > Windows Security > App & browser
control > Smart App Control settings > **Off**
.. =============================================================== OEM KERNEL ==
.. selected:: fam=ryzen
.. selected:: os=ubuntu
:heading: Install the OEM kernel
:heading-level: 3
Ryzen APUs require the OEM kernel 6.14 for Ubuntu 24.04. Use the
following command to install it using ``apt``.
.. code-block:: bash
sudo apt update && sudo apt install linux-image-6.14.0-1018-oem
.. note::
Reboot your system after installing the OEM kernel.
.. ================================================ REGISTER ENTERPRISE LINUX ==
.. selected:: os=rhel
:heading: Register your Red Hat Enterprise Linux system
:heading-level: 3
@@ -97,7 +146,7 @@ supported, see the :doc:`Compatibility matrix
subscription-manager register --username <username> --password <password>
.. selected:: os-version=9.7 os-version=9.6 os-version=8
.. selected:: os-version=9.7 os-version=9.6 os-version=9.4 os-version=8.10
.. code-block:: bash
@@ -117,6 +166,8 @@ supported, see the :doc:`Compatibility matrix
sudo SUSEConnect -r <REGCODE>
.. ========================================== ADDITIONAL PACKAGE REPOSITORIES ==
.. selected:: os=rhel
:heading: Update your system
:heading-level: 3
@@ -150,7 +201,13 @@ supported, see the :doc:`Compatibility matrix
sudo dnf update --releasever=9.6 --exclude=\*release\*
.. selected:: os-version=8
.. selected:: os-version=9.4
.. code-block:: bash
sudo dnf update --releasever=9.4 --exclude=\*release\*
.. selected:: os-version=8.10
.. code-block:: bash
@@ -169,11 +226,158 @@ supported, see the :doc:`Compatibility matrix
sudo zypper update
.. selected:: i=pkgman
.. selected:: os=oracle-linux
:heading: Update your system
:heading-level: 3
Update Oracle Linux to the latest available packages.
Run the following command to update your system:
.. code-block:: bash
sudo dnf update
.. selected:: os=rhel
:heading: Add additional package repositories
:heading-level: 3
ROCm installation packages depend on packages that aren’t included in
the default package repositories. Use the following command to add the
necessary repositories.
.. selected:: os-version=10.1 os-version=10.0
.. code-block:: bash
wget https://dl.fedoraproject.org/pub/epel/epel-release-latest-10.noarch.rpm
sudo rpm -ivh epel-release-latest-10.noarch.rpm
.. code-block:: bash
sudo dnf config-manager --enable codeready-builder-for-rhel-10-x86_64-rpms
.. selected:: os-version=9.7 os-version=9.6 os-version=9.4
.. code-block:: bash
wget https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm
sudo rpm -ivh epel-release-latest-9.noarch.rpm
.. code-block:: bash
sudo dnf config-manager --enable codeready-builder-for-rhel-9-x86_64-rpms
.. selected:: os-version=8.10
.. code-block:: bash
wget https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm
sudo rpm -ivh epel-release-latest-8.noarch.rpm
.. code-block:: bash
sudo dnf config-manager --enable codeready-builder-for-rhel-8-x86_64-rpms
.. selected:: os=oracle-linux os=rocky-linux
:heading: Add additional package repositories
:heading-level: 3
ROCm installation packages depend on packages that aren’t included in
the default package repositories. Use the following command to add the
necessary repositories.
.. selected:: os-version=10.1 os-version=10.0
.. code-block:: bash
wget https://dl.fedoraproject.org/pub/epel/epel-release-latest-10.noarch.rpm
sudo rpm -ivh epel-release-latest-10.noarch.rpm
.. selected:: os-version=9.7 os-version=9.6 os-version=9.4
.. code-block:: bash
wget https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm
sudo rpm -ivh epel-release-latest-9.noarch.rpm
.. selected:: os-version=8.10
.. code-block:: bash
wget https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm
sudo rpm -ivh epel-release-latest-8.noarch.rpm
.. code-block:: bash
sudo crb enable
.. selected:: i=tar i=pip
.. selected:: os=sles
:heading: Add additional package repositories
:heading-level: 3
ROCm installation packages depend on packages that aren’t included in
the default package repositories. Use the following command to add the
necessary repositories.
.. selected:: os-version=16.0
.. code-block:: bash
sudo SUSEConnect -p sle-module-desktop-applications/16.0/x86_64
sudo SUSEConnect -p sle-module-development-tools/16.0/x86_64
sudo SUSEConnect -p PackageHub/16.0/x86_64
.. selected:: os-version=15.7
.. code-block:: bash
sudo SUSEConnect -p sle-module-desktop-applications/15.7/x86_64
sudo SUSEConnect -p sle-module-development-tools/15.7/x86_64
sudo SUSEConnect -p PackageHub/15.7/x86_64
.. ============================================== INSTALL ADDITIONAL PACKAGES ==
.. selected:: os=ubuntu os=debian os=rhel os=oracle-linux os=rocky-linux os=sles
.. selected:: i=pkgman i=pip i=tar
:heading: Install additional packages
:heading-level: 3
Some ROCm tools require the ``libatomic`` library to run correctly. Install
it using your distribution's package manager.
.. selected:: os=ubuntu os=debian
.. code-block:: bash
sudo apt install libatomic1
.. selected:: os=rhel os=oracle-linux os=rocky-linux
.. code-block:: bash
sudo dnf install libatomic
.. selected:: os=sles
.. code-block:: bash
sudo zypper install libatomic1
.. =========================================================== INSTALL PYTHON ==
.. selected:: i=pip
.. selected:: os=ubuntu
.. selected:: os-version=24
.. selected:: os-version=24.04
:heading: Install Python
:heading-level: 3
@@ -184,7 +388,7 @@ supported, see the :doc:`Compatibility matrix
sudo apt install python3.12 python3.12-venv
.. selected:: os-version=22
.. selected:: os-version=22.04
:heading: Install Python
:heading-level: 3
@@ -195,7 +399,20 @@ supported, see the :doc:`Compatibility matrix
sudo apt install python3.11 python3.11-venv
.. selected:: os=rhel
.. selected:: os=debian
.. selected:: os-version=13
:heading: Install Python
:heading-level: 3
Install a supported Python version. For example, to install Python
3.13, run the following command:
.. code-block:: bash
sudo apt install python3.13 python3.13-venv
.. selected:: os=rhel os=oracle-linux os=rocky-linux
.. selected:: os-version=10.1 os-version=10.0
:heading: Install Python
@@ -223,40 +440,35 @@ supported, see the :doc:`Compatibility matrix
:heading: Install Python
:heading-level: 3
Install a supported Python version. For example, to install Python 3.11,
run the following command:
.. selected:: os-version=16.0
.. code-block:: bash
Install a supported Python version. For example, to install Python 3.13,
run the following command:
sudo zypper install -y python311 python311-pip
.. code-block:: bash
sudo zypper install -y python313 python313-pip
.. selected:: os-version=15.7
Install a supported Python version. For example, to install Python 3.11,
run the following command:
.. code-block:: bash
sudo zypper install -y python311 python311-pip
.. selected:: os=windows
:heading: Install Python
:heading-level: 3
Install a supported Python version: 3.11, 3.12, or 3.13.
Install a supported Python version: 3.11, 3.12, or 3.13. See `Python
Releases for Windows <https://www.python.org/downloads/windows/>`__ for
installation details.
.. selected:: os=rhel
.. =================================================== GPU ACCESS PERMISSIONS ==
.. selected:: os-version=10.0 os-version=8
:heading: Install additional development packages
:heading-level: 3
.. code-block:: bash
sudo dnf install libatomic
.. selected:: os=sles
.. selected:: os-version=15
:heading: Install additional development packages
:heading-level: 3
.. code-block:: bash
sudo zypper install libatomic1
.. selected:: os=ubuntu os=rhel os=sles
.. selected:: os=ubuntu os=debian os=rhel os=oracle-linux os=rocky-linux os=sles
:heading: Configure permissions for GPU access
:heading-level: 3

242
docs/install/includes/selector.rst
View File

@@ -1,68 +1,227 @@
.. include:: /compatibility/includes/selector.rst
.. selected:: fam=instinct fam=radeon-pro fam=radeon
.. =========================================================== UBUNTU VERSION ==
.. selected:: os=ubuntu
.. selector:: Ubuntu version
:key: os-version
:show-when: os=ubuntu
.. selector-option:: 24.04.3
:value: 24
:show-when: fam=instinct fam=radeon-pro fam=radeon
:value: 24.04
:width: 6
.. selector-option:: 22.04.5
:value: 22
.. selected:: fam=ryzen
.. selector:: Ubuntu version
:key: os-version
:show-when: os=ubuntu
:show-when: fam=instinct fam=radeon-pro fam=radeon
:value: 22.04
:width: 6
.. selector-option:: 24.04.3
:value: 24
:show-when: fam=ryzen
:value: 24.04
:width: 12
.. selector:: RHEL version
:key: os-version
:show-when: os=rhel
.. selector-option:: 10.1
:value: 10.1
:width: 3
.. =========================================================== DEBIAN VERSION ==
.. selector-option:: 10.0
:value: 10.0
:width: 3
.. selected:: os=debian
.. selector-option:: 9.7
:value: 9.7
:width: 2
.. selector:: Debian version
:show-when: gpu=mi355x gpu=mi325x gpu=mi350x gpu=mi300x
:key: os-version
.. selector-option:: 9.6
:value: 9.6
:width: 2
.. selector-option:: 13
:width: 12
.. selector-option:: 8.10
:value: 8
:width: 2
.. selector:: SLES version
:key: os-version
:show-when: os=sles
.. ============================================================= RHEL VERSION ==
.. selector-option:: 15.7
:value: 15
:width: 12
.. selected:: os=rhel
.. selector:: Windows version
:key: os-version
:show-when: os=windows
.. selector:: RHEL version
:key: os-version
:show-when: fam=instinct fam=radeon-pro fam=radeon
.. selector-option:: 11 25H2
:value: 11-25h2
:width: 12
.. selector-option:: 10.1
:show-when: gpu=mi355x gpu=mi350x gpu=mi300x gpu=mi300a gpu=mi250x gpu=mi250 gpu=mi210
:width: 2
.. selector-option:: 10.0
:show-when: gpu=mi355x gpu=mi350x gpu=mi300x gpu=mi300a gpu=mi250x gpu=mi250 gpu=mi210
:width: 2
.. selector-option:: 9.7
:show-when: gpu=mi355x gpu=mi350x gpu=mi300x gpu=mi300a gpu=mi250x gpu=mi250 gpu=mi210
:width: 2
.. selector-option:: 9.6
:show-when: gpu=mi355x gpu=mi350x gpu=mi300x gpu=mi300a gpu=mi250x gpu=mi250 gpu=mi210
:width: 2
.. selector-option:: 9.4
:show-when: gpu=mi355x gpu=mi350x gpu=mi300x gpu=mi300a gpu=mi250x gpu=mi250 gpu=mi210
:width: 2
.. selector-option:: 8.10
:show-when: gpu=mi355x gpu=mi350x gpu=mi300x gpu=mi300a gpu=mi250x gpu=mi250 gpu=mi210
:width: 2
.. selector-option:: 10.1
:show-when: gpu=mi325x
:width: 20%
.. selector-option:: 10.0
:show-when: gpu=mi325x
:width: 20%
.. selector-option:: 9.7
:show-when: gpu=mi325x
:width: 20%
.. selector-option:: 9.6
:show-when: gpu=mi325x
:width: 20%
.. selector-option:: 9.4
:show-when: gpu=mi325x
:width: 20%
.. selector-option:: 10.1
:show-when: fam=radeon-pro fam=radeon
:width: 6
.. selector-option:: 9.7
:show-when: fam=radeon-pro fam=radeon
:width: 6
.. ===================================================== ORACLE LINUX VERSION ==
.. selected:: os=oracle-linux
.. selector:: Oracle Linux version
:show-when: gpu=mi355x gpu=mi350x gpu=mi325x gpu=mi300x
:key: os-version
.. selector-option:: 10
:show-when: gpu=mi355x gpu=mi350x gpu=mi325x
:width: 6
:value: 10.1
.. selector-option:: 9
:show-when: gpu=mi355x gpu=mi350x gpu=mi325x
:width: 6
:value: 9.6
.. selector-option:: 10
:show-when: gpu=mi300x
:width: 4
:value: 10.1
.. selector-option:: 9
:show-when: gpu=mi300x
:width: 4
:value: 9.6
.. selector-option:: 8
:show-when: gpu=mi300x
:width: 4
:value: 8.10
.. ====================================================== ROCKY LINUX VERSION ==
.. selected:: os=rocky-linux
.. selector:: Rocky Linux version
:show-when: gpu=mi300x gpu=mi300a
:key: os-version
.. selector-option:: 9
:width: 12
:value: 9.7
.. ============================================================= SLES VERSION ==
.. selected:: os=sles
.. selector:: SLES version
:show-when: fam=instinct
:key: os-version
.. selector-option:: 16.0
:width: 6
.. selector-option:: 15.7
:width: 6
.. ========================================================== WINDOWS VERSION ==
.. selected:: os=windows
.. selector:: Windows version
:key: os-version
.. selector-option:: 11 25H2
:width: 12
.. ====================================================== INSTALLATION METHOD ==
.. selector:: Installation method
:show-when: os=ubuntu os=debian
:key: i
.. selector-option:: apt
:value: pkgman
:width: 4
.. selector-option:: pip
:value: pip
:width: 4
.. selector-option:: Tarball
:value: tar
:width: 4
.. selector:: Installation method
:show-when: os=rhel os=oracle-linux os=rocky-linux
:key: i
.. selector-option:: dnf
:value: pkgman
:width: 4
.. selector-option:: pip
:value: pip
:width: 4
.. selector-option:: Tarball
:value: tar
:width: 4
.. selector:: Installation method
:show-when: os=sles
:key: i
.. selector-option:: zypper
:value: pkgman
:width: 4
.. selector-option:: pip
:value: pip
:width: 4
.. selector-option:: Tarball
:value: tar
:width: 4
.. selector:: Installation method
:show-when: os=windows
:key: i
.. selector-option:: pip
@@ -70,4 +229,3 @@
.. selector-option:: Tarball
:value: tar

175
docs/install/includes/uninstall.rst
View File

@@ -8,13 +8,153 @@ Uninstalling
.. include:: ./includes/selector.rst
.. ========================================================== PACKAGE MANAGER ==
.. selected:: i=pkgman
:heading: Uninstall ROCm packages
:heading-level: 3
1. Use your package manager to remove :ref:`ROCm meta packages <rocm-install-meta-packages>` installed on your system.
.. selected:: os=ubuntu os=debian
.. selected:: gpu=mi355x gpu=mi350x
.. code-block:: bash
sudo apt autoremove amdrocm7.11-gfx950
.. selected:: gpu=mi325x gpu=mi300x gpu=mi300a
.. code-block:: bash
sudo apt autoremove amdrocm7.11-gfx94x
.. selected:: gpu=mi250x gpu=mi250 gpu=mi210
.. code-block:: bash
sudo apt autoremove amdrocm7.11-gfx90x
.. selected:: gpu=ai-r9700 gpu=ai-r9600d gpu=rx-9070-xt gpu=rx-9070-gre gpu=rx-9070 gpu=rx-9060-xt-lp gpu=rx-9060-xt gpu=rx-9060
.. code-block:: bash
sudo apt autoremove amdrocm7.11-gfx120x
.. selected:: gpu=w7900-dual-slot gpu=w7900 gpu=w7800-48gb gpu=w7800 gpu=w7700 gpu=v710 gpu=v620
.. code-block:: bash
sudo apt autoremove amdrocm7.11-gfx110x
.. selected:: gpu=w6800 gpu=v620
.. code-block:: bash
sudo apt autoremove amdrocm7.11-gfx103x
.. selected:: gpu=max-pro-395 gpu=max-pro-390 gpu=max-pro-385 gpu=max-pro-380 gpu=max-395 gpu=max-390 gpu=max-385
.. code-block:: bash
sudo apt install amdrocm7.11-gfx1151
.. selected:: gpu=9-hx-375 gpu=9-hx-370 gpu=9-365
.. code-block:: bash
sudo apt install amdrocm7.11-gfx1150
.. selected:: os=rhel os=oracle-linux os=rocky-linux
.. selected:: gpu=mi355x gpu=mi350x
.. code-block:: bash
sudo dnf remove amdrocm7.11-gfx950
.. selected:: gpu=mi325x gpu=mi300x gpu=mi300a
.. code-block:: bash
sudo dnf remove amdrocm7.11-gfx94x
.. selected:: gpu=mi250x gpu=mi250 gpu=mi210
.. code-block:: bash
sudo dnf remove amdrocm7.11-gfx90x
.. selected:: gpu=ai-r9700 gpu=ai-r9600d gpu=rx-9070-xt gpu=rx-9070-gre gpu=rx-9070 gpu=rx-9060-xt-lp gpu=rx-9060-xt gpu=rx-9060
.. code-block:: bash
sudo dnf remove amdrocm7.11-gfx120x
.. selected:: gpu=w7900-dual-slot gpu=w7900 gpu=w7800-48gb gpu=w7800 gpu=w7700 gpu=v710 gpu=v620
.. code-block:: bash
sudo dnf remove amdrocm7.11-gfx110x
.. selected:: gpu=w6800 gpu=v620
.. code-block:: bash
sudo dnf remove amdrocm7.11-gfx103x
.. selected:: os=sles
.. code-block:: bash
sudo zypper remove amdrocm*
2. Remove ROCm repositories.
.. selected:: os=ubuntu os=debian
.. code-block:: bash
# Remove ROCm repositories
sudo rm /etc/apt/sources.list.d/rocm.list
# Clear the cache and clean the system
sudo rm -rf /var/cache/apt/*
sudo apt clean all
sudo apt update
.. selected:: os=rhel os=oracle-linux os=rocky-linux
.. code-block:: bash
# Remove ROCm repositories
sudo rm /etc/yum.repos.d/rocm.repo*
# Clear the cache and clean the system
sudo rm -rf /var/cache/dnf
sudo dnf clean all
.. selected:: os=sles
.. code-block:: bash
# Remove ROCm repositories
sudo zypper removerepo "rocm"
# Clear the cache and clean the system
sudo zypper clean --all
sudo zypper refresh
.. ====================================================================== PIP ==
.. selected:: i=pip
:heading: Remove your Python virtual environment
:heading-level: 3
1. Clear the pip cache.
.. selected:: os=ubuntu os=rhel os=sles
.. selected:: os=ubuntu os=debian os=rhel os=oracle-linux os=rocky-linux os=sles
.. code-block:: bash
@@ -28,7 +168,7 @@ Uninstalling
2. Remove your local Python virtual environment.
.. selected:: os=ubuntu os=rhel os=sles
.. selected:: os=ubuntu os=debian os=rhel os=oracle-linux os=rocky-linux os=sles
.. code-block:: bash
@@ -40,13 +180,13 @@ Uninstalling
rmdir /s /q .venv
.. selected:: os=windows
.. ================================================================== TARBALL ==
.. selected:: i=tar
:heading: Remove your installation directory
:heading-level: 3
.. selected:: os=ubuntu os=rhel os=sles
.. selected:: os=ubuntu os=debian os=rhel os=oracle-linux os=rocky-linux os=sles
1. To uninstall ROCm, remove your installation directory.
@@ -71,8 +211,11 @@ Uninstalling
.. selected:: os=windows
1. Delete your ``C:\TheRock\build`` installation directory and its
contents.
1. To uninstall ROCm, remove your installation directory.
.. code-block:: cmd
rmdir /s /q C:\TheRock
.. important::
@@ -81,22 +224,26 @@ Uninstalling
:ref:`installing ROCm <rocm-install>`, adjust this step
accordingly.
2. Delete the environment variables. For example, using PowerShell as an administrator:
2. **Run command prompt as an administrator** and delete the following environment variables.
.. code-block:: powershell
.. code-block:: cmd
[Environment]::SetEnvironmentVariable("HIP_PATH", $null, "Machine")
[Environment]::SetEnvironmentVariable("HIP_DEVICE_LIB_PATH", $null, "Machine")
[Environment]::SetEnvironmentVariable("HIP_PLATFORM", $null, "Machine")
[Environment]::SetEnvironmentVariable("LLVM_PATH", $null, "Machine")
setx HIP_DEVICE_LIB_PATH "" /M
setx HIP_PATH "" /M
setx HIP_PLATFORM "" /M
setx LLVM_PATH "" /M
Remove the following paths from your PATH environment variable using your system settings GUI.
Navigate to the following screen:
* Control Panel > System and Security > Edit environment variables
Edit the PATH variable and delete the following paths:
* ``C:\TheRock\build\bin``
* ``C:\TheRock\build\lib\llvm\bin``
3. If you want to uninstall the Adrenalin driver, see `Uninstall AMD
Software
3. To uninstall the Adrenalin Driver, see `Uninstall AMD Software
<https://www.amd.com/en/resources/support-articles/faqs/RSX2-UNINSTALL.html>`__.

13
docs/install/rocm.rst
View File

@@ -1,6 +1,6 @@
.. meta::
:description: Learn how to install AMD ROCm 7.10.0 for supported Instinct GPUs and Ryzen AI APUs on Ubuntu, RHEL, and Windows. This step-by-step guide covers prerequisites, driver setup, installation methods (pip and tarball), and troubleshooting.
:keywords: AMD ROCm 7.10.0, install ROCm, Instinct GPU, Ryzen APU, Ubuntu, RHEL, Windows, pip install ROCm, ROCm wheel, ROCm tarball, ROCm GPU driver, ROCm setup, ROCm uninstall, ROCm troubleshooting
:description: Learn how to install AMD ROCm 7.11.0 for supported Instinct GPUs and Ryzen AI APUs on Ubuntu, RHEL, and Windows. This step-by-step guide covers prerequisites, driver setup, installation methods (pip and tarball), and troubleshooting.
:keywords: AMD ROCm 7.11.0, install ROCm, Instinct GPU, Ryzen APU, Ubuntu, RHEL, Windows, pip install ROCm, ROCm wheel, ROCm tarball, ROCm GPU driver, ROCm setup, ROCm uninstall, ROCm troubleshooting
*******************************
Install AMD ROCm |ROCM_VERSION|
@@ -52,4 +52,11 @@ in ROCm |ROCM_VERSION|, see the :doc:`Release notes </about/release-notes>`.
.. raw:: html
<script src="../_static/next-button-install-page.js"></script>
<script>
document.addEventListener("DOMContentLoaded", () => {
const nextLink = document.querySelector("footer.prev-next-footer a.right-next");
const nextTitle = nextLink.querySelector(".prev-next-title");
nextTitle.textContent = "Build the ROCm Core SDK from source";
nextLink.href = "./build-from-source.html";
});
</script>

28
docs/release/versions.md
View File

@@ -1,28 +0,0 @@
<head>
<meta charset="UTF-8">
<meta name="description" content="ROCm preview release history">
<meta name="keywords" content="documentation, release history, ROCm, AMD">
</head>
# ROCm preview release history
| Version | Release date |
| ------- | ------------ |
| [7.10.0](https://rocm.docs.amd.com/en/7.10.0-preview/) | December 11, 2025 |
| [7.9.0](https://rocm.docs.amd.com/en/7.9.0-preview/) | October 20, 2025 |
```{important}
ROCm 7.9.0 introduced a versioning discontinuity following the previous [7.0
releases](https://rocm.docs.amd.com/en/latest/release/versions.html). Versions
7.0 through 7.8 are reserved for production stream ROCm releases, while
versions 7.9.0 and later listed on this page represent the technology preview
release stream. Both streams share a largely similar code base but differ in
their build systems. These differences include the CMake configuration,
operating system package dependencies, and the integration of AMD GPU Driver
components.
Maintaining parallel release streams -- preview and production -- gives users
ample time to evaluate and adopt the new build system and dependency changes.
The technology preview stream is planned to continue through mid‑2026, after
which it will replace the current production stream.
```

38
docs/release/versions.rst Normal file
View File

@@ -0,0 +1,38 @@
:orphan:
.. meta::
:description: ROCm preview release history
:keywords: documentation, rocm, amd, past, previous, rel, ver, versions, docs
****************************
ROCm preview release history
****************************
.. list-table::
:header-rows: 1
* - Version
- Release date
* - `7.11.0 <https://rocm.docs.amd.com/en/7.11.0-preview>`__
- February 11, 2026
* - `7.10.0 <https://rocm.docs.amd.com/en/7.10.0-preview>`__
- December 11, 2025
* - `7.9.0 <https://rocm.docs.amd.com/en/7.9.0-preview>`__
- October 20, 2025
.. important::
ROCm 7.9.0 introduced a versioning discontinuity following the previous `7.0
releases <https://rocm.docs.amd.com/en/latest/release/versions.html>`__.
Versions 7.0 through 7.8 are reserved for production stream ROCm releases,
while versions 7.9.0 and later listed on this page represent the technology
preview release stream. Both streams share a largely similar code base but
differ in their build systems.
Maintaining parallel release streams -- preview and production -- gives
users ample time to evaluate and adopt the new build system and dependency
changes. The technology preview stream is planned to continue through
mid‑2026, after which it will replace the current production stream.

215
docs/rocm-for-ai/pytorch-comfyui.rst
View File

@@ -18,7 +18,7 @@ showcasing AI-powered image generation.
:value: radeon-pro
:width: 3
.. selector-option:: Radeon RX
.. selector-option:: Radeon
:value: radeon
:width: 3
@@ -27,62 +27,172 @@ showcasing AI-powered image generation.
:width: 3
.. selector:: Instinct GPU
:key: gfx
:key: gpu
:show-when: fam=instinct
.. selector-info:: https://www.amd.com/en/products/accelerators/instinct.html
.. selector-option:: Instinct MI355X<br>Instinct MI350X
:value: 950
:width: 4
.. selector-option:: MI355X
:width: 3
.. selector-option:: Instinct MI325X<br>Instinct MI300X<br>Instinct MI300A
:value: 942
:width: 4
.. selector-option:: MI350X
:width: 3
.. selector-option:: Instinct MI250X<br>Instinct MI250<br>Instinct MI210
:value: 90a
:width: 4
.. selector-option:: MI325X
:width: 3
.. selector-option:: MI300X
:width: 3
.. selector-option:: MI300A
:width: 3
.. selector-option:: MI250X
:width: 3
.. selector-option:: MI250
:width: 3
.. selector-option:: MI210
:width: 3
.. selector:: Radeon PRO GPU
:key: gfx
:key: gpu
:show-when: fam=radeon-pro
.. selector-info:: https://www.amd.com/en/products/graphics/workstations.html
.. selector-option:: Radeon PRO W7900D<br>Radeon PRO W7900<br>Radeon PRO W7800 48GB<br>Radeon PRO W7800
:value: 1100
:width: 6
.. selector-option:: AI PRO R9700
:value: ai-r9700
:width: 3
.. selector-option:: Radeon PRO W7700
:value: 1101
:width: 6
.. selector-option:: AI PRO R9600D
:value: ai-r9600d
:width: 3
.. selector:: Radeon RX GPU
:key: gfx
.. selector-option:: W7900 Dual Slot
:value: w7900-dual-slot
:width: 3
.. selector-option:: W7900
:value: w7900
:width: 3
.. selector-option:: W7800 48GB
:value: w7800-48gb
:width: 3
.. selector-option:: W7800
:value: w7800
:width: 3
.. selector-option:: W7700
:value: w7700
:width: 3
.. selector-option:: V710
:value: v710
:width: 3
.. selector:: Radeon GPU
:key: gpu
:show-when: fam=radeon
.. selector-info:: https://www.amd.com/en/products/graphics/desktops/radeon.html
.. selector-option:: Radeon RX 7900 XTX<br>Radeon RX 7900 XT<br>Radeon RX 7900 GRE
:value: 1100
.. selector-option:: RX 9070 XT
:value: rx-9070-xt
:width: 3
.. selector-option:: Radeon RX 7800 XT<br>Radeon RX 7700 XT
:value: 1101
.. selector-option:: RX 9070 GRE
:value: rx-9070-gre
:width: 3
.. selector-option:: RX 9070
:value: rx-9070
:width: 3
.. selector-option:: RX 9060 XT LP
:value: rx-9060-xt-lp
:width: 3
.. selector-option:: RX 9060 XT
:value: rx-9060-xt
:width: 3
.. selector-option:: RX 9060
:value: rx-9060
:width: 3
.. selector-option:: RX 7900 XTX
:value: rx-7900-xtx
:width: 3
.. selector-option:: RX 7900 XT
:value: rx-7900-xt
:width: 3
.. selector-option:: RX 7900 GRE
:value: rx-7900-gre
:width: 3
.. selector-option:: RX 7800 XT
:value: rx-7800-xt
:width: 3
.. selector-option:: RX 7700 XT
:value: rx-7700-xt
:width: 3
.. selector-option:: RX 7700
:value: rx-7700
:width: 3
.. selector:: Ryzen AI APU
:key: gfx
:key: gpu
:show-when: fam=ryzen
.. selector-info:: https://www.amd.com/en/products/processors/workstations/mobile.html
.. selector-option:: Ryzen AI Max+ PRO 395<br>Ryzen AI Max PRO 390, 385, 380<br>Ryzen AI Max+ 395<br>Ryzen AI Max 390, 385
:value: 1151
:width: 7
.. selector-option:: Max+ PRO 395
:value: max-pro-395
:width: 3
.. selector-option:: Ryzen AI 9 HX 375<br>Ryzen AI 9 HX 370<br>Ryzen AI 9 365
:value: 1150
:width: 5
.. selector-option:: Max PRO 390
:value: max-pro-390
:width: 3
.. selector-option:: Max PRO 385
:value: max-pro-385
:width: 3
.. selector-option:: Max PRO 380
:value: max-pro-380
:width: 3
.. selector-option:: Max+ 395
:value: max-395
:width: 2
.. selector-option:: Max 390
:value: max-390
:width: 2
.. selector-option:: Max 385
:value: max-385
:width: 2
.. selector-option:: 9 HX 375
:value: 9-hx-375
:width: 2
.. selector-option:: 9 HX 370
:value: 9-hx-370
:width: 2
.. selector-option:: 9 365
:value: 9-365
:width: 2
.. selector:: Operating system
:key: os
@@ -111,13 +221,6 @@ showcasing AI-powered image generation.
Prerequisites
=============
.. selected:: os=windows
To run ComfyUI workloads on Windows, ensure you have Adrenalin Driver
version 25.20.01.17. For details and the download link, see `AMD Software:
PyTorch on Windows Edition 7.1.1
<https://www.amd.com/en/resources/support-articles/release-notes/RN-AMDGPU-WINDOWS-PYTORCH-7-1-1.html>`__. See the :ref:`related known issue <comfyui-driver-known-issue>`.
Ensure your system has a :ref:`supported Python version
<rocm-compat-python>` installed and accessible: 3.11, 3.12, or 3.13.
@@ -132,7 +235,7 @@ For prerequisite steps and post-installation recommendations, see the
:doc:`ROCm installation instructions </install/rocm>`.
1. Set up your Python virtual environment. If you already have a successful
:doc:`ROCm 7.10.0 installation using pip </install/rocm>`, skip this step.
:doc:`ROCm 7.11.0 installation using pip </install/rocm>`, skip this step.
For example, run the following command to create a virtual environment:
@@ -157,42 +260,54 @@ For prerequisite steps and post-installation recommendations, see the
3. Install the appropriate ROCm-enabled PyTorch build for your operating system
and AMD hardware architecture.
.. selected:: gfx=950
.. selected:: gpu=mi355x gpu=mi350x
.. code-block:: bash
python -m pip install --index-url https://repo.amd.com/rocm/whl/gfx950-dcgpu/ torch torchvision torchaudio
.. selected:: gfx=942
.. selected:: gpu=mi325x gpu=mi300x gpu=mi300a
.. code-block:: bash
python -m pip install --index-url https://repo.amd.com/rocm/whl/gfx94X-dcgpu/ torch torchvision torchaudio
.. selected:: gfx=90a
.. selected:: gpu=mi250x gpu=mi250 gpu=mi210
.. code-block:: bash
python -m pip install --index-url https://repo.amd.com/rocm/whl/gfx90X-dcgpu/ torch torchvision torchaudio
.. selected:: gfx=1151
.. selected:: gpu=ai-r9700 gpu=ai-r9600d gpu=rx-9070-xt gpu=rx-9070-gre gpu=rx-9070 gpu=rx-9060-xt-lp gpu=rx-9060-xt gpu=rx-9060
.. code-block:: bash
python -m pip install --index-url https://repo.amd.com/rocm/whl/gfx120X-all/ torch torchvision torchaudio
.. selected:: gpu=w7900-dual-slot gpu=w7900 gpu=w7800-48gb gpu=w7800 gpu=w7700 gpu=v710 gpu=rx-7900-xtx gpu=rx-7900-xt gpu=rx-7900-gre gpu=rx-7800-xt gpu=rx-7700-xt gpu=rx-7700
.. code-block:: bash
python -m pip install --index-url https://repo.amd.com/rocm/whl/gfx110X-dgpu/ torch torchvision torchaudio
.. selected:: gpu=w6800 gpu=v620
.. code-block:: bash
python -m pip install --index-url https://repo.amd.com/rocm/whl/gfx103X-dgpu/ torch torchvision torchaudio
.. selected:: gpu=max-pro-395 gpu=max-pro-390 gpu=max-pro-385 gpu=max-pro-380 gpu=max-395 gpu=max-390 gpu=max-385
.. code-block:: bash
python -m pip install --index-url https://repo.amd.com/rocm/whl/gfx1151/ torch torchvision torchaudio
.. selected:: gfx=1150
.. selected:: gpu=9-hx-375 gpu=9-hx-370 gpu=9-365
.. code-block:: bash
python -m pip install --index-url https://repo.amd.com/rocm/whl/gfx1150/ torch torchvision torchaudio
.. selected:: gfx=1100 gfx=1101
.. code-block:: bash
python -m pip install --index-url https://repo.amd.com/rocm/whl/gfx110X-dgpu/ torch torchvision torchaudio
4. Check your PyTorch installation.
.. code-block:: shell

4
docs/sphinx/_toc.yml.in
View File

@@ -30,3 +30,7 @@ subtrees:
entries:
- file: rocm-for-ai/pytorch-comfyui.rst
title: Install PyTorch and ComfyUI
- caption: Tutorials
entries:
- url: https://github.com/ROCm/rocm-examples/tree/release/therock-7.11
title: ROCm examples

3
docs/sphinx/requirements.in
View File

@@ -1,2 +1,3 @@
rocm-docs-core==1.31.0
rocm-docs-core==1.31.3
sphinx-sitemap
ckdl

55
docs/sphinx/requirements.txt
View File

@@ -2,7 +2,7 @@
# This file is autogenerated by pip-compile with Python 3.10
# by the following command:
#
# pip-compile --cert=None --client-cert=None --index-url=None --pip-args=None docs/sphinx/requirements.in
# pip-compile docs/sphinx/requirements.in
#
accessible-pygments==0.0.5
# via pydata-sphinx-theme
@@ -15,7 +15,7 @@ attrs==25.4.0
# jsonschema
# jupyter-cache
# referencing
babel==2.17.0
babel==2.18.0
# via
# pydata-sphinx-theme
# sphinx
@@ -23,7 +23,7 @@ beautifulsoup4==4.14.3
# via pydata-sphinx-theme
breathe==4.36.0
# via rocm-docs-core
certifi==2025.11.12
certifi==2026.1.4
# via requests
cffi==2.0.0
# via
@@ -31,15 +31,17 @@ cffi==2.0.0
# pynacl
charset-normalizer==3.4.4
# via requests
ckdl==1.0
# via -r docs/sphinx/requirements.in
click==8.3.1
# via
# jupyter-cache
# sphinx-external-toc
comm==0.2.3
# via ipykernel
cryptography==46.0.3
cryptography==46.0.4
# via pyjwt
debugpy==1.8.17
debugpy==1.8.20
# via ipykernel
decorator==5.2.1
# via ipython
@@ -58,21 +60,21 @@ fastjsonschema==2.21.2
# rocm-docs-core
gitdb==4.0.12
# via gitpython
gitpython==3.1.45
gitpython==3.1.46
# via rocm-docs-core
greenlet==3.3.0
greenlet==3.3.1
# via sqlalchemy
idna==3.11
# via requests
imagesize==1.4.1
# via sphinx
importlib-metadata==8.7.0
importlib-metadata==8.7.1
# via
# jupyter-cache
# myst-nb
ipykernel==7.1.0
# via myst-nb
ipython==8.37.0
ipython==8.38.0
# via
# ipykernel
# myst-nb
@@ -82,13 +84,13 @@ jinja2==3.1.6
# via
# myst-parser
# sphinx
jsonschema==4.25.1
jsonschema==4.26.0
# via nbformat
jsonschema-specifications==2025.9.1
# via jsonschema
jupyter-cache==1.0.1
# via myst-nb
jupyter-client==8.6.3
jupyter-client==8.8.0
# via
# ipykernel
# nbclient
@@ -116,7 +118,7 @@ myst-nb==1.3.0
# via rocm-docs-core
myst-parser==4.0.1
# via myst-nb
nbclient==0.10.2
nbclient==0.10.4
# via
# jupyter-cache
# myst-nb
@@ -127,7 +129,7 @@ nbformat==5.10.4
# nbclient
nest-asyncio==1.6.0
# via ipykernel
packaging==25.0
packaging==26.0
# via
# ipykernel
# pydata-sphinx-theme
@@ -140,13 +142,13 @@ platformdirs==4.5.1
# via jupyter-core
prompt-toolkit==3.0.52
# via ipython
psutil==7.1.3
psutil==7.2.2
# via ipykernel
ptyprocess==0.7.0
# via pexpect
pure-eval==0.2.3
# via stack-data
pycparser==2.23
pycparser==3.0
# via cffi
pydata-sphinx-theme==0.15.4
# via
@@ -160,9 +162,9 @@ pygments==2.19.2
# ipython
# pydata-sphinx-theme
# sphinx
pyjwt[crypto]==2.10.1
pyjwt[crypto]==2.11.0
# via pygithub
pynacl==1.6.1
pynacl==1.6.2
# via pygithub
python-dateutil==2.9.0.post0
# via jupyter-client
@@ -185,7 +187,7 @@ requests==2.32.5
# via
# pygithub
# sphinx
rocm-docs-core==1.31.0
rocm-docs-core==1.31.3
# via -r docs/sphinx/requirements.in
rpds-py==0.30.0
# via
@@ -197,7 +199,7 @@ smmap==5.0.2
# via gitdb
snowballstemmer==3.0.1
# via sphinx
soupsieve==2.8
soupsieve==2.8.3
# via beautifulsoup4
sphinx==8.1.3
# via
@@ -211,6 +213,7 @@ sphinx==8.1.3
# sphinx-design
# sphinx-external-toc
# sphinx-last-updated-by-git
# sphinx-multitoc-numbering
# sphinx-notfound-page
sphinx-book-theme==1.1.4
# via rocm-docs-core
@@ -218,10 +221,12 @@ sphinx-copybutton==0.5.2
# via rocm-docs-core
sphinx-design==0.6.1
# via rocm-docs-core
sphinx-external-toc==1.0.1
sphinx-external-toc==1.1.0
# via rocm-docs-core
sphinx-last-updated-by-git==0.3.8
# via sphinx-sitemap
sphinx-multitoc-numbering==0.1.3
# via sphinx-external-toc
sphinx-notfound-page==1.1.0
# via rocm-docs-core
sphinx-sitemap==2.9.0
@@ -238,15 +243,15 @@ sphinxcontrib-qthelp==2.0.0
# via sphinx
sphinxcontrib-serializinghtml==2.0.0
# via sphinx
sqlalchemy==2.0.44
sqlalchemy==2.0.46
# via jupyter-cache
stack-data==0.6.3
# via ipython
tabulate==0.9.0
# via jupyter-cache
tomli==2.3.0
tomli==2.4.0
# via sphinx
tornado==6.5.2
tornado==6.5.4
# via
# ipykernel
# jupyter-client
@@ -270,11 +275,11 @@ typing-extensions==4.15.0
# pygithub
# referencing
# sqlalchemy
urllib3==2.6.1
urllib3==2.6.3
# via
# pygithub
# requests
wcwidth==0.2.14
wcwidth==0.5.3
# via prompt-toolkit
zipp==3.23.0
# via importlib-metadata

7
docs/sphinx/static/next-button-install-page.js
View File

@@ -1,7 +0,0 @@
document.addEventListener("DOMContentLoaded", () => {
const nextLink = document.querySelector("footer.prev-next-footer a.right-next");
const nextTitle = nextLink.querySelector(".prev-next-title");
console.log(nextLink);
nextTitle.textContent = "Build the ROCm Core SDK from source";
nextLink.href = "./build-from-source.html";
});

13
docs/sphinx/static/setup-toc-install-headings.js
View File

@@ -27,10 +27,10 @@ function getDocsRoot() {
// HACK:
// Look for version pattern: at least two dots (e.g., 6.4.3, 7.10.0-preview)
const versionIdx = parts.findIndex(part =>
const versionIdx = parts.findIndex(part =>
(part.match(/\./g) || []).length >= 2 || /^\d+$/.test(part)
);
if (versionIdx !== -1) {
return "/" + parts.slice(0, versionIdx + 1).join("/") + `/${INSTALL_PAGE_DIR}/`;
}
@@ -40,6 +40,15 @@ function getDocsRoot() {
}
function buildHref(docsRoot, page, hash) {
// If already on the install page, just use hash anchors
const pathname = window.location.pathname;
const isOnInstallPage = pathname.endsWith(`/${INSTALL_PAGE_DIR}/${INSTALL_PAGE_FILE}`) ||
pathname.endsWith(`/${INSTALL_PAGE_FILE}`);
if (isOnInstallPage && hash) {
return `#${hash}`;
}
return `${docsRoot}${page}${hash ? "#" + hash : ""}`;
}