e87dba01c6
Flattened out page structure for improved navigability. * Change Table of Contents * Update the install guides for windows and linux * Removed extraneous index pages * GPU architecture pages duplicate entries removed * spack page cleanup --------- Co-authored-by: Sam Wu <samwu103@amd.com> Co-authored-by: Saad Rahim (AMD) <44449863+saadrahim@users.noreply.github.com>
6.4 KiB
Windows quick-start installation guide
For a quick summary on installing ROCm (HIP SDK) on Windows, follow the steps listed on this page. If you want a more in-depth installation guide, see Installing ROCm on Windows.
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
Download the installer
Download the installer from the HIP-SDK download page.
Launch the installer
To launch the AMD HIP SDK Installer, click the Setup icon shown in the following image.
The installer requires Administrator Privileges, so you may be greeted with a User Access Control (UAC) pop-up. Click Yes.
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.
The installer will then detect your system configuration to determine which installable components are applicable to your system.
Customize the install
When the installer launches, it displays a window that lets the user customize 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.
HIP SDK installer
The HIP SDK installation options are listed in the following table.
:name: hip-sdk-options-win
| **HIP Components** | **Install Type** | **Additional Options** |
|:------------------:|:----------------:|:----------------------:|
| HIP SDK Core | 5.5.0 | Install location |
| HIP Libraries | Full, Partial, None | Runtime, Development (Libs and headers) |
| HIP Runtime Compiler | Full, Partial, None | Runtime, Development (Headers) |
| HIP Ray Tracing | Full, Partial, None | Runtime, Development (Headers) |
| Visual Studio Plugin | Full, Partial, None | Visual Studio 2017, 2019, 2022 Plugin |
The Select/DeSelect All option only applies to the installation of HIP SDK
components. To install the bundled AMD Display Driver, manually select the
install type.
Should you only wish to install a few select components,
DeSelecting All and then picking the individual components may be more
convenient.
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:
:name: display-driver-install-win
| **Install Option** | **Description** |
|:------------------:|:---------------:|
| Install Location | Location on disk to store driver files. |
| Install Type | The breadth of components to be installed. |
| Factory Reset (Optional) | A Factory Reset will remove all prior versions of AMD HIP SDK and drivers. You will not be able to roll back to previously installed drivers. |
:name: display-driver-win-types
| **Install Type** | **Description** |
|:----------------:|:---------------:|
| Full Install | Provides all AMD Software features and controls for gaming, recording, streaming, and tweaking the performance on your graphics hardware. |
| Minimal Install | Provides only the basic controls for AMD Software features and does not include advanced features such as performance tweaking or recording and capturing content. |
| Driver Only | Provides no user interface for AMD Software features. |
You must perform a system restart for a complete installation of the
Display Driver.
Install components
Please wait for the installation to complete during as shown in the following image.
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.
Should the installer terminate due to unexpcted 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).
Uninstall
All components, except visual studio plug-in should be uninstalled through control panel -> Add/Remove Program. For visual studio extension uninstallation, please refer to https://github.com/ROCm-Developer-Tools/HIP-VS/blob/master/README.md. 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".
