Update default.xml to 5.5.1 release.

Merging Documentation into 5.5

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @saadrahim @Rmalavally @amd-aakash @zhang2amd @jlgreathouse @samjwu

.github/dependabot.yml

@@ -0,0 +1,12 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/docs/sphinx" # Location of package manifests
+    open-pull-requests-limit: 10
+    schedule:
+      interval: "daily"

.github/workflows/linting.yml

@@ -0,0 +1,56 @@
+name: Linting
+
+on:
+  push:
+    branches: 
+    - develop
+    - main
+  pull_request:
+    branches: 
+    - develop
+    - main
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+  lint-rest:
+    name: "RestructuredText"
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+    - name: Install rst-lint
+      run: pip install restructuredtext-lint
+    - name: Lint ResT files
+      run: rst-lint ${{ join(github.workspace, '/docs') }}
+
+  lint-md:
+    name: "Markdown"
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+    - name: Use markdownlint
+      uses: actionshub/markdownlint@v3.1.3
+      with:
+        filesToIgnoreRegex: CHANGELOG.md|(docs\/)?(RELEASE|release).md|tools\/autotag\/templates\/.
+
+  spelling:
+    name: "Spelling"
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+    - name: Fetch config
+      shell: sh
+      run: |
+        curl --silent --show-error --fail --location https://raw.github.com/RadeonOpenCompute/rocm-docs-core/develop/.spellcheck.yaml -O
+        curl --silent --show-error --fail --location https://raw.github.com/RadeonOpenCompute/rocm-docs-core/develop/.wordlist.txt >> .wordlist.txt
+    - name: Run spellcheck
+      uses: rojopolis/spellcheck-github-actions@0.30.0
+    - name: On fail
+      if: failure()
+      run: |
+        echo "Please check for spelling mistakes or add them to '.wordlist.txt' in either the root of this project or in rocm-docs-core."

.gitignore

@@ -0,0 +1,17 @@
+.venv
+.vscode
+build
+
+# documentation artifacts
+_build/
+_images/
+_static/
+_templates/
+_toc.yml
+docBin/
+_doxygen/
+_readthedocs/
+
+# avoid duplicating contributing.md due to conf.py
+docs/contributing.md
+docs/release.md

.mdlrc

@@ -0,0 +1 @@
+style "mdlrc-style.rb"

.readthedocs.yaml

@@ -0,0 +1,14 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+sphinx:
+   configuration: docs/conf.py
+
+formats: [htmlzip, pdf, epub]
+
+python:
+   version: "3.8"
+   install:
+   - requirements: docs/sphinx/requirements.txt

.wordlist.txt

@@ -0,0 +1,29 @@
+# isv_deployment_win
+ABI
+# gpu_aware_mpi
+DMA
+GDR
+HCA
+MPI
+MVAPICH
+Mellanox's
+NIC
+OFED
+OSU
+OpenFabrics
+PeerDirect
+RDMA
+UCX
+ib_core
+# linear algebra
+LAPACK
+MMA
+backends
+cuSOLVER
+cuSPARSE
+# tuning_guides
+BMC
+DGEMM
+HPCG
+HPL
+IOPM

CONTRIBUTING.md

@@ -0,0 +1,246 @@
+# Contributing to ROCm Docs
+
+AMD values and encourages the ROCm community to contribute to our code and
+documentation. This repository is focused on ROCm documentation and this
+contribution guide describes the recommend method for creating and modifying our
+documentation.
+
+While interacting with ROCm Documentation, we encourage you to be polite and
+respectful in your contributions, content or otherwise. Authors, maintainers of
+these docs act on good intentions and to the best of their knowledge.
+Keep that in mind while you engage. Should you have issues with contributing
+itself, refer to
+[discussions](https://github.com/RadeonOpenCompute/ROCm/discussions) on the
+GitHub repository.
+
+## Supported Formats
+
+Our documentation includes both markdown and rst files. Markdown is encouraged
+over rst due to the lower barrier to participation. GitHub flavored markdown is preferred
+for all submissions as it will render accurately on our GitHub repositories. For existing documentation,
+[MyST](https://myst-parser.readthedocs.io/en/latest/intro.html) markdown
+is used to implement certain features unsupported in GitHub markdown. This is
+not encouraged for new documentation. AMD will transition
+to stricter use of GitHub flavored markdown with a few caveats. ROCm documentation
+also uses [sphinx-design](https://sphinx-design.readthedocs.io/en/latest/index.html)
+in our markdown and rst files. We also will use breathe syntax for doxygen documentation
+in our markdown files. Other design elements for effective HTML rendering of the documents
+may be added to our markdown files. Please see
+[GitHub](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github)'s
+guide on writing and formatting on GitHub as a starting point.
+
+ROCm documentation adds additional requirements to markdown and rst based files
+as follows:
+
+- Level one headers are only used for page titles. There must be only one level
+  1 header per file for both Markdown and Restructured Text.
+- Pass [markdownlint](https://github.com/markdownlint/markdownlint) check via
+  our automated github action on a Pull Request (PR).
+
+## Filenames and folder structure
+
+Please use snake case for file names. Our documentation follows pitchfork for
+folder structure. All documentation is in /docs except for special files like
+the contributing guide in the / folder. All images used in the documentation are
+place in the /docs/data folder.
+
+## How to provide feedback for for ROCm documentation
+
+There are three standard ways to provide feedback for this repository.
+
+### Pull Request
+
+All contributions to ROCm documentation should arrive via the
+[GitHub Flow](https://docs.github.com/en/get-started/quickstart/github-flow)
+targetting the develop branch of the repository. If you are unable to contribute
+via the GitHub Flow, feel free to email us. TODO, confirm email address.
+
+### GitHub Issue
+
+Issues on existing or absent docs can be filed as [GitHub issues
+](https://github.com/RadeonOpenCompute/ROCm/issues).
+
+### Email Feedback
+
+## Language and Style
+
+Adopting Microsoft CPP-Docs guidelines for [Voice and Tone
+](https://github.com/MicrosoftDocs/cpp-docs/blob/main/styleguide/voice-tone.md).
+
+ROCm documentation templates to be made public shortly. ROCm templates dictate
+the recommended structure and flow of the documentation. Guidelines on how to
+integrate figures, equations, and tables are all based off
+[MyST](https://myst-parser.readthedocs.io/en/latest/intro.html).
+
+Font size and selection, page layout, white space control, and other formatting
+details are controlled via rocm-docs-core, sphinx extention. Please raise issues
+in rocm-docs-core for any formatting concerns and changes requested.
+
+## Building Documentation
+
+While contributing, one may build the documentation locally on the command-line
+or rely on Continuous Integration for previewing the resulting HTML pages in a
+browser.
+
+### Command line documentation builds
+
+Python versions known to build documentation:
+
+- 3.8
+
+To build the docs locally using Python Virtual Environment (`venv`), execute the
+following commands from the project root:
+
+```sh
+python3 -mvenv .venv
+# Windows
+.venv/Scripts/python -m pip install -r docs/sphinx/requirements.txt
+.venv/Scripts/python -m sphinx -T -E -b html -d _build/doctrees -D language=en docs _build/html
+# Linux
+.venv/bin/python     -m pip install -r docs/sphinx/requirements.txt
+.venv/bin/python     -m sphinx -T -E -b html -d _build/doctrees -D language=en docs _build/html
+```
+
+Then open up `_build/html/index.html` in your favorite browser.
+
+### Pull Requests documentation builds
+
+When opening a PR to the `develop` branch on GitHub, the page corresponding to
+the PR (`https://github.com/RadeonOpenCompute/ROCm/pull/<pr_number>`) will have
+a summary at the bottom. This requires the user be logged in to GitHub.
+
+- There, click `Show all checks` and `Details` of the Read the Docs pipeline. It
+  will take you to `https://readthedocs.com/projects/advanced-micro-devices-rocm/
+  builds/<some_build_num>/`
+  - The list of commands shown are the exact ones used by CI to produce a render
+    of the documentation.
+- There, click on the small blue link `View docs` (which is not the same as the
+  bigger button with the same text). It will take you to the built HTML site with
+  a URL of the form `https://
+  advanced-micro-devices-demo--<pr_number>.com.readthedocs.build/projects/alpha/en
+  /<pr_number>/`.
+
+### Build the docs using VS Code
+
+One can put together a productive environment to author documentation and also
+test it locally using VS Code with only a handful of extensions. Even though the
+extension landscape of VS Code is ever changing, here is one example setup that
+proved useful at the time of writing. In it, one can change/add content, build a
+new version of the docs using a single VS Code Task (or hotkey), see all errors/
+warnings emitted by Sphinx in the Problems pane and immediately see the
+resulting website show up on a locally serving web server.
+
+#### Configuring VS Code
+
+1. Install the following extensions:
+
+    - Python (ms-python.python)
+    - Live Server (ritwickdey.LiveServer)
+
+2. Add the following entries in `.vscode/settings.json`
+
+    ```json
+    {
+      "liveServer.settings.root": "/.vscode/build/html",
+      "liveServer.settings.wait": 1000,
+      "python.terminal.activateEnvInCurrentTerminal": true
+    }
+    ```
+
+    The settings in order are set for the following reasons:
+    - Sets the root of the output website for live previews. Must be changed
+      alongside the `tasks.json` command.
+    - Tells live server to wait with the update to give time for Sphinx to
+      regenerate site contents and not refresh before all is don. (Empirical value)
+    - Automatic virtual env activation is a nice touch, should you want to build
+      the site from the integrated terminal.
+
+3. Add the following tasks in `.vscode/tasks.json`
+
+    ```json
+    {
+      "version": "2.0.0",
+      "tasks": [
+        {
+          "label": "Build Docs",
+          "type": "process",
+          "windows": {
+            "command": "${workspaceFolder}/.venv/Scripts/python.exe"
+          },
+          "command": "${workspaceFolder}/.venv/bin/python3",
+          "args": [
+            "-m",
+            "sphinx",
+            "-j",
+            "auto",
+            "-T",
+            "-b",
+            "html",
+            "-d",
+            "${workspaceFolder}/.vscode/build/doctrees",
+            "-D",
+            "language=en",
+            "${workspaceFolder}/docs",
+            "${workspaceFolder}/.vscode/build/html"
+          ],
+          "problemMatcher": [
+            {
+              "owner": "sphinx",
+              "fileLocation": "absolute",
+              "pattern": {
+                "regexp": "^(?:.*\\.{3}\\s+)?(\\/[^:]*|[a-zA-Z]:\\\\[^:]*):(\\d+):\\s+(WARNING|ERROR):\\s+(.*)$",
+                "file": 1,
+                "line": 2,
+                "severity": 3,
+                "message": 4
+              },
+            },
+            {
+              "owner": "sphinx",
+              "fileLocation": "absolute",
+              "pattern": {
+                "regexp": "^(?:.*\\.{3}\\s+)?(\\/[^:]*|[a-zA-Z]:\\\\[^:]*):{1,2}\\s+(WARNING|ERROR):\\s+(.*)$",
+                "file": 1,
+                "severity": 2,
+                "message": 3
+              }
+            }
+          ],
+          "group": {
+            "kind": "build",
+            "isDefault": true
+          }
+        },
+      ],
+    }
+    ```
+
+    > (Implementation detail: two problem matchers were needed to be defined,
+    > because VS Code doesn't tolerate some problem information being potentially
+    > absent. While a single regex could match all types of errors, if a capture
+    > group remains empty (the line number doesn't show up in all warning/error
+    > messages) but the `pattern` references said empty capture group, VS Code
+    > discards the message completely.)
+
+4. Configure Python virtual environment (venv)
+
+    - From the Command Palette, run `Python: Create Environment`
+      - Select `venv` environment and the `docs/sphinx/requirements.txt` file.
+      _(Simply pressing enter while hovering over the file from the dropdown is
+      insufficient, one has to select the radio button with the 'Space' key if
+      using the keyboard.)_
+
+5. Build the docs
+
+    - Launch the default build Task using either:
+      - a hotkey _(default is 'Ctrl+Shift+B')_ or
+      - by issuing the `Tasks: Run Build Task` from the Command Palette.
+
+6. Open the live preview
+
+    - Navigate to the output of the site within VS Code, right-click on
+    `.vscode/build/html/index.html` and select `Open with Live Server`. The
+    contents should update on every rebuild without having to refresh the
+    browser.
+
+<!-- markdownlint-restore -->

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,707 +1,45 @@
+# AMD ROCm™ Platform - Powering Your GPU Computational Needs
 
+ROCm™ is an open-source stack for GPU computation. ROCm is primarily Open-Source
+Software (OSS) that allows developers the freedom to customize and tailor their
+GPU software for their own needs while collaborating with a community of other
+developers, and helping each other find solutions in an agile, flexible, rapid
+and secure manner.
 
-# AMD ROCm™ v4.5 Release Notes 
+ROCm is a collection of drivers, development tools and APIs enabling GPU
+programming from the low-level kernel to end-user applications. ROCm is powered
+by AMD’s Heterogeneous-computing Interface for Portability (HIP), an OSS C++ GPU
+programming environment and its corresponding runtime. HIP allows ROCm
+developers to create portable applications on different platforms by deploying
+code on a range of platforms, from dedicated gaming GPUs to exascale HPC
+clusters. ROCm supports programming models such as OpenMP and OpenCL, and
+includes all the necessary OSS compilers, debuggers and libraries. ROCm is fully
+integrated into ML frameworks such as PyTorch and TensorFlow. ROCm can be
+deployed in many ways, including through the use of containers such as Docker,
+Spack, and your own build from source.
 
-This document describes the features, fixed issues, and information about downloading and installing the AMD ROCm™ software. It also covers known issues and deprecations in this release.
+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.
 
-- Supported Operating Environments and Documentation Updates
-  * [Supported Operating Environments](#Supported-Operating-Environments)
-  * [ROCm Installation Updates](#ROCm-Installation-Updates)
-  * [AMD ROCm Documentation Updates](#AMD-ROCm-Documentation-Updates)
+This repository contains the manifest file for ROCm™ releases, changelogs, and
+release information. The file default.xml contains information for all
+repositories and the associated commit used to build the current ROCm release.
 
-   
-- What\'s New in This Release
-  * [HIP Enhancements](#HIP-Enhancements)
-  * [Unified Memory Support in ROCm](#Unified-Memory-Support-in-ROCm)
-  * [System Management Interface](#System-Management-Interface) 
-  * [ROCm Math and Communication Libraries](#ROCm-Math-and-Communication-Libraries)
-  * [OpenMP Enhancements](#OpenMP-Enhancements)   
+The default.xml file uses the repo Manifest format.
 
-- Known Issues in This Release
-  * [Known Issues in This Release](#Known-Issues-in-This-Release)
+## How to build documentation via Sphinx
 
-- Deprecations in This Release
-  * [Deprecations](#Deprecations)
+```bash
+cd docs
 
-- [Hardware and Software Support](#Hardware-and-Software-Support)
-
-- [Machine Learning and High Performance Computing Software Stack for AMD GPU](#Machine-Learning-and-High-Performance-Computing-Software-Stack-for-AMD-GPU)
-  * [ROCm Binary Package Structure](#ROCm-Binary-Package-Structure)
-  * [ROCm Platform Packages](#ROCm-Platform-Packages)
-  
-
-
-
-# ROCm Installation Updates
-
-This document describes the features, fixed issues, and information
-about downloading and installing the AMD ROCm™ software.
-
-It also covers known issues and deprecations in this release.
-
-## Supported Operating Environments
-
-The AMD ROCm platform supports the following operating systems:
-
-| OS                | Kernel              |
-| ---               | ---                 |
-| SLES15 SP3        | 5.3.18-24.49        |
-| RHEL 7.9          | 3.10.0-1160.6.1.el7 |
-| CentOS 7.9        | 3.10.0-1127         |
-| RHEL 8.4          | 4.18.0-193.1.1.el8  |
-| CentOS 8.3        | 4.18.0-193.el8      |
-| Ubuntu 18.04.5    | 5.4.0-71-generic    |
-| Ubuntu 20.04.3HWE | 5.8.0-48-generic    |
-| Host OS           | Azure RS1.86        |
-| Guest OS          | Ubuntu 20.04        |
-
-
-
-## Enhanced Installation Process for ROCm v4.5
-
-In addition to the installation method using the native Package Manager, AMD ROCm v4.5 introduces added methods to install ROCm. With this
-release, the ROCm installation uses the *amdgpu-install* and *amdgpu-uninstall* scripts. 
-
-The *amdgpu-install* script streamlines the installation process by:
-
--   Abstracting the distribution-specific package installation logic
-
--   Performing the repository set-up
-
--   Allowing user to specify the use case and automating the installation of all the required packages,
-
--   Performing post-install checks to verify whether the installation was performed successfully
-
--   Installing the uninstallation script
-
-The *amdgpu-uninstall* script allows the removal of the entire ROCm stack by using a single command.
-
-Some of the ROCm-specific use cases that the installer currently supports are:
-
--   OpenCL (ROCr/KFD based) runtime
-
--   HIP runtimes
-
--   ROCm libraries and applications
-
--   ROCm Compiler and device libraries
-
--   ROCr runtime and thunk
-
-**Note:** Graphics use cases are not supported in this release.
-
-For more details, refer to the AMD ROCm Installation Guide v4.5 at,
-
-https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation_new.html
-
-
-# AMD ROCm Documentation Updates 
-
-## AMD ROCm Installation Guide 
-
-The AMD ROCm Installation Guide in this release includes the following
-updates:
-
--   New - Installation Guide for ROCm v4.5
-
-    https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation_new.html
-
-
-## AMD Instinct™ High Performance Computing and Tuning
-
-- New - AMD Instinct™ High Performance Computing and Tuning Guide 
-
-   https://github.com/RadeonOpenCompute/ROCm/blob/master/AMD%20Instinct%E2%84%A2High%20Performance%20Computing%20and%20Tuning%20Guide.pdf
-   
-   
-## HIP Documentation
-
--  HIP installation instructions
-
-   https://rocmdocs.amd.com/en/latest/Installation_Guide/HIP-Installation.html
-
--   HIP Programming Guide
-
-    https://github.com/RadeonOpenCompute/ROCm/blob/master/AMD_HIP_Programming_Guide.pdf
-
--   HIP API Guide
-
-    https://github.com/RadeonOpenCompute/ROCm/blob/master/AMD-HIP-API-4.5.pdf
-
--   HIP-Supported CUDA API Reference Guide
-
-    https://github.com/RadeonOpenCompute/ROCm/blob/master/AMD_HIP_Supported_CUDA_API_Reference_Guide.pdf
-
--   AMD ROCm Compiler Reference Guide
-
-    https://github.com/RadeonOpenCompute/ROCm/blob/master/AMD_Compiler_Reference_Guide_v4.5.pdf
-
--   HIP FAQ
-
-    <https://rocmdocs.amd.com/en/latest/Programming_Guides/HIP-FAQ.html#hip-faq>
-   
-
-## System Interface Management
-
--   System Interface Management (SMI)
-
-    https://rocmdocs.amd.com/en/latest/ROCm_System_Managment/ROCm-System-Managment.html
-    
-
-## AMD ROCm Data Center Tool
-
-- AMD ROCm Data Center Tool API Guide
-
-  https://github.com/RadeonOpenCompute/ROCm/blob/master/RDC_API_Manual_4.5.pdf
-  
-- AMD ROCm Data Center Tool User Guide
-
-  https://github.com/RadeonOpenCompute/ROCm/blob/master/AMD_ROCm_DataCenter_Tool_User_Guide_v4.5.pdf
-
-## ROCm SMI API Guide
-
--   ROCm SMI API Guide
-
-    https://github.com/RadeonOpenCompute/ROCm/blob/master/ROCm_SMI_Manual_4.5.pdf
-
-## ROC Debugger User and API Guide 
-
--   ROCDebugger User Guide
-
-    https://github.com/RadeonOpenCompute/ROCm/blob/master/ROCDebugger_User_Guide.pdf
-
--   Debugger API Guide
-
-    https://github.com/RadeonOpenCompute/ROCm/blob/master/ROCDebugger_API_Guide.pdf
-    
-## OpenMP Documentation
-
-- Updated OpenMP documentation 
-
-  https://rocmdocs.amd.com/en/latest/Programming_Guides/openmp_support.html
-  
-
-## AMD ROCm General Documentation Links
-
--   For AMD ROCm documentation, see
-
-    https://rocmdocs.amd.com/en/latest/
-
--   For installation instructions on supported platforms, see
-
-    https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html
-
--   For AMD ROCm binary structure, see
-
-    https://rocmdocs.amd.com/en/latest/Installation_Guide/Software-Stack-for-AMD-GPU.html
-
--   For AMD ROCm release history, see
-
-    https://rocmdocs.amd.com/en/latest/Current_Release_Notes/ROCm-Version-History.html
-
-
-# What's New in This Release 
-
-## HIP Enhancements
-
-The ROCm v4.5 release consists of the following HIP enhancements:
-
-### HIP Direct Dispatch
-
-The conventional producer-consumer model where the host thread(producer) enqueues commands to a command queue (per stream), which is then
-processed by a separate, per-stream worker thread (consumer) created by the runtime, is no longer applicable.
-
-In this release, for Direct Dispatch, the runtime directly queues a packet to the AQL queue (user mode queue to GPU) in Dispatch and some of
-the synchronization. This new functionality indicates the total latency of the HIP Dispatch API and the latency to launch the first wave on the
-GPU.
-
-In addition, eliminating the threads in runtime has reduced the variance in the dispatch numbers as the thread scheduling delays and
-atomics/locks synchronization latencies are reduced.
-
-This feature can be disabled by setting the following environment variable,
-
-```     
-     AMD_DIRECT_DISPATCH=0
+pip3 install -r sphinx/requirements.txt
 
+python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
 ```
 
-### Support for HIP Graph 
-
-ROCm v4.5 extends support for HIP Graph. For details, refer to the HIP
-API Guide at
-
-https://github.com/RadeonOpenCompute/ROCm/blob/master/AMD-HIP-API-4.5.pdf
-
-### Enhanced *launch_bounds* Check Error Log Message 
-
-When a kernel is launched with HIP APIs, for example, hipModuleLaunchKernel(), HIP validates to check that input kernel
-dimension size is not larger than specified launch_bounds.
-
-If exceeded, HIP returns launch failure if AMD_LOG_LEVEL is set with the proper value. Users can find more information in the error log message,
-including launch parameters of kernel dim size, launch bounds, and the name of the faulting kernel. It is helpful to figure out the faulting
-kernel. Besides, the kernel dim size and launch bounds values will also assist in debugging such failures.
-
-For more details, refer to the HIP Programming Guide at
-
-https://github.com/RadeonOpenCompute/ROCm/blob/master/AMD_HIP_Programming_Guide.pdf
-
-
-### HIP Runtime Compilation
-
-HIP now supports runtime compilation (hipRTC), the usage of which will provide the possibility of optimizations and performance improvement
-compared with other APIs via regular offline static compilation. 
-
-hipRTC APIs accept HIP source files in character string format as input parameters and create handles of programs by compiling the HIP source
-files without spawning separate processes.
-
-For more details on hipRTC APIs, refer to the HIP API Guide at
-
-https://github.com/RadeonOpenCompute/ROCm/blob/master/AMD-HIP-API-4.5.pdf
-
-### New Flag for Backwards Compatibility on float/double atomicAdd Function
-
-In the ROCm4.5 release, a new compilation flag is introduced as an
-option in the CMAKE file. This flag ensures backwards compatibility in
-float/double atomicAdd functions.
-
-```   
-     \_\_HIP_USE_CMPXCHG_FOR_FP_ATOMICS
-```   
-
-This compilation flag is not set("0") by default, so the HIP runtime uses the current float/double atomicAdd functions.
-
-If this compilation flag is set to "1" with the CMAKE option, the existing float/double atomicAdd functions is used for compatibility with
-compilers that do not support floating point atomics.
-
-```  
-     D\_\_HIP_USE_CMPXCHG_FOR_FP_ATOMICS=1
-```  
-For details on how to build the HIP runtime, refer to the HIP Programming Guide at
-
-https://github.com/RadeonOpenCompute/ROCm/blob/master/AMD_HIP_Programming_Guide.pdf
-
-
-
-### Updated HIP Version Definition
-
-The HIP version definition is updated as follows:
-
-```  
-     HIP_VERSION=HIP_VERSION_MAJOR \* 10000000 + HIP_VERSION_MINOR \*
-     100000 + HIP_VERSION_PATCH)
-```  
-
-The HIP version can be queried from the following HIP API call,
-
-```  
-     hipRuntimeGetVersion(&runtimeVersion);
-```  
-
-The version returned is always greater than the versions in the previous
-ROCm releases.
-
-**Note:** The version definition of the HIP runtime is different from that of CUDA. The function returns the HIP runtime version on the AMD
-platform, while on the NVIDIA platform, it returns the CUDA runtime version. There is no mapping or a correlation between the HIP and CUDA
-versions.
-
-
-
-### Planned HIP Enhancements and Fixes
-
-#### Changes to hiprtc implementation to match nvrtc behavior
-
-In this release, there are changes to the *hiprtc* implementation to
-match the *nvrtc* behavior.
-
-**Impact:** Applications can no longer explicitly include HIP runtime header files. Minor code changes are required to remove the HIP runtime
-header files.
-
-#### HIP device attribute enumeration
-
-In a future release, there will be a breaking change in the HIP device attribute enumeration. Enum values are being rearranged to accommodate
-future enhancements and additions.
-
-**Impact:** This will require users to rebuild their applications. No code changes are required.
-
-#### Changes to behavior of hipGetLastError() and hipPeekAtLastError() to match CUDA behavior available
-
-In a later release, changes to behavior of hipGetLastError() and hipPeekAtLastError() to match CUDA behavior will be available.
-
-**Impact:** Applications relying on the previous behavior will be impacted and may require some code changes.
-
-## Unified Memory Support in ROCm
-
-Unified memory allows applications to map and migrate data between CPU and GPU seamlessly without explicitly copying it between different
-allocations. This enables a more complete implementation of *hipMallocManaged*, *hipMemAdvise*, *hipMemPrefetchAsync* and related
-APIs. Without unified memory, these APIs only support system memory. With unified memory, the driver can automatically migrate such memory to
-GPU memory for faster access.
-
-### Supported Operating Systems and Versions
-
-This feature is only supported on recent Linux kernels. Currently, it works on Ubuntu versions with 5.6 or newer kernels and the DKMS driver
-from ROCm. Current releases of RHEL and SLES do not support this feature yet. Future releases of those distributions will add support for this.
-The unified memory feature is also supported in the KFD driver included with upstream kernels starting from Linux 5.14.
-
-Unified memory only works on GFXv9 and later GPUs, including Vega10 and MI100. Fiji, Polaris and older GPUs are not supported. To check whether
-unified memory is enabled, look in the kernel log for this message:
-
-```  
-     \$ dmesg \| grep \"HMM registered"
-```  
-
-If unified memory is enabled, there should be a message like "HMM registered xyzMB device memory". If unified memory is not supported on
-your GPU or kernel version, this message is missing.
-
-### Unified Memory Support and XNACK
-
-Unified memory support comes in two flavours, XNACK-enabled and XNACK-disabled. XNACK refers to the ability of the GPU to handle page
-faults gracefully and retry a memory access. In XNACK-enabled mode, the GPU can handle retry after page-faults, which enables mapping and
-migrating data on demand, as well as memory overcommitment. In XNACK-disabled mode, all memory must be resident and mapped in the GPU
-page tables when the GPU is executing application code. Any migrations involve temporary preemption of the GPU queues by the driver. Both page
-fault handling and preemptions, happen automatically and are transparent to the applications.
-
-XNACK-enabled mode only has experimental support. XNACK-enabled mode requires compiling shader code differently. By default, the ROCm
-compiler builds code that works in both modes. Code can be optimized for one specific mode with compiler options:
-
-OpenCL:
-
-```  
-     clang \... -mcpu=gfx908:***xnack+***:sramecc- \... // xnack on, sramecc off\
-     clang \... -mcpu=gfx908:***xnack-***:sramecc+ \... // xnack off, sramecc on
-```  
-
-HIP:
-```  
-     clang \... \--cuda-gpu-arch=gfx906:xnack+ \... // xnack on\
-     clang \... \--cuda-gpu-arch=gfx906:xnack- \... // xnack off
-```  
-Not all the math libraries included in ROCm support XNACK-enabled mode on current hardware. Applications will fail to run if their shaders are
-compiled in the incorrect mode.
-
-On current hardware, the XNACK mode can be chosen at boot-time by a module parameter amdgpu.noretry. The default is XNACK-disabled
-(amdgpu.noretry=1).
-
-## System Management Interface 
-
-### Enhanced ROCm SMI --setpoweroverdrive Functionality
-
-The ROCm System Management Interface (SMI) *--setpoweroverdrive* functionality is used to lower the power cap on a device without needing
-to enable the OverDrive functionality in the driver. Similarly, even with the OverDrive driver functionality enabled, it is possible to
-request a lower power cap than the card's default.
-
-Currently, any use of the *--setpoweroverdrive* functionality in rocm-smi prints an out-of-spec warning to the screen and requires the
-user to agree that using this functionality potentially voids their warranty. However, this warning should only be printed when users are
-trying to set the power cap to higher than the card's default, which requires the OverDrive driver functionality to be enabled.
-
-For example:
-
-The default power cap is 225.0W before any changes.
-
-```
-
-     \[atitest\@rhel85 smi\]\$ ./rocm_smi.py --resetpoweroverdrive
-     ======================= ROCm System Management Interface =======================
-
-     ========================== Reset GPU Power OverDrive ===========================
-
-     GPU\[0\] : Successfully reset Power OverDrive to: 225W
-     ============================ End of ROCm SMI Log ============================
-
-     Now, after using --setpoweroverdrive to lower the power cap to 123
-     watts:
-
-     \[atitest\@rhel85 smi\]\$ ./rocm_smi.py --setpoweroverdrive 123
-     ======================= ROCm System Management Interface =======================
-
-     =========================== Set GPU Power OverDrive ============================
-
-     GPU\[0\] : Successfully set power to: 123W
-     ======================= End of ROCm SMI Log ==============================
-
-     Setting a power cap lower than the default of 225.0W (in this case,
-     123W) does not give a warning.
-
-     To verify that the power is set to the correct value:
-
-     \[atitest\@rhel85 smi\]\$ ./rocm_smi.py --showmaxpower
-     ======================= ROCm System Management Interface =======================
-
-     ======================== Power Cap ===================================
-
-     GPU\[0\] : Max Graphics Package Power (W): 123.0
-     ========================End of ROCm SMI Log ==============================
-```
-
-
-## OpenMP Enhancements
-
-The ROCm installation includes an LLVM-based implementation, which fully
-supports OpenMP 4.5 standard and a subset of the OpenMP 5.0 standard.
-Fortran and C/C++ compilers and corresponding runtime libraries are
-included. Along with host APIs, the OpenMP compilers support offloading
-code and data onto GPU devices.
-
-For more information, refer to
-
-<https://rocmdocs.amd.com/en/latest/Programming_Guides/openmp_support.html>
-
-## ROCm Math and Communication Libraries
-
-In this release, ROCm Math and Communication Libraries consists of the
-following enhancements and fixes:
-
-| Library   | Changes                                                  |
-| ---       | ---                                                      |
-| rocBLAS | **Optimizations** <ul><li>Improved performance of non-batched and batched syr for all sizes and data types</li><li>Improved performance of non-batched and batched hemv for all sizes and data types</li><li>Improved performance of non-batched and batched symv for all sizes and data types</li><li>Improved memory utilization in rocblas-bench, rocblas-test gemm functions, increasing possible runtime sizes.</li></ul>**Changes** <ul><li>Update from C++14 to C++17.</li>  <li>Packaging split into a runtime package (called rocblas) and a development package (called rocblas-dev for .deb packages, and rocblas-devel for .rpm packages). The development package depends on runtime. The runtime package suggests the development package for all supported OSes except CentOS 7 to aid in the transition. The 'suggest' feature in packaging is introduced as a deprecated feature and will be removed in a future ROCm release.</li></ul> **Fixed**<ul><li>For function geam avoid overflow in offset calculation.</li>  <li> For function syr avoid overflow in offset calculation.</li> <li>For function gemv (Transpose-case) avoid overflow in offset calculation.</li> <li>For functions ssyrk and dsyrk, allow conjugate-transpose case to match legacy BLAS. Behavior is the same as the transpose case.</li></ul> |
-| hipBLAS| **Added**<ul><li>More support for hipblas-bench</li></ul>**Fixed**<ul><li>Avoid large offset overflow for gemv and hemv in hipblas-test</li></ul>**Changed**<ul><li>Packaging split into a runtime package called hipblas and a development package called hipblas-devel. The development package depends on runtime. The runtime package suggests the development package for all supported OSes except CentOS 7 to aid in the transition. The 'suggests' feature in packaging is a transitional feature and will be removed in a future rocm release.</li></ul> |
-| rocFFT | **Optimizations**<ul><li>Optimized SBCC kernels of length 52, 60, 72, 80, 84, 96, 104, 108, 112, 160, 168, 208, 216, 224, 240 with new kernel generator.</li></ul>**Added**<ul><li>Split 2D device code into separate libraries.</li> </ul>**Changed**<ul><li>Packaging split into a runtime package called rocfft and a development package called rocfft-devel. The development package depends on runtime. The runtime package suggests the development package for all supported OSes except CentOS 7 to aid in the transition. The suggests feature in packaging is introduced as a deprecated feature and will be removed in a future rocm release.</li></ul>**Fixed**<ul><li>Fixed a few validation failures of even-length R2C inplace. 2D, 3D cubics sizes such as 100^2 (or ^3), 200^2 (or ^3), 256^2 (or ^3)...etc. We don't combine the three kernels (stockham-r2c-transpose). We only combine two kernels (r2c-transpose) instead.</li></ul> |
-| hipFFT | **Changed**  <ul><li>Packaging split into a runtime package called hipfft and a development package called hipfft-devel. The development package depends on runtime. The runtime package suggests the development package for all supported OSes except CentOS 7 to aid in the transition. The 'suggests' feature in packaging is a transitional feature and will be removed in a future rocm release.</li></ul> |
-| rocSPARSE | **Added** <ul><li>Triangular solve for multiple right-hand sides using BSR format</li> <li>SpMV for BSRX format</li> <li>SpMM in CSR format enhanced to work with transposed A</li> <li>Matrix coloring for CSR matrices </li><li>Added batched tridiagonal solve (gtsv_strided_batch)</li></ul> **Improved** <ul><li>Fixed a bug with gemvi on Navi21 </li><li>Optimization for pivot based gtsv</li></ul> |
-| hipSPARSE | **Added** <ul><li>Triangular solve for multiple right-hand sides using BSR format</li> <li>SpMV for BSRX format</li> <li>SpMM in CSR format enhanced to work with transposed A</li> <li>Matrix coloring for CSR matrices </li>  <li>Added batched tridiagonal solve (gtsv_strided_batch)</li></ul> **Improved** <ul><li>Fixed a bug with gemvi on Navi21</li> <li>Optimization for pivot based gtsv</li></ul> |
-| rocALUTION | **Changed** <ul><li>Packaging split into a runtime package called rocalution and a development package called rocalution-devel. The development package depends on runtime. The runtime package suggests the development package for all supported OSes except CentOS 7 to aid in the transition. The 'suggests' feature in packaging is a transitional feature and will be removed in a future rocm release.</li></ul> **Improved** <ul><li>(A)MG solving phase optimization</li></ul> |
-| rocTHRUST | **Changed**  <ul><li>Packaging changed to a development package (called rocthrust-dev for .deb packages, and rocthrust-devel for .rpm packages). As rocThrust is a header-only library, there is no runtime package. To aid in the transition, the development package sets the "provides" field to provide the package rocthrust, so that existing packages depending on rocthrust can continue to work. The 'provides' feature is a transitional feature and will be removed in a future ROCm release.</li></ul> |
-| rocSOLVER | **Added** <ul><li>RQ factorization routines:</li><li>GERQ2, GERQF (with batched and strided_batchedversions)</li>  <li>Linear solvers for general square systems:</li> <li>GESV (with batched and strided_batched versions)</li><li>Linear solvers for symmetric/hermitian positive definite systems:</li> <li>POTRS (with batched and strided_batched versions)</li> <li>POSV (with batched and strided_batched versions) </li> <li>Inverse of symmetric/hermitian positive definite matrices:</li><li>POTRI (with batched and strided_batched versions)</li> <li>General matrix inversion without pivoting:  </li>  <li>GETRI_NPVT (with batched and strided_batched versions)</li> <li>GETRI_NPVT_OUTOFPLACE (with batched and  strided_batched versions)</li></ul>**Optimized**<ul><li>Improved performance of LU factorization (especially for large matrix sizes)</li> <li>Changed</li>  <li>Raised reference LAPACK version used for rocSOLVER test and benchmark clients to v3.9.1</li>  <li>Minor CMake improvements for users building from source without install.sh:</li> <li>Removed fmt::fmt from rocsolver\'s public usage requirements</li> <li>Enabled small-size optimizations by default </li>  <li>Split packaging into a runtime package ('rocsolver') and a development package ('rocsolver-devel'). The development package depends on the runtime package. To aid in the transition, the runtime package suggests the development package (except on CentOS 7). This use of the 'suggests feature' is transitional and will be removed in a future ROCm release.</li></ul> **Fixed** <ul><li>Use of the GCC / Clang __attribute__((deprecated(...))) extension is now guarded by compiler detection macros. |
-| hipSOLVER | The following functions were added in this release:<ul><li>gesv</li><ul><li>hipsolverSSgesv_bufferSize, hipsolverDDgesv_bufferSize, hipsolverCCgesv_bufferSize, hipsolverZZgesv_bufferSize</li><li>hipsolverSSgesv, hipsolverDDgesv, hipsolverCCgesv, hipsolverZZgesv</li></ul><li>potrs</li><ul><li>hipsolverSpotrs_bufferSize, hipsolverDpotrs_bufferSize, hipsolverCpotrs_bufferSize, hipsolverZpotrs_bufferSize</li><li>hipsolverSpotrs, hipsolverDpotrs, hipsolverCpotrs, hipsolverZpotrs</li></ul><li>potrsBatched</li><ul><li>hipsolverSpotrsBatched_bufferSize, hipsolverDpotrsBatched_bufferSize, hipsolverCpotrsBatched_bufferSize, hipsolverZpotrsBatched_bufferSize</li><li>hipsolverSpotrsBatched, hipsolverDpotrsBatched, hipsolverCpotrsBatched, hipsolverZpotrsBatched</li></ul><li>potri</li><ul><li>hipsolverSpotri_bufferSize, hipsolverDpotri_bufferSize, hipsolverCpotri_bufferSize, hipsolverZpotri_bufferSize</li><li>hipsolverSpotri, hipsolverDpotri, hipsolverCpotri, hipsolverZpotri</li></ul></ul></li></ul> |
-| RCCL | **Added** <ul><li>Compatibility with NCCL 2.9.9 </li></ul>**Changed**  <ul><li>Packaging split into a runtime package called rccl and a development package called rccl-devel. The development package depends on runtime. The runtime package suggests the development package for all supported OSes except CentOS 7 to aid in the transition. The 'suggests' feature in packaging is a tranistional feature and will be removed in a future rocm release.</li></ul> |
-| hipCUB | **Changed**  <ul><li>Packaging changed to a development package (called hipcub-dev for .deb packages, and hipcub-devel for .rpm packages). As hipCUB is a header-only library, there is no runtime package. To aid in the transition, the development package sets the "provides" field to provide the package hipcub, so that existing packages depending on hipcub can continue to work. This provides feature is introduced as a deprecated feature and will be removed in a future ROCm release.</li></ul> |
-| rocPRIM| **Added** <ul><li>bfloat16 support added.</li></ul> **Changed**  <ul><li>Packaging split into a runtime package called rocprim and a development package called rocprim-devel. The development package depends on runtime. The runtime package suggests the development package for all supported OSes except CentOS 7 to aid in the transition. The suggests feature in packaging is introduced as a deprecated feature and will be removed in a future rocm release.</li> <li>As rocPRIM is a header-only library, the runtime package is an empty placeholder used to aid in the transition. This package is also a deprecated feature and will be removed in a future rocm release.</li></ul> **Deprecated** <ul><li>The warp_size() function is now deprecated; please switch to host_warp_size() and device_warp_size() for host and device references respectively.</li></ul> |
-| rocRAND| **Changed**  <ul><li>Packaging split into a runtime package called rocrand and a development package called rocrand-devel. The development package depends on runtime. The runtime package suggests the development package for all supported OSes except CentOS 7 to aid in the transition. The suggests feature in packaging is introduced as a deprecated feature and will be removed in a future rocm release.</li></ul> **Fixed** <ul><li>Fix for mrg_uniform_distribution_double generating incorrect range of values</li> <li>Fix for order of state calls for log_normal, normal, and uniform</li></ul> **Known issues**  <ul><li>kernel_xorwow test is failing for certain GPU architectures.</li></ul> |
-
-For more information about ROCm Libraries, refer to the documentation at
-
-<https://rocmdocs.amd.com/en/latest/ROCm_Libraries/ROCm_Libraries.html>
-
-# Known Issues in This Release 
-
-The following are the known issues in this release.
-
-## clinfo and rocminfo Do Not Display Marketing Name
-
-clinfo and rocminfo display a blank field for Marketing Name. 
-
-This is due to a missing package that is not yet available from ROCm. This package will be distributed in future ROCm releases.
-
-## Compiler Support for Function Pointers and Virtual Functions
-
-A known issue in the compiler support for function pointers and virtual functions on the GPU may cause undefined behavior due to register
-corruption. 
-
-A temporary workaround is to compile the affected application with this option:
-
-```
-     -mllvm -amdgpu-fixed-function-abi=1
-     
- ```
-
-**Note:** This is an internal compiler flag and may be removed without notice once the issue is addressed in a future release.
-
-
-## Debugger Process Exit May Cause ROCgdb Internal Error
-
-If the debugger process exits during debugging, ROCgdb may report internal errors. This issue occurs as it attempts to access the AMD GPU
-state for the exited process. To recover, users must restart ROCgdb.
- 
-As a workaround, users can set breakpoints to prevent the debugged process from exiting. For example, users can set breakpoints at the last
-statement of the main function and in the abort() and exit() functions. This temporary solution allows the application to be re-run without
-restarting ROCgdb.
-
-This issue is currently under investigation and will be fixed in a future release.
-
-For more information, refer to the ROCgdb User Guide at,
-
-https://github.com/RadeonOpenCompute/ROCm/blob/master/ROCDebugger_User_Guide.pdf
-
-## Cache Issues with ROCProfiler
-
-When the same kernel is launched back-to-back multiple times on a GPU, a cache flush is executed each time the kernel finishes when profiler data is collected. The cache flush is inserted by ROCprofiler for each kernel. This prevents kernel from being cached, instead it is being read each time it is launched. As a result the cache hit rate from rocprofiler is reported as 0% or very low.
-
-This issue is under investigation and will be fixed in a future release. 
-
-## Stability Issue on LAMMPS-KOKKOS Applications
-
-On mGPU machines, lammps-kokkos applications experience a stability issue (AMD Instinct MI100™). 
-
-As a workaround, perform a Translation LookAside Buffer (TLB) flush. 
-
-The issue is under active investigation and will be resolved in a future release.
-
-
-
-# Deprecations
-
-## AMD Instinct MI25 End of Life
-
-ROCm release v4.5 is the final release to support AMD Instinct MI25. AMD Instinct MI25 has reached End of Life (EOL). ROCm 4.5 represents the
-last certified release for software and driver support. AMD will continue to provide technical support and issue resolution for AMD
-Instinct MI25 on ROCm v4.5 for a period of 12 months from the software GA date. 
-
-## Planned Deprecation for Code Object Versions 2 and 3 
-
-With the ROCm v4.5 release, the generation of code object versions 2 and 3 is being deprecated and may be removed in a future release. This deprecation notice does not impact support for the execution of AMD GPU code object versions.
-
-The -mcode-object-version Clang option can be used to instruct the compiler to generate a specific AMD GPU code object version. In ROCm v4.5, the compiler can generate AMD GPU code object version 2, 3, and 4, with version 4 being the default if not specified. 
-
-
-
-# Deploying ROCm
-
-AMD hosts both Debian and RPM repositories for the ROCm packages. 
-
-For more information on ROCM installation on all platforms, see
-
-https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html
-
-
-# Machine Learning and High Performance Computing Software Stack for AMD GPU
-
-For an updated version of the software stack for AMD GPU, see
-
-https://rocmdocs.amd.com/en/latest/Installation_Guide/Software-Stack-for-AMD-GPU.html
-
-
-
-# Hardware and Software Support
-ROCm is focused on using AMD GPUs to accelerate computational tasks such as machine learning, engineering workloads, and scientific computing.
-In order to focus our development efforts on these domains of interest, ROCm supports a targeted set of hardware configurations which are detailed further in this section.
-
-**Note:** The AMD ROCm™ open software platform is a compute stack for headless system deployments. GUI-based software applications are currently not supported.
-
-#### Supported GPUs
-Because the ROCm Platform has a focus on particular computational domains, we offer official support for a selection of AMD GPUs that are designed to offer good performance and price in these domains.
-
-**Note:** The integrated GPUs of Ryzen are not officially supported targets for ROCm.
-
-ROCm officially supports AMD GPUs that use following chips:
-
-* GFX9 GPUs
-
-  - "Vega 10" chips, such as on the AMD Radeon RX Vega 64 and Radeon Instinct MI25
-  
-  - "Vega 7nm" chips, such as on the Radeon Instinct MI50, Radeon Instinct MI60 or AMD Radeon VII, Radeon Pro VII
-
-* CDNA GPUs
-
-  - MI100 chips such as on the AMD Instinct™ MI100
-
-
-ROCm is a collection of software ranging from drivers and runtimes to libraries and developer tools.
-Some of this software may work with more GPUs than the "officially supported" list above, though AMD does not make any official claims of support for these devices on the ROCm software platform.
-
-The following list of GPUs are enabled in the ROCm software, though full support is not guaranteed:
-
-  * GFX8 GPUs
-    * "Polaris 11" chips, such as on the AMD Radeon RX 570 and Radeon Pro WX 4100
-    * "Polaris 12" chips, such as on the AMD Radeon RX 550 and Radeon RX 540
-  * GFX7 GPUs
-    * "Hawaii" chips, such as the AMD Radeon R9 390X and FirePro W9100
-
-As described in the next section, GFX8 GPUs require PCI Express 3.0 (PCIe 3.0) with support for PCIe atomics. This requires both CPU and motherboard support. GFX9 GPUs require PCIe 3.0 with support for PCIe atomics by default, but they can operate in most cases without this capability.
-
-The integrated GPUs in AMD APUs are not officially supported targets for ROCm.
-As described [below](#limited-support), "Carrizo", "Bristol Ridge", and "Raven Ridge" APUs are enabled in our upstream drivers and the ROCm OpenCL runtime.
-However, they are not enabled in the HIP runtime, and may not work due to motherboard or OEM hardware limitations.
-As such, they are not yet officially supported targets for ROCm.
-
-For a more detailed list of hardware support, please see [the following documentation](https://en.wikipedia.org/wiki/List_of_AMD_graphics_processing_units).
-
-#### Supported CPUs
-As described above, GFX8 GPUs require PCIe 3.0 with PCIe atomics in order to run ROCm.
-In particular, the CPU and every active PCIe point between the CPU and GPU require support for PCIe 3.0 and PCIe atomics.
-The CPU root must indicate PCIe AtomicOp Completion capabilities and any intermediate switch must indicate PCIe AtomicOp Routing capabilities.
-
-Current CPUs which support PCIe Gen3 + PCIe Atomics are:
-
-  * AMD Ryzen CPUs
-  * The CPUs in AMD Ryzen APUs
-  * AMD Ryzen Threadripper CPUs
-  * AMD EPYC CPUs
-  * Intel Xeon E7 v3 or newer CPUs
-  * Intel Xeon E5 v3 or newer CPUs
-  * Intel Xeon E3 v3 or newer CPUs
-  * Intel Core i7 v4, Core i5 v4, Core i3 v4 or newer CPUs (i.e. Haswell family or newer)
-  * Some Ivy Bridge-E systems
-
-Beginning with ROCm 1.8, GFX9 GPUs (such as Vega 10) no longer require PCIe atomics.
-We have similarly opened up more options for number of PCIe lanes.
-GFX9 GPUs can now be run on CPUs without PCIe atomics and on older PCIe generations, such as PCIe 2.0.
-This is not supported on GPUs below GFX9, e.g. GFX8 cards in the Fiji and Polaris families.
-
-If you are using any PCIe switches in your system, please note that PCIe Atomics are only supported on some switches, such as Broadcom PLX.
-When you install your GPUs, make sure you install them in a PCIe 3.1.0 x16, x8, x4, or x1 slot attached either directly to the CPU's Root I/O controller or via a PCIe switch directly attached to the CPU's Root I/O controller.
-
-In our experience, many issues stem from trying to use consumer motherboards which provide physical x16 connectors that are electrically connected as e.g. PCIe 2.0 x4, PCIe slots connected via the Southbridge PCIe I/O controller, or PCIe slots connected through a PCIe switch that does
-not support PCIe atomics.
-
-If you attempt to run ROCm on a system without proper PCIe atomic support, you may see an error in the kernel log (`dmesg`):
-```
-kfd: skipped device 1002:7300, PCI rejects atomics
-```
-
-Experimental support for our Hawaii (GFX7) GPUs (Radeon R9 290, R9 390, FirePro W9100, S9150, S9170)
-does not require or take advantage of PCIe Atomics. However, we still recommend that you use a CPU
-from the list provided above for compatibility purposes.
-
-#### Not supported or limited support under ROCm
-
-##### Limited support
-
-* ROCm 4.x should support PCIe 2.0 enabled CPUs such as the AMD Opteron, Phenom, Phenom II, Athlon, Athlon X2, Athlon II and older Intel Xeon and Intel Core Architecture and Pentium CPUs. However, we have done very limited testing on these configurations, since our test farm has been catering to CPUs listed above. This is where we need community support. _If you find problems on such setups, please report these issues_.
-* Thunderbolt 1, 2, and 3 enabled breakout boxes should now be able to work with ROCm. Thunderbolt 1 and 2 are PCIe 2.0 based, and thus are only supported with GPUs that do not require PCIe 3.1.0 atomics (e.g. Vega 10). However, we have done no testing on this configuration and would need community support due to limited access to this type of equipment.
-* AMD "Carrizo" and "Bristol Ridge" APUs are enabled to run OpenCL, but do not yet support HIP or our libraries built on top of these compilers and runtimes.
-  * As of ROCm 2.1, "Carrizo" and "Bristol Ridge" require the use of upstream kernel drivers.
-  * In addition, various "Carrizo" and "Bristol Ridge" platforms may not work due to OEM and ODM choices when it comes to key configurations parameters such as inclusion of the required CRAT tables and IOMMU configuration parameters in the system BIOS.
-  * Before purchasing such a system for ROCm, please verify that the BIOS provides an option for enabling IOMMUv2 and that the system BIOS properly exposes the correct CRAT table. Inquire with your vendor about the latter.
-* AMD "Raven Ridge" APUs are enabled to run OpenCL, but do not yet support HIP or our libraries built on top of these compilers and runtimes.
-  * As of ROCm 2.1, "Raven Ridge" requires the use of upstream kernel drivers.
-  * In addition, various "Raven Ridge" platforms may not work due to OEM and ODM choices when it comes to key configurations parameters such as inclusion of the required CRAT tables and IOMMU configuration parameters in the system BIOS.
-  * Before purchasing such a system for ROCm, please verify that the BIOS provides an option for enabling IOMMUv2 and that the system BIOS properly exposes the correct CRAT table. Inquire with your vendor about the latter.
-
-##### Not supported
-
-* "Tonga", "Iceland", "Vega M", and "Vega 12" GPUs are not supported.
-* We do not support GFX8-class GPUs (Fiji, Polaris, etc.) on CPUs that do not have PCIe 3.0 with PCIe atomics.
-  * As such, we do not support AMD Carrizo and Kaveri APUs as hosts for such GPUs.
-  * Thunderbolt 1 and 2 enabled GPUs are not supported by GFX8 GPUs on ROCm. Thunderbolt 1 & 2 are based on PCIe 2.0.
-
-In the default ROCm configuration, GFX8 and GFX9 GPUs require PCI Express 3.0 with PCIe atomics. The ROCm platform leverages these advanced capabilities to allow features such as user-level submission of work from the host to the GPU. This includes PCIe atomic Fetch and Add, Compare and Swap, Unconditional Swap, and AtomicOp Completion.
-
-#### ROCm support in upstream Linux kernels
-
-As of ROCm 1.9.0, the ROCm user-level software is compatible with the AMD drivers in certain upstream Linux kernels.
-As such, users have the option of either using the ROCK kernel driver that are part of AMD's ROCm repositories or using the upstream driver and only installing ROCm user-level utilities from AMD's ROCm repositories.
-
-These releases of the upstream Linux kernel support the following GPUs in ROCm:
- * 4.17: Fiji, Polaris 10, Polaris 11
- * 4.18: Fiji, Polaris 10, Polaris 11, Vega10
- * 4.20: Fiji, Polaris 10, Polaris 11, Vega10, Vega 7nm
-
-The upstream driver may be useful for running ROCm software on systems that are not compatible with the kernel driver available in AMD's repositories.
-For users that have the option of using either AMD's or the upstreamed driver, there are various tradeoffs to take into consideration:
-
-|   | Using AMD's `rock-dkms` package | Using the upstream kernel driver |
-| ---- | ------------------------------------------------------------| ----- |
-| Pros | More GPU features, and they are enabled earlier | Includes the latest Linux kernel features |
-|      | Tested by AMD on supported distributions | May work on other distributions and with custom kernels |
-|      | Supported GPUs enabled regardless of kernel version | |
-|      | Includes the latest GPU firmware | |
-| Cons | May not work on all Linux distributions or versions | Features and hardware support varies depending on kernel version |
-|      | Not currently supported on kernels newer than 5.4 | Limits GPU's usage of system memory to 3/8 of system memory (before 5.6). For 5.6 and beyond, both DKMS and upstream kernels allow use of 15/16 of system memory. |
-|      |   | IPC and RDMA capabilities are not yet enabled |
-|      |   | Not tested by AMD to the same level as `rock-dkms` package |
-|      |   | Does not include most up-to-date firmware |
-
-
-# Disclaimer
-
-The information presented in this document is for informational purposes only and may contain technical inaccuracies, omissions, and typographical errors.  The information contained herein is subject to change and may be rendered inaccurate for many reasons, including but not limited to product and roadmap changes, component and motherboard versionchanges, new  model and/or product releases, product differences between differing manufacturers, software changes, BIOS flashes, firmware upgrades, or the like. Any computer system has risks of security vulnerabilities that cannot be completely prevented or mitigated.AMD  assumes  no  obligation  to  update  or  otherwise  correct  or  revise  this  information.  However, AMD reserves the right to revise this information and to make changes from time to time to the content hereof without obligation of AMD to notify any person of such revisions or changes.THIS INFORMATION IS PROVIDED ‘AS IS.” AMD MAKES NO REPRESENTATIONS OR WARRANTIES WITH RESPECT  TO  THE  CONTENTS  HEREOF  AND  ASSUMES  NO  RESPONSIBILITY  FOR  ANY  INACCURACIES, ERRORS, OR OMISSIONS THAT MAY APPEAR IN THIS INFORMATION. AMD SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR ANY PARTICULAR PURPOSE.  IN NO EVENT WILL AMD BE LIABLE TO ANY PERSON FOR ANY RELIANCE, DIRECT, INDIRECT, SPECIAL,  OR  OTHER  CONSEQUENTIAL  DAMAGES  ARISING  FROM  THE  USE  OF  ANY  INFORMATION CONTAINED HEREIN, EVEN IF AMD IS EXPRESSLY ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.AMD,  the  AMD  Arrow  logo,[insert  all  other  AMD  trademarks  used  in  the  material  here  perAMD Trademarks]and combinations thereof are trademarks of Advanced Micro Devices, Inc.Other product names  used  in  this  publication  are  for  identification  purposes  only  and  may  be  trademarks  of  their respective  companies. [Insert  any  third  party  trademark  attribution  here  per  AMD'sThird  Party Trademark List.]
-©[2021]Advanced Micro Devices, Inc.All rights reserved.
-
-Third-party Disclaimer
-Third-party content is licensed to you directly by the third party that owns the content and is not licensed to you by AMD.  ALL LINKED THIRD-PARTY CONTENT IS PROVIDED “AS IS” WITHOUT A WARRANTY OF ANY KIND.  USE OF SUCH THIRD-PARTY CONTENT IS DONE AT YOUR SOLE DISCRETION AND UNDER NO CIRCUMSTANCES WILL AMD BE LIABLE TO YOU FOR ANY THIRD-PARTY CONTENT.  YOU ASSUME ALL RISK AND ARE SOLELY RESPONSIBLE FOR ANY DAMAGES THAT MAY ARISE FROM YOUR USE OF THIRD-PARTY CONTENT. 
-
-
-
-## Disclaimer
-Third-party content is licensed to you directly by the third party that owns the content and is not licensed to you by AMD.  ALL LINKED THIRD-PARTY CONTENT IS PROVIDED “AS IS” WITHOUT A WARRANTY OF ANY KIND.  USE OF SUCH THIRD-PARTY CONTENT IS DONE AT YOUR SOLE DISCRETION AND UNDER NO CIRCUMSTANCES WILL AMD BE LIABLE TO YOU FOR ANY THIRD-PARTY CONTENT.  YOU ASSUME ALL RISK AND ARE SOLELY RESPONSIBLE FOR ANY DAMAGES THAT MAY ARISE FROM YOUR USE OF THIRD-PARTY CONTENT.
-
+## Older ROCm™ Releases
 
+For release information for older ROCm™ releases, refer to
+[CHANGELOG](./CHANGELOG.md).

RELEASE.md

@@ -0,0 +1,693 @@
+# Release Notes
+<!-- Do not edit this file! This file is autogenerated with -->
+<!--   tools/autotag/tag_script.py                          -->
+
+<!-- Disable lints since this is an auto-generated file.    -->
+<!-- markdownlint-disable blanks-around-headers             -->
+<!-- markdownlint-disable no-duplicate-header               -->
+<!-- markdownlint-disable no-blanks-blockquote              -->
+<!-- markdownlint-disable ul-indent                         -->
+<!-- markdownlint-disable no-trailing-spaces                -->
+
+<!-- spellcheck-disable -->
+
+The release notes for the ROCm platform.
+
+-------------------
+
+## ROCm 5.5.0
+<!-- markdownlint-disable first-line-h1 -->
+<!-- markdownlint-disable no-duplicate-header -->
+### What's New in This Release
+
+#### HIP Enhancements
+
+The ROCm v5.5 release consists of the following HIP enhancements:
+
+##### Enhanced Stack Size Limit
+
+In this release, the stack size limit is increased from 16k to 131056 bytes (or 128K - 16).
+Applications requiring to update the stack size can use hipDeviceSetLimit API.
+
+##### `hipcc` Changes
+
+The following hipcc changes are implemented in this release:
+
+- `hipcc` will not implicitly link to `libpthread` and `librt`, as they are no longer a link time dependence for HIP programs.  Applications that depend on these libraries must explicitly link to them.
+- `-use-staticlib` and `-use-sharedlib` options are deprecated.
+
+##### Future Changes
+
+- Separation of `hipcc` binaries (Perl scripts) from HIP to `hipcc` project. Users will access separate `hipcc` package for installing `hipcc` binaries in future ROCm releases.
+- In a future ROCm release, the following samples will be removed from the `hip-tests` project.
+  - `hipBusbandWidth` at <https://github.com/ROCm-Developer-Tools/hip-tests/tree/develop/samples/1_Utils/shipBusBandwidth>
+  - `hipCommander` at <https://github.com/ROCm-Developer-Tools/hip-tests/tree/develop/samples/1_Utils/hipCommander>
+
+  Note that the samples will continue to be available in previous release branches.
+
+##### New HIP APIs in This Release
+
+> **Note**
+>
+> This is a pre-official version (beta) release of the new APIs and may contain unresolved issues.
+
+###### Memory Management HIP APIs
+
+The new memory management HIP API is as follows:
+
+- Sets information on the specified pointer [BETA].
+
+  ```h
+  hipError_t hipPointerSetAttribute(const void* value, hipPointer_attribute attribute, hipDeviceptr_t ptr);
+  ```
+
+###### Module Management HIP APIs
+
+The new module management HIP APIs are as follows:
+
+- Launches kernel $f$ with launch parameters and shared memory on stream with arguments passed to `kernelParams`, where thread blocks can cooperate and synchronize as they execute.
+
+  ```h
+  hipError_t hipModuleLaunchCooperativeKernel(hipFunction_t f, unsigned int gridDimX, unsigned int gridDimY, unsigned int gridDimZ, unsigned int blockDimX, unsigned int blockDimY, unsigned int blockDimZ, unsigned int sharedMemBytes, hipStream_t stream, void** kernelParams);
+  ```
+
+- Launches kernels on multiple devices where thread blocks can cooperate and synchronize as they execute.
+
+  ```h
+  hipError_t hipModuleLaunchCooperativeKernelMultiDevice(hipFunctionLaunchParams* launchParamsList, unsigned int numDevices, unsigned int flags);
+  ```
+
+###### HIP Graph Management APIs
+
+The new HIP Graph Management APIs are as follows:
+
+- Creates a memory allocation node and adds it to a graph [BETA]
+
+  ```h
+  hipError_t hipGraphAddMemAllocNode(hipGraphNode_t* pGraphNode, hipGraph_t graph, const hipGraphNode_t* pDependencies, size_t numDependencies, hipMemAllocNodeParams* pNodeParams);
+  ```
+
+- Return parameters for memory allocation node [BETA]
+
+  ```h
+  hipError_t hipGraphMemAllocNodeGetParams(hipGraphNode_t node, hipMemAllocNodeParams* pNodeParams);
+  ```
+
+- Creates a memory free node and adds it to a graph [BETA]
+
+  ```h
+  hipError_t hipGraphAddMemFreeNode(hipGraphNode_t* pGraphNode, hipGraph_t graph, const hipGraphNode_t* pDependencies, size_t numDependencies, void* dev_ptr);
+  ```
+
+- Returns parameters for memory free node [BETA].
+
+  ```h
+  hipError_t hipGraphMemFreeNodeGetParams(hipGraphNode_t node, void* dev_ptr);
+  ```
+
+- Write a DOT file describing graph structure [BETA].
+
+  ```h
+  hipError_t hipGraphDebugDotPrint(hipGraph_t graph, const char* path, unsigned int flags);
+  ```
+
+- Copies attributes from source node to destination node [BETA].
+
+  ```h
+  hipError_t hipGraphKernelNodeCopyAttributes(hipGraphNode_t hSrc, hipGraphNode_t hDst);
+  ```
+
+- Enables or disables the specified node in the given graphExec [BETA]
+
+  ```h
+  hipError_t hipGraphNodeSetEnabled(hipGraphExec_t hGraphExec, hipGraphNode_t hNode, unsigned int isEnabled);
+  ```
+
+- Query whether a node in the given graphExec is enabled [BETA]
+
+  ```h
+  hipError_t hipGraphNodeGetEnabled(hipGraphExec_t hGraphExec, hipGraphNode_t hNode, unsigned int* isEnabled);
+  ```
+
+##### OpenMP Enhancements
+This release consists of the following OpenMP enhancements:
+
+- Additional support for OMPT functions `get_device_time` and `get_record_type`.
+- Add support for min/max fast fp atomics on AMD GPUs.
+- Fix the use of the abs function in C device regions.
+
+### Deprecations and Warnings
+
+#### HIP Deprecation
+
+The `hipcc` and `hipconfig` Perl scripts are deprecated. In a future release, compiled binaries will be available as `hipcc.bin` and `hipconfig.bin` as replacements for the Perl scripts.
+
+> **Note**
+>
+> There will be a transition period where the Perl scripts and compiled binaries are available  before the scripts are removed. There will be no functional difference between the Perl scripts and their compiled binary counterpart. No user action is required. Once these are available, users can optionally switch to `hipcc.bin` and `hipconfig.bin`. The `hipcc`/`hipconfig` soft link will be assimilated to point from `hipcc`/`hipconfig` to the respective compiled binaries as the default option.
+
+##### Linux Filesystem Hierarchy Standard for ROCm
+
+ROCm packages have adopted the Linux foundation filesystem hierarchy standard in this release to ensure ROCm components follow open source conventions for Linux-based distributions. While moving to a new filesystem hierarchy, ROCm ensures backward compatibility with its 5.1 version or older filesystem hierarchy. See below for a detailed explanation of the new filesystem hierarchy and backward compatibility.
+
+##### New Filesystem Hierarchy
+
+The following is the new filesystem hierarchy:4
+
+```text
+/opt/rocm-<ver>
+    | --bin
+      | --All externally exposed Binaries
+    | --libexec
+        | --<component>
+            | -- Component specific private non-ISA executables (architecture independent)
+    | --include
+        | -- <component>
+            | --<header files>
+    | --lib
+        | --lib<soname>.so -> lib<soname>.so.major -> lib<soname>.so.major.minor.patch
+            (public libraries linked with application)
+        | --<component> (component specific private library, executable data)
+        | --<cmake>
+            | --components
+                | --<component>.config.cmake
+    | --share
+        | --html/<component>/*.html
+        | --info/<component>/*.[pdf, md, txt]
+        | --man
+        | --doc
+            | --<component>
+                | --<licenses>
+        | --<component>
+            | --<misc files> (arch independent non-executable)
+            | --samples
+
+```
+
+> **Note**
+>
+> ROCm will not support backward compatibility with the v5.1(old) file system hierarchy in its next major release.
+
+For more information, refer to <https://refspecs.linuxfoundation.org/fhs.shtml>.
+
+##### Backward Compatibility with Older Filesystems
+
+ROCm has moved header files and libraries to its new location as indicated in the above structure and included symbolic-link and wrapper header files in its old location for backward compatibility.
+
+> **Note**
+>
+> ROCm will continue supporting backward compatibility until the next major release.
+
+##### Wrapper header files
+
+Wrapper header files are placed in the old location (`/opt/rocm-xxx/<component>/include`) with a warning message to include files from the new location (`/opt/rocm-xxx/include`) as shown in the example below:
+
+```h
+// Code snippet from hip_runtime.h
+#pragma message “This file is deprecated. Use file from include path /opt/rocm-ver/include/ and prefix with hip”.
+#include "hip/hip_runtime.h"
+```
+
+The wrapper header files’ backward compatibility deprecation is as follows:
+
+- `#pragma` message announcing deprecation -- ROCm v5.2 release
+- `#pragma` message changed to `#warning` -- Future release
+- `#warning` changed to `#error` -- Future release
+- Backward compatibility wrappers removed -- Future release
+
+##### Library files
+
+Library files are available in the `/opt/rocm-xxx/lib` folder. For backward compatibility, the old library location (`/opt/rocm-xxx/<component>/lib`) has a soft link to the library at the new location.
+
+Example:
+
+```log
+$ ls -l /opt/rocm/hip/lib/
+total 4
+drwxr-xr-x 4 root root 4096 May 12 10:45 cmake
+lrwxrwxrwx 1 root root   24 May 10 23:32 libamdhip64.so -> ../../lib/libamdhip64.so
+```
+
+##### CMake Config files
+
+All CMake configuration files are available in the `/opt/rocm-xxx/lib/cmake/<component>` folder.
+For backward compatibility, the old CMake locations (`/opt/rocm-xxx/<component>/lib/cmake`) consist of a soft link to the new CMake config.
+
+Example:
+
+```log
+$ ls -l /opt/rocm/hip/lib/cmake/hip/
+total 0
+lrwxrwxrwx 1 root root 42 May 10 23:32 hip-config.cmake -> ../../../../lib/cmake/hip/hip-config.cmake
+```
+
+#### ROCm Support For Code Object V3 Deprecated
+
+Support for Code Object v3 is deprecated and will be removed in a future release.
+
+#### Comgr V3.0 Changes
+
+The following APIs and macros have been marked as deprecated. These are expected to be removed in a future ROCm release and coincides with the release of Comgr v3.0.
+
+##### API Changes
+
+- `amd_comgr_action_info_set_options()`
+- `amd_comgr_action_info_get_options()`
+
+##### Actions and Data Types
+
+- `AMD_COMGR_ACTION_ADD_DEVICE_LIBRARIES`
+- `AMD_COMGR_ACTION_COMPILE_SOURCE_TO_FATBIN`
+
+For replacements, see the `AMD_COMGR_ACTION_INFO_GET`/`SET_OPTION_LIST APIs`, and the `AMD_COMGR_ACTION_COMPILE_SOURCE_(WITH_DEVICE_LIBS)_TO_BC` macros.
+
+#### Deprecated Environment Variables
+
+The following environment variables are removed in this ROCm release:
+
+- `GPU_MAX_COMMAND_QUEUES`
+- `GPU_MAX_WORKGROUP_SIZE_2D_X`
+- `GPU_MAX_WORKGROUP_SIZE_2D_Y`
+- `GPU_MAX_WORKGROUP_SIZE_3D_X`
+- `GPU_MAX_WORKGROUP_SIZE_3D_Y`
+- `GPU_MAX_WORKGROUP_SIZE_3D_Z`
+- `GPU_BLIT_ENGINE_TYPE`
+- `GPU_USE_SYNC_OBJECTS`
+- `AMD_OCL_SC_LIB`
+- `AMD_OCL_ENABLE_MESSAGE_BOX`
+- `GPU_FORCE_64BIT_PTR`
+- `GPU_FORCE_OCL20_32BIT`
+- `GPU_RAW_TIMESTAMP`
+- `GPU_SELECT_COMPUTE_RINGS_ID`
+- `GPU_USE_SINGLE_SCRATCH`
+- `GPU_ENABLE_LARGE_ALLOCATION`
+- `HSA_LOCAL_MEMORY_ENABLE`
+- `HSA_ENABLE_COARSE_GRAIN_SVM`
+- `GPU_IFH_MODE`
+- `OCL_SYSMEM_REQUIREMENT`
+- `OCL_CODE_CACHE_ENABLE`
+- `OCL_CODE_CACHE_RESET`
+
+### Known Issues In This Release
+
+The following are the known issues in this release.
+
+#### `DISTRIBUTED`/`TEST_DISTRIBUTED_SPAWN` Fails
+
+When user applications call `ncclCommAbort` to destruct communicators and then create new
+communicators repeatedly, subsequent communicators may fail to initialize.
+
+This issue is under investigation and will be resolved in a future release.
+
+#### Failures In HIP Directed Tests
+
+Multiple HIP directed tests fail.
+
+### Library Changes in ROCM 5.5.0
+
+| Library | Version |
+|---------|---------|
+| hipBLAS | 0.53.0 ⇒ [0.54.0](https://github.com/ROCmSoftwarePlatform/hipBLAS/releases/tag/rocm-5.5.0) |
+| hipCUB | 2.13.0 ⇒ [2.13.1](https://github.com/ROCmSoftwarePlatform/hipCUB/releases/tag/rocm-5.5.0) |
+| hipFFT | 1.0.10 ⇒ [1.0.11](https://github.com/ROCmSoftwarePlatform/hipFFT/releases/tag/rocm-5.5.0) |
+| hipSOLVER | 1.6.0 ⇒ [1.7.0](https://github.com/ROCmSoftwarePlatform/hipSOLVER/releases/tag/rocm-5.5.0) |
+| hipSPARSE | 2.3.3 ⇒ [2.3.5](https://github.com/ROCmSoftwarePlatform/hipSPARSE/releases/tag/rocm-5.5.0) |
+| rccl | 2.13.4 ⇒ [2.15.5](https://github.com/ROCmSoftwarePlatform/rccl/releases/tag/rocm-5.5.0) |
+| rocALUTION | 2.1.3 ⇒ [2.1.8](https://github.com/ROCmSoftwarePlatform/rocALUTION/releases/tag/rocm-5.5.0) |
+| rocBLAS | 2.46.0 ⇒ [2.47.0](https://github.com/ROCmSoftwarePlatform/rocBLAS/releases/tag/rocm-5.5.0) |
+| rocFFT | 1.0.21 ⇒ [1.0.22](https://github.com/ROCmSoftwarePlatform/rocFFT/releases/tag/rocm-5.5.0) |
+| rocPRIM | 2.12.0 ⇒ [2.13.0](https://github.com/ROCmSoftwarePlatform/rocPRIM/releases/tag/rocm-5.5.0) |
+| rocRAND | 2.10.16 ⇒ [2.10.17](https://github.com/ROCmSoftwarePlatform/rocRAND/releases/tag/rocm-5.5.0) |
+| rocSOLVER | 3.20.0 ⇒ [3.21.0](https://github.com/ROCmSoftwarePlatform/rocSOLVER/releases/tag/rocm-5.5.0) |
+| rocSPARSE | 2.4.0 ⇒ [2.5.1](https://github.com/ROCmSoftwarePlatform/rocSPARSE/releases/tag/rocm-5.5.0) |
+| rocThrust | [2.17.0](https://github.com/ROCmSoftwarePlatform/rocThrust/releases/tag/rocm-5.5.0) |
+| rocWMMA | 0.9 ⇒ [1.0](https://github.com/ROCmSoftwarePlatform/rocWMMA/releases/tag/rocm-5.5.0) |
+| Tensile | 4.35.0 ⇒ [4.36.0](https://github.com/ROCmSoftwarePlatform/Tensile/releases/tag/rocm-5.5.0) |
+
+#### hipBLAS 0.54.0
+
+hipBLAS 0.54.0 for ROCm 5.5.0
+
+##### Added
+
+- added option to opt-in to use __half for hipblasHalf type in the API for c++ users who define HIPBLAS_USE_HIP_HALF
+- added scripts to plot performance for multiple functions
+- data driven hipblas-bench and hipblas-test execution via external yaml format data files
+- client smoke test added for quick validation using command hipblas-test --yaml hipblas_smoke.yaml
+
+##### Fixed
+
+- fixed datatype conversion functions to support more rocBLAS/cuBLAS datatypes
+- fixed geqrf to return successfully when nullptrs are passed in with n == 0 || m == 0
+- fixed getrs to return successfully when given nullptrs with corresponding size = 0
+- fixed getrs to give info = -1 when transpose is not an expected type
+- fixed gels to return successfully when given nullptrs with corresponding size = 0
+- fixed gels to give info = -1 when transpose is not in (&#39;N&#39;, &#39;T&#39;) for real cases or not in (&#39;N&#39;, &#39;C&#39;) for complex cases
+
+##### Changed
+
+- changed reference code for Windows to OpenBLAS
+- hipblas client executables all now begin with hipblas- prefix
+
+#### hipCUB 2.13.1
+
+hipCUB 2.13.1 for ROCm 5.5.0
+
+##### Added
+
+- Benchmarks for `BlockShuffle`, `BlockLoad`, and `BlockStore`.
+
+##### Changed
+
+- CUB backend references CUB and Thrust version 1.17.2.
+- Improved benchmark coverage of `BlockScan` by adding `ExclusiveScan`, benchmark coverage of `BlockRadixSort` by adding `SortBlockedToStriped`, and benchmark coverage of `WarpScan` by adding `Broadcast`.
+
+##### Fixed
+
+- Windows HIP SDK support
+
+##### Known Issues
+
+- `BlockRadixRankMatch` is currently broken under the rocPRIM backend.
+- `BlockRadixRankMatch` with a warp size that does not exactly divide the block size is broken under the CUB backend.
+
+#### hipFFT 1.0.11
+
+hipFFT 1.0.11 for ROCm 5.5.0
+
+##### Fixed
+
+- Fixed old version rocm include/lib folders not removed on upgrade.
+
+#### hipSOLVER 1.7.0
+
+hipSOLVER 1.7.0 for ROCm 5.5.0
+
+##### Added
+
+- Added functions
+  - gesvdj
+    - hipsolverSgesvdj_bufferSize, hipsolverDgesvdj_bufferSize, hipsolverCgesvdj_bufferSize, hipsolverZgesvdj_bufferSize
+    - hipsolverSgesvdj, hipsolverDgesvdj, hipsolverCgesvdj, hipsolverZgesvdj
+  - gesvdjBatched
+    - hipsolverSgesvdjBatched_bufferSize, hipsolverDgesvdjBatched_bufferSize, hipsolverCgesvdjBatched_bufferSize, hipsolverZgesvdjBatched_bufferSize
+    - hipsolverSgesvdjBatched, hipsolverDgesvdjBatched, hipsolverCgesvdjBatched, hipsolverZgesvdjBatched
+
+#### hipSPARSE 2.3.5
+
+hipSPARSE 2.3.5 for ROCm 5.5.0
+
+##### Improved
+
+- Fixed an issue, where the rocm folder was not removed on upgrade of meta packages
+- Fixed a compilation issue with cusparse backend
+- Added more detailed messages on unit test failures due to missing input data
+- Improved documentation
+- Fixed a bug with deprecation messages when using gcc9 (Thanks @Maetveis)
+
+#### rccl 2.15.5
+
+RCCL 2.15.5 for ROCm 5.5.0
+
+##### Changed
+
+- Compatibility with NCCL 2.15.5
+- Unit test executable renamed to rccl-UnitTests
+
+##### Added
+
+- HW-topology aware binary tree implementation
+- Experimental support for MSCCL
+- New unit tests for hipGraph support
+- NPKit integration
+
+##### Fixed
+
+- rocm-smi ID conversion
+- Support for HIP_VISIBLE_DEVICES for unit tests
+- Support for p2p transfers to non (HIP) visible devices
+
+##### Removed
+
+- Removed TransferBench from tools.  Exists in standalone repo: https://github.com/ROCmSoftwarePlatform/TransferBench
+
+#### rocALUTION 2.1.8
+
+rocALUTION 2.1.8 for ROCm 5.5.0
+
+##### Added
+
+- Added build support for Navi32
+
+##### Improved
+
+- Fixed a typo in MPI backend
+- Fixed a bug with the backend when HIP support is disabled
+- Fixed a bug in SAAMG hierarchy building on HIP backend
+- Improved SAAMG hierarchy build performance on HIP backend
+
+##### Changed
+
+- LocalVector::GetIndexValues(ValueType\*) is deprecated, use LocalVector::GetIndexValues(const LocalVector&amp;, LocalVector\*) instead
+- LocalVector::SetIndexValues(const ValueType\*) is deprecated, use LocalVector::SetIndexValues(const LocalVector&amp;, const LocalVector&amp;) instead
+- LocalMatrix::RSDirectInterpolation(const LocalVector&amp;, const LocalVector&amp;, LocalMatrix\*, LocalMatrix\*) is deprecated, use LocalMatrix::RSDirectInterpolation(const LocalVector&amp;, const LocalVector&amp;, LocalMatrix\*) instead
+- LocalMatrix::RSExtPIInterpolation(const LocalVector&amp;, const LocalVector&amp;, bool, float, LocalMatrix\*, LocalMatrix\*) is deprecated, use LocalMatrix::RSExtPIInterpolation(const LocalVector&amp;, const LocalVector&amp;, bool, LocalMatrix\*) instead
+- LocalMatrix::RugeStueben() is deprecated
+- LocalMatrix::AMGSmoothedAggregation(ValueType, const LocalVector&amp;, const LocalVector&amp;, LocalMatrix\*, LocalMatrix\*, int) is deprecated, use LocalMatrix::AMGAggregation(ValueType, const LocalVector&amp;, const LocalVector&amp;, LocalMatrix\*, int) instead
+- LocalMatrix::AMGAggregation(const LocalVector&amp;, LocalMatrix\*, LocalMatrix\*) is deprecated, use LocalMatrix::AMGAggregation(const LocalVector&amp;, LocalMatrix\*) instead
+
+#### rocBLAS 2.47.0
+
+rocBLAS 2.47.0 for ROCm 5.5.0
+
+##### Added
+
+- added functionality rocblas_geam_ex for matrix-matrix minimum operations
+- added HIP Graph support as beta feature for rocBLAS Level 1, Level 2, and Level 3(pointer mode host) functions
+- added beta features API. Exposed using compiler define ROCBLAS_BETA_FEATURES_API
+- added support for vector initialization in the rocBLAS test framework with negative increments
+- added windows build documentation for forthcoming support using ROCm HIP SDK
+- added scripts to plot performance for multiple functions
+
+##### Optimizations
+
+- improved performance of Level 2 rocBLAS GEMV for float and double precision. Performance enhanced by 150-200% for certain problem sizes when (m==n) measured on a gfx90a GPU.
+- improved performance of Level 2 rocBLAS GER for float, double and complex float precisions. Performance enhanced by 5-7% for certain problem sizes measured on a gfx90a GPU.
+- improved performance of Level 2 rocBLAS SYMV for float and double precisions. Performance enhanced by 120-150% for certain problem sizes measured on both gfx908 and gfx90a GPUs.
+
+##### Fixed
+
+- fixed setting of executable mode on client script rocblas_gentest.py to avoid potential permission errors with clients rocblas-test and rocblas-bench
+- fixed deprecated API compatibility with Visual Studio compiler
+- fixed test framework memory exception handling for Level 2 functions when the host memory allocation exceeds the available memory
+
+##### Changed
+
+- install.sh internally runs rmake.py (also used on windows) and rmake.py may be used directly by developers on linux (use --help)
+- rocblas client executables all now begin with rocblas- prefix
+
+##### Removed
+
+- install.sh removed options -o --cov as now Tensile will use the default COV format, set by cmake define Tensile_CODE_OBJECT_VERSION=default
+
+#### rocFFT 1.0.22
+
+rocFFT 1.0.22 for ROCm 5.5.0
+
+##### Optimizations
+
+- Improved performance of 1D lengths &lt; 2048 that use Bluestein&#39;s algorithm.
+- Reduced time for generating code during plan creation.
+- Optimized 3D R2C/C2R lengths 32, 84, 128.
+- Optimized batched small 1D R2C/C2R cases.
+
+##### Added
+
+- Added gfx1101 to default AMDGPU_TARGETS.
+
+##### Changed
+
+- Moved client programs to C++17.
+- Moved planar kernels and infrequently used Stockham kernels to be runtime-compiled.
+- Moved transpose, real-complex, Bluestein, and Stockham kernels to library kernel cache.
+
+##### Fixed
+
+- Removed zero-length twiddle table allocations, which fixes errors from hipMallocManaged.
+- Fixed incorrect freeing of HIP stream handles during twiddle computation when multiple devices are present.
+
+#### rocPRIM 2.13.0
+
+rocPRIM 2.13.0 for ROCm 5.5.0
+
+##### Added
+
+- New block level `radix_rank` primitive.
+- New block level `radix_rank_match` primitive.
+
+##### Changed
+
+- Improved the performance of `block_radix_sort` and `device_radix_sort`.
+
+##### Known Issues
+
+- Disabled GPU error messages relating to incorrect warp operation usage with Navi GPUs on Windows, due to GPU printf performance issues on Windows.
+
+##### Fixed
+
+- Fixed benchmark build on Windows
+
+#### rocRAND 2.10.17
+
+rocRAND 2.10.17 for ROCm 5.5.0
+
+##### Added
+
+- MT19937 pseudo random number generator based on M. Matsumoto and T. Nishimura, 1998, Mersenne Twister: A 623-dimensionally equidistributed uniform pseudorandom number generator.
+- New benchmark for the device API using Google Benchmark, `benchmark_rocrand_device_api`, replacing `benchmark_rocrand_kernel`. `benchmark_rocrand_kernel` is deprecated and will be removed in a future version. Likewise, `benchmark_curand_host_api` is added to replace `benchmark_curand_generate` and `benchmark_curand_device_api` is added to replace `benchmark_curand_kernel`.
+- experimental HIP-CPU feature
+- ThreeFry pseudorandom number generator based on Salmon et al., 2011, &#34;Parallel random numbers: as easy as 1, 2, 3&#34;.
+
+##### Changed
+
+- Python 2.7 is no longer officially supported.
+
+##### Fixed
+
+- Windows HIP SDK support
+
+#### rocSOLVER 3.21.0
+
+rocSOLVER 3.21.0 for ROCm 5.5.0
+
+##### Added
+
+- SVD for general matrices using Jacobi algorithm:
+    - GESVDJ (with batched and strided\_batched versions)
+- LU factorization without pivoting for block tridiagonal matrices:
+    - GEBLTTRF_NPVT (with batched and strided\_batched versions)
+- Linear system solver without pivoting for block tridiagonal matrices:
+    - GEBLTTRS_NPVT (with batched and strided\_batched, versions)
+- Product of triangular matrices
+    - LAUUM
+- Added experimental hipGraph support for rocSOLVER functions
+
+##### Optimized
+
+- Improved the performance of SYEVJ/HEEVJ.
+
+##### Changed
+
+- STEDC, SYEVD/HEEVD and SYGVD/HEGVD now use fully implemented Divide and Conquer approach.
+
+##### Fixed
+
+- SYEVJ/HEEVJ should now be invariant under matrix scaling.
+- SYEVJ/HEEVJ should now properly output the eigenvalues when no sweeps are executed.
+- Fixed GETF2\_NPVT and GETRF\_NPVT input data initialization in tests and benchmarks.
+- Fixed rocblas missing from the dependency list of the rocsolver deb and rpm packages.
+
+#### rocSPARSE 2.5.1
+
+rocSPARSE 2.5.1 for ROCm 5.5.0
+
+##### Added
+
+- Added bsrgemm and spgemm for BSR format
+- Added bsrgeam
+- Added build support for Navi32
+- Added experimental hipGraph support for some rocSPARSE routines
+- Added csritsv, spitsv csr iterative triangular solve
+- Added mixed precisions for SpMV
+- Added batched SpMM for transpose A in COO format with atomic atomic algorithm
+
+##### Improved
+
+- Optimization to csr2bsr
+- Optimization to csr2csr_compress
+- Optimization to csr2coo
+- Optimization to gebsr2csr
+- Optimization to csr2gebsr
+- Fixes to documentation
+- Fixes a bug in COO SpMV gridsize
+- Fixes a bug in SpMM gridsize when using very large matrices
+
+##### Known Issues
+
+- In csritlu0, the algorithm rocsparse_itilu0_alg_sync_split_fusion has some accuracy issues to investigate with XNACK enabled. The fallback is rocsparse_itilu0_alg_sync_split.
+
+#### rocWMMA 1.0
+
+rocWMMA 1.0 for ROCm 5.5.0
+
+##### Added
+
+- Added support for wave32 on gfx11+
+- Added infrastructure changes to support hipRTC
+- Added performance tracking system
+
+##### Changed
+
+- Modified the assignment of hardware information
+- Modified the data access for unsigned datatypes
+- Added library config to support multiple architectures
+
+#### Tensile 4.36.0
+
+Tensile 4.36.0 for ROCm 5.5.0
+
+##### Added
+
+- Add functions for user-driven tuning
+- Add GFX11 support: HostLibraryTests yamls, rearragne FP32(C)/FP64(C) instruction order, archCaps for instruction renaming condition, adjust vgpr bank for A/B/C for optimize, separate vscnt and vmcnt, dual mac
+- Add binary search for Grid-Based algorithm
+- Add reject condition for (StoreCInUnroll + BufferStore=0) and (DirectToVgpr + ScheduleIterAlg&lt;3 + PrefetchGlobalRead==2)
+- Add support for (DirectToLds + hgemm + NN/NT/TT) and (DirectToLds + hgemm + GlobalLoadVectorWidth &lt; 4)
+- Add support for (DirectToLds + hgemm(TLU=True only) or sgemm + NumLoadsCoalesced &gt; 1)
+- Add GSU SingleBuffer algorithm for HSS/BSS
+- Add gfx900:xnack-, gfx1032, gfx1034, gfx1035
+- Enable gfx1031 support
+
+##### Optimizations
+
+- Use AssertSizeLessThan for BufferStoreOffsetLimitCheck if it is smaller than MT1
+- Improve InitAccVgprOpt
+
+##### Changed
+
+- Use global_atomic for GSU instead of flat and global_store for debug code
+- Replace flat_load/store with global_load/store
+- Use global_load/store for BufferLoad/Store=0 and enable scheduling
+- LocalSplitU support for HGEMM+HPA when MFMA disabled
+- Update Code Object Version
+- Type cast local memory to COMPUTE_DATA_TYPE in LDS to avoid precision loss
+- Update asm cap cache arguments
+- Unify SplitGlobalRead into ThreadSeparateGlobalRead and remove SplitGlobalRead
+- Change checks, error messages, assembly syntax, and coverage for DirectToLds
+- Remove unused cmake file
+- Clean up the LLVM dependency code
+- Update ThreadSeparateGlobalRead test cases for PrefetchGlobalRead=2
+- Update sgemm/hgemm test cases for DirectToLds and ThreadSepareteGlobalRead
+
+##### Fixed
+
+- Add build-id to header of compiled source kernels
+- Fix solution index collisions
+- Fix h beta vectorwidth4 correctness issue for WMMA
+- Fix an error with BufferStore=0
+- Fix mismatch issue with (StoreCInUnroll + PrefetchGlobalRead=2)
+- Fix MoveMIoutToArch bug
+- Fix flat load correctness issue on I8 and flat store correctness issue
+- Fix mismatch issue with BufferLoad=0 + TailLoop for large array sizes
+- Fix code generation error with BufferStore=0 and StoreCInUnrollPostLoop
+- Fix issues with DirectToVgpr + ScheduleIterAlg&lt;3
+- Fix mismatch issue with DGEMM TT + LocalReadVectorWidth=2
+- Fix mismatch issue with PrefetchGlobalRead=2
+- Fix mismatch issue with DirectToVgpr + PrefetchGlobalRead=2 + small tile size
+- Fix an error with PersistentKernel=0 + PrefetchAcrossPersistent=1 + PrefetchAcrossPersistentMode=1
+- Fix mismatch issue with DirectToVgpr + DirectToLds + only 1 iteration in unroll loop case
+- Remove duplicate GSU kernels: for GSU = 1, GSUAlgorithm SingleBuffer and MultipleBuffer kernels are identical
+- Fix for failing CI tests due to CpuThreads=0
+- Fix mismatch issue with DirectToLds + PrefetchGlobalRead=2
+- Remove the reject condition for ThreadSeparateGlobalRead and DirectToLds (HGEMM, SGEMM only)
+- Modify reject condition for minimum lanes of ThreadSeparateGlobalRead (SGEMM or larger data type only)

default.xml

@@ -12,7 +12,7 @@ fetch="https://github.com/GPUOpen-ProfessionalCompute-Libraries/" />
 fetch="https://github.com/GPUOpen-Tools/" />
     <remote name="KhronosGroup"
 fetch="https://github.com/KhronosGroup/" />
-    <default revision="refs/tags/rocm-4.5.0"
+    <default revision="refs/tags/rocm-5.5.1"
      remote="roc-github"
      sync-c="true"
      sync-j="4" />
@@ -21,6 +21,7 @@ fetch="https://github.com/KhronosGroup/" />
     <project name="ROCT-Thunk-Interface" />
     <project name="ROCR-Runtime" />
     <project name="rocm_smi_lib" />
+    <project name="rocm-core" />
     <project name="rocm-cmake" />
     <project name="rocminfo" />
     <project name="rocprofiler" remote="rocm-devtools" />
@@ -34,6 +35,7 @@ fetch="https://github.com/KhronosGroup/" />
     <project name="HIP-Examples" remote="rocm-devtools" />
     <project name="ROCclr" remote="rocm-devtools" />
     <project name="HIPIFY" remote="rocm-devtools" />
+    <project name="HIPCC" remote="rocm-devtools" />
 <!-- The following projects are all associated with the AMDGPU LLVM compiler -->
     <project name="llvm-project" />
     <project name="ROCm-Device-Libs" />
@@ -48,25 +50,25 @@ fetch="https://github.com/KhronosGroup/" />
     <project name="ROCdbgapi" remote="rocm-devtools" />
 <!-- ROCm Libraries -->
     <project name="rdc" />
-    <project name="rocBLAS" remote="rocm-swplat" />
-    <project name="Tensile" remote="rocm-swplat" />
-    <project name="hipBLAS" remote="rocm-swplat" />
-    <project name="rocFFT" remote="rocm-swplat" />
-    <project name="hipFFT" remote="rocm-swplat" />
-    <project name="rocRAND" remote="rocm-swplat" />
-    <project name="rocSPARSE" remote="rocm-swplat" />
-    <project name="rocSOLVER" remote="rocm-swplat" />
-    <project name="hipSOLVER" remote="rocm-swplat" />
-    <project name="hipSPARSE" remote="rocm-swplat" />
-    <project name="rocALUTION" remote="rocm-swplat" />
+    <project groups="mathlibs" name="rocBLAS" remote="rocm-swplat" />
+    <project groups="mathlibs" name="Tensile" remote="rocm-swplat" />
+    <project groups="mathlibs" name="hipBLAS" remote="rocm-swplat" />
+    <project groups="mathlibs" name="rocFFT" remote="rocm-swplat" />
+    <project groups="mathlibs" name="hipFFT" remote="rocm-swplat" />
+    <project groups="mathlibs" name="rocRAND" remote="rocm-swplat" />
+    <project groups="mathlibs" name="rocSPARSE" remote="rocm-swplat" />
+    <project groups="mathlibs" name="rocSOLVER" remote="rocm-swplat" />
+    <project groups="mathlibs" name="hipSOLVER" remote="rocm-swplat" />
+    <project groups="mathlibs" name="hipSPARSE" remote="rocm-swplat" />
+    <project groups="mathlibs" name="rocALUTION" remote="rocm-swplat" />
     <project name="MIOpenGEMM" remote="rocm-swplat" />
     <project name="MIOpen" remote="rocm-swplat" />
-    <project name="MIOpenTensile" remote="rocm-swplat" />
-    <project name="rccl" remote="rocm-swplat" />
+    <project groups="mathlibs" name="rccl" remote="rocm-swplat" />
     <project name="MIVisionX" remote="gpuopen-libs" />
-    <project name="rocThrust" remote="rocm-swplat" />
-    <project name="hipCUB" remote="rocm-swplat" />
-    <project name="rocPRIM" remote="rocm-swplat" />
+    <project groups="mathlibs" name="rocThrust" remote="rocm-swplat" />
+    <project groups="mathlibs" name="hipCUB" remote="rocm-swplat" />
+    <project groups="mathlibs" name="rocPRIM" remote="rocm-swplat" />
+    <project groups="mathlibs" name="rocWMMA" remote="rocm-swplat" />
     <project name="hipfort" remote="rocm-swplat" />
     <project name="AMDMIGraphX" remote="rocm-swplat" />
     <project name="ROCmValidationSuite" remote="rocm-devtools" />

docs/404.md

@@ -0,0 +1,6 @@
+# 404 Page Not Found
+
+Page could not be found.
+
+Return to [home](./index) or please use the links from the sidebar to find what
+you are looking for.

docs/about.md

@@ -0,0 +1,74 @@
+# About ROCm Documentation
+
+ROCm documentation is made available under open source [licenses](licensing.md).
+Documentation is built using open source toolchains. Contributions to our
+documentation is encouraged and welcome. As a contributor, please familiarize
+yourself with our documentation toolchain.
+
+## ReadTheDocs
+
+[ReadTheDocs](https://docs.readthedocs.io/en/stable/) is our front end for the
+our documentation. By front end, this is the tool that serves our HTML based
+documentation to our end users.
+
+## Doxygen
+
+[Doxygen](https://www.doxygen.nl/) is the most common inline code documentation
+standard. ROCm projects are use Doxygen for public API documentation (unless the
+upstream project is using a different tool).
+
+## Sphinx
+
+[Sphinx](https://www.sphinx-doc.org/en/master/) is a documentation generator
+originally used for python. It is now widely used in the Open Source community.
+Originally, sphinx supported RST based documentation. Markdown support is now
+available. ROCm documentation plans to default to markdown for new projects.
+Existing projects using RST are under no obligation to convert to markdown. New
+projects that believe markdown is not suitable should contact the documentation
+team prior to selecting RST.
+
+### MyST
+
+[Markedly Structured Text (MyST)](https://myst-tools.org/docs/spec) is an extended
+flavor of Markdown ([CommonMark](https://commonmark.org/)) influenced by reStructuredText (RST) and Sphinx.
+It is integrated via [`myst-parser`](https://myst-parser.readthedocs.io/en/latest/).
+A cheat sheet that showcases how to use the MyST syntax is available over at [the Jupyter
+reference](https://jupyterbook.org/en/stable/reference/cheatsheet.html).
+
+### Sphinx Theme
+
+ROCm is using the
+[Sphinx Book Theme](https://sphinx-book-theme.readthedocs.io/en/latest/). This
+theme is used by Jupyter books. ROCm documentation applies some customization
+include a header and footer on top of the Sphinx Book Theme. A future custom
+ROCm theme will be part of our documentation goals.
+
+### Sphinx Design
+
+Sphinx Design is an extension for sphinx based websites that add design
+functionality. Please see the documentation
+[here](https://sphinx-design.readthedocs.io/en/latest/index.html). ROCm
+documentation uses sphinx design for grids, cards, and synchronized tabs.
+Other features may be used in the future.
+
+### Sphinx External TOC
+
+ROCm uses the
+[sphinx-external-toc](https://sphinx-external-toc.readthedocs.io/en/latest/intro.html)
+for our navigation. This tool allows a YAML file based left navigation menu. This
+tool was selected due to its flexibility that allows scripts to operate on the
+YAML file. Please transition to this file for the project's navigation. You can
+see the `_toc.yml.in` file in this repository in the docs/sphinx folder for an
+example.
+
+### Breathe
+
+Sphinx uses [Breathe](https://www.breathe-doc.org/) to integrate Doxygen
+content.
+
+## `rocm-docs-core` pip package
+
+[rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) is an AMD
+maintained project that applies customization for our documentation. This
+project is the tool most ROCm repositories will use as part of the documentation
+build.

docs/conf.py

@@ -0,0 +1,90 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+import shutil
+shutil.copy2('../CONTRIBUTING.md','./contributing.md')
+shutil.copy2('../RELEASE.md','./release.md')
+
+
+from rocm_docs import ROCmDocs
+
+# working anchors that linkcheck cannot find
+linkcheck_anchors_ignore = [
+    'd90e61', 
+    'd1667e113', 
+    'd2999e60', 
+    'building-from-source', 
+    'use-the-rocm-build-tool-rbuild', 
+    'use-cmake-to-build-migraphx', 
+    'example'
+]
+linkcheck_ignore = [
+    # site to be built
+    "https://rocmdocs.amd.com/projects/ROCmCC/en/latest/", 
+    "https://rocmdocs.amd.com/projects/amdsmi/en/latest/",
+    "https://rocmdocs.amd.com/projects/rdc/en/latest/",
+    "https://rocmdocs.amd.com/projects/rocmsmi/en/latest/", 
+    "https://rocmdocs.amd.com/projects/roctracer/en/latest/",
+    "https://rocmdocs.amd.com/projects/MIGraphX/en/latest/",
+    "https://rocmdocs.amd.com/projects/rocprofiler/en/latest/",
+    # correct links that linkcheck times out on
+    "https://github.com/ROCm-Developer-Tools/HIP-VS/blob/master/README.md",
+    r"https://www.amd.com/system/files/.*.pdf",
+    "https://www.amd.com/en/developer/aocc.html",
+    "https://www.amd.com/en/support/linux-drivers",
+    "https://www.amd.com/en/technologies/infinity-hub",
+    r"https://bitbucket.org/icl/magma/*",
+    "http://cs231n.stanford.edu/"
+]
+
+setting_all_article_info = True
+all_article_info_os = ["linux"]
+all_article_info_author = ""
+
+# pages with specific settings
+article_pages = [
+    {"file":"deploy/linux/index", "os":["linux"]},
+    {"file":"deploy/linux/install_overview", "os":["linux"]},
+    {"file":"deploy/linux/prerequisites", "os":["linux"]},
+    {"file":"deploy/linux/quick_start", "os":["linux"]},
+    {"file":"deploy/linux/install", "os":["linux"]},
+    {"file":"deploy/linux/upgrade", "os":["linux"]},
+    {"file":"deploy/linux/uninstall", "os":["linux"]},
+    {"file":"deploy/linux/package_manager_integration", "os":["linux"]},
+    {"file":"deploy/docker", "os":["linux"]},
+    
+    {"file":"release/gpu_os_support", "os":["linux"]},
+    {"file":"release/docker_support_matrix", "os":["linux"]},
+    
+    {"file":"reference/gpu_libraries/communication", "os":["linux"]},
+    {"file":"reference/ai_tools", "os":["linux"]},
+    {"file":"reference/management_tools", "os":["linux"]},
+    {"file":"reference/validation_tools", "os":["linux"]},
+    {"file":"reference/framework_compatibility/framework_compatibility", "os":["linux"]},
+    {"file":"reference/computer_vision", "os":["linux"]},
+    
+    {"file":"how_to/deep_learning_rocm", "os":["linux"]},
+    {"file":"how_to/gpu_aware_mpi", "os":["linux"]},
+    {"file":"how_to/magma_install/magma_install", "os":["linux"]},
+    {"file":"how_to/pytorch_install/pytorch_install", "os":["linux"]},
+    {"file":"how_to/system_debugging", "os":["linux"]},
+    {"file":"how_to/tensorflow_install/tensorflow_install", "os":["linux"]},
+
+    {"file":"examples/ai_ml_inferencing", "os":["linux"]},
+    {"file":"examples/inception_casestudy/inception_casestudy", "os":["linux"]},
+    
+    {"file":"understand/file_reorg", "os":["linux"]},
+
+    {"file":"understand/isv_deployment_win", "os":["windows"]},
+]
+
+external_toc_path = "./sphinx/_toc.yml"
+
+docs_core = ROCmDocs("ROCm Documentation")
+docs_core.setup()
+
+for sphinx_var in ROCmDocs.SPHINX_VARS:
+    globals()[sphinx_var] = getattr(docs_core, sphinx_var)