diff --git a/.wordlist.txt b/.wordlist.txt index 7e16ba8d..b2f77fb7 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -43,3 +43,4 @@ whl ub udev Udev +sudo diff --git a/docs/conf.py b/docs/conf.py index 5fa542d3..331db76b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -40,14 +40,17 @@ sles_version_numbers = ['15.6', '15.5'] ol_release_version_numbers = ['8'] ol_version_numbers = [('8.10')] +azl_version_numbers = ['3.0'] exclude_patterns = [ 'temp', - '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' + 'install/install-methods/includes/rhel-multi-install.rst', + 'install/install-methods/includes/sles-multi-install.rst', + 'install/install-methods/includes/ubuntu-multi-install.rst', + 'install/install-methods/includes/debian-multi-install.rst', + 'install/install-methods/includes/ol-multi-install.rst', + 'install/install-methods/includes/azl-multi-install.rst', + 'install/install-methods/includes/amdgpu-installer-common.rst' ] external_toc_path = "./sphinx/_toc.yml" @@ -86,7 +89,8 @@ "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 + "ol_version_numbers" : ol_version_numbers, + "azl_version_numbers": azl_version_numbers } footnote_backlinks = False diff --git a/docs/install/3rd-party/jax-install.rst b/docs/install/3rd-party/jax-install.rst index 4e50229c..aac3ce0d 100644 --- a/docs/install/3rd-party/jax-install.rst +++ b/docs/install/3rd-party/jax-install.rst @@ -27,8 +27,6 @@ The ROCm JAX team provides prebuilt Docker images, which is the simplest way to Additional Docker images are available at `ROCm JAX on Docker Hub `_. 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: .. code-block:: bash diff --git a/docs/install/amdgpu-install.rst b/docs/install/amdgpu-install.rst index 9da25522..f5dfdad6 100644 --- a/docs/install/amdgpu-install.rst +++ b/docs/install/amdgpu-install.rst @@ -10,9 +10,9 @@ Installation via AMDGPU installer .. warning:: - ROCm doesn't currently support integrated graphics. Should your system have an + ROCm doesn't support integrated graphics. If your system has an AMD IGP installed, disable it in the BIOS prior to using ROCm. If the driver can - enumerate the IGP, the ROCm runtime may crash the system, even if told to omit + enumerate the IGP, the ROCm runtime might crash the system, even if told to omit it via `HIP_VISIBLE_DEVICES `_. .. _amdgpu-install-installation: diff --git a/docs/install/install-methods/amdgpu-installer-index.rst b/docs/install/install-methods/amdgpu-installer-index.rst new file mode 100644 index 00000000..76e50df1 --- /dev/null +++ b/docs/install/install-methods/amdgpu-installer-index.rst @@ -0,0 +1,37 @@ +.. meta:: + :description: Installation via AMDGPU installer + :keywords: ROCm install, installation instructions, AMDGPU installer, AMD, + ROCm + +****************************************************************************** +Installation via AMDGPU installer +****************************************************************************** + +Select the install instructions for your operating system + +.. grid:: 2 + :gutter: 3 + + .. grid-item-card:: Install + + * :doc:`Ubuntu <./amdgpu-installer/amdgpu-installer-ubuntu>` + * :doc:`Debian <./amdgpu-installer/amdgpu-installer-debian>` + * :doc:`Red Hat Enterprise Linux <./amdgpu-installer/amdgpu-installer-rhel>` + * :doc:`Oracle Linux <./amdgpu-installer/amdgpu-installer-ol>` + * :doc:`SUSE Linux Enterprise Server <./amdgpu-installer/amdgpu-installer-sles>` + * :doc:`Azure Linux <./amdgpu-installer/amdgpu-installer-azl>` + + .. grid-item-card:: Uninstall + + * :ref:`Ubuntu ` + * :ref:`Debian ` + * :ref:`Red Hat Enterprise Linux ` + * :ref:`Oracle Linux ` + * :ref:`SUSE Linux Enterprise Server ` + * :ref:`Azure Linux ` + + + + +See also: :doc:`/reference/system-requirements`. If you encounter install issues, you can refer to the +:doc:`troubleshooting ` page. diff --git a/docs/install/install-methods/amdgpu-installer/amdgpu-installer-azl.rst b/docs/install/install-methods/amdgpu-installer/amdgpu-installer-azl.rst new file mode 100644 index 00000000..a8377475 --- /dev/null +++ b/docs/install/install-methods/amdgpu-installer/amdgpu-installer-azl.rst @@ -0,0 +1,220 @@ +.. meta:: + :description: Azure Linux AMDGPU installer installation + :keywords: installation instructions, AMDGPU, AMDGPU installer, AMD, ROCm, Azure Linux, Azure Linux AMDGPU installer installation + +************************************************************************************* +Azure Linux AMDGPU installer installation +************************************************************************************* + +``amdgpu-install`` is a tool that helps you install and update AMDGPU, ROCm, and ROCm components. + +.. warning:: + + ROCm doesn't support integrated graphics. If your system has an + AMD IGP installed, disable it in the BIOS prior to using ROCm. If the driver can + enumerate the IGP, the ROCm runtime might crash the system, even if told to omit + it via `HIP_VISIBLE_DEVICES `_. + +.. _azl-amdgpu-install-installation: + +Installation +================================================= + +.. caution:: + + Ensure that the :doc:`/install/prerequisites` are met before installing. + +.. datatemplate:nodata:: + + .. tab-set:: + {% for os_version in config.html_context['azl_version_numbers'] %} + {% set os_major, _ = os_version.split('.') %} + .. tab-item:: AZL {{ os_version }} + + .. code-block:: bash + :substitutions: + + sudo tdnf install https://repo.radeon.com/amdgpu-install/|amdgpu_version|/azurelinux/{{ os_version }}/amdgpu-install-|amdgpu_install_version|.azl{{ os_major }}.noarch.rpm --nogpgcheck + {% endfor %} + +.. _azl-amdgpu-install-use-cases: + +Use cases +================================================= + +Instead of installing individual applications or libraries, the installer script groups packages into specific +use cases that match typical workflows and runtimes. + +To display a list of available use cases, run: + +.. code-block:: bash + + sudo amdgpu-install --list-usecase + +The available use-cases are printed in a format similar to: + +.. code-block:: + + If --usecase option is not present, the default selection is "graphics,opencl,hip" + + Available use cases: + 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/KMD 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/KMD based) runtime + - ASAN enabled HIP runtimes + - ASAN enabled Machine learning framework + - ASAN enabled ROCm libraries + + +.. _azl-amdgpu-install-dkms: + +Install kernel driver +------------------------------------------------- + +.. code-block:: bash + + sudo tdnf install azurelinux-repos-amd + sudo tdnf repolist --refresh + sudo tdnf install amdgpu + sudo modprobe amdgpu + +Upgrading ROCm +================================================= + +The upgrade procedure with the installer script is the same as installing it for first-time use. + +Installing ROCm packages +================================================= + +To install use cases specific to your requirements, use the installer (``amdgpu-install``) as follows: + +* To install a single use case, add it with the ``--usecase`` option: + + .. code-block:: bash + + sudo amdgpu-install --usecase=rocm --no-dkms + +* The ``--help`` option displays all available options for the ``amdgpu-install`` script: + + .. code-block:: bash + + sudo amdgpu-install --help + + +.. _azl-amdgpu-install-uninstall: + +Uninstalling +===================================================== + +Uninstalling ROCm +--------------------------------------------------------------------------- + +.. code-block:: bash + + sudo amdgpu-install --uninstall + +Uninstall kernel driver +--------------------------------------------------------------------------- + +.. code-block:: bash + + sudo tdnf remove amdgpu amdgpu-firmware kernel-drivers-gpu + +Uninstalling amdgpu-install +--------------------------------------------------------------------------- + +After uninstalling ROCm and kernel driver, remove the amdgpu-install package from the system. + +.. code-block:: bash + + sudo tdnf remove amdgpu-install + +Remove ROCm and AMDGPU repositories +--------------------------------------------------------------------------- + +.. code-block:: bash + + # Remove the repositories + sudo tdnf remove azurelinux-repos-amd + sudo rm /etc/yum.repos.d/rocm.repo* + sudo rm /etc/yum.repos.d/amdgpu.repo* + + # Clear the cache and clean the system + sudo rm -rf /var/cache/tdnf + sudo tdnf clean all + + # Restart the system. + sudo reboot + +Additional options +================================================= + +* Unattended installation. + + Adding ``-y`` as a parameter to ``amdgpu-install`` skips user prompts (for automation). For example: + + .. code-block:: bash + + amdgpu-install -y --usecase=rocm + +* Skipping kernel mode driver installation. + + The installer script tries to install the kernel mode driver and the requested use cases. This + might be unnecessary (as in the case of Docker containers). You might want to keep a specific version + when using multi-version installation, and not have the last installed version overwrite the kernel + mode driver. + + To skip the installation of the kernel-mode driver, add the ``--no-dkms`` option when calling the + installer script. diff --git a/docs/install/install-methods/amdgpu-installer/amdgpu-installer-debian.rst b/docs/install/install-methods/amdgpu-installer/amdgpu-installer-debian.rst new file mode 100644 index 00000000..312153c9 --- /dev/null +++ b/docs/install/install-methods/amdgpu-installer/amdgpu-installer-debian.rst @@ -0,0 +1,100 @@ +.. meta:: + :description: Debian AMDGPU installer installation + :keywords: installation instructions, AMDGPU, AMDGPU installer, AMD, ROCm, Debian, Debian AMDGPU installer installation + +************************************************************************************* +Debian AMDGPU installer installation +************************************************************************************* + +``amdgpu-install`` is a tool that helps you install and update AMDGPU, ROCm, and ROCm components. + +.. warning:: + + ROCm doesn't support integrated graphics. If your system has an + AMD IGP installed, disable it in the BIOS prior to using ROCm. If the driver can + enumerate the IGP, the ROCm runtime might crash the system, even if told to omit + it via `HIP_VISIBLE_DEVICES `_. + +.. _debian-amdgpu-install-installation: + +Installation +================================================= + +.. caution:: + + Ensure that the :doc:`/install/prerequisites` are met before installing. + +.. datatemplate:nodata:: + + .. tab-set:: + {% for (os_version, os_release) in config.html_context['debian_version_numbers'] %} + .. tab-item:: 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 %} + +.. include:: ../includes/amdgpu-installer-common.rst + + +.. _debian-amdgpu-install-uninstall: + +Uninstalling ROCm +================================================= + +To uninstall all ROCm packages and the kernel-mode driver, use the following commands. + +* Uninstalling single-version install + + .. code-block:: bash + + sudo amdgpu-install --uninstall + +* Uninstalling a specific ROCm release + + .. code-block:: bash + + sudo amdgpu-install --uninstall --rocmrelease= + + +* Uninstalling all ROCm releases + + .. code-block:: bash + + sudo amdgpu-install --uninstall --rocmrelease=all + +Uninstalling amdgpu-install +================================================= + +After uninstalling ROCm, remove the amdgpu-install package from system. + +.. code-block:: bash + + sudo apt purge amdgpu-install + sudo apt autoremove + +Additional options +================================================= + +* Unattended installation. + + Adding ``-y`` as a parameter to ``amdgpu-install`` skips user prompts (for automation). For example: + + .. code-block:: bash + + amdgpu-install -y --usecase=rocm + +* Skipping kernel mode driver installation. + + The installer script tries to install the kernel mode driver and the requested use cases. This + might be unnecessary (as in the case of Docker containers). You might want to keep a specific version + when using multi-version installation, and not have the last installed version overwrite the kernel + mode driver. + + To skip the installation of the kernel-mode driver, add the ``--no-dkms`` option when calling the + installer script. diff --git a/docs/install/install-methods/amdgpu-installer/amdgpu-installer-ol.rst b/docs/install/install-methods/amdgpu-installer/amdgpu-installer-ol.rst new file mode 100644 index 00000000..53706463 --- /dev/null +++ b/docs/install/install-methods/amdgpu-installer/amdgpu-installer-ol.rst @@ -0,0 +1,88 @@ +.. meta:: + :description: Oracle Linux AMDGPU installer installation + :keywords: installation instructions, AMDGPU, AMDGPU installer, AMD, ROCm, Oracle Linux, Oracle Linux AMDGPU installer installation + +************************************************************************************* +Oracle Linux AMDGPU installer installation +************************************************************************************* + +``amdgpu-install`` is a tool that helps you install and update AMDGPU, ROCm, and ROCm components. + +.. warning:: + + ROCm doesn't support integrated graphics. If your system has an + AMD IGP installed, disable it in the BIOS prior to using ROCm. If the driver can + enumerate the IGP, the ROCm runtime might crash the system, even if told to omit + it via `HIP_VISIBLE_DEVICES `_. + +.. _ol-amdgpu-install-installation: + +Installation +================================================= + +.. caution:: + + Ensure that the :doc:`/install/prerequisites` are met before installing. + +.. datatemplate:nodata:: + + .. tab-set:: + {% for os_version in config.html_context['ol_version_numbers'] %} + {% set os_major, _ = os_version.split('.') %} + .. tab-item:: OL {{ os_version }} + + .. code-block:: bash + :substitutions: + + sudo dnf install https://repo.radeon.com/amdgpu-install/|amdgpu_version|/el/{{ os_version }}/amdgpu-install-|amdgpu_install_version|.el{{ os_major }}.noarch.rpm + {% endfor %} + +.. include:: ../includes/amdgpu-installer-common.rst + + +.. _ol-amdgpu-install-uninstall: + +Uninstalling ROCm +================================================= + +To uninstall all ROCm packages and the kernel-mode driver, use the following commands. + +* Uninstalling single-version install + + .. code-block:: bash + + sudo amdgpu-install --uninstall + +* Uninstalling a specific ROCm release + + .. code-block:: bash + + sudo amdgpu-install --uninstall --rocmrelease= + + +* Uninstalling all ROCm releases + + .. code-block:: bash + + sudo amdgpu-install --uninstall --rocmrelease=all + +Additional options +================================================= + +* Unattended installation. + + Adding ``-y`` as a parameter to ``amdgpu-install`` skips user prompts (for automation). For example: + + .. code-block:: bash + + amdgpu-install -y --usecase=rocm + +* Skipping kernel mode driver installation. + + The installer script tries to install the kernel mode driver and the requested use cases. This + might be unnecessary (as in the case of Docker containers). You might want to keep a specific version + when using multi-version installation, and not have the last installed version overwrite the kernel + mode driver. + + To skip the installation of the kernel-mode driver, add the ``--no-dkms`` option when calling the + installer script. diff --git a/docs/install/install-methods/amdgpu-installer/amdgpu-installer-rhel.rst b/docs/install/install-methods/amdgpu-installer/amdgpu-installer-rhel.rst new file mode 100644 index 00000000..12404cdd --- /dev/null +++ b/docs/install/install-methods/amdgpu-installer/amdgpu-installer-rhel.rst @@ -0,0 +1,88 @@ +.. meta:: + :description: Red Hat Enterprise Linux AMDGPU installer installation + :keywords: installation instructions, AMDGPU, AMDGPU installer, AMD, ROCm, Red Hat Enterprise Linux, Red Hat Enterprise Linux AMDGPU installer installation + +************************************************************************************* +Red Hat Enterprise Linux AMDGPU installer installation +************************************************************************************* + +``amdgpu-install`` is a tool that helps you install and update AMDGPU, ROCm, and ROCm components. + +.. warning:: + + ROCm doesn't support integrated graphics. If your system has an + AMD IGP installed, disable it in the BIOS prior to using ROCm. If the driver can + enumerate the IGP, the ROCm runtime might crash the system, even if told to omit + it via `HIP_VISIBLE_DEVICES `_. + +.. _rhel-amdgpu-install-installation: + +Installation +================================================= + +.. caution:: + + Ensure that the :doc:`/install/prerequisites` are met before installing. + +.. datatemplate:nodata:: + + .. tab-set:: + {% for os_version in config.html_context['rhel_version_numbers'] %} + {% set os_major, _ = os_version.split('.') %} + .. tab-item:: RHEL {{ os_version }} + + .. code-block:: bash + :substitutions: + + sudo dnf install https://repo.radeon.com/amdgpu-install/|amdgpu_version|/rhel/{{ os_version }}/amdgpu-install-|amdgpu_install_version|.el{{ os_major }}.noarch.rpm + {% endfor %} + +.. include:: ../includes/amdgpu-installer-common.rst + + +.. _rhel-amdgpu-install-uninstall: + +Uninstalling ROCm +================================================= + +To uninstall all ROCm packages and the kernel-mode driver, use the following commands. + +* Uninstalling single-version install + + .. code-block:: bash + + sudo amdgpu-install --uninstall + +* Uninstalling a specific ROCm release + + .. code-block:: bash + + sudo amdgpu-install --uninstall --rocmrelease= + + +* Uninstalling all ROCm releases + + .. code-block:: bash + + sudo amdgpu-install --uninstall --rocmrelease=all + +Additional options +================================================= + +* Unattended installation. + + Adding ``-y`` as a parameter to ``amdgpu-install`` skips user prompts (for automation). For example: + + .. code-block:: bash + + amdgpu-install -y --usecase=rocm + +* Skipping kernel mode driver installation. + + The installer script tries to install the kernel mode driver and the requested use cases. This + might be unnecessary (as in the case of Docker containers). You might want to keep a specific version + when using multi-version installation, and not have the last installed version overwrite the kernel + mode driver. + + To skip the installation of the kernel-mode driver, add the ``--no-dkms`` option when calling the + installer script. diff --git a/docs/install/install-methods/amdgpu-installer/amdgpu-installer-sles.rst b/docs/install/install-methods/amdgpu-installer/amdgpu-installer-sles.rst new file mode 100644 index 00000000..33f1a647 --- /dev/null +++ b/docs/install/install-methods/amdgpu-installer/amdgpu-installer-sles.rst @@ -0,0 +1,87 @@ +.. meta:: + :description: SUSE Enterprise Linux AMDGPU installer installation + :keywords: installation instructions, AMDGPU, AMDGPU installer, AMD, ROCm, SUSE Enterprise Linux, SUSE Enterprise Linux AMDGPU installer installation + +************************************************************************************* +SUSE Enterprise Linux AMDGPU installer installation +************************************************************************************* + +``amdgpu-install`` is a tool that helps you install and update AMDGPU, ROCm, and ROCm components. + +.. warning:: + + ROCm doesn't support integrated graphics. If your system has an + AMD IGP installed, disable it in the BIOS prior to using ROCm. If the driver can + enumerate the IGP, the ROCm runtime might crash the system, even if told to omit + it via `HIP_VISIBLE_DEVICES `_. + +.. _sles-amdgpu-install-installation: + +Installation +================================================= + +.. caution:: + + Ensure that the :doc:`/install/prerequisites` are met before installing. + +.. datatemplate:nodata:: + + .. tab-set:: + {% for os_version in config.html_context['sles_version_numbers'] %} + .. tab-item:: SLES {{ os_version }} + + .. code-block:: bash + :substitutions: + + sudo zypper --no-gpg-checks install https://repo.radeon.com/amdgpu-install/|amdgpu_version|/sle/{{ os_version }}/amdgpu-install-|amdgpu_install_version|.noarch.rpm + {% endfor %} + +.. include:: ../includes/amdgpu-installer-common.rst + + +.. _sles-amdgpu-install-uninstall: + +Uninstalling ROCm +================================================= + +To uninstall all ROCm packages and the kernel-mode driver, use the following commands. + +* Uninstalling single-version install + + .. code-block:: bash + + sudo amdgpu-install --uninstall + +* Uninstalling a specific ROCm release + + .. code-block:: bash + + sudo amdgpu-install --uninstall --rocmrelease= + + +* Uninstalling all ROCm releases + + .. code-block:: bash + + sudo amdgpu-install --uninstall --rocmrelease=all + +Additional options +================================================= + +* Unattended installation. + + Adding ``-y`` as a parameter to ``amdgpu-install`` skips user prompts (for automation). For example: + + .. code-block:: bash + + amdgpu-install -y --usecase=rocm + +* Skipping kernel mode driver installation. + + The installer script tries to install the kernel mode driver and the requested use cases. This + might be unnecessary (as in the case of Docker containers). You might want to keep a specific version + when using multi-version installation, and not have the last installed version overwrite the kernel + mode driver. + + To skip the installation of the kernel-mode driver, add the ``--no-dkms`` option when calling the + installer script. diff --git a/docs/install/install-methods/amdgpu-installer/amdgpu-installer-ubuntu.rst b/docs/install/install-methods/amdgpu-installer/amdgpu-installer-ubuntu.rst new file mode 100644 index 00000000..7728dab4 --- /dev/null +++ b/docs/install/install-methods/amdgpu-installer/amdgpu-installer-ubuntu.rst @@ -0,0 +1,100 @@ +.. meta:: + :description: Ubuntu AMDGPU installer installation + :keywords: installation instructions, AMDGPU, AMDGPU installer, AMD, ROCm, Ubuntu, Ubuntu AMDGPU installer installation + +************************************************************************************* +Ubuntu AMDGPU installer installation +************************************************************************************* + +``amdgpu-install`` is a tool that helps you install and update AMDGPU, ROCm, and ROCm components. + +.. warning:: + + ROCm doesn't support integrated graphics. If your system has an + AMD IGP installed, disable it in the BIOS prior to using ROCm. If the driver can + enumerate the IGP, the ROCm runtime might crash the system, even if told to omit + it via `HIP_VISIBLE_DEVICES `_. + +.. _ubuntu-amdgpu-install-installation: + +Installation +================================================= + +.. caution:: + + Ensure that the :doc:`/install/prerequisites` are met before installing. + +.. datatemplate:nodata:: + + .. tab-set:: + {% for (os_version, os_release) in config.html_context['ubuntu_version_numbers'] %} + .. tab-item:: Ubuntu {{ 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 %} + +.. include:: ../includes/amdgpu-installer-common.rst + + +.. _ubuntu-amdgpu-install-uninstall: + +Uninstalling ROCm +================================================= + +To uninstall all ROCm packages and the kernel-mode driver, use the following commands. + +* Uninstalling single-version install + + .. code-block:: bash + + sudo amdgpu-install --uninstall + +* Uninstalling a specific ROCm release + + .. code-block:: bash + + sudo amdgpu-install --uninstall --rocmrelease= + + +* Uninstalling all ROCm releases + + .. code-block:: bash + + sudo amdgpu-install --uninstall --rocmrelease=all + +Uninstalling amdgpu-install +================================================= + +After uninstalling ROCm, remove the amdgpu-install package from system. + +.. code-block:: bash + + sudo apt purge amdgpu-install + sudo apt autoremove + +Additional options +================================================= + +* Unattended installation. + + Adding ``-y`` as a parameter to ``amdgpu-install`` skips user prompts (for automation). For example: + + .. code-block:: bash + + amdgpu-install -y --usecase=rocm + +* Skipping kernel mode driver installation. + + The installer script tries to install the kernel mode driver and the requested use cases. This + might be unnecessary (as in the case of Docker containers). You might want to keep a specific version + when using multi-version installation, and not have the last installed version overwrite the kernel + mode driver. + + To skip the installation of the kernel-mode driver, add the ``--no-dkms`` option when calling the + installer script. diff --git a/docs/install/install-methods/includes/amdgpu-installer-common.rst b/docs/install/install-methods/includes/amdgpu-installer-common.rst new file mode 100644 index 00000000..612a6c93 --- /dev/null +++ b/docs/install/install-methods/includes/amdgpu-installer-common.rst @@ -0,0 +1,154 @@ +Use cases +================================================= + +Instead of installing individual applications or libraries, the installer script groups packages into specific +use cases that match typical workflows and runtimes. + +To display a list of available use cases, run: + +.. code-block:: bash + + sudo amdgpu-install --list-usecase + +The available use-cases are printed in a format similar to: + +.. code-block:: + + If --usecase option is not present, the default selection is "graphics,opencl,hip" + + Available use cases: + 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/KMD 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/KMD based) runtime + - ASAN enabled HIP runtimes + - ASAN enabled Machine learning framework + - ASAN enabled ROCm libraries + +Install amdgpu-dkms +------------------------------------------------- + +In order to install only the DKMS, which is a minimal requirement for launching containers with GPU +access, use the ``dkms`` use case: + +.. code-block:: bash + + amdgpu-install --usecase=dkms + +To verify the kernel installation, use this command: + +.. code-block:: shell + + sudo dkms status + +If the installation of the kernel module was successful, the command displays the output +in the following format: + +.. code-block:: shell + + amdgpu, 4.3-52.el7, 3.10.0-1160.11.1.el7.x86_64, x86_64: installed (original_module exists) + +Upgrading ROCm +================================================= + +The upgrade procedure with the installer script is the same as installing it for first-time use. + +Installing ROCm packages +================================================= + +To install use cases specific to your requirements, use the installer (``amdgpu-install``) as follows: + +* To install a single use case, add it with the ``--usecase`` option: + + .. code-block:: bash + + sudo amdgpu-install --usecase=rocm + +* For multiple use cases, separate them with commas: + + .. code-block:: bash + + sudo amdgpu-install --usecase=hiplibsdk,rocm + +* For graphical workloads using the open-source driver, add ``graphics``. For example: + + .. code-block:: bash + + sudo amdgpu-install --usecase=graphics,rocm + +* For graphical workloads using the proprietary driver, add ``workstation``. For example: + + .. code-block:: bash + + sudo amdgpu-install --usecase=workstation,rocm + +* To install LLVM AddressSanitizer (ASAN) instrumented binaries (for packages that support it), add + ``asan``. For example: + + .. code-block:: bash + + sudo amdgpu-install --usecase=rocm,asan + +* To list all possible use cases, use the ``--list-usecase`` option: + + .. code-block:: bash + + sudo amdgpu-install --list-usecase + +* The ``--help`` option displays all available options for the ``amdgpu-install`` script: + + .. code-block:: bash + + sudo amdgpu-install --help + \ No newline at end of file diff --git a/docs/install/native-install/includes/debian-multi-install.rst b/docs/install/install-methods/includes/debian-multi-install.rst similarity index 100% rename from docs/install/native-install/includes/debian-multi-install.rst rename to docs/install/install-methods/includes/debian-multi-install.rst diff --git a/docs/install/native-install/includes/ol-multi-install.rst b/docs/install/install-methods/includes/ol-multi-install.rst similarity index 100% rename from docs/install/native-install/includes/ol-multi-install.rst rename to docs/install/install-methods/includes/ol-multi-install.rst diff --git a/docs/install/native-install/includes/rhel-multi-install.rst b/docs/install/install-methods/includes/rhel-multi-install.rst similarity index 100% rename from docs/install/native-install/includes/rhel-multi-install.rst rename to docs/install/install-methods/includes/rhel-multi-install.rst diff --git a/docs/install/native-install/includes/sles-multi-install.rst b/docs/install/install-methods/includes/sles-multi-install.rst similarity index 100% rename from docs/install/native-install/includes/sles-multi-install.rst rename to docs/install/install-methods/includes/sles-multi-install.rst diff --git a/docs/install/native-install/includes/ubuntu-multi-install.rst b/docs/install/install-methods/includes/ubuntu-multi-install.rst similarity index 100% rename from docs/install/native-install/includes/ubuntu-multi-install.rst rename to docs/install/install-methods/includes/ubuntu-multi-install.rst diff --git a/docs/install/native-install/multi-version-install.rst b/docs/install/install-methods/multi-version-install.rst similarity index 100% rename from docs/install/native-install/multi-version-install.rst rename to docs/install/install-methods/multi-version-install.rst diff --git a/docs/install/install-methods/package-manager-index.rst b/docs/install/install-methods/package-manager-index.rst new file mode 100644 index 00000000..baeb45c0 --- /dev/null +++ b/docs/install/install-methods/package-manager-index.rst @@ -0,0 +1,37 @@ +.. meta:: + :description: Installation via native package manager + :keywords: ROCm install, installation instructions, package manager, native package manager, AMD, + ROCm + +****************************************************************************** +Installation via native package manager +****************************************************************************** + +Select the install instructions for your operating system + +.. grid:: 2 + :gutter: 3 + + .. grid-item-card:: Install + + * :doc:`Ubuntu <./package-manager/package-manager-ubuntu>` + * :doc:`Debian <./package-manager/package-manager-debian>` + * :doc:`Red Hat Enterprise Linux <./package-manager/package-manager-rhel>` + * :doc:`Oracle Linux <./package-manager/package-manager-ol>` + * :doc:`SUSE Linux Enterprise Server <./package-manager/package-manager-sles>` + * :doc:`Azure Linux <./package-manager/package-manager-azl>` + + .. grid-item-card:: Uninstall + + * :ref:`Ubuntu ` + * :ref:`Debian ` + * :ref:`Red Hat Enterprise Linux ` + * :ref:`Oracle Linux ` + * :ref:`SUSE Linux Enterprise Server ` + * :ref:`Azure Linux ` + + + + +See also: :doc:`/reference/system-requirements`. If you encounter install issues, you can refer to the +:doc:`troubleshooting ` page. diff --git a/docs/install/install-methods/package-manager/package-manager-azl.rst b/docs/install/install-methods/package-manager/package-manager-azl.rst new file mode 100644 index 00000000..bdfd254c --- /dev/null +++ b/docs/install/install-methods/package-manager/package-manager-azl.rst @@ -0,0 +1,119 @@ +.. meta:: + :description: Azure Linux native installation + :keywords: ROCm install, installation instructions, AZL, Azure Linux native installation, + AMD, ROCm + +********************************************************************************************** +Azure Linux native installation +********************************************************************************************** + +.. important:: + + Ensure that the :doc:`/install/prerequisites` are met before installing. + +.. _azl-register-repo: + +Registering ROCm repositories +===================================================== + +.. datatemplate:nodata:: + + .. tab-set:: + {% for os_version in config.html_context['azl_version_numbers'] %} + {% set os_major, _ = os_version.split('.') %} + .. tab-item:: AZL {{ os_version }} + :sync: azl-{{ os_version }} + + .. code-block:: bash + :substitutions: + + sudo tee --append /etc/yum.repos.d/rocm.repo <` -* :doc:`Running the amdgpu-install script <../install/amdgpu-install>` +* :doc:`Using the Linux distribution package manager <../install/install-methods/package-manager-index>` +* :doc:`Running the amdgpu-install script <../install/install-methods/amdgpu-installer-index>` There is no difference in the final installation between these two methods. @@ -61,7 +61,7 @@ Multi-version installation 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>`. +For instructions, see :doc:`installing multiple ROCm versions<../install/install-methods/multi-version-install>`. .. _rocm-offline-installer-creator: diff --git a/docs/install/native-install/index.rst b/docs/install/native-install/index.rst deleted file mode 100644 index 6fecf40f..00000000 --- a/docs/install/native-install/index.rst +++ /dev/null @@ -1,34 +0,0 @@ -.. meta:: - :description: Installation via native package manager - :keywords: ROCm install, installation instructions, package manager, native package manager, AMD, - ROCm - -****************************************************************************** -Installation via native package manager -****************************************************************************** - -Select the install instructions for your operating system - -.. grid:: 2 - :gutter: 5 - - .. grid-item-card:: Install - - * :doc:`Ubuntu <./ubuntu>` - * :doc:`Debian <./debian>` - * :doc:`RHEL <./rhel>` - * :doc:`OL <./ol>` - * :doc:`SLES <./sles>` - - .. grid-item-card:: Uninstall - - * :ref:`Ubuntu ` - * :ref:`Debian ` - * :ref:`RHEL ` - * :ref:`OL ` - * :ref:`SLES ` - - - -See also: :doc:`/reference/system-requirements`. If you encounter install issues, you can refer to the -:doc:`troubleshooting ` page. diff --git a/docs/install/post-install.rst b/docs/install/post-install.rst index 4ea3ffe1..0cbfe8f3 100644 --- a/docs/install/post-install.rst +++ b/docs/install/post-install.rst @@ -79,15 +79,49 @@ After installing ROCm, follow these steps to finalize and validate the installat 3. Verify the kernel-mode driver installation. - .. code-block:: bash + .. tab-set:: + + .. tab-item:: Ubuntu + + .. code-block:: bash + + dkms status + + .. tab-item:: Debian + + .. code-block:: bash + + dkms status + + .. tab-item:: RHEL + + .. code-block:: bash + + dkms status - dkms status + .. tab-item:: OL + + .. code-block:: bash + + dkms status + + .. tab-item:: SLES + + .. code-block:: bash + + dkms status + + .. tab-item:: AZL + + .. code-block:: bash + + modinfo amdgpu | grep -w "version:" 4. Export LD_LIBRARY_PATH as needed .. important:: - This step is required for version specific or :doc:`multi-version installations <./native-install/multi-version-install>`. + This step is required for version specific or :doc:`multi-version installations <./install-methods/multi-version-install>`. .. code-block:: shell :substitutions: @@ -134,3 +168,9 @@ After installing ROCm, follow these steps to finalize and validate the installat .. code-block:: bash zypper search --installed-only + + .. tab-item:: AZL + + .. code-block:: bash + + tdnf list installed diff --git a/docs/install/prerequisites.rst b/docs/install/prerequisites.rst index 4b24482c..83f05cc9 100644 --- a/docs/install/prerequisites.rst +++ b/docs/install/prerequisites.rst @@ -96,6 +96,11 @@ your operating system to ensure you're able to download and install packages. More details about `registering for SLES `_ + .. tab-item:: Azure Linux + :sync: azl-tab + + There is no registration required for Azure Linux. + Additional package repositories ========================================================== @@ -201,6 +206,26 @@ instructions specific to your distribution to add the necessary repositories. {% endfor %} + .. tab-item:: Azure Linux + :sync: azl-tab + + Enable the the config repository for additional packages. In order to enable config, you may need to install ``dnf-plugin-config-manager`` first. + + .. datatemplate:nodata:: + + .. tab-set:: + + {% for os_version in config.html_context['azl_version_numbers'] %} + + .. tab-item:: AZL {{ os_version }} + + .. code-block:: shell + + sudo tdnf install dnf-plugin-config-manager + sudo curl -o /etc/yum.repos.d/azurelinux-extended.repo https://packages.microsoft.com/azurelinux/{{ os_version }}/prod/extended/x86_64/config.repo + + {% endfor %} + Kernel headers and development packages ================================================================ @@ -218,7 +243,7 @@ To install for the currently active kernel run the command corresponding to your .. tab-item:: Ubuntu :sync: ubuntu-tab - .. datatemplate:nodata:: + .. code-block:: shell .. tab-set:: @@ -284,6 +309,13 @@ To install for the currently active kernel run the command corresponding to your sudo zypper install kernel-default-devel sudo zypper install python3-setuptools python3-wheel + .. tab-item:: Azure Linux + :sync: azl-tab + + .. code-block:: shell + + sudo tdnf install "kernel-headers-$(uname -r)" "kernel-devel-$(uname -r)" + sudo tdnf install python3-setuptools python3-wheel .. _group_permissions: diff --git a/docs/install/quick-start.rst b/docs/install/quick-start.rst index 0b36cf04..a612226e 100644 --- a/docs/install/quick-start.rst +++ b/docs/install/quick-start.rst @@ -148,6 +148,31 @@ For more in-depth installation instructions, refer to :ref:`detailed-install-ove {% endfor %} + .. tab-item:: Azure Linux + + .. tab-set:: + + {% for os_version in config.html_context['azl_version_numbers'] %} + {% set os_major, _ = os_version.split('.') %} + .. tab-item:: {{ os_version }} + + .. code-block:: bash + :substitutions: + + sudo tdnf install dnf-plugin-config-manager + sudo curl -o /etc/yum.repos.d/azurelinux-extended.repo https://packages.microsoft.com/azurelinux/{{ os_version }}/prod/extended/x86_64/config.repo + sudo tdnf install "kernel-headers-$(uname -r)" "kernel-devel-$(uname -r)" + sudo tdnf install python3-setuptools python3-wheel + sudo usermod -a -G render,video $LOGNAME # Add the current user to the render and video groups + sudo tdnf install https://repo.radeon.com/amdgpu-install/|amdgpu_version|/azurelinux/{{ os_version }}/amdgpu-install-|amdgpu_install_version|.azl{{ os_major }}.noarch.rpm --nogpgcheck + sudo tdnf install azurelinux-repos-amd + sudo tdnf repolist --refresh + sudo tdnf install amdgpu + sudo modprobe amdgpu + sudo tdnf clean all + sudo tdnf install rocm + {% endfor %} + .. important:: To apply all settings, reboot your system. diff --git a/docs/reference/install-faq.rst b/docs/reference/install-faq.rst index f410d859..e1365fcb 100644 --- a/docs/reference/install-faq.rst +++ b/docs/reference/install-faq.rst @@ -20,8 +20,8 @@ As an example, the latest version of ROCm is 6.0.2, but the installation instruc **Solution:** You may have used the quick-start installation method which only installs the latest major release. Use one of the other available installation methods: * :doc:`Quick-start installation <../install/quick-start>` - Installs only the latest **major** release (i.e. 6.0.0, or 6.1.0) -* :doc:`Native package manager install method <../install/native-install/index>` - Installs the specified *major and minor* release version (i.e. 6.0.0, 6.0.2) -* :doc:`amdgpu-install method <../install/amdgpu-install>` - Installs the specified *major and minor* release version (i.e. 6.0.0, 6.0.2) +* :doc:`Native package manager install method <../install/install-methods/package-manager-index>` - Installs the specified *major and minor* release version (i.e. 6.0.0, 6.0.2) +* :doc:`amdgpu-install method <../install/install-methods/amdgpu-installer-index>` - Installs the specified *major and minor* release version (i.e. 6.0.0, 6.0.2) Refer to `ROCm Issue #2422 `_ for additional details. diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index f31d674f..946a5e0e 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -17,24 +17,40 @@ subtrees: title: Installation methods subtrees: - entries: - - file: install/native-install/index + - file: install/install-methods/package-manager-index title: Package manager subtrees: - entries: - - file: install/native-install/ubuntu + - file: install/install-methods/package-manager/package-manager-ubuntu title: Ubuntu - - file: install/native-install/debian + - file: install/install-methods/package-manager/package-manager-debian title: Debian - - file: install/native-install/rhel - title: RHEL - - file: install/native-install/ol - title: OL - - file: install/native-install/sles - title: SLES - - file: install/amdgpu-install + - file: install/install-methods/package-manager/package-manager-rhel + title: Red Hat Enterprise Linux + - file: install/install-methods/package-manager/package-manager-ol + title: Oracle Linux + - file: install/install-methods/package-manager/package-manager-sles + title: SUSE Linux Enterprise Server + - file: install/install-methods/package-manager/package-manager-azl + title: Azure Linux + - file: install/install-methods/amdgpu-installer-index title: AMDGPU installer - - file: install/native-install/multi-version-install - title: Multi version install + subtrees: + - entries: + - file: install/install-methods/amdgpu-installer/amdgpu-installer-ubuntu + title: Ubuntu + - file: install/install-methods/amdgpu-installer/amdgpu-installer-debian + title: Debian + - file: install/install-methods/amdgpu-installer/amdgpu-installer-rhel + title: Red Hat Enterprise Linux + - file: install/install-methods/amdgpu-installer/amdgpu-installer-ol + title: Oracle Linux + - file: install/install-methods/amdgpu-installer/amdgpu-installer-sles + title: SUSE Linux Enterprise Server + - file: install/install-methods/amdgpu-installer/amdgpu-installer-azl + title: Azure Linux + - file: install/install-methods/multi-version-install + title: Multi-version install - file: install/rocm-offline-installer title: ROCm Offline Installer Creator - file: install/rocm-runfile-installer