Merge pull request #2349 from saadrahim/windows_additional_gpus

Windows additional GPUs

.github/workflows/linting.yml

@@ -5,11 +5,13 @@ on:
     branches: 
     - develop
     - main
+    - 'docs/*'
     - 'roc**'    
   pull_request:
     branches: 
     - develop
     - main
+    - 'docs/*'
     - 'roc**'
 
 concurrency:

.wordlist.txt

@@ -36,6 +36,11 @@ DGEMM
 HPCG
 HPL
 IOPM
+# windows
+SKU
+SKUs
+PowerShell
+UAC
 # pytorch_install
 kdb
 precompiled

CHANGELOG.md

@@ -588,9 +588,22 @@ Tensile 4.37.0 for ROCm 5.6.0
 <!-- markdownlint-disable no-duplicate-header -->
 ### What's New in This Release
 
+#### HIP SDK for Windows
+
+AMD is pleased to announce the availability of the HIP SDK for Windows as part
+of the ROCm platform. The
+[HIP SDK OS and GPU support page](https://rocm.docs.amd.com/en/docs-5.5.1/release/windows_support.html)
+lists the versions of Windows and GPUs validated by AMD. HIP SDK features on
+Windows are described in detail in our
+[What is ROCm?](https://rocm.docs.amd.com/en/docs-5.5.1/rocm.html#rocm-on-windows)
+page and differs from the Linux feature set. Visit
+[Quick Start](https://rocm.docs.amd.com/en/docs-5.5.1/deploy/windows/quick_start.html#)
+page to get started. Known issues are tracked on
+[GitHub](https://github.com/RadeonOpenCompute/ROCm/issues?q=is%3Aopen+label%3A5.5.1+label%3A%22Verified+Issue%22+label%3AWindows).
+
 #### HIP API Change
 
-The following HIP API is updated in the ROCm v5.5.1 release,
+The following HIP API is updated in the ROCm 5.5.1 release:
 
 ##### `hipDeviceSetCacheConfig`
 

docs/conf.py

@@ -14,6 +14,8 @@ shutil.copy2('../RELEASE.md','./release.md')
 # Keep capitalization due to similar linking on GitHub's markdown preview.
 shutil.copy2('../CHANGELOG.md','./CHANGELOG.md')
 
+latex_engine = "xelatex"
+
 # configurations for PDF output by Read the Docs
 project = "ROCm Documentation"
 author = "Advanced Micro Devices, Inc."
@@ -21,16 +23,17 @@ copyright = "Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved
 version = "5.6.0"
 release = "5.6.0"
 
+
 setting_all_article_info = True
-all_article_info_os = ["linux"]
+all_article_info_os = ["linux", "windows"]
 all_article_info_author = ""
 
 # pages with specific settings
 article_pages = [
     {
         "file":"release",
-        "os":["linux"],
-        "date":"2023-06-28"
+        "os":["linux", "windows"],
+        "date":"2023-07-27"
     },
 
     {"file":"deploy/linux/index", "os":["linux"]},
@@ -43,7 +46,20 @@ article_pages = [
     {"file":"deploy/linux/package_manager_integration", "os":["linux"]},
     {"file":"deploy/docker", "os":["linux"]},
     
+    {"file":"deploy/windows/cli/index", "os":["windows"]},
+    {"file":"deploy/windows/cli/install", "os":["windows"]},
+    {"file":"deploy/windows/cli/uninstall", "os":["windows"]},
+    {"file":"deploy/windows/cli/upgrade", "os":["windows"]},
+    {"file":"deploy/windows/gui/index", "os":["windows"]},
+    {"file":"deploy/windows/gui/install", "os":["windows"]},
+    {"file":"deploy/windows/gui/uninstall", "os":["windows"]},
+    {"file":"deploy/windows/gui/upgrade", "os":["windows"]},
+    {"file":"deploy/windows/index", "os":["windows"]},
+    {"file":"deploy/windows/prerequisites", "os":["windows"]},
+    {"file":"deploy/windows/quick_start", "os":["windows"]},
+
     {"file":"release/gpu_os_support", "os":["linux"]},
+    {"file":"release/windows_support", "os":["windows"]},
     {"file":"release/docker_support_matrix", "os":["linux"]},
     
     {"file":"reference/gpu_libraries/communication", "os":["linux"]},

docs/data/deploy/quick_start_windows/image planning

@@ -1 +0,0 @@
-

docs/deploy/linux/installer/index.md

@@ -21,7 +21,7 @@ Instructions for upgrading an existing ROCm installation.
 :link: uninstall
 :link-type: doc
 
-Steps for removing ROCm packages libraries and tools.
+Steps for removing ROCm packages, libraries and tools.
 :::
 
 ::::

docs/deploy/windows/cli/index.md

@@ -0,0 +1,31 @@
+# Command Line Installation
+
+::::{grid} 2 3 3 3
+:gutter: 1
+
+:::{grid-item-card} Install
+:link: install
+:link-type: doc
+
+How to install ROCm?
+:::
+
+:::{grid-item-card} Upgrade
+:link: upgrade
+:link-type: doc
+
+Instructions for upgrading an existing ROCm installation.
+:::
+
+:::{grid-item-card} Uninstall
+:link: uninstall
+:link-type: doc
+
+Steps for removing ROCm packages and libraries.
+:::
+
+::::
+
+## See Also
+
+- {doc}`/release/gpu_os_support`

docs/deploy/windows/cli/install.md

@@ -0,0 +1,56 @@
+# Installation Using the Command Line Interface
+
+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.
+
+## HIP SDK Installation
+
+The command line installer is the same executable which is used by the graphical
+front-end. Download the installer from the
+[HIP-SDK download page](https://www.amd.com/en/developer/rocm-hub/hip-sdk.html).
+The options supported by the command line interface are summarized in
+{numref}`hip-sdk-cli-options`.
+
+```{table} HIP SDK Command Line Options
+:name: hip-sdk-cli-options
+| **Install Option** | **Description** |
+|:------------------:|:---------------:|
+| `-install` | Command used to install packages, both driver and applications. No output to the screen. |
+| `-install -boot` | Silent install with auto reboot. |
+| `-install -log <absolute path>` | Write install result code to the specified log file. The specified log file must be on a local machine. Double quotes are needed if there are spaces in the log file path. |
+| `-uninstall` | Command to uninstall all packages installed by this installer on the system. There is no option to specify which packages to uninstall. |
+| `-uninstall -boot` | Silent uninstall with auto reboot. |
+| `/?` or /help | Shows a brief description of all switch commands. |
+```
+
+```{note}
+Unlike the graphical installer, the command line interface doesn't support
+selectively installing parts of the SDK bundle. It's all or nothing.
+```
+
+### Launching the Installer From the Command Line
+
+The installer is still a graphical application with a `WinMain` entry point, even
+when called on the command line. This means that the application lifetime is
+tied to a window, even on headless systems where that window may not be visible.
+To launch the installer from PowerShell that will block until the installer
+exits, one may use the following pattern:
+
+```pwsh
+Start-Process $InstallerExecutable -ArgumentList $InstallerArgs -NoNewWindow -Wait
+```
+
+```{important}
+Running the installer requires Administrator Privileges.
+```
+
+For example, installing all components and
+
+```pwsh
+Start-Process ~\Downloads\Setup.exe -ArgumentList '-install','-log',"${env:USERPROFILE}\installer_log.txt" -NoNewWindow -Wait
+```

docs/deploy/windows/cli/uninstall.md

@@ -0,0 +1,48 @@
+# Uninstallation Using the Command Line Interface
+
+The steps to uninstall the HIP SDK for Windows are described in this document.
+
+## HIP SDK Uninstallation
+
+The command line installer is the same executable which is used by the graphical
+front-end. The options supported by the command line interface are summarized in
+{numref}`hip-sdk-cli-options`.
+
+```{table} HIP SDK Command Line Options
+:name: hip-sdk-cli-options
+| **Install Option** | **Description** |
+|:------------------:|:---------------:|
+| `-install` | Command used to install packages, both driver and applications. No output to the screen. |
+| `-install -boot` | Silent install with auto reboot. |
+| `-install -log <absolute path>` | Write install result code to the specified log file. The specified log file must be on a local machine. Double quotes are needed if there are spaces in the log file path. |
+| `-uninstall` | Command to uninstall all packages installed by this installer on the system. There is no option to specify which packages to uninstall. |
+| `-uninstall -boot` | Silent uninstall with auto reboot. |
+| `/?` or /help | Shows a brief description of all switch commands. |
+```
+
+```{note}
+Unlike the graphical installer, the command line interface doesn't support
+selectively installing parts of the SDK bundle. It's all or nothing.
+```
+
+### Launching the Installer From the Command Line
+
+The installer is still a graphical application with a `WinMain` entry point, even
+when called on the command line. This means that the application lifetime is
+tied to a window, even on headless systems where that window may not be visible.
+To launch the installer from PowerShell that will block until the installer
+exits, one may use the following pattern:
+
+```pwsh
+Start-Process $InstallerExecutable -ArgumentList $InstallerArgs -NoNewWindow -Wait
+```
+
+```{important}
+Running the installer requires Administrator Privileges.
+```
+
+For example, uninstalling all components and
+
+```pwsh
+Start-Process ~\Downloads\Setup.exe -ArgumentList '-uninstall' -NoNewWindow -Wait
+```

docs/deploy/windows/cli/upgrade.md

@@ -0,0 +1,14 @@
+# Upgrading Using the Graphical Interface
+
+The steps to uninstall the HIP SDK for Windows are described in this document.
+
+## HIP SDK Upgrade
+
+To upgrade an existing installation of the HIP SDK without preserving the
+previous version, first uninstall it, then install the new version following the
+instructions in {doc}`/deploy/windows/cli/uninstall` and
+{doc}`/deploy/windows/cli/install` using the old and new installers
+respectively.
+
+To upgrade by installing both versions side-by-side, just run the installer of
+the newer version.

docs/deploy/windows/gui/index.md

@@ -0,0 +1,31 @@
+# Graphical Installation
+
+::::{grid} 2 3 3 3
+:gutter: 1
+
+:::{grid-item-card} Install
+:link: install
+:link-type: doc
+
+How to install ROCm?
+:::
+
+:::{grid-item-card} Upgrade
+:link: upgrade
+:link-type: doc
+
+Instructions for upgrading an existing ROCm installation.
+:::
+
+:::{grid-item-card} Uninstall
+:link: uninstall
+:link-type: doc
+
+Steps for removing ROCm packages and libraries.
+:::
+
+::::
+
+## See Also
+
+- {doc}`/release/gpu_os_support`

docs/deploy/windows/gui/install.md

@@ -0,0 +1,163 @@
+# Installation Using the Graphical Interface
+
+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.
+
+## HIP SDK Installation
+
+### Download the installer
+
+Download the installer from the
+[HIP-SDK download page](https://www.amd.com/en/developer/rocm-hub/hip-sdk.html).
+
+### Launching the installer
+
+To launch the AMD HIP SDK Installer, click the **Setup** icon shown in
+{numref}`setup-icon`.
+
+```{figure} /data/deploy/windows/000-setup-icon.png
+:name: setup-icon
+:alt: Icon with AMD arrow logo and User Access Control Shield overlayed.
+Setup Icon
+```
+
+The installer requires Administrator Privileges, so you may be greeted with a
+User Access Control (UAC) pop-up. Click Yes.
+
+```{figure} /data/deploy/windows/001-uac-dark.png
+:name: uac-dark
+:class: only-dark
+:alt: User Access Control pop-up
+User Access Control pop-up
+```
+
+```{figure} /data/deploy/windows/001-uac-light.png
+:name: uac-light
+:class: only-light
+:alt: User Access Control pop-up
+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 {numref}`init-install`.
+
+```{figure} /data/deploy/windows/002-initializing.png
+:name: init-install
+:alt: Window with AMD arrow logo, futuristic background and progress counter.
+Installer initialization window
+```
+
+The installer will then detect your system configuration as per
+{numref}`detecting-system-components` to decide, which installable components
+are applicable to your system.
+
+```{figure} /data/deploy/windows/003-detecting-system-config.png
+:name: detecting-system-components
+:alt: Window with AMD arrow logo, futuristic background and activity indicator.
+Installer initialization window.
+```
+
+### Customizing 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 {numref}`installer-window` for an instance when the Select All option
+is turned on.
+
+```{figure} /data/deploy/windows/004-installer-window.png
+:name: installer-window
+:alt: Window with AMD arrow logo, futuristic background and activity indicator.
+Installer initialization window.
+```
+
+#### HIP SDK Installer
+
+The HIP SDK installation options are listed in {numref}`hip-sdk-options`.
+
+```{table} HIP SDK Components for Installation
+:name: hip-sdk-options
+| **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   |
+```
+
+```{note}
+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.
+```
+
+```{tip}
+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 by
+{numref}`display-driver-install-options`:
+
+```{table} AMD Display Driver Install Options
+:name: display-driver-install-options
+| **Install Option** | **Description** |
+|:------------------:|:---------------:|
+| Install Location         | Location on disk to store driver files. |
+| Install Type             | The breadth of components to be installed. Refer to {numref}`display-driver-install-types` for details. |
+| 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. |
+```
+
+```{table} AMD Display Driver Install Types
+:name: display-driver-install-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. |
+```
+
+```{note}
+You must perform a system restart for a complete installation of the
+Display Driver.
+```
+
+### Installing Components
+
+Please wait for the installation to complete during as shown in
+{numref}`install-progress`.
+
+```{figure} /data/deploy/windows/012-install-progress.png
+:name: install-progress
+:alt: Window with AMD arrow logo, futuristic background and progress meter.
+Installation Progress
+```
+
+### 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}`install-complete`
+
+```{figure} /data/deploy/windows/013-install-complete.png
+:name: install-complete
+:alt: Window with AMD arrow logo, futuristic background and completion notice.
+Installation Complete
+```
+
+```{error}
+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).
+```

docs/deploy/windows/gui/uninstall.md

@@ -0,0 +1,27 @@
+# Uninstallation Using the Graphical Interface
+
+The steps to uninstall the HIP SDK for Windows are described in this document.
+
+## 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>.
+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/deploy/windows/014-uninstall-dark.png
+:name: uninstall-dark
+:class: only-dark
+:alt: Installed apps section of the Setting app showing installed HIP SDK components.
+Removing the SDK via the Setting app
+```
+
+```{figure} /data/deploy/windows/014-uninstall-light.png
+:name: uninstall-light
+:class: only-light
+:alt: Installed apps section of the Setting app showing installed HIP SDK components.
+Removing the SDK via the Setting app
+```

docs/deploy/windows/gui/upgrade.md

@@ -0,0 +1,4 @@
+# Upgrading Using the Graphical Interface
+
+The steps to upgrade an existing HIP SDK installation for Windows are described
+in this document.

docs/deploy/windows/index.md

@@ -0,0 +1,44 @@
+# Deploy ROCm on Windows
+
+Start with {doc}`/deploy/windows/quick_start` or follow the detailed
+instructions below.
+
+## Prepare to Install
+
+::::{grid} 1 1 2 2
+:gutter: 1
+
+:::{grid-item-card} Prerequisites
+:link: prerequisites
+:link-type: doc
+
+The prerequisites page lists the required steps to verify that the system
+supports ROCm.
+:::
+
+::::
+
+## Choose your install method
+
+::::{grid} 1 1 2 2
+:gutter: 1
+
+:::{grid-item-card} Graphical Installation
+:link: gui/index
+:link-type: doc
+
+Use the graphical front-end of the installer.
+:::
+
+:::{grid-item-card} Command Line Installation
+:link: cli/index
+:link-type: doc
+
+Use the command line front-end of the installer.
+:::
+
+::::
+
+## See Also
+
+- {doc}`/release/gpu_os_support`

docs/deploy/windows/prerequisites.md

@@ -0,0 +1,74 @@
+# Installation Prerequisites (Windows)
+
+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 Is Supported
+
+The ROCm installation is supported only on specific host architectures, Windows
+SKUs and update versions.
+
+### Check the Windows SKU and Update Version on Your System
+
+This section discusses obtaining information about the host architecture,
+Windows SKU and update version.
+
+#### Command Line Check
+
+Verify the Windows SKU using the following steps:
+
+1. To obtain the Linux distribution information, type the following command on
+   your system from a PowerShell Command Line Interface (CLI):
+
+   ```pwsh
+   Get-ComputerInfo | Format-Table CsSystemType,OSName,OSDisplayVersion
+   ```
+
+2. Confirm that the obtained information matches with those listed in
+   {ref}`supported_skus`.
+
+   **Example:** Running the command above on a Windows system may result in the
+   following output:
+
+   ```output
+   CsSystemType OsName                   OSDisplayVersion
+   ------------ ------                   ----------------
+   x64-based PC Microsoft Windows 11 Pro 22H2
+   ```
+
+#### Graphical Check
+
+1. Open the Setting app.
+
+   ```{figure} /data/deploy/windows/000-settings-dark.png
+   :name: settings-dark
+   :class: only-dark
+   :alt: Gear icon of the Windows Settings app
+   Windows Settings app icon
+   ```
+
+   ```{figure} /data/deploy/windows/000-settings-light.png
+   :name: settings-light
+   :class: only-light
+   :alt: Gear icon of the Windows Settings app
+   Windows Settings app icon
+   ```
+
+2. Navigate to **System > About**.
+
+   ```{figure} /data/deploy/windows/001-about-dark.png
+   :name: about-dark
+   :class: only-dark
+   :alt: Settings app panel showing Device and OS information
+   Settings > About page
+   ```
+
+   ```{figure} /data/deploy/windows/001-about-light.png
+   :name: about-light
+   :class: only-light
+   :alt: Settings app panel showing Device and OS information
+   Settings > About page
+   ```
+
+3. Confirm that the obtained information matches with those listed in
+   {ref}`supported_skus`.

docs/deploy/windows/quick_start.md

@@ -0,0 +1,187 @@
+# 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.
+
+## HIP SDK Installation
+
+### Download the installer
+
+Download the installer from the
+[HIP-SDK download page](https://www.amd.com/en/developer/rocm-hub/hip-sdk.html).
+
+### Launching the installer
+
+To launch the AMD HIP SDK Installer, click the **Setup** icon shown in
+{numref}`setup-icon`.
+
+```{figure} /data/deploy/windows/000-setup-icon.png
+:name: setup-icon
+:alt: Icon with AMD arrow logo and User Access Control Shield overlayed.
+Setup Icon
+```
+
+The installer requires Administrator Privileges, so you may be greeted with a
+User Access Control (UAC) pop-up. Click Yes.
+
+```{figure} /data/deploy/windows/001-uac-dark.png
+:name: uac-dark
+:class: only-dark
+:alt: User Access Control pop-up
+User Access Control pop-up
+```
+
+```{figure} /data/deploy/windows/001-uac-light.png
+:name: uac-light
+:class: only-light
+:alt: User Access Control pop-up
+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 {numref}`init-install`.
+
+```{figure} /data/deploy/windows/002-initializing.png
+:name: init-install
+:alt: Window with AMD arrow logo, futuristic background and progress counter.
+Installer initialization window
+```
+
+The installer will then detect your system configuration as per
+{numref}`detecting-system-components` to decide, which installable components
+are applicable to your system.
+
+```{figure} /data/deploy/windows/003-detecting-system-config.png
+:name: detecting-system-components
+:alt: Window with AMD arrow logo, futuristic background and activity indicator.
+Installer initialization window.
+```
+
+### Customizing 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 {numref}`installer-window` for an instance when the Select All option
+is turned on.
+
+```{figure} /data/deploy/windows/004-installer-window.png
+:name: installer-window
+:alt: Window with AMD arrow logo, futuristic background and activity indicator.
+Installer initialization window.
+```
+
+#### HIP SDK Installer
+
+The HIP SDK installation options are listed in {numref}`hip-sdk-options`.
+
+```{table} HIP SDK Components for Installation
+:name: hip-sdk-options
+| **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   |
+```
+
+```{note}
+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.
+```
+
+```{tip}
+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 by
+{numref}`display-driver-install-options`:
+
+```{table} AMD Display Driver Install Options
+:name: display-driver-install-options
+| **Install Option** | **Description** |
+|:------------------:|:---------------:|
+| Install Location         | Location on disk to store driver files. |
+| Install Type             | The breadth of components to be installed. Refer to {numref}`display-driver-install-types` for details. |
+| 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. |
+```
+
+```{table} AMD Display Driver Install Types
+:name: display-driver-install-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. |
+```
+
+```{note}
+You must perform a system restart for a complete installation of the
+Display Driver.
+```
+
+### Installing Components
+
+Please wait for the installation to complete during as shown in
+{numref}`install-progress`.
+
+```{figure} /data/deploy/windows/012-install-progress.png
+:name: install-progress
+:alt: Window with AMD arrow logo, futuristic background and progress meter.
+Installation Progress
+```
+
+### 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}`install-complete`
+
+```{figure} /data/deploy/windows/013-install-complete.png
+:name: install-complete
+:alt: Window with AMD arrow logo, futuristic background and completion notice.
+Installation Complete
+```
+
+```{error}
+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).
+```
+
+## 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>.
+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/deploy/windows/014-uninstall-dark.png
+:name: uninstall-dark
+:class: only-dark
+:alt: Installed apps section of the Setting app showing installed HIP SDK components.
+Removing the SDK via the Setting app
+```
+
+```{figure} /data/deploy/windows/014-uninstall-light.png
+:name: uninstall-light
+:class: only-light
+:alt: Installed apps section of the Setting app showing installed HIP SDK components.
+Removing the SDK via the Setting app
+```

docs/reference/management_tools.md

@@ -24,7 +24,6 @@ This tool acts as a command line interface for manipulating and monitoring the A
 :::{grid-item-card} {doc}`ROCm Data Center Tool <rdc:index>`
 The ROCm™ Data Center Tool simplifies the administration and addresses key infrastructure challenges in AMD GPUs in cluster and data center environments.
 
-- {doc}`Documentation <rdc:index>`
 - [GitHub](https://github.com/RadeonOpenCompute/rdc)
 - [Changelog](https://github.com/RadeonOpenCompute/rdc/blob/master/CHANGELOG.md)
 - [Examples](https://github.com/RadeonOpenCompute/rdc/tree/master/example)

docs/release/windows_support.md

@@ -0,0 +1,79 @@
+# GPU and OS Support (Windows)
+
+(supported_skus)=
+
+## Supported SKUs
+
+AMD ROCm™ Platform supports the following Windows SKU.
+
+| Distribution        |Processor Architectures| Validated update   |
+|---------------------|-----------------------|--------------------|
+| Windows 10          | x86-64                | 22H2 (GA)          |
+| Windows 11          | x86-64                | 22H2 (GA)          |
+| Windows Server 2022 | x86-64                |                    |
+
+## GPU Support Table
+
+::::{tab-set}
+
+:::{tab-item} Radeon Pro™
+:sync: radeonpro
+
+| Name | Architecture |[LLVM Target](https://www.llvm.org/docs/AMDGPUUsage.html#processors) | Runtime | HIP SDK |
+|:----:|:------------:|:--------------------------------------------------------------------:|:-------:|:----------------:|
+| AMD Radeon™ Pro W7900   | RDNA3  | gfx1100 | ✅ | ✅ |
+| AMD Radeon™ Pro W7800   | RDNA3  | gfx1100 | ✅ | ✅ |
+| AMD Radeon™ Pro W6800   | RDNA2  | gfx1030 | ✅ | ✅ |
+| AMD Radeon™ Pro W6600   | RDNA2  | gfx1032 | ✅ | ❌ |
+| AMD Radeon™ Pro W5500   | RDNA1  | gfx1012 | ❌ | ❌ |
+| AMD Radeon™ Pro VII     | GCN5.1 | gfx906  | ❌ | ❌ |
+
+:::
+
+:::{tab-item} Radeon™
+:sync: radeon
+
+| Name | Architecture | [LLVM Target](https://www.llvm.org/docs/AMDGPUUsage.html#processors) | Runtime | HIP SDK |
+|:----:|:------------:|:--------------------------------------------------------------------:|:-------:|:----------------:|
+| AMD Radeon™ RX 7900 XTX | RDNA3  | gfx1100 | ✅ | ✅ |
+| AMD Radeon™ RX 7900 XT  | RDNA3  | gfx1100 | ✅ | ✅ |
+| AMD Radeon™ RX 7600     | RDNA3  | gfx1100 | ✅ | ✅ |
+| AMD Radeon™ RX 6950 XT  | RDNA2  | gfx1030 | ✅ | ✅ |
+| AMD Radeon™ RX 6900 XT  | RDNA2  | gfx1030 | ✅ | ✅ |
+| AMD Radeon™ RX 6800 XT  | RDNA2  | gfx1030 | ✅ | ✅ |
+| AMD Radeon™ RX 6800     | RDNA2  | gfx1030 | ✅ | ✅ |
+| AMD Radeon™ RX 6750     | RDNA2  | gfx1032 | ✅ | ❌ |
+| AMD Radeon™ RX 6700 XT  | RDNA2  | gfx1032 | ✅ | ❌ |
+| AMD Radeon™ RX 6700     | RDNA2  | gfx1032 | ✅ | ❌ |
+| AMD Radeon™ RX 6650 XT  | RDNA2  | gfx1032 | ✅ | ❌ |
+| AMD Radeon™ RX 6600 XT  | RDNA2  | gfx1032 | ✅ | ❌ |
+| AMD Radeon™ RX 6600     | RDNA2  | gfx1032 | ✅ | ❌ |
+
+:::
+
+::::
+
+### Component Support
+
+ROCm components are described in the [reference](../reference/all) page. Support
+on Windows is provided with two levels on enablement.
+
+- **Runtime**: Runtime enables the use of the HIP/OpenCL runtimes only.
+- **HIP SDK**: Runtime plus additional components refer to libraries found under
+  [Math Libraries](../reference/gpu_libraries/math.md) and
+  [C++ Primitive Libraries](../reference/gpu_libraries/c%2B%2B_primitives.md).
+  Some [Math Libraries](../reference/gpu_libraries/math.md) are Linux exclusive,
+  please check the library details.
+
+### Support Status
+
+- ✅: **Supported** - AMD enables these GPUs in our software distributions for
+  the corresponding ROCm product.
+- ⚠️: **Deprecated** - Support will be removed in a future release.
+- ❌: **Unsupported** - This configuration is not enabled in our software
+  distributions.
+
+## CPU Support
+
+ROCm requires CPUs that support PCIe™ Atomics. Modern CPUs after the release of
+1st generation AMD Zen CPU and Intel™ Haswell support PCIe Atomics.

docs/rocm.md

@@ -22,3 +22,93 @@ ROCm’s goal is to allow our users to maximize their GPU hardware investment.
 ROCm is designed to help develop, test and deploy GPU accelerated HPC, AI,
 scientific computing, CAD, and other applications in a free, open-source,
 integrated and secure software ecosystem.
+
+## ROCm on Windows
+
+Starting with ROCm 5.5, the HIP SDK brings a subset of ROCm to developers on Windows.
+The collection of features enabled on Windows is referred to as the HIP SDK.
+These features allow developers to use the HIP runtime, HIP math libraries
+and HIP Primitive libraries. The following table shows the differences
+between Windows and Linux releases.
+
+|Component|Linux|Windows|
+|---------|-----|-------|
+|Driver|Radeon Software for Linux |AMD Software Pro Edition|
+|Compiler|`hipcc`/`amdclang++`|`hipcc`/`clang++`|
+|Debugger|`rocgdb`|no debugger available|
+|Profiler|`rocprof`|[Radeon GPU Profiler](https://gpuopen.com/rgp/)|
+|Porting Tools|HIPIFY|Coming Soon|
+|Runtime|HIP (Open Sourced)|HIP (closed source)|
+|Math Libraries|Supported|Supported|
+|Primitives Libraries|Supported|Supported|
+|Communication Libraries|Supported|Not Available|
+|AI Libraries|MIOpen, MIGraphX|Not Available|
+|System Management|`rocm-smi-lib`, RDC, `rocminfo`|`amdsmi`, `hipInfo`|
+|AI Frameworks|PyTorch, TensorFlow, etc.|Not Available|
+|CMake HIP Language|Enabled|Unsupported|
+|Visual Studio| Not applicable| Plugin Available|
+|HIP Ray Tracing| Supported|Supported|
+
+AMD is continuing to invest in Windows support and AMD plans to release enhanced
+features in subsequent revisions.
+
+```{note}
+The 5.5 Windows Installer collectively groups the Math and Primitives
+libraries.
+```
+
+```{note}
+GPU support on Windows and Linux may differ. You must refer to
+Windows and Linux GPU support tables separately.
+```
+
+```{note}
+HIP Ray Tracing is not distributed via ROCm in Linux.
+```
+
+### ROCm release versioning
+
+Linux OS releases set the canonical version numbers for ROCm. Windows will
+follow Linux version numbers as Windows releases are based on Linux ROCm
+releases. However, not all Linux ROCm releases will have a corresponding Windows
+release. The following table shows the ROCm releases on Windows and Linux. Releases
+with both Windows and Linux are referred to as a joint release. Releases with
+only Linux support are referred to as a skipped release from the Windows
+perspective.
+
+|Release version|Linux|Windows|
+|---------------|-----|-------|
+|5.5|✅|✅|
+|5.6|✅|❌|
+
+ROCm Linux releases are versioned with following the Major.Minor.Patch
+version number system. Windows releases will only be versioned with Major.Minor.
+
+In general, Windows releases will trail Linux releases. Software developers that
+wish to support both Linux and Windows using a single ROCm version should
+refrain from upgrading ROCm unless there is a joint release.
+
+### Windows Documentation implications
+
+The ROCm documentation website contains both Windows and Linux documentation.
+Just below each article title, a convenient article information section states
+whether the page applies to Linux only, Windows only or both OSes. To find the
+exact Windows documentation for a release of the HIP SDK, please view the ROCm documentation with the same
+Major.Minor version number while ignoring the Patch version. The Patch version
+only matters for Linux releases.  For convenience,
+Windows documentation will continue to be included in the overall ROCm
+documentation for the skipped Windows releases.
+
+Windows release notes will contain only information pertinent to Windows.
+The software developer must read all the previous ROCm release notes (including)
+skipped ROCm versions on Windows for information on all the changes present in
+the Windows release.
+
+### Windows Builds from Source
+
+Not all source code required to build Windows from source is available under a
+permissive open source license. Build instructions on Windows is only provided
+for projects that can be built from source on Windows using a toolchain that
+has closed source build prerequisites. The ROCm manifest file is not valid for
+Windows. AMD does not release a manifest or tag our components in Windows.
+Users may use corresponding Linux tags to build on Windows.

docs/sphinx/_toc.yml.in

@@ -38,6 +38,32 @@ subtrees:
                 title: Upgrade
               - file: deploy/linux/installer/uninstall
                 title: Uninstallation
+  - file: deploy/windows/quick_start
+    title: Windows Quick Start
+  - file: deploy/windows/index
+    title: Windows Overview
+    subtrees:
+      - entries:
+        - file: deploy/windows/prerequisites
+          title: Prerequisites
+        - file: deploy/windows/gui/index
+          subtrees:
+            - entries:
+              - file: deploy/windows/gui/install
+                title: Installation
+              - file: deploy/windows/gui/upgrade
+                title: Upgrade
+              - file: deploy/windows/gui/uninstall
+                title: Uninstallation
+        - file: deploy/windows/cli/index
+          subtrees:
+            - entries:
+              - file: deploy/windows/cli/install
+                title: Installation
+              - file: deploy/windows/cli/upgrade
+                title: Upgrade
+              - file: deploy/windows/cli/uninstall
+                title: Uninstallation
   - file: deploy/docker
     title: Docker
 
@@ -47,6 +73,7 @@ subtrees:
   - file: CHANGELOG
     title: Changelog
   - file: release/gpu_os_support
+  - file: release/windows_support
   - url: https://github.com/RadeonOpenCompute/ROCm/labels/Verified%20Issue
     title: Known Issues
   - file: release/compatibility

docs/sphinx/requirements.txt

@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile with Python 3.8
+# This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
 #    pip-compile --resolver=backtracking requirements.in
@@ -26,6 +26,10 @@ charset-normalizer==2.1.1
     # via requests
 click==8.1.3
     # via sphinx-external-toc
+colorama==0.4.6
+    # via
+    #   click
+    #   sphinx
 cryptography==40.0.2
     # via pyjwt
 deprecated==1.2.13

tools/autotag/templates/rocm_changes/5.5.1.md

@@ -2,9 +2,22 @@
 <!-- markdownlint-disable no-duplicate-header -->
 ### What's New in This Release
 
+#### HIP SDK for Windows
+
+AMD is pleased to announce the availability of the HIP SDK for Windows as part
+of the ROCm platform. The
+[HIP SDK OS and GPU support page](https://rocm.docs.amd.com/en/docs-5.5.1/release/windows_support.html)
+lists the versions of Windows and GPUs validated by AMD. HIP SDK features on
+Windows are described in detail in our
+[What is ROCm?](https://rocm.docs.amd.com/en/docs-5.5.1/rocm.html#rocm-on-windows)
+page and differs from the Linux feature set. Visit
+[Quick Start](https://rocm.docs.amd.com/en/docs-5.5.1/deploy/windows/quick_start.html#)
+page to get started. Known issues are tracked on
+[GitHub](https://github.com/RadeonOpenCompute/ROCm/issues?q=is%3Aopen+label%3A5.5.1+label%3A%22Verified+Issue%22+label%3AWindows).
+
 #### HIP API Change
 
-The following HIP API is updated in the ROCm v5.5.1 release,
+The following HIP API is updated in the ROCm 5.5.1 release:
 
 ##### `hipDeviceSetCacheConfig`