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
Files
5ac64b9f6b331fed87d3fbdb993cf77d493417f5
ROCm/docs/install/includes/prerequisites.rst
Peter Park 5ac64b9f6b [docs/7.11.0] Update docs for 7.11 
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
2026-02-11 13:20:02 -05:00

514 lines
15 KiB
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
Prerequisites
=============
.. selected:: os=ubuntu os=debian os=rhel os=oracle-linux os=rocky-linux 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>`.
.. selected:: os=windows
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>`.
.. ====================================================== DOCKER REQUIREMENTS ==
.. selected:: i=pip i=tar i=pkgman
.. selected:: os=ubuntu os=debian os=rhel os=rocky-linux os=oracle-linux os=sles
.. dropdown:: Install essential packages for Docker containers
:animate: fade-in-slide-down
:color: info
:icon: tools
:chevron: down-up
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.
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
.. selected:: os=sles
.. selected:: i=pkgman
.. code-block:: bash
zypper install sudo wget SUSEConnect
.. selected:: i=pip
.. 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. To uninstall the HIP SDK using the
GUI, navigate to the following screen:
* Control Panel > Programs > Uninstall a program
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:
* Turn off WDAG (Windows Defender Application Guard)
* Control Panel > Programs > Programs and Features > Turn Windows
features on or off > **Clear** “Microsoft Defender Application
Guard”
* Turn off SAC (Smart App Control)
* 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
Register your Red Hat Enterprise Linux (RHEL) system to enable access to Red
Hat repositories and ensure you’re able to download and install packages.
Run the following command to register your system:
.. selected:: os-version=10.1 os-version=10.0
.. code-block:: bash
subscription-manager register --username <username> --password <password>
.. selected:: os-version=9.7 os-version=9.6 os-version=9.4 os-version=8.10
.. code-block:: bash
subscription-manager register --username <username> --password <password>
subscription-manager attach --auto
.. selected:: os=sles
:heading: Register your SUSE Linux Enterprise Server system
:heading-level: 3
Register your SUSE Linux Enterprise Server (SLES) system to enable access to
SUSE repositories and ensure you’re able to download and install packages.
Run the following command to register your system:
.. code-block:: bash
sudo SUSEConnect -r <REGCODE>
.. ========================================== ADDITIONAL PACKAGE REPOSITORIES ==
.. selected:: os=rhel
:heading: Update your system
:heading-level: 3
After registering your system, update RHEL to the latest packages. This is
particularly important for newer hardware on older versions of RHEL.
Run the following command to update your system:
.. selected:: os-version=10.1
.. code-block:: bash
sudo dnf update --releasever=10.1 --exclude=\*release\*
.. selected:: os-version=10.0
.. code-block:: bash
sudo dnf update --releasever=10.0 --exclude=\*release\*
.. selected:: os-version=9.7
.. code-block:: bash
sudo dnf update --releasever=9.7 --exclude=\*release\*
.. selected:: os-version=9.6
.. code-block:: bash
sudo dnf update --releasever=9.6 --exclude=\*release\*
.. selected:: os-version=9.4
.. code-block:: bash
sudo dnf update --releasever=9.4 --exclude=\*release\*
.. selected:: os-version=8.10
.. code-block:: bash
sudo dnf update --releasever=8.10 --exclude=\*release\*
.. selected:: os=sles
:heading: Update your system
:heading-level: 3
After registering your system, update SLES to the latest available packages.
This is particularly important for newer hardware on older versions of SLES.
Run the following command to update your system:
.. code-block:: bash
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.04
:heading: Install Python
:heading-level: 3
Install a supported Python version. For example, to install Python
3.12, run the following command:
.. code-block:: bash
sudo apt install python3.12 python3.12-venv
.. selected:: os-version=22.04
:heading: Install Python
:heading-level: 3
Install a supported Python version. For example, to install Python
3.11, run the following command:
.. code-block:: bash
sudo apt install python3.11 python3.11-venv
.. 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
:heading-level: 3
Install a supported Python version. For example, to install Python
3.12, run the following command:
.. code-block:: bash
sudo dnf install python3.12 python3.12-pip
.. selected:: os-version=9.7 os-version=9.6 os-version=8
:heading: Install Python
:heading-level: 3
Install a supported Python version. For example, to install Python
3.11, run the following command:
.. code-block:: bash
sudo dnf install python3.11 python3.11-pip
.. selected:: os=sles
:heading: Install Python
:heading-level: 3
.. selected:: os-version=16.0
Install a supported Python version. For example, to install Python 3.13,
run the following command:
.. 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. See `Python
Releases for Windows <https://www.python.org/downloads/windows/>`__ for
installation details.
.. =================================================== GPU ACCESS PERMISSIONS ==
.. selected:: os=ubuntu os=debian os=rhel os=oracle-linux os=rocky-linux os=sles
:heading: Configure permissions for GPU access
:heading-level: 3
There are two primary methods of configuring GPU access for ROCm: group
membership or udev rules. Each method has its own advantages. The choice
depends on your specific requirements and system management preferences.
.. tab-set::
.. tab-item:: Group membership
By default, GPU access is controlled by membership in the ``video`` and
``render`` Linux system groups. The ``video`` group traditionally handles
video device access, while the ``render`` group manages GPU rendering
through DRM render nodes.
.. code-block:: bash
# Add the current user to the render and video groups
sudo usermod -a -G render,video $LOGNAME
.. tab-item:: udev rules
udev rules are a flexible, system-wide approach for managing device
permissions, eliminating the need for user group management while
allowing granular GPU access. To enable them and grant GPU access to
all users, run the following command:
.. code-block:: bash
sudo tee /etc/udev/rules.d/70-amdgpu.rules << EOF
KERNEL=="kfd", GROUP="render", MODE="0666"
SUBSYSTEM=="drm", KERNEL=="renderD*", GROUP="render", MODE="0666"
EOF
sudo udevadm control --reload-rules
sudo udevadm trigger
.. note::
To apply all settings, reboot your system.
Reference in New Issue View Git Blame Copy Permalink