57c601262b
* Clean up the deployment related pages - Add an index page for the linux deployment submenu - Remove deployment options that are not yet completed (i.e. spack, from source installation) - remove the general deployment index page - various cleanups and clarifications in the rest of the pages * Move all deploy pages to deploy folder --------- Co-authored-by: Gergely Meszaros <gergely@streamhpc.com>
9.0 KiB
Quick Start (Windows)
The steps to install the HIP SDK for Windows are described in this document.
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.
SDK Installation
Installation options are listed in {numref}installation-components.
:::{table} Components for Installation :name: installation-components
| HIP Components | Install Type | Display Driver | Install Options |
|---|---|---|---|
| HIP SDK Core | Full | Adrenalin 22.40 | Full: Provides all AMD Software features and controls for gaming, recording, streaming, and tweaking your performance on your graphics hardware. |
| HIP Libraries | Full | Minimal: Provides only the basic controls for AMD Software features and does not include advanced features such as performance tweaking or recording and capturing content. | |
| HIP Runtime Compiler | Full | Driver Only: Provides no user interface for AMD Software features. | |
| Ray Tracing | Full | Do Not Install | |
| BitCode Profiler | Full | ||
| ::: |
HIP SDK Installer
The AMD HIP SDK Installer manages the installation and uninstallation process of HIP SDK for Windows. This includes system configuration checks, installing components, and installing the display driver.
To launch the AMD HIP SDK Installer, click the Setup icon shown in
{numref}setup-icon. The installer will begin to load and detect your system's
configuration and compatibility, as shown in {numref}loading-window. A
completely loaded AMD HIP SDK Installer window will appear, as shown in {numref}installer-window.
:::{figure} /data/deploy/quick_start_windows/Setup-Icon.png :name: setup-icon :alt: Setup Setup Icon. :::
:::{figure} /data/deploy/quick_start_windows/Loading-Window.png :name: loading-window :alt: Loading Window AMD HIP SDK Loading Window :::
:::{figure} /data/deploy/quick_start_windows/Installer-Window.png :name: installer-window :alt: Installer Window AMD HIP SDK Installer Window :::
Installation Selections
By default, all components are selected for installation. Refer to {numref}installer-window for
an instance when the Select All option is turned on.
Note The Select All option only applies to the installation of HIP components. To install the AMD Display Driver, manually select the install type.
Note To customize the install location on your system, click Additional Options under HIP SDK Core and AMD Radeon Vega 10 Graphics. Refer to the sections HIP Components and AMD Display Driver for more information on each installation.
To make installation selections and install, follow these steps:
- Scroll the window to AMD Display Driver and select the desired install type. Refer to the section AMD Display Driver for more information on installation types.
- Once selected, click Install located in the lower right corner, and skip to Installing Components.
Deselect All
To select individual component installs onto your system click Deselect All
in the upper right corner of the installer window, as seen in {numref}installer-window. {numref}deselect-all
demonstrates the installer window once the installation components are all
deselected.
:::{figure} /data/deploy/quick_start_windows/DeSelectAll.png :name: deselect-all :alt: DeSelect All Deselect All Selection :::
HIP Components
By default, each HIP component will be checked off for full installation,
{numref}deselect-all through {numref}bitcode-profiler demonstrate the options available to you when you click
Additional Options under each component.
:::{table} Custom Selections for Installation :name: custom-selections
| If: | Then: |
|---|---|
| You intend to make custom selections for this installation | Skip to the section Deselect All. |
| You do not intend to make custom selections for this installation | Continue to the section AMD Display Driver. |
| ::: |
Note You can manually select installation locations for the HIP SDK Core, as
shown in {numref}hip-sdk-core.
:::{figure} /data/deploy/quick_start_windows/HIP-SDK-Core.png :name: hip-sdk-core :alt: HIP SDK Core HIP SDK Core Option :::
:::{figure} /data/deploy/quick_start_windows/HIP-Libraries.png :name: hip-libraries :alt: Hip Libraries Hip Libraries Option :::
:::{figure} /data/deploy/quick_start_windows/HIP-Runtime-Compiler.png :name: hip-rtc :alt: HIP Runtime Compiler HIP Runtime Compiler Option :::
:::{figure} /data/deploy/quick_start_windows/HIP-Ray-Tracing.png :name: hip-ray-tracing :alt: HIP Ray Tracing HIP Ray Tracing :::
:::{figure} /data/deploy/quick_start_windows/BitCode-Profiler.png :name: bitcode-profiler :alt: BitCode Profiler BitCode Profiler :::
AMD Display Driver
The AMD Display Driver offers three install types:
- Full Install
- Minimal Install
- Driver only
{numref}driver-options describes the difference in each option shown in
{numref}display-driver.
Note You must perform a system restart for a complete installation of the Display Driver.
Note Unless you intend to factory reset your machine, leave the Factory Reset (Optional) box unchecked. 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.
:::{table} Table 3. Display Driver Install Options :name: driver-options
| Install Option | 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. |
| ::: |
:::{figure} /data/deploy/quick_start_windows/AMD-Display-Driver.png :name: display-driver :alt: Display Driver AMD Display Driver Options :::
Installing Components
Please wait for the installation to complete during as shown in {numref}installing.
:::{figure} /data/deploy/quick_start_windows/Installation.png :name: installing :alt: Installing Active Installation :::
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
{numref}installation-complete
:::{figure} /data/deploy/quick_start_windows/Installation-Complete.png :name: installation-complete :alt: Installation Complete Installation Complete :::
Uninstallation
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. For the uninstallation of the HIP SDK Core and drivers repeat the steps in the sections HIP SDK Installer and Installing Components.
Note Selecting Install once ROCm has already installed results in its uninstallation.
:::{figure} /data/deploy/quick_start_windows/Uninstallation.png :name: uninstall :alt: Uninstall HIP SDK Uninstalling :::