Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update 6.2.1 docs from develop #291

Merged
merged 10 commits into from
Sep 11, 2024
1 change: 1 addition & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ FWDEV
hostname
hotplug
IFWI
IGP
IIO
IRQs
MACVTAP
Expand Down
4 changes: 3 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@

# ROCm version numbers
rocm_version = '6.2'
rocm_multi_versions = '6.2.0 6.1.2'
rocm_multi_versions = '6.2 6.1.2' # in 6.2, the folder names on repo.radeon.com use 6.2 for minor releases
rocm_multi_versions_package_versions = '6.2.0 6.1.2' # however, in multi, the packages use 6.2.0
rocm_directory_version = '6.2.0' # in 6.0 rocm was located in /opt/rocm-6.0.0
amdgpu_version = '6.2' # directory in https://repo.radeon.com/rocm/apt/ and https://repo.radeon.com/amdgpu-install/
amdgpu_install_version = '6.2.60200-1' # version in https://repo.radeon.com/amdgpu-install/6.0.2/ubuntu/jammy/
Expand Down Expand Up @@ -66,6 +67,7 @@
rst_prolog = f"""
.. |rocm_version| replace:: {rocm_version}
.. |rocm_multi_versions| replace:: {rocm_multi_versions}
.. |rocm_multi_versions_package_versions| replace:: {rocm_multi_versions_package_versions}
.. |amdgpu_version| replace:: {amdgpu_version}
.. |rocm_directory_version| replace:: {rocm_directory_version}
.. |amdgpu_install_version| replace:: {amdgpu_install_version}
Expand Down
18 changes: 9 additions & 9 deletions docs/install/3rd-party/pytorch-install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,38 +75,38 @@ wheels command, you must select 'Linux', 'Python', 'pip', and 'ROCm' in the matr

* - Base OS
- Docker Image
* - Ubuntu 20.04
- `rocm/dev-ubuntu-20.04 <https://hub.docker.com/r/rocm/dev-ubuntu-20.04>`_
* - Ubuntu 22.04
- `rocm/dev-ubuntu-22.04 <https://hub.docker.com/r/rocm/dev-ubuntu-22.04>`_
* - Ubuntu 24.04
- `rocm/dev-ubuntu-24.04 <https://hub.docker.com/r/rocm/dev-ubuntu-24.04>`_

b. Pull the selected image.

.. code-block:: bash

docker pull rocm/dev-ubuntu-20.04:latest
docker pull rocm/dev-ubuntu-22.04:latest

c. Start a Docker container using the downloaded image.

.. code-block:: bash

docker run -it --device=/dev/kfd --device=/dev/dri --group-add video rocm/dev-ubuntu-20.04:latest
docker run -it --device=/dev/kfd --device=/dev/dri --group-add video rocm/dev-ubuntu-22.04:latest

**Option 2:**

Select a base OS Docker image (Check :ref:`system-requirements`)

Pull selected base OS image (Ubuntu 20.04 for example)
Pull selected base OS image (Ubuntu 22.04 for example)

.. code-block:: bash

docker pull ubuntu:20.04
docker pull ubuntu:22.04

Start a Docker container using the downloaded image

.. code-block:: bash

docker run -it --device=/dev/kfd --device=/dev/dri --group-add video ubuntu:20.04
docker run -it --device=/dev/kfd --device=/dev/dri --group-add video ubuntu:22.04

Install ROCm using the directions in the :ref:`rocm-install-overview` section.

Expand All @@ -128,12 +128,12 @@ wheels command, you must select 'Linux', 'Python', 'pip', and 'ROCm' in the matr

.. note::

The following command uses the ROCm 6.1 PyTorch wheel. If you want a different version of ROCm,
The following command uses the ROCm 6.2 PyTorch wheel. If you want a different version of ROCm,
modify the command accordingly.

.. code-block:: bash

pip3 install --pre torch torchvision torchaudio --index-url https://download.pytorch.org/whl/nightly/rocm6.1/
pip3 install --pre torch torchvision torchaudio --index-url https://download.pytorch.org/whl/nightly/rocm6.2/

4. (Optional) Use MIOpen kdb files with ROCm PyTorch wheels.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
.. code-block:: bash
:substitutions:

for ver in |rocm_multi_versions|; do
for ver in |rocm_multi_versions_package_versions|; do
sudo dnf install rocm$ver
done

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
.. code-block:: bash
:substitutions:

for ver in |rocm_multi_versions|; do
for ver in |rocm_multi_versions_package_versions|; do
sudo zypper --gpg-auto-import-keys install rocm$ver
done

Expand Down
17 changes: 16 additions & 1 deletion docs/install/native-install/includes/ubuntu-multi-install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@

.. tab-set::
{% for (os_version, os_release) in config.html_context['ubuntu_version_numbers'] %}
{% if os_version == '24.04' %}

{% else %}
.. tab-item:: Ubuntu {{ os_version }}
:sync: ubuntu-{{ os_version}}

Expand All @@ -21,6 +24,8 @@
| sudo tee /etc/apt/sources.list.d/amdgpu.list
done
sudo apt update

{% endif %}
{% endfor %}

.. _ubuntu-multi-register-rocm:
Expand All @@ -33,6 +38,9 @@

.. tab-set::
{% for (os_version, os_release) in config.html_context['ubuntu_version_numbers'] %}
{% if os_version == '24.04' %}

{% else %}
.. tab-item:: Ubuntu {{ os_version }}
:sync: ubuntu-{{ os_version}}

Expand All @@ -46,6 +54,7 @@
echo -e 'Package: *\nPin: release o=repo.radeon.com\nPin-Priority: 600' \
| sudo tee /etc/apt/preferences.d/rocm-pin-600
sudo apt update
{% endif %}
{% endfor %}

4. Install ROCm.
Expand All @@ -62,12 +71,18 @@
.. code-block:: bash
:substitutions:

for ver in |rocm_multi_versions|; do
for ver in |rocm_multi_versions_package_versions|; do
sudo apt install rocm$ver
done

5. Complete the :doc:`../post-install`.

.. note::

Since Ubuntu 24.04 is newly supported with ROCm 6.2, we only have one package to
install on Ubuntu 24.04. As a result, multi-version support is not available for
Ubuntu 24.04 as there are no additional versions at this time.

.. tip::

For a single-version installation of the latest ROCm version on Ubuntu,
Expand Down
49 changes: 39 additions & 10 deletions docs/install/prerequisites.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,27 +67,48 @@ your operating system to ensure you're able to download and install packages.
Typically you can register by following the step-by-step user interface.
If you need to register by command line, use the following commands:

.. code-block:: shell
.. datatemplate:nodata::

.. tab-set::

{% for os_release in config.html_context['rhel_release_version_numbers'] %}

.. tab-item:: RHEL {{ os_release }}

.. code-block:: shell

subscription-manager register --username <username> --password <password>
subscription-manager attach --auto
subscription-manager register --username <username> --password <password>
subscription-manager attach --auto

More details about `registering for RHEL <https://access.redhat.com/solutions/253273>`_
{% endfor %}

More details about `registering for RHEL <https://access.redhat.com/solutions/253273>`_

.. tab-item:: SUSE Linux Enterprise Server
:sync: sle-tab

Typically you can register by following the step-by-step user interface.
If you need to register by command line, use the following commands:

.. code-block:: shell
.. datatemplate:nodata::

.. tab-set::

SUSEConnect -r <REGCODE>
SUSEConnect -p sle-module-desktop-applications/15.4/x86_64
SUSEConnect -p sle-module-development-tools/15.4/x86_64
SUSEConnect -p PackageHub/15.4/x86_64
{% for os_version in config.html_context['sles_version_numbers'] %}
{% set os_release, os_sp = os_version.split('.') %}

.. tab-item:: SLES {{ os_version }}

.. code-block:: shell

SUSEConnect -r <REGCODE>
SUSEConnect -p sle-module-desktop-applications/{{ os_version }}/x86_64
SUSEConnect -p sle-module-development-tools/{{ os_version }}/x86_64
SUSEConnect -p PackageHub/{{ os_version }}/x86_64

More details about `registering for SLES <https://www.suse.com/support/kb/doc/?id=000018564>`_
{% endfor %}

More details about `registering for SLES <https://www.suse.com/support/kb/doc/?id=000018564>`_


Additional package repositories
Expand Down Expand Up @@ -219,3 +240,11 @@ recommend using the video group for all ROCm-supported operating systems.
.. tip::

On systems with multiple users, if ROCm is installed system wide, each individual user should be added to the ``render`` and ``video`` groups.

Disable integrated graphics (IGP), if applicable
================================================================

ROCm doesn't currently support integrated graphics. Should your system have 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
it via `HIP_VISIBLE_DEVICES <https://rocm.docs.amd.com/en/latest/conceptual/gpu-isolation.html#hip-visible-devices>`_.
6 changes: 3 additions & 3 deletions docs/reference/3rd-party-support-matrix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ TensorFlow. For TensorFlow the exact version follows the ``<TensorFlowVersion>.<

* - 6.2.x
- 1.13, 2.0, 2.1, 2.2, 2.3
- 2.14, 2.15, 2.16
- 2.14.1, 2.15.1, 2.16.1

* - 6.1.x
- 1.13, 2.0, 2.1
- 2.13, 2.14, 2.15
- 2.13.1, 2.14.0, 2.15.0

* - 6.0.x
- 1.13, 2.0, 2.1
- 2.12, 2.13, 2.14
- 2.12.1, 2.13.1, 2.14.0

* - 5.7.x
- 1.12.1, 1.13, 2.0, 2.1
Expand Down
Loading