Update titles to sentence case (#2455)

2026-04-27 03:01:52 -04:00 · 2023-09-18 12:26:31 -06:00
parent 772b51a7d2
commit d0d4eed1a6
128 changed files with 1857 additions and 2019 deletions
--- a/docs/tutorials/install/linux/index.md
+++ b/docs/tutorials/install/linux/index.md
@@ -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)
--- a/docs/tutorials/install/linux/install-options.md
+++ b/docs/tutorials/install/linux/install-options.md
@@ -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")
--- a/docs/tutorials/install/linux/installer/index.md
+++ b/docs/tutorials/install/linux/installer/index.md
@@ -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)
--- a/docs/tutorials/install/linux/installer/install.md
+++ b/docs/tutorials/install/linux/installer/install.md
@@ -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
--- a/docs/tutorials/install/linux/installer/uninstall.md
+++ b/docs/tutorials/install/linux/installer/uninstall.md
@@ -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.
--- a/docs/tutorials/install/linux/installer/upgrade.md
+++ b/docs/tutorials/install/linux/installer/upgrade.md
@@ -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`
--- a/docs/tutorials/install/linux/os-native/index.md
+++ b/docs/tutorials/install/linux/os-native/index.md
@@ -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)
--- a/docs/tutorials/install/linux/os-native/install.md
+++ b/docs/tutorials/install/linux/os-native/install.md
@@ -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:

--- a/docs/tutorials/install/linux/os-native/package-manager-integration.md
+++ b/docs/tutorials/install/linux/os-native/package-manager-integration.md
@@ -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.
--- a/docs/tutorials/install/linux/os-native/uninstall.md
+++ b/docs/tutorials/install/linux/os-native/uninstall.md
@@ -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:
--- a/docs/tutorials/install/linux/os-native/upgrade.md
+++ b/docs/tutorials/install/linux/os-native/upgrade.md
@@ -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
--- a/docs/tutorials/install/linux/prerequisites.md
+++ b/docs/tutorials/install/linux/prerequisites.md
@@ -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.