mirror of
https://github.com/ROCm/ROCm.git
synced 2026-02-11 23:15:06 -05:00
5ac64b9f6b
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
318 lines
10 KiB
ReStructuredText
318 lines
10 KiB
ReStructuredText
Post-installation
|
|
=================
|
|
|
|
.. dropdown:: Installation environment
|
|
:animate: fade-in-slide-down
|
|
:icon: desktop-download
|
|
:chevron: down-up
|
|
|
|
.. include:: ./includes/selector.rst
|
|
|
|
After installing the ROCm Core SDK |ROCM_VERSION|, complete these
|
|
post-installation steps to complete your system configuration and validate the
|
|
installation.
|
|
|
|
.. selected:: i=tar
|
|
|
|
.. selected:: os=ubuntu os=debian os=rhel os=oracle-linux os=rocky-linux os=sles
|
|
:heading: Configure your environment
|
|
:heading-level: 3
|
|
|
|
Configure environment variables so that ROCm libraries and tools are
|
|
available either to all users on the system or only to your user account.
|
|
|
|
.. _rocm-post-install-system-wide:
|
|
|
|
.. tab-set::
|
|
|
|
.. tab-item:: System-wide setup
|
|
|
|
Create a profile script so that all users inherit the ROCm
|
|
environment variables when they start a shell session. Make sure
|
|
you're in the ``therock-tarball`` directory before proceeding.
|
|
|
|
.. code-block:: bash
|
|
|
|
# Configure ROCm PATH. Make sure you're in the therock-tarball directory before proceeding.
|
|
ROCM_INSTALL_PATH=$(pwd)/install
|
|
sudo tee /etc/profile.d/set-rocm-env.sh << EOF
|
|
export ROCM_PATH=$ROCM_INSTALL_PATH
|
|
export PATH=\$PATH:\$ROCM_PATH/bin
|
|
export LD_LIBRARY_PATH=\$ROCM_PATH/lib
|
|
EOF
|
|
sudo chmod +x /etc/profile.d/set-rocm-env.sh
|
|
source /etc/profile.d/set-rocm-env.sh
|
|
|
|
.. tab-item:: User setup
|
|
|
|
Configure the ROCm environment for your user by updating your shell
|
|
configuration file.
|
|
|
|
1. Add the following to your shell configuration file
|
|
(``~/.bashrc``, ``~/.profile``). Make sure you're in the
|
|
``therock-tarball`` directory before proceeding.
|
|
|
|
.. code-block:: bash
|
|
|
|
# Configure ROCm PATH. Make sure you're in the therock-tarball directory before proceeding.
|
|
export ROCM_PATH=$PWD/install
|
|
export PATH=$PATH:$ROCM_PATH/bin
|
|
export LD_LIBRARY_PATH=$ROCM_PATH/lib
|
|
|
|
2. After modifying your shell configuration, apply the change to
|
|
your current session by sourcing your updated shell
|
|
configuration file.
|
|
|
|
.. tab-set::
|
|
|
|
.. tab-item:: .bashrc
|
|
|
|
.. code-block:: bash
|
|
|
|
source ~/.bashrc
|
|
|
|
.. tab-item:: .profile
|
|
|
|
.. code-block:: bash
|
|
|
|
source ~/.profile
|
|
|
|
.. selected:: os=windows
|
|
:heading: Configure your environment
|
|
:heading-level: 3
|
|
|
|
Configure environment variables so that ROCm libraries and tools are
|
|
available on your Windows system.
|
|
|
|
1. **Run command prompt as an administrator** and set the following environment variables.
|
|
|
|
.. code-block:: cmd
|
|
|
|
setx HIP_DEVICE_LIB_PATH “C:\TheRock\build\lib\llvm\amdgcn\bitcode” /M
|
|
setx HIP_PATH “C:\TheRock\build” /M
|
|
setx HIP_PLATFORM “amd” /M
|
|
setx LLVM_PATH “C:\TheRock\build\lib\llvm” /M
|
|
|
|
2. Add the following paths into the PATH environment variable.
|
|
|
|
.. code-block:: cmd
|
|
|
|
setx PATH "%PATH%;C:\TheRock\build\bin" /M
|
|
setx PATH "%PATH%;C:\TheRock\build\lib\llvm\bin" /M
|
|
|
|
3. Open a new command prompt window for the environment variables to take effect. Run ``set``
|
|
to see the list of active variables.
|
|
|
|
.. code-block:: bat
|
|
|
|
set
|
|
|
|
.. selected:: os=ubuntu os=debian os=rhel os=oracle-linux os=rocky-linux os=sles
|
|
:heading: Verify your installation
|
|
:heading-level: 3
|
|
|
|
Use the following ROCm tools to verify that the ROCm Core SDK is correctly
|
|
installed and that your AMD devices are visible to the system.
|
|
|
|
1. Use ``rocminfo`` to list detected AMD GPUs and confirm that the ROCm
|
|
runtimes and drivers are correctly installed and loaded.
|
|
|
|
.. code-block:: bash
|
|
|
|
rocminfo
|
|
|
|
.. dropdown:: Example output of ``rocminfo``
|
|
:animate: fade-in-slide-down
|
|
:color: success
|
|
:icon: note
|
|
:chevron: down-up
|
|
|
|
.. code-block:: shell-session
|
|
|
|
ROCk module version 6.18.4 is loaded
|
|
=====================
|
|
HSA System Attributes
|
|
=====================
|
|
Runtime Version: 1.18
|
|
Runtime Ext Version: 1.14
|
|
System Timestamp Freq.: 1000.000000MHz
|
|
Sig. Max Wait Duration: 18446744073709551615 (0xFFFFFFFFFFFFFFFF) (timestamp count)
|
|
Machine Model: LARGE
|
|
System Endianness: LITTLE
|
|
Mwaitx: DISABLED
|
|
XNACK enabled: NO
|
|
DMAbuf Support: YES
|
|
VMM Support: YES
|
|
|
|
==========
|
|
HSA Agents
|
|
==========
|
|
*******
|
|
Agent 1
|
|
*******
|
|
Name: AMD RYZEN AI MAX+ PRO 395 w/ Radeon 8060S
|
|
Uuid: CPU-XX
|
|
Marketing Name: AMD RYZEN AI MAX+ PRO 395 w/ Radeon 8060S
|
|
Vendor Name: CPU
|
|
|
|
... [output truncated]
|
|
|
|
2. Use the AMD SMI CLI ``amd-smi`` to validate system information.
|
|
|
|
.. code-block:: bash
|
|
|
|
amd-smi version
|
|
|
|
.. dropdown:: Example output of ``amd-smi version``
|
|
:animate: fade-in-slide-down
|
|
:color: success
|
|
:icon: note
|
|
:chevron: down-up
|
|
|
|
.. code-block:: shell-session
|
|
|
|
AMDSMI Tool: 26.2.1+7b886380f9 | AMDSMI Library version: 26.2.1 | ROCm version: 7.11.0 | amdgpu version: 6.18.4 | hsmp version: N/A
|
|
|
|
.. selected:: i=pip
|
|
|
|
3. Inspect your installation in your Python environment and confirm that
|
|
ROCm packages, including the ``rocm-sdk`` CLI, are available.
|
|
|
|
.. code-block:: bash
|
|
|
|
pip freeze | grep rocm
|
|
which rocm-sdk
|
|
ls .venv/bin
|
|
|
|
.. selected:: os=windows
|
|
:heading: Verify your installation
|
|
:heading-level: 3
|
|
|
|
Use the following ROCm tools to verify that the ROCm Core SDK is correctly
|
|
installed and that your AMD devices are visible to the system.
|
|
|
|
.. selected:: i=pip
|
|
|
|
1. Use ``hipinfo`` to list detected AMD GPUs and confirm that the ROCm
|
|
runtimes and drivers are correctly installed and loaded.
|
|
|
|
.. code-block:: bash
|
|
|
|
hipinfo
|
|
|
|
.. dropdown:: Example output of ``hipinfo``
|
|
:animate: fade-in-slide-down
|
|
:color: success
|
|
:icon: note
|
|
:chevron: down-up
|
|
|
|
.. code-block:: shell-session
|
|
|
|
--------------------------------------------------------------------------------
|
|
device# 0
|
|
Name: AMD Radeon(TM) 8060S Graphics
|
|
pciBusID: 197
|
|
pciDeviceID: 0
|
|
pciDomainID: 0
|
|
multiProcessorCount: 20
|
|
|
|
... [output truncated]
|
|
|
|
2. Inspect your installation in your Python environment and confirm that
|
|
ROCm packages, including the ``rocm-sdk`` CLI, are available.
|
|
|
|
.. code-block:: bash
|
|
|
|
pip freeze
|
|
where rocm-sdk
|
|
dir .venv\Scripts
|
|
|
|
.. selected:: i=tar
|
|
|
|
Use ``hipinfo`` to list detected AMD GPUs and confirm that the ROCm
|
|
runtimes and drivers are correctly installed and loaded.
|
|
|
|
.. code-block:: bash
|
|
|
|
hipinfo
|
|
|
|
.. dropdown:: Example output of ``hipinfo``
|
|
:animate: fade-in-slide-down
|
|
:color: success
|
|
:icon: note
|
|
:chevron: down-up
|
|
|
|
.. code-block:: shell-session
|
|
|
|
--------------------------------------------------------------------------------
|
|
device# 0
|
|
Name: AMD Radeon(TM) 8060S Graphics
|
|
pciBusID: 197
|
|
pciDeviceID: 0
|
|
pciDomainID: 0
|
|
multiProcessorCount: 20
|
|
|
|
... [output truncated]
|
|
|
|
.. selected:: os=ubuntu os=debian os=rhel os=oracle-linux os=rocky-linux os=sles
|
|
|
|
.. selected:: i=pip
|
|
:heading: Test your installation
|
|
:heading-level: 3
|
|
|
|
Run the following commands from your Python virtual environment to confirm
|
|
that the ROCm SDK is correctly configured and that basic checks complete
|
|
successfully.
|
|
|
|
.. code-block:: bash
|
|
|
|
rocm-sdk targets
|
|
rocm-sdk path --cmake
|
|
rocm-sdk path --bin
|
|
rocm-sdk path --root
|
|
rocm-sdk test
|
|
|
|
To learn more about the ``rocm-sdk`` tool and to see example expected
|
|
outputs, see `Using ROCm Python packages (TheRock)
|
|
<https://github.com/ROCm/TheRock/blob/main/RELEASES.md#using-rocm-python-packages>`__.
|
|
|
|
.. selected:: i=tar
|
|
:heading: Test your installation
|
|
:heading-level: 3
|
|
|
|
Run the ``test_hip_api`` tool to verify that the HIP runtime can access
|
|
your GPU and execute a simple workload.
|
|
|
|
.. code-block:: bash
|
|
|
|
test_hip_api
|
|
|
|
.. selected:: os=windows
|
|
|
|
.. selected:: i=pip
|
|
:heading: Test your installation
|
|
:heading-level: 3
|
|
|
|
Run the following commands from your Python virtual environment to confirm
|
|
that the ROCm SDK is correctly configured and that basic checks complete
|
|
successfully.
|
|
|
|
.. code-block:: bash
|
|
|
|
rocm-sdk test
|
|
|
|
To learn more about the ``rocm-sdk`` tool and to see example expected
|
|
outputs, see `Using ROCm Python packages (TheRock)
|
|
<https://github.com/ROCm/TheRock/blob/main/RELEASES.md#using-rocm-python-packages>`__.
|
|
|
|
.. selected:: i=pip
|
|
|
|
.. tip::
|
|
|
|
If you need to deactivate your Python virtual environment when finished, run:
|
|
|
|
.. code-block:: bash
|
|
|
|
deactivate
|
|
|