Update titles to sentence case (#2455)

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

View File

@@ -3,7 +3,7 @@
For a quick summary on installing ROCm on Linux, follow the steps listed on this page. If you
want a more in-depth installation guide, see [Installing ROCm on Linux](../install/linux/index.md).
## Add Repositories
## Add repositories
::::::{tab-set}
:::::{tab-item} Ubuntu
@@ -294,7 +294,7 @@ sudo zypper ref
:::::
::::::
## Install Drivers
## Install drivers
Install the `amdgpu-dkms` kernel module, aka driver, on your system.
@@ -329,7 +329,7 @@ sudo zypper install amdgpu-dkms
::::
## Install ROCm Runtimes
## Install ROCm runtimes
Install the `rocm-hip-libraries` meta-package. This contains dependencies for most
common ROCm applications.

View File

@@ -4,13 +4,13 @@ For a quick summary on installing ROCm (HIP SDK) on Windows, follow the steps li
you want a more in-depth installation guide, see
[Installing ROCm on Windows](../install/windows/index.md).
## 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
@@ -21,47 +21,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
: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
: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
: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-win-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: detecting-system-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
@@ -70,13 +48,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: install-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.
@@ -103,7 +77,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:
@@ -131,26 +105,18 @@ 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-win
: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-win
: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
@@ -169,16 +135,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-win
: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-win
: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")