Merge pull request #375 from ROCm/sync-develop-from-internal

Sync develop from internal

.wordlist.txt

@@ -3,6 +3,7 @@ BARs
 br
 Broadcom
 CTest
+debian
 denylist
 DHCP
 dkms
@@ -21,12 +22,14 @@ KMD
 MACVTAP
 MSRs
 OL
+Packageless
 pci
 PLX
 preconfigured
 Repo
 rocHPL
 ROCmVersion
+Runfile
 SBR
 SMCi
 SVM
@@ -37,5 +40,6 @@ vfio
 VFIO
 vhost
 whl
+ub
 udev
 Udev

docs/conf.py

@@ -5,12 +5,12 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 # ROCm version numbers
-rocm_version = '6.3'
-rocm_multi_versions = '6.3 6.2.4' # in 6.3, the folder names on repo.radeon.com use 6.3 for minor releases
-rocm_multi_versions_package_versions = '6.3.0 6.2.4' # however, in multi, the packages use 6.3.0
-rocm_directory_version = '6.3.0' # in 6.0 rocm was located in /opt/rocm-6.0.0
-amdgpu_version = '6.3' # directory in https://repo.radeon.com/rocm/apt/ and https://repo.radeon.com/amdgpu-install/
-amdgpu_install_version = '6.3.60300-1' # version in https://repo.radeon.com/amdgpu-install/6.0.2/ubuntu/jammy/
+rocm_version = '6.3.1'
+rocm_multi_versions = '6.3.1 6.3' # in 6.3, the folder names on repo.radeon.com use 6.3 for minor releases
+rocm_multi_versions_package_versions = '6.3.1 6.3.0' # however, in multi, the packages use 6.3.0
+rocm_directory_version = '6.3.1' # in 6.0 rocm was located in /opt/rocm-6.0.0
+amdgpu_version = '6.3.1' # directory in https://repo.radeon.com/rocm/apt/ and https://repo.radeon.com/amdgpu-install/
+amdgpu_install_version = '6.3.60301-1' # version in https://repo.radeon.com/amdgpu-install/6.0.2/ubuntu/jammy/
 
 
 latex_engine = "xelatex"
@@ -26,14 +26,15 @@
 project = "ROCm installation on Linux"
 author = "Advanced Micro Devices, Inc."
 copyright = "Copyright (c) 2024 Advanced Micro Devices, Inc. All rights reserved."
-version = "6.3.0"
-release = "6.3.0"
+version = "6.3.1"
+release = "6.3.1"
 setting_all_article_info = True
 all_article_info_os = ["linux"]
 all_article_info_author = ""
 
 # Supported linux version numbers
 ubuntu_version_numbers = [('24.04', 'noble'), ('22.04', 'jammy')]
+debian_version_numbers = [('12', 'jammy')]
 rhel_release_version_numbers = ['9', '8']
 rhel_version_numbers = ['9.5', '9.4', '8.10']
 sles_version_numbers = ['15.6', '15.5']
@@ -45,6 +46,7 @@
     'install/native-install/includes/rhel-multi-install.rst',
     'install/native-install/includes/sles-multi-install.rst',
     'install/native-install/includes/ubuntu-multi-install.rst'
+    'install/native-install/includes/debian-multi-install.rst'
     'install/native-install/includes/ol-multi-install.rst'
 ]
 
@@ -79,9 +81,12 @@
 
 html_context = {
     "ubuntu_version_numbers" : ubuntu_version_numbers,
+    "debian_version_numbers" : debian_version_numbers,
     "sles_version_numbers" : sles_version_numbers,
     "rhel_release_version_numbers" : rhel_release_version_numbers,
     "rhel_version_numbers" : rhel_version_numbers,
     "ol_release_version_numbers" : ol_release_version_numbers,
     "ol_version_numbers" : ol_version_numbers
 }
+
+footnote_backlinks = False

docs/index.rst

@@ -42,10 +42,8 @@ The documentation is structured as follows:
 
     .. grid-item-card:: Reference
 
-        * :doc:`reference/docker-image-support-matrix`
         * :doc:`reference/package-manager-integration`
         * :doc:`reference/system-requirements`
         * :doc:`reference/3rd-party-support-matrix`
         * :doc:`Troubleshooting <reference/install-faq>`
         * :doc:`reference/user-kernel-space-compat-matrix`
-

docs/install/3rd-party/jax-install.rst

@@ -21,8 +21,13 @@ The ROCm JAX team provides prebuilt Docker images, which is the simplest way to
 
    .. note::
 
-      For older versions, review the periodically pushed Docker images at:
-      `ROCm JAX Community on Docker Hub <https://hub.docker.com/r/rocm/jax-community/tags>`_.
+      For specific versions of JAX, review the periodically pushed Docker images at `ROCm JAX Community on
+      Docker Hub <https://hub.docker.com/r/rocm/jax-community/tags>`_.
+
+      Additional Docker images are available at `ROCm JAX on Docker Hub <https://hub.docker.com/r/rocm/jax/tags>`_.
+      These contain the latest ROCm version but might use an older version of JAX.
+
+   .. note::
 
 2. Once the image is downloaded, launch a container using the following command:
 
@@ -38,6 +43,7 @@ The ROCm JAX team provides prebuilt Docker images, which is the simplest way to
 
       * The ``--shm-size`` parameter allocates shared memory for the container. Adjust it based on your system's resources if needed.
       * Replace ``$(pwd)`` with the absolute path to the directory you want to mount inside the container.
+      * If you prefer to use ``rocm/jax``, remember to replace ``rocm/jax-community`` with ``rocm/jax``.
 
 3. Verify the installation of ROCm JAX. See :ref:`jax-verify-installation`.
 

docs/install/amdgpu-install.rst

@@ -42,6 +42,26 @@ Ubuntu
                 sudo apt update
                 wget https://repo.radeon.com/amdgpu-install/|amdgpu_version|/ubuntu/{{ os_release }}/amdgpu-install_|amdgpu_install_version|_all.deb
                 sudo apt install ./amdgpu-install_|amdgpu_install_version|_all.deb
+                sudo apt update
+        {% endfor %}
+
+Debian
+--------------------------------------------------------------------
+
+.. datatemplate:nodata::
+
+    .. tab-set::
+        {% for (os_version, os_release) in config.html_context['debian_version_numbers'] %}
+        .. tab-item:: Debian {{ os_version }}
+            :sync: debian-{{ os_version}}
+
+            .. code-block:: bash
+                :substitutions:
+
+                sudo apt update
+                wget https://repo.radeon.com/amdgpu-install/|amdgpu_version|/ubuntu/{{ os_release }}/amdgpu-install_|amdgpu_install_version|_all.deb
+                sudo apt install ./amdgpu-install_|amdgpu_install_version|_all.deb
+                sudo apt update
         {% endfor %}
 
 Red Hat Enterprise Linux
@@ -282,13 +302,22 @@ Uninstalling amdgpu-install
 
 After uninstalling ROCm, remove the amdgpu-install package from system.
 
-Ubuntu
---------------------------------------------------------------------
+.. tab-set::
 
-.. code-block:: bash
+    .. tab-item:: Ubuntu
+
+        .. code-block:: bash
+
+          sudo apt purge amdgpu-install
+          sudo apt autoremove
+  
+    .. tab-item:: Debian
+
+        .. code-block:: bash
 
-    sudo apt purge amdgpu-install
-    sudo apt autoremove
+          sudo apt purge amdgpu-install
+          sudo apt autoremove
+  
 
 Additional options
 =================================================

docs/install/install-overview.rst

@@ -23,8 +23,9 @@ Installation methods
 ######################
 
 * :ref:`package_manager_versus_amdgpu`
-* :ref:`Multi version installation (Optional) <multi-version-install-overview>`
+* :ref:`Multi-version installation <multi-version-install-overview>`
 * :ref:`ROCm Offline Installer Creator <rocm-offline-installer-creator>`
+* :ref:`ROCm Runfile Installer <rocm-runfile-installer>`
 
 .. _package_manager_versus_amdgpu:
 
@@ -54,11 +55,13 @@ installation.
 
 .. _multi-version-install-overview:
 
-Multi version installation (Optional)
+Multi-version installation
 ===========================================================
 
-A select few users may want to install multiple versions of ROCm. Multi version installation covers situations where you need multiple versions of ROCm on the same machine. 
-Follow :doc:`installing multiple ROCm versions<../install/native-install/multi-version-install>` for instructions.
+A multi-version ROCm installation handles situations where users need multiple
+versions of ROCm on the same machine for compatibility with different
+applications and hardware, testing, and other use cases.
+For instructions, see :doc:`installing multiple ROCm versions<../install/native-install/multi-version-install>`.
 
 .. _rocm-offline-installer-creator:
 
@@ -69,3 +72,12 @@ The ROCm Offline Installer Creator creates an
 installation package for a preconfigured setup of ROCm, the AMDGPU driver, or a combination
 of the two on a target system without network or internet access.
 See :doc:`ROCm Offline Installer Creator <../install/rocm-offline-installer>` for instructions.
+
+.. _rocm-runfile-installer:
+
+ROCm Runfile Installer
+===========================================================
+
+The ROCm Runfile Installer lets you install ROCm without using a native Linux package management system.
+It can be used with or without network or internet access.
+See :doc:`ROCm Runfile Installer <../install/rocm-runfile-installer>` for instructions.

docs/install/native-install/debian.rst

@@ -0,0 +1,173 @@
+.. meta::
+  :description: Debian native installation
+  :keywords: ROCm install, installation instructions, Debian, Debian native installation, AMD, ROCm
+
+****************************************************************************
+Debian native installation
+****************************************************************************
+
+.. important::
+
+    Ensure that the :doc:`/install/prerequisites` are met before installing.
+
+.. _debian-register-repo:
+
+Registering ROCm repositories
+=================================================
+
+.. _debian-package-key:
+
+Package signing key
+---------------------------------------------------------------------------
+
+Download and convert the package signing key.
+
+.. code-block:: bash
+
+    # Make the directory if it doesn't exist yet.
+    # This location is recommended by the distribution maintainers.
+    sudo mkdir --parents --mode=0755 /etc/apt/keyrings
+
+    # Download the key, convert the signing-key to a full
+    # keyring required by apt and store in the keyring directory
+    wget https://repo.radeon.com/rocm/rocm.gpg.key -O - | \
+        gpg --dearmor | sudo tee /etc/apt/keyrings/rocm.gpg > /dev/null
+
+.. _debian-register-driver:
+
+.. note::
+
+    The GPG key may change; ensure it is updated when installing a new release.
+    If the key signature verification fails while updating,
+    re-add the key from the ROCm to the apt repository as mentioned above.
+
+Register kernel-mode driver
+---------------------------------------------------------------------------
+
+Add the AMDGPU repository for the driver.
+
+.. datatemplate:nodata::
+
+    .. tab-set::
+        {% for (os_version, os_release) in config.html_context['debian_version_numbers'] %}
+        .. tab-item:: Debian {{ os_version }}
+            :sync: debian-{{ os_version}}
+
+            .. code-block:: bash
+                :substitutions:
+
+                echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amdgpu/|rocm_version|/ubuntu {{ os_release }} main" \
+                    | sudo tee /etc/apt/sources.list.d/amdgpu.list
+                sudo apt update
+        {% endfor %}
+
+.. _debian-register-rocm:
+
+Register ROCm packages
+---------------------------------------------------------------------------
+
+Add the ROCm repository.
+
+.. datatemplate:nodata::
+
+    .. tab-set::
+        {% for (os_version, os_release) in config.html_context['debian_version_numbers'] %}
+        .. tab-item:: Debian {{ os_version }}
+            :sync: debian-{{ os_version}}
+
+            .. code-block:: bash
+                :substitutions:
+
+                echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/rocm/apt/|rocm_version| {{ os_release }} main" \
+                    | sudo tee --append /etc/apt/sources.list.d/rocm.list
+                echo -e 'Package: *\nPin: release o=repo.radeon.com\nPin-Priority: 600' \
+                    | sudo tee /etc/apt/preferences.d/rocm-pin-600
+                sudo apt update
+        {% endfor %}
+
+.. _debian-install:
+
+Installing
+================================================
+
+Install kernel driver
+---------------------------------------------------------------------------
+
+.. code-block:: bash
+
+    sudo apt install amdgpu-dkms
+    sudo reboot
+
+Install ROCm packages
+---------------------------------------------------------------------------
+
+.. code-block:: bash
+
+    sudo apt install rocm
+
+Complete the :doc:`../post-install`.
+
+
+.. _debian-upgrade:
+
+Upgrading
+================================================
+
+To upgrade an existing ROCm installation to a newer version, follow the steps in
+:ref:`debian-register-repo` and :ref:`debian-install`. 
+
+.. note::
+
+    Upgrading the kernel driver may also upgrade the GPU firmware, which requires a
+    system reboot to take effect.
+
+.. _debian-uninstall:
+
+Uninstalling
+================================================
+
+Uninstall specific meta packages
+---------------------------------------------------------------------------
+
+.. code-block:: bash
+    :substitutions:
+
+    # sudo apt autoremove <package-name>
+    # For example:
+    sudo apt autoremove rocm
+    # Or for version specific packages:
+    sudo apt autoremove rocm|rocm_version|
+
+Uninstall ROCm packages
+---------------------------------------------------------------------------
+
+.. code-block:: bash
+    :substitutions:
+
+    sudo apt autoremove rocm-core
+    # Or for version specific packages:
+    sudo apt autoremove rocm-core|rocm_version|
+
+Uninstall kernel-mode driver
+---------------------------------------------------------------------------
+
+.. code-block:: bash
+
+    sudo apt autoremove amdgpu-dkms
+
+Remove ROCm and AMDGPU repositories
+---------------------------------------------------------------------------
+
+.. code-block:: bash
+
+    # Remove the repositories.
+    sudo rm /etc/apt/sources.list.d/rocm.list
+    sudo rm /etc/apt/sources.list.d/amdgpu.list
+
+    # Clear the cache and clean the system.
+    sudo rm -rf /var/cache/apt/*
+    sudo apt clean all
+    sudo apt update
+
+    # Restart the system.
+    sudo reboot