Merge pull request #49 from ROCm/develop

Merging develop into 6.0.0
ROCm · Jan 22, 2024 · b906ab5 · b906ab5
2 parents 413e75a + 53c5ae6
commit b906ab5
Show file tree

Hide file tree

Showing 22 changed files with 177 additions and 46 deletions.
diff --git a/docs/how-to/3rd-party/magma-install.rst b/docs/how-to/3rd-party/magma-install.rst
@@ -1,3 +1,7 @@
+.. meta::
+  :description: Installing MAGMA for ROCm
+  :keywords: installation instructions, MAGMA, AMD, ROCm
+
 *******************************************************************************************
 Installing MAGMA for ROCm
 *******************************************************************************************

diff --git a/docs/how-to/3rd-party/pytorch-install.rst b/docs/how-to/3rd-party/pytorch-install.rst
@@ -1,3 +1,7 @@
+.. meta::
+  :description: Installing PyTorch for ROCm
+  :keywords: installation instructions, PyTorch, AMD, ROCm
+
 **********************************************************************************
 Installing PyTorch for ROCm
 **********************************************************************************

diff --git a/docs/how-to/3rd-party/tensorflow-install.rst b/docs/how-to/3rd-party/tensorflow-install.rst
@@ -1,3 +1,7 @@
+.. meta::
+  :description: Installing TensorFlow for ROCm
+  :keywords: installation instructions, TensorFlow, AMD, ROCm
+
 ****************************************************************************************
 Installing TensorFlow for ROCm
 ****************************************************************************************

diff --git a/docs/how-to/amdgpu-install.rst b/docs/how-to/amdgpu-install.rst
@@ -1,3 +1,7 @@
+.. meta::
+  :description: Installation via AMDGPU installer
+  :keywords: installation instructions, AMDGPU, AMDGPU installer, AMD, ROCm
+
 *************************************************************************************
 Installation via AMDGPU installer
 *************************************************************************************
@@ -44,7 +48,7 @@ Red Hat Enterprise Linux
 .. datatemplate:nodata::
 
     .. tab-set::
-        {% for (os_release, os_version) in [('8', '8.8'), ('8', '8.7'), ('9', '9.2'), ('9', '9.1')] %}
+        {% for (os_release, os_version) in [('9', '9.3'), ('9', '9.2'), ('8', '8.9'), ('8', '8.8')] %}
         .. tab-item:: RHEL {{ os_version }}
             :sync: rhel-{{ os_version }} rhel-{{ os_release }}
 
@@ -90,32 +94,65 @@ output below.
     If --usecase option is not present, the default selection is "graphics,opencl,hip"
 
     Available use cases:
-    rocm(for users and developers requiring full ROCm stack)
-    - OpenCL (ROCr/KFD based) runtime
-    - HIP runtimes
-    - Machine learning framework
-    - All ROCm libraries and applications
-    - ROCm Compiler and device libraries
-    - ROCr runtime and thunk
-    lrt(for users of applications requiring ROCm runtime)
-    - ROCm Compiler and device libraries
-    - ROCr runtime and thunk
-    opencl(for users of applications requiring OpenCL on Vega or
-    later products)
-    - ROCr based OpenCL
-    - ROCm Language runtime
-
-    openclsdk (for application developers requiring ROCr based OpenCL)
-    - ROCr based OpenCL
-    - ROCm Language runtime
-    - development and SDK files for ROCr based OpenCL
-
-    hip(for users of HIP runtime on AMD products)
-    - HIP runtimes
-    hiplibsdk (for application developers requiring HIP on AMD products)
-    - HIP runtimes
-    - ROCm math libraries
-    - HIP development libraries
+    dkms            (to only install the kernel mode driver)
+      - Kernel mode driver (included in all usecases)
+    graphics        (for users of graphics applications)
+      - Open source Mesa 3D graphics and multimedia libraries
+    multimedia      (for users of open source multimedia)
+      - Open source Mesa 3D multimedia libraries
+    multimediasdk   (for developers of open source multimedia)
+      - Open source Mesa 3D multimedia libraries
+      - Development headers for multimedia libraries
+    workstation     (for users of legacy WS applications)
+      - Open source multimedia libraries
+      - Closed source (legacy) OpenGL
+    rocm            (for users and developers requiring full ROCm stack)
+      - OpenCL (ROCr/KFD based) runtime
+      - HIP runtimes
+      - Machine learning framework
+      - All ROCm libraries and applications
+    rocmdev         (for developers requiring ROCm runtime and
+                    profiling/debugging tools)
+      - HIP runtimes
+      - OpenCL runtime
+      - Profiler, Tracer and Debugger tools
+    rocmdevtools    (for developers requiring ROCm profiling/debugging tools)
+      - Profiler, Tracer and Debugger tools
+    amf             (for users of AMF based multimedia)
+      - AMF closed source multimedia library
+    lrt             (for users of applications requiring ROCm runtime)
+      - ROCm Compiler and device libraries
+      - ROCr runtime and thunk
+    opencl          (for users of applications requiring OpenCL on Vega or later
+                    products)
+      - ROCr based OpenCL
+      - ROCm Language runtime
+    openclsdk       (for application developers requiring ROCr based OpenCL)
+      - ROCr based OpenCL
+      - ROCm Language runtime
+      - development and SDK files for ROCr based OpenCL
+    hip             (for users of HIP runtime on AMD products)
+      - HIP runtimes
+    hiplibsdk       (for application developers requiring HIP on AMD products)
+      - HIP runtimes
+      - ROCm math libraries
+      - HIP development libraries
+    openmpsdk       (for users of openmp/flang on AMD products)
+      - OpenMP runtime and devel packages
+    mllib           (for users executing machine learning workloads)
+      - MIOpen hip/tensile libraries
+      - Clang OpenCL
+      - MIOpen kernels
+    mlsdk           (for developers executing machine learning workloads)
+      - MIOpen development libraries
+      - Clang OpenCL development libraries
+      - MIOpen kernels
+    asan            (for users of ASAN enabled ROCm packages)
+      - ASAN enabled OpenCL (ROCr/KFD based) runtime
+      - ASAN enabled HIP runtimes
+      - ASAN enabled Machine learning framework
+      - ASAN enabled ROCm libraries
+
 
 Upgrading ROCm
 =================================================
@@ -155,6 +192,13 @@ To install use cases specific to your requirements, use the installer
 
     sudo amdgpu-install --usecase=workstation,rocm
 
+- To install LLVM ASAN (Address Sanitizer) instrumented binaries of packages
+  that support it add ``asan``. For example:
+
+  .. code-block:: bash
+
+    sudo amdgpu-install --usecase=rocm,asan
+
 Uninstalling ROCm
 =================================================
 

diff --git a/docs/how-to/docker.rst b/docs/how-to/docker.rst
@@ -1,3 +1,7 @@
+.. meta::
+  :description: Install ROCm Docker containers
+  :keywords: installation instructions, Docker, AMD, ROCm
+
 ********************************************************************************
 Install ROCm Docker containers
 ********************************************************************************

diff --git a/docs/how-to/native-install/index.rst b/docs/how-to/native-install/index.rst
@@ -1,3 +1,8 @@
+.. meta::
+  :description: Installation via native package manager
+  :keywords: ROCm install, installation instructions, package manager, native package manager, AMD,
+    ROCm
+
 ******************************************************************************
 Installation via native package manager
 ******************************************************************************

diff --git a/docs/how-to/native-install/package-manager-integration.rst b/docs/how-to/native-install/package-manager-integration.rst
@@ -1,3 +1,7 @@
+.. meta::
+  :description: Package manager integration
+  :keywords: OpenCL, OpenMP, package manager, AMD, ROCm
+
 ************************************************************************************
 Package manager integration
 ************************************************************************************

diff --git a/docs/how-to/native-install/post-install.rst b/docs/how-to/native-install/post-install.rst
@@ -1,3 +1,7 @@
+.. meta::
+  :description: Post-installation instructions
+  :keywords: ROCm install, installation instructions, AMD, ROCm
+
 *************************************************************************
 Post-installation instructions
 *************************************************************************

diff --git a/docs/how-to/native-install/rhel.rst b/docs/how-to/native-install/rhel.rst
@@ -1,3 +1,8 @@
+.. meta::
+  :description: Red Hat Enterprise Linux native installation
+  :keywords: ROCm install, installation instructions, RHEL, Red Hat Enterprise Linux native installation,
+    AMD, ROCm
+
 **********************************************************************************************
 Red Hat Enterprise Linux native installation
 **********************************************************************************************
@@ -79,7 +84,7 @@ Install ROCm packages
 
 .. code-block:: bash
 
-    sudo yum install rocm-hip-sdk
+    sudo yum install rocm
 
 Complete the :doc:`post-install`.
 

diff --git a/docs/how-to/native-install/sle.rst b/docs/how-to/native-install/sle.rst
@@ -1,3 +1,8 @@
+.. meta::
+  :description: SUSE Enterprise Linux native installation
+  :keywords: ROCm install, installation instructions, SUSE, SUSE Linux Enterprise native installation,
+    AMD, ROCm
+
 *********************************************************************************************
 SUSE Linux Enterprise native installation
 *********************************************************************************************

diff --git a/docs/how-to/native-install/ubuntu.rst b/docs/how-to/native-install/ubuntu.rst
@@ -1,3 +1,7 @@
+.. meta::
+  :description: Ubuntu native installation
+  :keywords: ROCm install, installation instructions, Ubuntu, Ubuntu native installation, AMD, ROCm
+
 ****************************************************************************
 Ubuntu native installation
 ****************************************************************************

diff --git a/docs/how-to/prerequisites.rst b/docs/how-to/prerequisites.rst
@@ -1,3 +1,7 @@
+.. meta::
+  :description: Installation prerequisites
+  :keywords: installation prerequisites, AMD, ROCm
+
 *********************************************************************
 Installation prerequisites
 *********************************************************************
@@ -74,9 +78,15 @@ installation. Follow the instructions below based on your distributions.
                    .. code-block:: shell
 
                        wget https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm
-                       sudo rpm -ivh epel-release-latest-8.noarch.rpm
+                       sudo rpm -ivh epel-release-latest-9.noarch.rpm
+
+        2. Enable the CodeReady Linux Builder (CRB) repository.
+
+            In order to enable CRB, you may need to install ``dnf-plugin-config-manager`` first.
+
+           .. code-block:: shell
 
-        2. Enable the CodeReady Linux Builder repository.
+               sudo dnf install dnf-plugin-config-manager
 
            .. code-block:: shell
 

diff --git a/docs/how-to/spack.rst b/docs/how-to/spack.rst
@@ -1,3 +1,7 @@
+.. meta::
+  :description: Introduction to Spack
+  :keywords: Spack, package management tool, AMD, ROCm
+
 **************************************************************
 Introduction to Spack
 **************************************************************

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,3 +1,7 @@
+.. meta::
+  :description: ROCm installation for Linux
+  :keywords: ROCm installation, AMD, ROCm, Package manager, AMDGPU
+
 .. _rocm-install-home:
 
 ****************************************************************

diff --git a/docs/reference/3rd-party-support-matrix.rst b/docs/reference/3rd-party-support-matrix.rst
@@ -1,12 +1,16 @@
+.. meta::
+  :description: Third-party support matrix
+  :keywords: ROCm installation, AMD, ROCm, third-party support matrix
+
 .. _3rd-party-support-matrix:
 
 ***************************************************************************
 Third-party support matrix
 ***************************************************************************
 
-ROCm™ supports various 3rd party libraries and frameworks. Supported versions
-are tested and known to work. Non-supported third-party versions may also
-work, but these aren't tested.
+ROCm™ supports various third-party libraries and frameworks. We've tested our supported versions, so
+you can be assured that they work. Non-supported third-party versions may also work, but we haven't
+tested these for functionality.
 
 Deep learning
 ================================================
@@ -62,9 +66,8 @@ TensorFlow.
 Communication libraries
 ================================================
 
-ROCm supports `OpenUCX <https://openucx.org/>`_, an open-source,
-production-grade communication framework for data-centric and high performance
-applications.
+ROCm supports `OpenUCX <https://openucx.org/>`_, an open-source, production-grade
+communication framework for data-centric and high performance applications.
 
 
 .. list-table::
@@ -103,8 +106,8 @@ support for ROCm devices.
 Algorithm libraries
 ================================================
 
-ROCm releases provide algorithm libraries with interfaces compatible with
-contemporary CUDA / NVIDIA HPC SDK alternatives.
+ROCm releases provide algorithm libraries with interfaces compatible with contemporary
+CUDA/NVIDIA HPC SDK alternatives.
 
 * Thrust → rocThrust
 * CUB → hipCUB
@@ -149,7 +152,7 @@ contemporary CUDA / NVIDIA HPC SDK alternatives.
       - 22.9
 
     * - 6.0.x
-      - 3.0.0
+      - 2.0.1
       - 22.9
 
 For the latest documentation of these libraries, refer to the

diff --git a/docs/reference/docker-image-support-matrix.rst b/docs/reference/docker-image-support-matrix.rst
@@ -1,3 +1,7 @@
+.. meta::
+  :description: Docker image support matrix
+  :keywords: ROCm installation, AMD, ROCm, Docker, Docker image
+
 .. _docker-support-matrix:
 
 ******************************************************************

diff --git a/docs/reference/system-requirements.rst b/docs/reference/system-requirements.rst
@@ -1,6 +1,7 @@
 .. meta::
   :description: Linux GPU and OS support
-  :keywords: Linux support, ROCm distributions
+  :keywords: Linux support, ROCm distributions, system requirements, supported GPUs,  Instinct,
+    Radeon Pro, Radeon, AMD, ROCm
 
 .. _system-requirements:
 
@@ -79,11 +80,14 @@ AMD ROCm™ Software supports the following Linux distributions.
     "CentOS 7.9", "3.10", "✅"
     "SLES 15 SP5", "5.14.21-150500", "✅"
     "SLES 15 SP4", "5.14.21-150500", "✅"
+    "Ubuntu 22.04.4", "6.6", "✅ :sup:`2`"
     "Ubuntu 22.04.3", "6.2", "✅"
     "Ubuntu 22.04.2", "5.19", "✅"
     "Ubuntu 20.04.6", "5.15", "✅"
     "Ubuntu 20.04.5", "5.15", "✅"
 
+:sup:`2` Preview support for HWE kernels
+
 Virtualization support
 =============================================
 

diff --git a/docs/reference/user-kernel-space-compat-matrix.rst b/docs/reference/user-kernel-space-compat-matrix.rst
@@ -1,5 +1,11 @@
+.. meta::
+  :description: User and kernel-space support matrix
+
+  :keywords: Linux support, support matrix, system requirements, user space versions, Kernel Fusion
+    Driver , AMD, ROCm
+
 *****************************************************************************************
-User/kernel-space support matrix
+User and kernel-space support matrix
 *****************************************************************************************
 
 ROCm™ provides forward and backward compatibility between the Kernel Fusion

diff --git a/docs/sphinx/requirements.in b/docs/sphinx/requirements.in
@@ -1,3 +1,3 @@
-rocm-docs-core==0.30.3
+rocm-docs-core==0.31.0
 Sphinx-Substitution-Extensions==2022.2.16
 sphinxcontrib.datatemplates==0.11.0
diff --git a/docs/sphinx/requirements.txt b/docs/sphinx/requirements.txt
@@ -104,7 +104,7 @@ requests==2.31.0
     # via
     #   pygithub
     #   sphinx
-rocm-docs-core==0.30.3
+rocm-docs-core==0.31.0
     # via -r requirements.in
 smmap==5.0.0
     # via gitdb

diff --git a/docs/tutorial/install-overview.rst b/docs/tutorial/install-overview.rst
@@ -1,3 +1,8 @@
+.. meta::
+  :description: ROCm installation options
+  :keywords: ROCm installation, AMD, ROCm, Package manager, AMDGPU, single-version installation,
+    multi-version installation
+
 .. _rocm-install-overview:
 
 *************************************************************