github/ROCm
1
1
Fork 0
mirror of https://github.com/ROCm/ROCm.git synced 2026-04-27 03:01:52 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update titles to sentence case (#2455)

Browse Source
This commit is contained in:
Lisa
2023-09-18 12:26:31 -06:00
committed by GitHub
parent 772b51a7d2
commit d0d4eed1a6
128 changed files with 1857 additions and 2019 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/tutorials/install/docker.md
View File

@@ -55,7 +55,7 @@ like:
docker run --device /dev/kfd --device /dev/dri/renderD128 --device /dev/dri/renderD130 <image>
```
### Additional Options
### Additional options
The performance of an application can vary depending on the assignment of GPUs
and CPUs to the task. Typically, `numactl` is installed as part of many HPC

10
docs/tutorials/install/linux/index.md
View File

@@ -3,7 +3,7 @@
Start with {doc}`../../quick-start/linux` or follow the detailed
instructions below.
## Prepare to Install
## Prepare to install
::::{grid} 1 1 2 2
:gutter: 1
@@ -17,9 +17,9 @@ The prerequisites page lists the required steps *before* installation.
:::{grid-item-card}
**[Installation options](./install-options.md)**
Package manager vs AMDGPU Installer
Package manager vs AMDGPU installer
Standard Packages vs Multi-Version Packages
Standard vs multi-version packages
:::
::::
@@ -38,7 +38,7 @@ Directly use your distribution's package manager to install ROCm.
:::
:::{grid-item-card}
**[AMDGPU Installer](./installer/index.md)**
**[AMDGPU installer](./installer/index.md)**
Use an installer tool that orchestrates changes via the package
manager.
@@ -46,6 +46,6 @@ manager.
::::
## See Also
## See also
[Linux support](../../../about/compatibility/linux-support.md)

19
docs/tutorials/install/linux/install-options.md
View File

@@ -1,9 +1,9 @@
# ROCm Installation Options (Linux)
# ROCm installation options (Linux)
Users installing ROCm must choose between various installation options. A new
user should follow the [Quick Start guide](../../quick-start/linux).
## Package Manager versus AMDGPU Installer?
## Package manager versus AMDGPU installer
ROCm supports two methods for installation:
@@ -29,19 +29,19 @@ installation.
(installation-types)=
## Single Version ROCm install versus Multi-Version
## Single-version versus multi-version ROCm install
ROCm packages are versioned with both semantic versioning that is package
specific and a ROCm release version.
### Single-version Installation
### Single-version installation
The single-version ROCm installation refers to the following:
* Installation of a single instance of the ROCm release on a system
* Use of non-versioned ROCm meta-packages
### Multi-version Installation
### Multi-version installation
The multi-version installation refers to the following:
@@ -57,15 +57,10 @@ conflicts.
```
```{note}
Multiversion install is not available for the kernel driver module, also referred to as AMDGPU.
Multi-version install is not available for the kernel driver module, also referred to as AMDGPU.
```
The following image demonstrates the difference between single-version and
multi-version ROCm installation types:
```{figure-md} install-types
<img src="/data/tutorials/install/linux/linux001.png" alt="">
ROCm Installation Types
```
![ROCm installation types](../../../data/tutorials/install/linux/linux001.png "ROCm installation types")

4
docs/tutorials/install/linux/installer/index.md
View File

@@ -1,4 +1,4 @@
# AMDGPU Install Script
# AMDGPU install script
::::{grid} 2 3 3 3
:gutter: 1
@@ -23,6 +23,6 @@ Instructions for removing ROCm packages, libraries and tools.
::::
## See Also
## See also
[Linux support](../../../../about/compatibility/linux-support.md)

10
docs/tutorials/install/linux/installer/install.md
View File

@@ -3,7 +3,7 @@
Prior to beginning, please ensure you have the [prerequisites](../prerequisites)
installed.
## Download the Installer Script
## Download the installer script
To download and install the `amdgpu-install` script on the system, use the
following commands based on your distribution.
@@ -148,7 +148,7 @@ openclsdk (for application developers requiring ROCr based OpenCL)
- ROCm Language runtime
- development and SDK files for ROCr based OpenCL
hip(for users of HIP runtime on AMD products)
hip (for users of HIP runtime on AMD products)
- HIP runtimes
hiplibsdk (for application developers requiring HIP on AMD products)
- HIP runtimes
@@ -171,12 +171,12 @@ To install use cases specific to your requirements, use the installer
sudo amdgpu-install --usecase=hiplibsdk,rocm
```
## Single-version ROCm Installation
## Single-version ROCm installation
By default (without the `--rocmrelease` option)
the installer script will install packages in the single-version layout.
## Multi-version ROCm Installation
## Multi-version ROCm installation
For the multi-version ROCm installation you must use the installer script from
the latest release of ROCm that you wish to install.
@@ -185,7 +185,7 @@ the latest release of ROCm that you wish to install.
simultaneously, you are required to download the installer from the latest ROCm
release v5.4.3.
### Add Required Repositories
### Add required repositories
You must add the ROCm repositories manually for all ROCm releases
you want to install except the latest one. The `amdgpu-install` script

2
docs/tutorials/install/linux/installer/uninstall.md
View File

@@ -1,4 +1,4 @@
# Installer Script Uninstallation (Linux)
# Installer script uninstallation (Linux)
To uninstall all ROCm packages and the kernel-mode driver the following commands
can be used.

2
docs/tutorials/install/linux/installer/upgrade.md
View File

@@ -1,4 +1,4 @@
# Upgrading with the Installer Script (Linux)
# Upgrading with the installer script (Linux)
The upgrade procedure with the installer script is exactly the same as
installing for 1st time use. Refer to the {doc}`install`

6
docs/tutorials/install/linux/os-native/index.md
View File

@@ -1,4 +1,4 @@
# Installation via Package manager
# Installation via package manager
::::{grid} 1 1 2 2
:gutter: 1
@@ -22,13 +22,13 @@ Instructions for removing ROCm packages, libraries and tools.
:::
:::{grid-item-card}
**[Package Manager Integration](./package-manager-integration.md)**
**[Package manager integration](./package-manager-integration.md)**
Information about packages.
:::
::::
## See Also
## See also
[Linux support](../../../../about/compatibility/linux-support.md)

26
docs/tutorials/install/linux/os-native/install.md
View File

@@ -1,6 +1,6 @@
# Installation (Linux)
## Understanding the Release-specific AMDGPU and ROCm Repositories on Linux Distributions
## Understanding the release-specific AMDGPU and ROCm repositories on Linux distributions
The release-specific repositories consist of packages from a specific release of
versions of AMDGPU and ROCm. The repositories are not updated for the latest
@@ -10,7 +10,7 @@ release to install, update the previously installed single version to the later
available release, or add the latest version of ROCm along with the currently
installed version by using the multi-version ROCm packages.
## Step by Step Instructions
## Step-by-step instructions
::::::{tab-set}
:::::{tab-item} Ubuntu
@@ -37,7 +37,7 @@ available in a standard key ring distribution but has the following SHA1 sum
hash: `73f5d8100de6048aa38a8b84cd9a87f05177d208 rocm.gpg.key`
```
::::{rubric} 2. Add the AMDGPU Repository and Install the Kernel-mode Driver
::::{rubric} 2. Add the AMDGPU repository and install the kernel-mode driver
::::
```{tip}
@@ -86,7 +86,7 @@ sudo apt install amdgpu-dkms
sudo reboot
```
::::{rubric} 3. Add the ROCm Repository
::::{rubric} 3. Add the ROCm repository
::::
To add the ROCm repository, use the following steps:
@@ -149,7 +149,7 @@ For a comprehensive list of meta-packages, refer to
:::::{tab-item} Red Hat Enterprise Linux
:sync: RHEL
::::{rubric} 1. Add the AMDGPU Stack Repository and Install the Kernel-mode Driver
::::{rubric} 1. Add the AMDGPU stack repository and install the kernel-mode driver
::::
```{tip}
@@ -278,7 +278,7 @@ sudo yum install amdgpu-dkms
sudo reboot
```
::::{rubric} 2. Add the ROCm Stack Repository
::::{rubric} 2. Add the ROCm stack repository
::::
To add the ROCm repository, use the following steps, based on your distribution:
@@ -349,7 +349,7 @@ For a comprehensive list of meta-packages, refer to
:::::{tab-item} SUSE Linux Enterprise Server
:sync: SLES
::::{rubric} 1. Add the AMDGPU Repository and Install the Kernel-mode Driver
::::{rubric} 1. Add the AMDGPU repository and install the kernel-mode driver
::::
```{tip}
@@ -407,7 +407,7 @@ sudo zypper --gpg-auto-import-keys install amdgpu-dkms
sudo reboot
```
::::{rubric} 2. Add the ROCm Stack Repository
::::{rubric} 2. Add the ROCm stack repository
::::
To add the ROCm repository, use the following steps:
@@ -453,12 +453,12 @@ For a comprehensive list of meta-packages, refer to
(post-install-actions-linux)=
## Post-install Actions and Verification Process
## Post-install actions and verification process
The post-install actions listed here are optional and depend on your use case,
but are generally useful. Verification of the install is advised.
### Post-install Actions
### Post-install actions
1. Instruct the system linker where to find the shared objects (`.so` files) for
ROCm applications.
@@ -501,7 +501,7 @@ but are generally useful. Verification of the install is advised.
(verifying-kernel-mode-driver-installation)=
### Verifying Kernel-mode Driver Installation
### Verifying kernel-mode driver installation
Check the installation of the kernel-mode driver by typing the command given
below:
@@ -510,7 +510,7 @@ below:
dkms status
```
### Verifying ROCm Installation
### Verifying ROCm installation
After completing the ROCm installation, execute the following commands on the
system to verify if the installation is successful. If you see your GPUs listed
@@ -522,7 +522,7 @@ by both commands, the installation is considered successful:
/opt/rocm/opencl/bin/clinfo
```
### Verifying Package Installation
### Verifying package installation
To ensure the packages are installed successfully, use the following commands:

27
docs/tutorials/install/linux/os-native/package-manager-integration.md
View File

@@ -1,4 +1,4 @@
# Package Manager Integration
# Package manager integration
This section provides information about the required meta-packages for the
following AMD ROCm programming models:
@@ -7,7 +7,7 @@ following AMD ROCm programming models:
* OpenCL™
* OpenMP™
## ROCm Package Naming Conventions
## ROCm package naming conventions
A meta-package is a grouping of related packages and dependencies used to
support a specific use case.
@@ -19,12 +19,7 @@ All meta-packages exist in both versioned and non-versioned forms.
* Non-versioned packages – For a single-version installation of the ROCm stack
* Versioned packages – For multi-version installations of the ROCm stack
```{figure} ../../../../data/tutorials/install/linux/linux002.png
:name: package-naming
:align: center
ROCm Release Package Naming
```
![ROCm release package naming](../../../../data/tutorials/install/linux/linux002.png "ROCm release package naming")
The preceding image demonstrates the single and multi-version ROCm packages' naming
structure, including examples for various Linux distributions. See terms below:
@@ -51,7 +46,7 @@ valid only for rpm packages.
**Example:** `el8` represents RHEL 8.x packages.
## Components of ROCm Programming Models
## Components of ROCm programming models
The following image demonstrates the high-level layered architecture of ROCm
programming models and their meta-packages. All meta-packages are a combination
@@ -64,11 +59,7 @@ of required packages and libraries.
* `rocm-hip-sdk` contains runtime components to deploy and execute HIP
applications.
```{figure} ../../../../data/tutorials/install/linux/linux003.png
:name: meta-packages
ROCm Meta Packages
```
![ROCm meta packages](../../../../data/tutorials/install/linux/linux003.png "ROCm meta packages")
```{note}
`rocm-llvm` is not a meta-package but a single package that installs the ROCm
@@ -93,17 +84,13 @@ clang compiler files.
| `rocm-openmp-runtime` | Run OpenMP-based applications for the AMD platform |
```
## Packages in ROCm Programming Models
## Packages in ROCm programming models
This section discusses the available meta-packages and their packages. The
following image visualizes the meta-packages and their associated packages in a
ROCm programming model.
```{figure} ../../../../data/tutorials/install/linux/linux004.png
:name: assoc-packages
Associated Packages
```
![Associated packages](../../../../data/tutorials/install/linux/linux004.png "Associated packages")
* Meta-packages can include another meta-package.
* `rocm-core` package is common across all the meta-packages.

36
docs/tutorials/install/linux/os-native/uninstall.md
View File

@@ -9,34 +9,34 @@ used for uninstallation too, refer to {doc}`../installer/uninstall`.
:::::{tab-item} Ubuntu
:sync: ubuntu
::::{rubric} Uninstalling Specific Meta-packages
::::{rubric} Uninstalling specific meta-packages
::::
```shell
# Uninstall single-version ROCm packages
sudo apt autoremove <package-name>
# Uninstall multiversion ROCm packages
# Uninstall multi-version ROCm packages
sudo apt autoremove <package-name with release version>
```
::::{rubric} Complete Uninstallation of ROCm Packages
::::{rubric} Complete uninstallation of ROCm packages
::::
```shell
# Uninstall single-version ROCm packages
sudo apt autoremove rocm-core
# Uninstall multiversion ROCm packages
# Uninstall multi-version ROCm packages
sudo apt autoremove rocm-core<release version>
```
::::{rubric} Uninstall Kernel-mode Driver
::::{rubric} Uninstall kernel-mode driver
::::
```shell
sudo apt autoremove amdgpu-dkms
```
::::{rubric} Remove ROCm and AMDGPU Repositories
::::{rubric} Remove ROCm and AMDGPU repositories
::::
1. Execute these commands:
@@ -63,34 +63,34 @@ sudo apt autoremove amdgpu-dkms
:::::{tab-item} Red Hat Enterprise Linux
:sync: RHEL
::::{rubric} Uninstalling Specific Meta-packages
::::{rubric} Uninstalling specific meta-packages
::::
```shell
# Uninstall single-version ROCm packages
sudo yum remove <package-name>
# Uninstall multiversion ROCm packages
# Uninstall multi-version ROCm packages
sudo yum remove <package-name with release version>
```
::::{rubric} Complete Uninstallation of ROCm Packages
::::{rubric} Complete uninstallation of ROCm packages
::::
```shell
# Uninstall single-version ROCm packages
sudo yum remove rocm-core
# Uninstall multiversion ROCm packages
# Uninstall multi-version ROCm packages
sudo yum remove rocm-core<release version>
```
::::{rubric} Uninstall Kernel-mode Driver
::::{rubric} Uninstall kernel-mode driver
::::
```shell
sudo yum autoremove amdgpu-dkms
```
::::{rubric} Remove ROCm and AMDGPU Repositories
::::{rubric} Remove ROCm and AMDGPU repositories
::::
1. Execute these commands:
@@ -117,34 +117,34 @@ sudo yum autoremove amdgpu-dkms
:::::{tab-item} SUSE Linux Enterprise Server
:sync: SLES
::::{rubric} Uninstalling Specific Meta-packages
::::{rubric} Uninstalling specific meta-packages
::::
```shell
# Uninstall all single-version ROCm packages
sudo zypper remove <package-name>
# Uninstall all multiversion ROCm packages
# Uninstall all multi-version ROCm packages
sudo zypper remove <package-name with release version>
```
::::{rubric} Complete Uninstallation of ROCm Packages
::::{rubric} Complete uninstallation of ROCm packages
::::
```shell
# Uninstall all single-version ROCm packages
sudo zypper remove rocm-core
# Uninstall all multiversion ROCm packages
# Uninstall all multi-version ROCm packages
sudo zypper remove rocm-core<release version>
```
::::{rubric} Uninstall Kernel-mode Driver
::::{rubric} Uninstall kernel-mode driver
::::
```shell
sudo zypper remove --clean-deps amdgpu-dkms
```
::::{rubric} Remove ROCm and AMDGPU Repositories
::::{rubric} Remove ROCm and AMDGPU repositories
::::
1. Execute these commands:

6
docs/tutorials/install/linux/os-native/upgrade.md
View File

@@ -9,7 +9,7 @@ is to install an updated version of the ROCm along with the currently
installed version, refer to the [](install) page.
```
## Upgrade Steps
## Upgrade steps
### Update the AMDGPU repository
@@ -213,7 +213,7 @@ sudo zypper ref
:::::
::::::
### Upgrade the kernel-mode driver & reboot
### Upgrade the kernel-mode driver and reboot
Upgrade the kernel mode driver and reboot the system using the following
commands based on your distribution:
@@ -394,7 +394,7 @@ sudo zypper --gpg-auto-import-keys update rocm-hip-sdk
:::
::::
## Verification Process
## Verification process
To verify if the upgrade is successful, refer to the
{ref}`post-install-actions-linux` given in the

14
docs/tutorials/install/linux/prerequisites.md
View File

@@ -1,24 +1,24 @@
# Installation Prerequisites (Linux)
# Installation prerequisites (Linux)
You must perform the following steps before installing ROCm and check if the
system meets all the requirements to proceed with the installation.
## Confirm the System Has a Supported Linux Distribution Version
## Confirm the system has a supported Linux distribution version
The ROCm installation is supported only on specific Linux distributions and
kernel versions.
### Check the Linux Distribution and Kernel Version on Your System
### Check the Linux distribution and kernel version on your system
This section discusses obtaining information about the Linux distribution and
kernel version.
#### Linux Distribution Information
#### Linux distribution information
Verify the Linux distribution using the following steps:
1. To obtain the Linux distribution information, type the following command on
your system from the Command Line Interface (CLI):
your system from the command-line interface (CLI):
```shell
uname -m && cat /etc/*release
@@ -39,7 +39,7 @@ Verify the Linux distribution using the following steps:
(check-kernel-info)=
#### Kernel Information
#### Kernel information
Verify the kernel version using the following steps:
@@ -183,7 +183,7 @@ sudo zypper install kernel-default-devel
(linux_group_permissions)=
## Setting Permissions for Groups
## Setting permissions for groups
This section provides steps to add any current user to a video group to access
GPU resources.

36
docs/tutorials/install/magma-install.md
View File

@@ -1,8 +1,8 @@
# Magma Installation for ROCm
# MAGMA installation for ROCm
## MAGMA for ROCm
Matrix Algebra on GPU and Multi-core Architectures, abbreviated as MAGMA, is a
Matrix Algebra on GPU and Multicore Architectures (MAGMA) is a
collection of next-generation dense linear algebra libraries that is designed
for heterogeneous architectures, such as multiple GPUs and multi- or many-core
CPUs.
@@ -19,7 +19,7 @@ represented as a multidimensional matrix. MAGMA accelerates tensor operations
with a variety of solutions including driver routines, computational routines,
BLAS routines, auxiliary routines, and utility routines.
### Build MAGMA from Source
### Building MAGMA from source
To build MAGMA from the source, follow these steps:
@@ -39,7 +39,7 @@ To build MAGMA from the source, follow these steps:
# "install" hipMAGMA into /opt/rocm/magma by copying after build
git clone https://bitbucket.org/icl/magma.git
pushd magma
# Fixes memory leaks of magma found while executing linalg UTs
# Fixes memory leaks of MAGMA found while executing linalg UTs
git checkout 5959b8783e45f1809812ed96ae762f38ee701972
cp make.inc-examples/make.inc.hip-gcc-mkl make.inc
echo 'LIBDIR += -L$(MKLROOT)/lib' >> make.inc
@@ -62,31 +62,3 @@ To build MAGMA from the source, follow these steps:
popd
mv magma /opt/rocm
```
## References
C. Szegedy, V. Vanhoucke, S. Ioffe, J. Shlens and Z. Wojna, "Rethinking the Inception Architecture for Computer Vision," CoRR, p. abs/1512.00567, 2015
PyTorch, \[Online\]. Available: [https://pytorch.org/vision/stable/index.html](https://pytorch.org/vision/stable/index.html)
PyTorch, \[Online\]. Available: [https://pytorch.org/hub/pytorch_vision_inception_v3/](https://pytorch.org/hub/pytorch_vision_inception_v3/)
Stanford, \[Online\]. Available: [http://cs231n.stanford.edu/](http://cs231n.stanford.edu/)
Wikipedia, \[Online\]. Available: [https://en.wikipedia.org/wiki/Cross_entropy](https://en.wikipedia.org/wiki/Cross_entropy)
AMD, "ROCm issues," \[Online\]. Available: [https://github.com/RadeonOpenCompute/ROCm/issues](https://github.com/RadeonOpenCompute/ROCm/issues)
PyTorch, \[Online image\]. [https://pytorch.org/assets/brand-guidelines/PyTorch-Brand-Guidelines.pdf](https://pytorch.org/assets/brand-guidelines/PyTorch-Brand-Guidelines.pdf)
TensorFlow, \[Online image\]. [https://www.tensorflow.org/extras/tensorflow_brand_guidelines.pdf](https://www.tensorflow.org/extras/tensorflow_brand_guidelines.pdf)
MAGMA, \[Online image\]. [https://bitbucket.org/icl/magma/src/master/docs/](https://bitbucket.org/icl/magma/src/master/docs/)
Advanced Micro Devices, Inc., \[Online\]. Available: [https://rocmsoftwareplatform.github.io/AMDMIGraphX/doc/html/](https://rocmsoftwareplatform.github.io/AMDMIGraphX/doc/html/)
Advanced Micro Devices, Inc., \[Online\]. Available: [https://github.com/ROCmSoftwarePlatform/AMDMIGraphX/wiki](https://github.com/ROCmSoftwarePlatform/AMDMIGraphX/wiki)
Docker, \[Online\]. [https://docs.docker.com/get-started/overview/](https://docs.docker.com/get-started/overview/)
Torchvision, \[Online\]. Available [https://pytorch.org/vision/master/index.html?highlight=torchvision#module-torchvision](https://pytorch.org/vision/master/index.html?highlight=torchvision#module-torchvision)

41
docs/tutorials/install/pytorch-install.md
View File

@@ -47,11 +47,11 @@ Follow these steps:
docker run -it --cap-add=SYS_PTRACE --security-opt seccomp=unconfined --device=/dev/kfd --device=/dev/dri --group-add video --ipc=host --shm-size 8G rocm/pytorch:latest
```
:::{note}
```{note}
This will automatically download the image if it does not exist on the host.
You can also pass the -v argument to mount any data directories from the host
onto the container.
:::
```
(install-pytorch-using-wheels)=
@@ -62,12 +62,7 @@ access this feature, refer to
[https://pytorch.org/get-started/locally/](https://pytorch.org/get-started/locally/)
and choose the "ROCm" compute platform. The following image is a matrix from <https://pytorch.org/> that illustrates the installation compatibility between ROCm and the PyTorch build.
```{figure} ../../data/tutorials/install/magma-install/magma006.png
:name: installation-matrix-pytorch
:align: center
Installation Matrix from Pytorch
```
![Pytorch installation matrix](../../data/tutorials/install/magma-install/magma006.png "Pytorch installation matrix")
To install PyTorch using the wheels package, follow these installation steps:
@@ -105,12 +100,12 @@ To install PyTorch using the wheels package, follow these installation steps:
pip3 install wheel setuptools
```
4. Install torch, `torchvision`, and `torchaudio` as specified by the installation
4. Install Torch, TorchVision, and TorchAudio as specified by the installation
matrix.
:::{note}
```{note}
ROCm 5.2 PyTorch wheel in the command below is shown for reference.
:::
```
```bash
pip3 install --pre torch torchvision torchaudio --extra-index-url https://download.pytorch.org/whl/nightly/rocm5.2/
@@ -159,7 +154,7 @@ Follow these steps:
4. Build PyTorch for ROCm.
:::{note}
```{note}
By default in the `rocm/pytorch:latest-base`, PyTorch builds for these
architectures simultaneously:
* gfx900
@@ -167,7 +162,7 @@ Follow these steps:
* gfx908
* gfx90a
* gfx1030
:::
```
5. To determine your AMD uarch, run:
@@ -254,7 +249,7 @@ Follow these steps:
5. Build PyTorch for ROCm.
:::{note}
```{note}
By default in the `rocm/pytorch:latest-base`, PyTorch builds for these
architectures simultaneously:
* gfx900
@@ -262,7 +257,7 @@ Follow these steps:
* gfx908
* gfx90a
* gfx1030
:::
```
6. To determine your AMD uarch, run:
@@ -307,9 +302,9 @@ Follow these steps:
1. Test if PyTorch is installed and accessible by importing the torch package in
Python.
:::{note}
```{note}
Do not run in the PyTorch git folder.
:::
```
```bash
python3 -c 'import torch' 2> /dev/null && echo 'Success' || echo 'Failure'
@@ -334,23 +329,23 @@ Follow these steps:
the required environment variable will be set to skip certain unit tests for
ROCm.
:::{note}
```{note}
Make sure the PyTorch source code is corresponding to the PyTorch wheel or
installation in the Docker image. Incompatible PyTorch source code might give
errors when running the unit tests.
:::
```
This will first install some dependencies, such as a supported `torchvision`
version for PyTorch. `torchvision` is used in some PyTorch tests for loading
This will first install some dependencies, such as a supported [torchvision](https://pytorch.org/vision/stable/index.html)
version for PyTorch. Torchvision is used in some PyTorch tests for loading
models. Next, this will run all the unit tests.
:::{note}
```{note}
Some tests may be skipped, as appropriate, based on your system
configuration. All features of PyTorch are not supported on ROCm, and the
tests that evaluate these features are skipped. In addition, depending on the
host memory, or the number of available GPUs, other tests may be skipped. No
test should fail if the compilation and installation are correct.
:::
```
4. Run individual unit tests with the following command:

50
docs/tutorials/install/tensorflow-install.md
View File

@@ -1,4 +1,4 @@
# TensorFlow Installation for ROCm
# Installing TensorFlow for ROCm
## TensorFlow
@@ -13,7 +13,7 @@ development.
The following sections contain options for installing TensorFlow.
#### Option 1: Install TensorFlow Using Docker Image
#### Option 1: Using a Docker image
To install ROCm on bare metal, follow the section
[Installation (Linux)](../../tutorials/install/linux/os-native/install). The recommended option to
@@ -38,7 +38,7 @@ Follow these steps:
--security-opt seccomp=unconfined rocm/tensorflow:latest
```
#### Option 2: Install TensorFlow Using Wheels Package
#### Option 2: using a wheels package
To install TensorFlow using the wheels package, follow these steps:
@@ -53,14 +53,14 @@ To install TensorFlow using the wheels package, follow these steps:
| The Python version is less than 3.7 | Upgrade Python. |
| The Python version is more than 3.7 | Skip this step and go to Step 3. |
:::{note}
```{note}
The supported Python versions are:
* 3.7
* 3.8
* 3.9
* 3.10
:::
```
```bash
sudo apt-get install python3.7 # or python3.8 or python 3.9 or python 3.10
@@ -74,9 +74,9 @@ To install TensorFlow using the wheels package, follow these steps:
/usr/bin/python3 python3 /usr/bin/python[version] [priority]
```
:::{note}
```{note}
Follow the instruction in Step 2 for incompatible Python versions.
:::
```
```bash
sudo update-alternatives --config python3
@@ -139,12 +139,12 @@ To install TensorFlow using the wheels package, follow these steps:
python3 -c 'import tensorflow' 2> /dev/null && echo 'Success' || echo 'Failure'
```
:::{note}
```{note}
For details on `tensorflow-rocm` wheels and ROCm version compatibility, see:
[https://github.com/ROCmSoftwarePlatform/tensorflow-upstream/blob/develop-upstream/rocm_docs/tensorflow-rocm-release.md](https://github.com/ROCmSoftwarePlatform/tensorflow-upstream/blob/develop-upstream/rocm_docs/tensorflow-rocm-release.md)
:::
```
### Test the TensorFlow Installation
### Test the TensorFlow installation
To test the installation of TensorFlow, run the container image as specified in
the previous section Installing TensorFlow. Ensure you have access to the Python
@@ -154,7 +154,7 @@ shell in the Docker container.
python3 -c 'import tensorflow' 2> /dev/null && echo ‘Success’ || echo ‘Failure’
```
### Run a Basic TensorFlow Example
### Run a basic TensorFlow example
The TensorFlow examples repository provides basic examples that exercise the
framework's functionality. The MNIST database is a collection of handwritten
@@ -176,31 +176,3 @@ Follow these steps:
#pip3 install requirement.txt
#python mnist_tf.py
```
## References
C. Szegedy, V. Vanhoucke, S. Ioffe, J. Shlens and Z. Wojna, "Rethinking the Inception Architecture for Computer Vision," CoRR, p. abs/1512.00567, 2015
PyTorch, \[Online\]. Available: [https://pytorch.org/vision/stable/index.html](https://pytorch.org/vision/stable/index.html)
PyTorch, \[Online\]. Available: [https://pytorch.org/hub/pytorch_vision_inception_v3/](https://pytorch.org/hub/pytorch_vision_inception_v3/)
Stanford, \[Online\]. Available: [http://cs231n.stanford.edu/](http://cs231n.stanford.edu/)
Wikipedia, \[Online\]. Available: [https://en.wikipedia.org/wiki/Cross_entropy](https://en.wikipedia.org/wiki/Cross_entropy)
AMD, "ROCm issues," \[Online\]. Available: [https://github.com/RadeonOpenCompute/ROCm/issues](https://github.com/RadeonOpenCompute/ROCm/issues)
PyTorch, \[Online image\]. [https://pytorch.org/assets/brand-guidelines/PyTorch-Brand-Guidelines.pdf](https://pytorch.org/assets/brand-guidelines/PyTorch-Brand-Guidelines.pdf)
TensorFlow, \[Online image\]. [https://www.tensorflow.org/extras/tensorflow_brand_guidelines.pdf](https://www.tensorflow.org/extras/tensorflow_brand_guidelines.pdf)
MAGMA, \[Online image\]. [https://bitbucket.org/icl/magma/src/master/docs/](https://bitbucket.org/icl/magma/src/master/docs/)
Advanced Micro Devices, Inc., \[Online\]. Available: [https://rocmsoftwareplatform.github.io/AMDMIGraphX/doc/html/](https://rocmsoftwareplatform.github.io/AMDMIGraphX/doc/html/)
Advanced Micro Devices, Inc., \[Online\]. Available: [https://github.com/ROCmSoftwarePlatform/AMDMIGraphX/wiki](https://github.com/ROCmSoftwarePlatform/AMDMIGraphX/wiki)
Docker, \[Online\]. [https://docs.docker.com/get-started/overview/](https://docs.docker.com/get-started/overview/)
Torchvision, \[Online\]. Available [https://pytorch.org/vision/master/index.html?highlight=torchvision#module-torchvision](https://pytorch.org/vision/master/index.html?highlight=torchvision#module-torchvision)

4
docs/tutorials/install/windows/cli/index.md
View File

@@ -1,4 +1,4 @@
# Command Line Installation
# Command-line installation
::::{grid} 2 3 3 3
:gutter: 1
@@ -23,6 +23,6 @@ Instructions for removing ROCm packages, libraries and tools.
::::
## See Also
## See also
[Windows Support](../../../../about/compatibility/windows-support.md)

14
docs/tutorials/install/windows/cli/install.md
View File

@@ -1,19 +1,19 @@
# Installation Using the Command Line Interface
# Installation using the command-line interface (CLI)
The steps to install the HIP SDK for Windows are described in this document.
## System Requirements
## System requirements
The HIP SDK is supported on Windows 10 and 11. The HIP SDK may be installed on a
system without AMD GPUs to use the build toolchains. To run HIP applications, a
compatible GPU is required. Please see the supported GPU guide for more details.
## HIP SDK Installation
## HIP SDK installation
The command line installer is the same executable which is used by the graphical
The command-line installer is the same executable which is used by the graphical
front-end. Download the installer from the
[HIP-SDK download page](https://www.amd.com/en/developer/rocm-hub/hip-sdk.html).
The options supported by the command line interface are summarized in the following table.
The options supported by the command-line interface (CLI) are summarized in the following table.
```{table} HIP SDK Command Line Options
:name: hip-sdk-cli-install
@@ -28,11 +28,11 @@ The options supported by the command line interface are summarized in the follow
```
```{note}
Unlike the graphical installer, the command line interface doesn't support
Unlike the graphical installer, the CLI doesn't support
selectively installing parts of the SDK bundle. It's all or nothing.
```
### Launching the Installer From the Command Line
### Launching the installer from the command line
The installer is still a graphical application with a `WinMain` entry point, even
when called on the command line. This means that the application lifetime is

14
docs/tutorials/install/windows/cli/uninstall.md
View File

@@ -1,14 +1,14 @@
# Uninstallation Using the Command Line Interface
# Uninstallation using the command-line interface (CLI)
The steps to uninstall the HIP SDK for Windows are described in this document.
## HIP SDK Uninstallation
## HIP SDK uninstallation
The command line installer is the same executable which is used by the graphical
front-end. The options supported by the command line interface are summarized in
The command-line installer is the same executable which is used by the graphical
front-end. The options supported by the command-line interface (CLI) are summarized in
the following table.
```{table} HIP SDK Command Line Options
```{table} HIP SDK Command-line Options
:name: hip-sdk-cli-uninstall
| **Install Option** | **Description** |
|:------------------:|:---------------:|
@@ -21,11 +21,11 @@ the following table.
```
```{note}
Unlike the graphical installer, the command line interface doesn't support
Unlike the graphical installer, the CLI doesn't support
selectively installing parts of the SDK bundle. It's all or nothing.
```
### Launching the Installer From the Command Line
### Launching the installer from the command line
The installer is still a graphical application with a `WinMain` entry point, even
when called on the command line. This means that the application lifetime is

4
docs/tutorials/install/windows/cli/upgrade.md
View File

@@ -1,8 +1,8 @@
# Upgrading Using the Graphical Interface
# Upgrading using the graphical interface
The steps to uninstall the HIP SDK for Windows are described in this document.
## HIP SDK Upgrade
## HIP SDK upgrade
To upgrade an existing installation of the HIP SDK without preserving the
previous version, first uninstall it, then install the new version following the

4
docs/tutorials/install/windows/gui/index.md
View File

@@ -1,4 +1,4 @@
# Graphical Installation
# Graphical installation
::::{grid} 2 3 3 3
:gutter: 1
@@ -23,6 +23,6 @@ Instructions for removing ROCm packages, libraries and tools.
::::
## See Also
## See also
[Windows Support](../../../../about/compatibility/windows-support.md)

66
docs/tutorials/install/windows/gui/install.md
View File

@@ -1,14 +1,14 @@
# Installation Using the Graphical Interface
# Installation using the graphical interface
The steps to install the HIP SDK for Windows are described in this document.
## System Requirements
## System requirements
The HIP SDK is supported on Windows 10 and 11. The HIP SDK may be installed on a
system without AMD GPUs to use the build toolchains. To run HIP applications, a
compatible GPU is required. Please see the supported GPU guide for more details.
## HIP SDK Installation
## HIP SDK installation
### Download the installer
@@ -19,47 +19,25 @@ Download the installer from the
To launch the AMD HIP SDK Installer, click the **Setup** icon shown in the following image.
```{figure} ../../../../data/tutorials/install/windows/000-setup-icon.png
:name: setup-icon-install
:alt: Icon with AMD arrow logo and User Access Control Shield overlayed.
Setup Icon
```
![Icon with AMD arrow logo and User Access Control Shield overlay](../../../../data/tutorials/install/windows/000-setup-icon.png "Setup Icon")
The installer requires Administrator Privileges, so you may be greeted with a
User Access Control (UAC) pop-up. Click Yes.
```{figure} ../../../../data/tutorials/install/windows/001-uac-dark.png
:name: uac-dark-install
:class: only-dark
:alt: User Access Control pop-up
User Access Control pop-up
```
![User Access Control pop-up](../../../../data/tutorials/install/windows/001-uac-dark.png "User Access Control pop-up")
```{figure} ../../../../data/tutorials/install/windows/001-uac-light.png
:name: uac-light-install
:class: only-light
:alt: User Access Control pop-up
User Access Control pop-up
```
![User Access Control pop-up](../../../../data/tutorials/install/windows/001-uac-light.png "User Access Control pop-up")
The installer executable will temporarily extract installer packages to `C:\AMD`
which it will remove after installation completes. This extraction is signified
by the "Initializing install" window in the following image.
```{figure} ../../../../data/tutorials/install/windows/002-initializing.png
:name: init-install
:alt: Window with AMD arrow logo, futuristic background and progress counter.
Installer initialization window
```
![Window with AMD arrow logo, futuristic background and progress counter](../../../../data/tutorials/install/windows/002-initializing.png "Installer initialization window")
The installer will then detect your system configuration to determine which installable components
are applicable to your system.
```{figure} ../../../../data/tutorials/install/windows/003-detecting-system-config.png
:name: detect-sys-components
:alt: Window with AMD arrow logo, futuristic background and activity indicator.
Installer initialization window.
```
![Window with AMD arrow logo, futuristic background and activity indicator](../../../../data/tutorials/install/windows/003-detecting-system-config.png "Installer initialization window")
### Customizing the install
@@ -68,13 +46,9 @@ the installation. By default, all components are selected for installation.
Refer to the following image for an instance when the Select All option
is turned on.
```{figure} ../../../../data/tutorials/install/windows/004-installer-window.png
:name: installer-window
:alt: Window with AMD arrow logo, futuristic background and activity indicator.
Installer initialization window.
```
![Window with AMD arrow logo, futuristic background and activity indicator](../../../../data/tutorials/install/windows/004-installer-window.png "Installer initialization window")
#### HIP SDK Installer
#### HIP SDK installer
The HIP SDK installation options are listed in the following table.
@@ -101,7 +75,7 @@ DeSelecting All and then picking the individual components may be more
convenient.
```
#### AMD Display Driver
#### AMD display driver
The HIP SDK installer bundles an AMD Radeon Software PRO 23.10 installer. The
supported install options are summarized in the following table:
@@ -129,29 +103,21 @@ You must perform a system restart for a complete installation of the
Display Driver.
```
### Installing Components
### Installing components
Please wait for the installation to complete during as shown in the following image.
```{figure} ../../../../data/tutorials/install/windows/012-install-progress.png
:name: install-progress
:alt: Window with AMD arrow logo, futuristic background and progress meter.
Installation Progress
```
![Window with AMD arrow logo, futuristic background and progress meter](../../../../data/tutorials/install/windows/012-install-progress.png "Installation progress")
### Installation Complete
### Installation complete
Once the installation is complete, the installer window may prompt you for a
system restart. Click **Restart** at the lower right corner, shown in the following image.
```{figure} ../../../../data/tutorials/install/windows/013-install-complete.png
:name: install-complete
:alt: Window with AMD arrow logo, futuristic background and completion notice.
Installation Complete
```
![Window with AMD arrow logo, futuristic background and completion notice](../../../../data/tutorials/install/windows/013-install-complete.png "Installation complete")
```{error}
Should the installer terminate due to unexpcted circumstances, or the user
Should the installer terminate due to unexpected circumstances, or the user
forcibly terminates the installer, the temporary directory created under
`C:\AMD` may be safely removed. Installed components will not depend on this
folder (unless the user specifies `C:\AMD` as an install folder explicitly).

16
docs/tutorials/install/windows/gui/uninstall.md
View File

@@ -1,4 +1,4 @@
# Uninstallation Using the Graphical Interface
# Uninstallation using the graphical interface
The steps to uninstall the HIP SDK for Windows are described in this document.
@@ -12,16 +12,6 @@ Uninstallation of the HIP SDK components can be done through the Windows
Settings app. Navigate to "Apps > Installed apps", click the "..." on the far
right next to the component to uninstall, and click "Uninstall".
```{figure} ../../../../data/tutorials/install/windows/014-uninstall-dark.png
:name: uninstall-dark
:class: only-dark
:alt: Installed apps section of the Setting app showing installed HIP SDK components.
Removing the SDK via the Setting app
```
![Installed apps section of the settings app showing installed HIP SDK components](../../../../data/tutorials/install/windows/014-uninstall-dark.png "Removing the SDK via the settings app")
```{figure} ../../../../data/tutorials/install/windows/014-uninstall-light.png
:name: uninstall-light
:class: only-light
:alt: Installed apps section of the Setting app showing installed HIP SDK components.
Removing the SDK via the Setting app
```
![Installed apps section of the settings app showing installed HIP SDK components](../../../../data/tutorials/install/windows/014-uninstall-light.png "Removing the SDK via the settings app")

2
docs/tutorials/install/windows/gui/upgrade.md
View File

@@ -1,4 +1,4 @@
# Upgrading Using the Graphical Interface
# Upgrading using the graphical interface
The steps to upgrade an existing HIP SDK installation for Windows are described
in this document.

18
docs/tutorials/install/windows/index.md
View File

@@ -3,7 +3,7 @@
Start with {doc}`../../quick-start/windows` or follow the detailed
instructions below.
## Prepare to Install
## Prepare to install
::::{grid} 1 1 2 2
:gutter: 1
@@ -23,38 +23,38 @@ supports ROCm.
:gutter: 1
:::{grid-item-card}
**[Graphical Installation](./gui/index.md)**
**[Graphical installation](./gui/index.md)**
Use the graphical front-end of the installer.
:::
:::{grid-item-card}
**[Command Line Installation](./cli/index.md)**
**[Command-line installation](./cli/index.md)**
Use the command line front-end of the installer.
:::
::::
## Post Installation
## Post-installation
::::{grid} 1 1 2 2
:gutter: 1
:::{grid-item-card} ROCm-Examples
**[ROCm-Examples](https://github.com/amd/rocm-examples)**
:::{grid-item-card}
**[ROCm examples](https://github.com/amd/rocm-examples)**
Learn how to use ROCm with descriptive examples for novice to intermediate users.
:::
:::{grid-item-card}
**[Windows App Deployment Guidelines](../../../conceptual/windows-app-deployment-guidelines.md)**
**[Windows app deployment guidelines](../../../conceptual/windows-app-deployment-guidelines.md)**
Discusses strategies on how to bundle HIP libraries with an end user application.
:::
::::
## See Also
## See also
[Windows Support](../../../about/compatibility/windows-support.md)
[Windows support](../../../about/compatibility/windows-support.md)

40
docs/tutorials/install/windows/prerequisites.md
View File

@@ -1,24 +1,24 @@
# Installation Prerequisites (Windows)
# Installation prerequisites (Windows)
You must perform the following steps before installing ROCm and check if the
system meets all the requirements to proceed with the installation.
## Confirm the System Is Supported
## Confirm the system is supported
The ROCm installation is supported only on specific host architectures, Windows
Editions and update versions.
### Check the Windows Editions and Update Version on Your System
### Check the windows editions and update version on your system
This section discusses obtaining information about the host architecture,
Windows Edition and update version.
#### Command Line Check
#### Command-line check
Verify the Windows Edition using the following steps:
1. To obtain the Linux distribution information, type the following command on
your system from a PowerShell Command Line Interface (CLI):
your system from a PowerShell command-line interface (CLI):
```pwsh
Get-ComputerInfo | Format-Table CsSystemType,OSName,OSDisplayVersion
@@ -36,39 +36,19 @@ Verify the Windows Edition using the following steps:
x64-based PC Microsoft Windows 11 Pro 22H2
```
#### Graphical Check
#### Graphical check
1. Open the Setting app.
```{figure} ../../../data/tutorials/install/windows/000-settings-dark.png
:name: settings-dark
:class: only-dark
:alt: Gear icon of the Windows Settings app
Windows Settings app icon
```
![Gear icon of the Windows Settings app](../../../data/tutorials/install/windows/000-settings-dark.png "Windows Settings app icon")
```{figure} ../../../data/tutorials/install/windows/000-settings-light.png
:name: settings-light
:class: only-light
:alt: Gear icon of the Windows Settings app
Windows Settings app icon
```
![Gear icon of the Windows Settings app](../../../data/tutorials/install/windows/000-settings-light.png "Windows Settings app icon")
2. Navigate to **System > About**.
```{figure} ../../../data/tutorials/install/windows/001-about-dark.png
:name: about-dark
:class: only-dark
:alt: Settings app panel showing Device and OS information
Settings > About page
```
![Settings app panel showing device and OS information](../../../data/tutorials/install/windows/001-about-dark.png "Settings > About page")
```{figure} ../../../data/tutorials/install/windows/001-about-light.png
:name: about-light
:class: only-light
:alt: Settings app panel showing Device and OS information
Settings > About page
```
![Settings app panel showing device and OS information](../../../data/tutorials/install/windows/001-about-light.png "Settings > About page")
3. Confirm that the obtained information matches with those listed in
{ref}`windows-support`.