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

ROCm A-Z page & link cleanup (#2450)

Browse Source
This commit is contained in:
Lisa
2023-09-13 13:00:50 -06:00
committed by GitHub
parent dba06fe315
commit 7c5976004f
172 changed files with 7557 additions and 2908 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,6 +1,6 @@
# Install ROCm on Linux
Start with {doc}`../../quick_start/linux` or follow the detailed
Start with {doc}`../../quick-start/linux` or follow the detailed
instructions below.
## Prepare to Install
@@ -8,16 +8,14 @@ instructions below.
::::{grid} 1 1 2 2
:gutter: 1
:::{grid-item-card} Prerequisites
:link: prerequisites
:link-type: doc
:::{grid-item-card}
**[Prerequisites](./prerequisites.md)**
The prerequisites page lists the required steps *before* installation.
:::
:::{grid-item-card} Install Choices
:link: install_overview
:link-type: doc
:::{grid-item-card}
**[Installation options](./install-options.md)**
Package manager vs AMDGPU Installer
@@ -26,23 +24,21 @@ Standard Packages vs Multi-Version Packages
::::
(linux_install_methods)=
(linux-install-methods)=
## Choose your install method
::::{grid} 1 1 2 2
:gutter: 1
:::{grid-item-card} Package Manager
:link: os-native/index
:link-type: doc
:::{grid-item-card}
**[Package manager](./os-native/index.md)**
Directly use your distribution's package manager to install ROCm.
:::
:::{grid-item-card} AMDGPU Installer
:link: installer/index
:link-type: doc
:::{grid-item-card}
**[AMDGPU Installer](./installer/index.md)**
Use an installer tool that orchestrates changes via the package
manager.
@@ -52,4 +48,4 @@ manager.
## See Also
- {doc}`../../../about/release/linux_support`
[Linux support](../../../about/compatibility/linux-support.md)

14
docs/tutorials/install/linux/install_overview.md → docs/tutorials/install/linux/install-options.md
View File

@@ -1,14 +1,14 @@
# 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).
user should follow the [Quick Start guide](../../quick-start/linux).
## Package Manager versus AMDGPU Installer?
ROCm supports two methods for installation:
- Directly using the Linux distribution's package manager
- The `amdgpu-install` script
* Directly using the Linux distribution's package manager
* The `amdgpu-install` script
There is no difference in the final installation state when choosing either
option.
@@ -38,17 +38,17 @@ specific and a ROCm release version.
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
* Installation of a single instance of the ROCm release on a system
* Use of non-versioned ROCm meta-packages
### Multi-version Installation
The multi-version installation refers to the following:
- Installation of multiple instances of the ROCm stack on a system. Extending
* Installation of multiple instances of the ROCm stack on a system. Extending
the package name and its dependencies with the release version adds the
ability to support multiple versions of packages simultaneously.
- Use of versioned ROCm meta-packages.
* Use of versioned ROCm meta-packages.
```{attention}
ROCm packages that were previously installed from a single-version installation

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

@@ -3,29 +3,26 @@
::::{grid} 2 3 3 3
:gutter: 1
:::{grid-item-card} Install
:link: install
:link-type: doc
:::{grid-item-card}
**[Installing ROCm](./install.md)**
How to install ROCm?
Installation instructions.
:::
:::{grid-item-card} Upgrade
:link: upgrade
:link-type: doc
:::{grid-item-card}
**[Upgrading ROCm](./upgrade.md)**
Instructions for upgrading an existing ROCm installation.
:::
:::{grid-item-card} Uninstall
:link: uninstall
:link-type: doc
:::{grid-item-card}
**[Uninstalling ROCm](./uninstall.md)**
Steps for removing ROCm packages, libraries and tools.
Instructions for removing ROCm packages, libraries and tools.
:::
::::
## See Also
- {doc}`../../../../about/release/linux_support`
[Linux support](../../../../about/compatibility/linux-support.md)

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

@@ -159,13 +159,13 @@ hiplibsdk (for application developers requiring HIP on AMD products)
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:
* To install a single use case add it with the `--usecase` option:
```shell
sudo amdgpu-install --usecase=rocm
```
- For multiple use cases separate them with commas:
* For multiple use cases separate them with commas:
```shell
sudo amdgpu-install --usecase=hiplibsdk,rocm

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

@@ -1,32 +1,28 @@
# Installation via Package manager
::::{grid} 2 3 3 3
::::{grid} 1 1 2 2
:gutter: 1
:::{grid-item-card} Install
:link: install
:link-type: doc
:::{grid-item-card}
**[Installing ROCm](./install.md)**
How to install ROCm?
Installation instructions.
:::
:::{grid-item-card} Upgrade
:link: upgrade
:link-type: doc
:::{grid-item-card}
**[Upgrading ROCm](./upgrade.md)**
Instructions for upgrading an existing ROCm installation.
:::
:::{grid-item-card} Uninstall
:link: uninstall
:link-type: doc
:::{grid-item-card}
**[Uninstalling ROCm](./uninstall.md)**
Steps for removing ROCm packages libraries and tools.
Instructions for removing ROCm packages, libraries and tools.
:::
:::{grid-item-card} Package Manager Integration
:link: package_manager_integration
:link-type: doc
:::{grid-item-card}
**[Package Manager Integration](./package-manager-integration.md)**
Information about packages.
:::
@@ -35,4 +31,4 @@ Information about packages.
## See Also
- {doc}`../../../../about/release/linux_support`
[Linux support](../../../../about/compatibility/linux-support.md)

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

@@ -133,13 +133,13 @@ single/multi-version installations are, refer to {ref}`installation-types`.
For a comprehensive list of meta-packages, refer to
{ref}`meta-package-desc`.
- Sample Single-version installation
* Sample Single-version installation
```shell
sudo apt install rocm-hip-sdk
```
- Sample Multi-version installation
* Sample Multi-version installation
```shell
sudo apt install rocm-hip-sdk5.6.1 rocm-hip-sdk5.5.3
@@ -333,13 +333,13 @@ single/multi-version installations are, refer to {ref}`installation-types`.
For a comprehensive list of meta-packages, refer to
{ref}`meta-package-desc`.
- Sample Single-version installation
* Sample Single-version installation
```shell
sudo yum install rocm-hip-sdk
```
- Sample Multi-version installation
* Sample Multi-version installation
```shell
sudo yum install rocm-hip-sdk5.6.1 rocm-hip-sdk5.5.3
@@ -436,13 +436,13 @@ single/multi-version installations are, refer to {ref}`installation-types`.
For a comprehensive list of meta-packages, refer to
{ref}`meta-package-desc`.
- Sample Single-version installation
* Sample Single-version installation
```shell
sudo zypper --gpg-auto-import-keys install rocm-hip-sdk
```
- Sample Multi-version installation
* Sample Multi-version installation
```shell
sudo zypper --gpg-auto-import-keys install rocm-hip-sdk5.6.1 rocm-hip-sdk5.5.3

24
docs/tutorials/install/linux/os-native/package_manager_integration.md → docs/tutorials/install/linux/os-native/package-manager-integration.md
View File

@@ -3,9 +3,9 @@
This section provides information about the required meta-packages for the
following AMD ROCm programming models:
- Heterogeneous-Computing Interface for Portability (HIP)
- OpenCL™
- OpenMP™
* Heterogeneous-Computing Interface for Portability (HIP)
* OpenCL™
* OpenMP™
## ROCm Package Naming Conventions
@@ -16,8 +16,8 @@ support a specific use case.
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
* 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
@@ -59,9 +59,9 @@ of required packages and libraries.
**Example:**
- `rocm-hip-runtime` is used to deploy on supported machines to execute HIP
* `rocm-hip-runtime` is used to deploy on supported machines to execute HIP
applications.
- `rocm-hip-sdk` contains runtime components to deploy and execute HIP
* `rocm-hip-sdk` contains runtime components to deploy and execute HIP
applications.
```{figure} ../../../../data/tutorials/install/linux/linux003.png
@@ -87,8 +87,8 @@ clang compiler files.
| `rocm-hip-libraries` | HIP libraries optimized for the AMD platform |
| `rocm-hip-sdk` | Develop or port HIP applications and libraries for the AMD platform |
| `rocm-developer-tools` | Debug and profile HIP applications |
| `rocm-ml-sdk` | Develop and run Machine Learning applications with optimized for AMD |
| `rocm-ml-libraries` | Key Machine Learning libraries, specifically MIOpen |
| `rocm-ml-sdk` | Develop and run machine-learning applications with optimized for AMD |
| `rocm-ml-libraries` | Key machine-learning libraries, specifically MIOpen |
| `rocm-openmp-sdk` | Develop OpenMP-based applications for the AMD platform |
| `rocm-openmp-runtime` | Run OpenMP-based applications for the AMD platform |
```
@@ -105,9 +105,9 @@ ROCm programming model.
Associated Packages
```
- Meta-packages can include another meta-package.
- `rocm-core` package is common across all the meta-packages.
- Meta-packages and associated packages are represented in the same color.
* Meta-packages can include another meta-package.
* `rocm-core` package is common across all the meta-packages.
* Meta-packages and associated packages are represented in the same color.
```{note}
The preceding image is for informational purposes only, as the individual

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

@@ -24,7 +24,7 @@ Verify the Linux distribution using the following steps:
uname -m && cat /etc/*release
```
2. Confirm that the obtained Linux distribution information matches with those listed in {ref}`linux_support`.
2. Confirm that the obtained Linux distribution information matches with those listed in {ref}`linux-support`.
**Example:** Running the command above on an Ubuntu system results in the
following output:
@@ -57,7 +57,7 @@ Verify the kernel version using the following steps:
```
2. Confirm that the obtained kernel version information matches with system
requirements as listed in {ref}`linux_support`.
requirements as listed in {ref}`linux-support`.
## Additional package repositories