Update default.xml to 5.5.1 release.

Merging Documentation into 5.5

.github/CODEOWNERS

@@ -1 +1 @@
-* @saadrahim
+* @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,767 +1,45 @@
+# AMD ROCm™ Platform - Powering Your GPU Computational Needs
 
-New AMD ROCm Information Portal ROCm v4.5 and Above
------------------------------------------------------
+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.
 
-Beginning ROCm release v5.0, AMD ROCm documentation has a new portal at https://docs.amd.com  This portal consists of ROCm documentation v4.5 and above.
+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.
 
-For documentation prior to ROCm v4.5, you may continue to access https://rocmdocs.amd.com.
+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.
 
-# AMD ROCm™ Releases
+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.
 
-## AMD  ROCm™ V5.2.1 Release
+The default.xml file uses the repo Manifest format.
 
-AMD ROCm v5.2.1 is now released. The release documentation is available at https://docs.amd.com.
+## How to build documentation via Sphinx
 
-## AMD  ROCm™ V5.2 Release
+```bash
+cd docs
 
-AMD ROCm v5.2 is now released. The release documentation is available at https://docs.amd.com.
+pip3 install -r sphinx/requirements.txt
 
-## AMD  ROCm™ V5.1.3 Release
-
-AMD ROCm v5.1.3 is now released. The release documentation is available at https://docs.amd.com.
-
-## AMD  ROCm™ V5.1.1 Release
-
-AMD ROCm v5.1.1 is now released. The release documentation is available at https://docs.amd.com.
-
-## AMD  ROCm™ V5.1 Release
-
-AMD ROCm v5.1 is now released. The release documentation is available at https://docs.amd.com.
-
-
-## AMD ROCm™ v5.0.2 Release Notes
-
-### Fixed Defects in This Release
-
-The following defects are fixed in the ROCm v5.0.2 release.
-
-#### Issue with hostcall Facility in HIP Runtime
-
-In ROCm v5.0, when using the “assert()” call in a HIP kernel, the compiler may sometimes fail to emit kernel metadata related to the hostcall facility, which results in incomplete initialization of the hostcall facility in the HIP runtime. This can cause the HIP kernel to crash when it attempts to execute the “assert()” call. 
-The root cause was an incorrect check in the compiler to determine whether the hostcall facility is required by the kernel. This is fixed in the ROCm v5.0.2 release. 
-The resolution includes a compiler change, which emits the required metadata by default, unless the compiler can prove that the hostcall facility is not required by the kernel. This ensures that the “assert()” call never fails. 
-
-**Note**: This fix may lead to breakage in some OpenMP offload use cases, which use print inside a target region and result in an abort in device code. The issue will be fixed in a future release. 
-
-#### Compatibility Matrix Updates to ROCm Deep Learning Guide
-
-The compatibility matrix in the AMD Deep Learning Guide is updated for ROCm v5.0.2.
-
-For more information and documentation updates, refer to https://docs.amd.com.
-
-
-
-## AMD ROCm™ v5.0.1 Release Notes
-
-### Deprecations and Warnings
-
-#### Refactor of HIPCC/HIPCONFIG
-
-In prior ROCm releases, by default, the hipcc/hipconfig Perl scripts were used to identify and set target compiler options, target platform, compiler, and runtime appropriately.
-In ROCm v5.0.1, hipcc.bin and hipconfig.bin have been added as the compiled binary implementations of the hipcc and hipconfig. These new binaries are currently a work-in-progress, considered, and marked as experimental. ROCm plans to fully transition to hipcc.bin and hipconfig.bin in the a future ROCm release. The existing hipcc and hipconfig Perl scripts are renamed to hipcc.pl and hipconfig.pl respectively. New top-level hipcc and hipconfig Perl scripts are created, which can switch between the Perl script or the compiled binary based on the environment variable HIPCC_USE_PERL_SCRIPT. 
-In ROCm 5.0.1, by default, this environment variable is set to use hipcc and hipconfig through the Perl scripts.
-Subsequently, Perl scripts will no longer be available in ROCm in a future release.
-
-
-### ROCM DOCUMENTATION UPDATES FOR ROCM 5.0.1
-
-* ROCm Downloads Guide
-
-* ROCm Installation Guide
-
-* ROCm Release Notes
-
-For more information, see https://docs.amd.com.
-
-
-
-## AMD ROCm™ v5.0 Release Notes
-
-
-# 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.
-
-## Notice for Open-source and Closed-source ROCm Repositories in Future Releases
-
-To make a distinction between open-source and closed-source components, all ROCm repositories will consist of sub-folders in future releases.
-
-- All open-source components will be placed in the `base-url/<rocm-ver>/main` sub-folder
-- All closed-source components will reside in the `base-url/<rocm-ver>/proprietary`  sub-folder
-
-## List of Supported Operating Systems
-
-The AMD ROCm platform supports the following operating systems:
-
-| **OS-Version (64-bit)** | **Kernel Versions** |
-| --- | --- |
-| CentOS 8.3 | 4.18.0-193.el8 |
-| CentOS 7.9 | 3.10.0-1127 |
-| RHEL 8.5 | 4.18.0-348.7.1.el8\_5.x86\_64 |
-| RHEL 8.4 | 4.18.0-305.el8.x86\_64 |
-| RHEL 7.9 | 3.10.0-1160.6.1.el7 |
-| SLES 15 SP3 | 5.3.18-59.16-default |
-| Ubuntu 20.04.3 | 5.8.0 LTS / 5.11 HWE |
-| Ubuntu 18.04.5 [5.4 HWE kernel] | 5.4.0-71-generic |
-
-### Support for RHEL v8.5
-
-This release extends support for RHEL v8.5.
-
-### Supported GPUs
-
-#### Radeon Pro V620 and W6800 Workstation GPUs
-
-This release extends ROCm support for Radeon Pro V620 and W6800 Workstation GPUs.
-
-- SRIOV virtualization support for Radeon Pro V620
-- KVM Hypervisor (1VF support only) on Ubuntu Host OS with Ubuntu, CentOs, and RHEL Guest
-- Support for ROCm-SMI in an SRIOV environment. For more details, refer to the ROCm SMI API documentation.
-
-**Note:** Radeon Pro v620 is not supported on SLES.
-
-## ROCm Installation Updates for ROCm v5.0
-
-This release has the following ROCm installation enhancements.
-
-### Support for Kernel Mode Driver
-
-In this release, users can install the kernel-mode driver using the Installer method. 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
-- Kernel-mode driver
-
-### Support for Multi-version ROCm Installation and Uninstallation
-
-Users now can install multiple ROCm releases simultaneously on a system using the newly introduced installer script and package manager install mechanism.
-
-Users can also uninstall multi-version ROCm releases using the `amdgpu-uninstall` script and package manager.
-
-### Support for Updating Information on Local Repositories
-
-In this release, the `amdgpu-install` script automates the process of updating local repository information before proceeding to ROCm installation.
-
-### Support for Release Upgrades
-
-Users can now upgrade the existing ROCm installation to specific or latest ROCm releases.
-
-For more details, refer to the AMD ROCm Installation Guide v5.0.
-
-# AMD ROCm V5.0 Documentation Updates
-
-## New AMD ROCm Information Portal – ROCm v4.5 and Above
-
-Beginning ROCm release v5.0, AMD ROCm documentation has a new portal at https://docs.amd.com. This portal consists of ROCm documentation v4.5 and above.
-
-For documentation prior to ROCm v4.5, you may continue to access https://rocmdocs.amd.com.
-
-## Documentation Updates for ROCm 5.0
-
-### Deployment Tools
-
-#### ROCm Data Center Tool Documentation Updates
-
-- ROCm Data Center Tool User Guide
-- ROCm Data Center Tool API Guide
-
-#### ROCm System Management Interface Updates
-
-- System Management Interface Guide
-- System Management Interface API Guide
-
-#### ROCm Command Line Interface Updates
-
-- Command Line Interface Guide
-
-### Machine Learning/AI Documentation Updates
-
-- Deep Learning Guide
-- MIGraphX API Guide
-- MIOpen API Guide
-- MIVisionX API Guide
-
-### ROCm Libraries Documentation Updates
-
-- hipSOLVER User Guide
-- RCCL User Guide
-- rocALUTION User Guide
-- rocBLAS User Guide
-- rocFFT User Guide
-- rocRAND User Guide
-- rocSOLVER User Guide
-- rocSPARSE User Guide
-- rocThrust User Guide
-
-### Compilers and Tools
-
-#### ROCDebugger Documentation Updates
-
-- ROCDebugger User Guide
-- ROCDebugger API Guide
-
-#### ROCTracer
-
-- ROCTracer User Guide
-- ROCTracer API Guide
-
-#### Compilers
-
-- AMD Instinct High Performance Computing and Tuning Guide
-- AMD Compiler Reference Guide
-
-#### HIPify Documentation
-
-- HIPify User Guide
-- HIP Supported CUDA API Reference Guide
-
-#### ROCm Debug Agent
-
-- ROCm Debug Agent Guide
-- System Level Debug Guide
-- ROCm Validation Suite
-
-### Programming Models Documentation
-
-#### HIP Documentation
-
-- HIP Programming Guide
-- HIP API Guide
-- HIP FAQ Guide
-
-#### OpenMP Documentation
-
-- OpenMP Support Guide
-
-### ROCm Glossary
-
-- ROCm Glossary – Terms and Definitions
-
-## AMD ROCm Legacy Documentation Links – ROCm v4.3 and Prior
-
-- 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 v5.0 release consists of the following HIP enhancements.
-
-### HIP Installation Guide Updates
-
-The HIP Installation Guide is updated to include building HIP from source on the NVIDIA platform.
-
-Refer to the HIP Installation Guide v5.0 for more details.
-
-### Managed Memory Allocation
-
-Managed memory, including the `__managed__` keyword, is now supported in the HIP combined host/device compilation. Through unified memory allocation, managed memory allows data to be shared and accessible to both the CPU and GPU using a single pointer. The allocation is managed by the AMD GPU driver using the Linux Heterogeneous Memory Management (HMM) mechanism. The user can call managed memory API hipMallocManaged to allocate a large chunk of HMM memory, execute kernels on a device, and fetch data between the host and device as needed.
-
-**Note:** In a HIP application, it is recommended to do a capability check before calling the managed memory APIs. For example,
-
-```c
-int managed_memory = 0;
-HIPCHECK(hipDeviceGetAttribute(&managed_memory, hipDeviceAttributeManagedMemory, p_gpuDevice));
-
-if (!managed_memory) {
-  printf ("info: managed memory access not supported on the device %d\n Skipped\n", p_gpuDevice);
-} else {
-  HIPCHECK(hipSetDevice(p_gpuDevice));
-  HIPCHECK(hipMallocManaged(&Hmm, N * sizeof(T)));
-  . . .
-}
+python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
 ```
 
-**Note:** The managed memory capability check may not be necessary; however, if HMM is not supported, managed malloc will fall back to using system memory. Other managed memory API calls will, then, have
+## Older ROCm™ Releases
 
-Refer to the HIP API documentation for more details on managed memory APIs.
-
-For the application, see [hipMallocManaged.cpp](https://github.com/ROCm-Developer-Tools/HIP/blob/rocm-4.5.x/tests/src/runtimeApi/memory/hipMallocManaged.cpp)
-
-## New Environment Variable
-
-The following new environment variable is added in this release:
-
-| **Environment Variable** | **Value** | **Description** |
-| --- | --- | --- |
-| **HSA\_COOP\_CU\_COUNT** | 0 or 1 (default is 0) | Some processors support more compute units than can reliably be used in a cooperative dispatch. Setting the environment variable HSA\_COOP\_CU\_COUNT to 1 will cause ROCr to return the correct CU count for cooperative groups through the HSA\_AMD\_AGENT\_INFO\_COOPERATIVE\_COMPUTE\_UNIT\_COUNT attribute of hsa\_agent\_get\_info(). Setting HSA\_COOP\_CU\_COUNT to other values, or leaving it unset, will cause ROCr to return the same CU count for the attributes HSA\_AMD\_AGENT\_INFO\_COOPERATIVE\_COMPUTE\_UNIT\_COUNT and HSA\_AMD\_AGENT\_INFO\_COMPUTE\_UNIT\_COUNT. Future ROCm releases will make HSA\_COOP\_CU\_COUNT=1 the default.
- |
-
-## ROCm Math and Communication Libraries
-
-| **Library** | **Changes** |
-| --- | --- |
-| **rocBLAS** | **Added** <ul><li>Added rocblas\_get\_version\_string\_size convenience function</li><li>Added rocblas\_xtrmm\_outofplace, an out-of-place version of rocblas\_xtrmm</li><li>Added hpl and trig initialization for gemm\_ex to rocblas-bench</li><li>Added source code gemm. It can be used as an alternative to Tensile for debugging and development</li><li>Added option `ROCM_MATHLIBS_API_USE_HIP_COMPLEX` to opt-in to use hipFloatComplex and hipDoubleComplex</li></ul> **Optimizations** <ul><li>Improved performance of non-batched and batched single-precision GER for size m > 1024. Performance enhanced by 5-10% measured on a MI100 (gfx908) GPU.</li><li>Improved performance of non-batched and batched HER for all sizes and data types. Performance enhanced by 2-17% measured on a MI100 (gfx908) GPU.</li></ul> **Changed** <ul><li>Instantiate templated rocBLAS functions to reduce size of librocblas.so</li><li>Removed static library dependency on msgpack</li><li>Removed boost dependencies for clients</li></ul> **Fixed** <ul><li>Option to install script to build only rocBLAS clients with a pre-built rocBLAS library</li><li>Correctly set output of nrm2\_batched\_ex and nrm2\_strided\_batched\_ex when given bad input</li><li>Fix for dgmm with side == rocblas\_side\_left and a negative incx</li><li>Fixed out-of-bounds read for small trsm</li><li>Fixed numerical checking for tbmv\_strided\_batched</li></ul> |
-| | |
-| **hipBLAS** | **Added** <ul><li>Added rocSOLVER functions to hipblas-bench</li><li>Added option `ROCM_MATHLIBS_API_USE_HIP_COMPLEX` to opt-in to use hipFloatComplex and hipDoubleComplex</li><li>Added compilation warning for future trmm changes</li><li>Added documentation to hipblas.h</li><li>Added option to forgo pivoting for getrf and getri when ipiv is nullptr</li><li>Added code coverage option</li></ul> **Fixed** <ul><li>Fixed use of incorrect `HIP_PATH` when building from source.</li><li>Fixed windows packaging</li><li>Allowing negative increments in hipblas-bench</li><li>Removed boost dependency</li></ul> |
-| | |
-| **rocFFT** | **Changed** <ul><li>Enabled runtime compilation of single FFT kernels > length 1024.</li><li>Re-aligned split device library into 4 roughly equal libraries.</li><li>Implemented the FuseShim framework to replace the original OptimizePlan</li><li>Implemented the generic buffer-assignment framework. The buffer assignment is no longer performed by each node. A generic algorithm is designed to test and pick the best assignment path. With the help of FuseShim, more kernel-fusions are achieved.</li><li>Do not read the imaginary part of the DC and Nyquist modes for even-length complex-to-real transforms.</li></ul> **Optimizations** <ul><li>Optimized twiddle-conjugation; complex-to-complex inverse transforms have similar performance to foward transforms now.</li><li>Improved performance of single-kernel small 2D transforms.</li></ul> |
-| | |
-| **hipFFT** | **Fixed** <ul><li>Fixed incorrect reporting of rocFFT version.</li></ul> **Changed** <ul><li>Unconditionally enabled callback functionality. On the CUDA backend, callbacks only run correctly when hipFFT is built as a static library, and is linked against the static cuFFT library.</li></ul> |
-| | |
-| **rocSPARSE** | **Added** <ul><li>csrmv, coomv, ellmv, hybmv for (conjugate) transposed matricescsrmv for symmetric matrices</li></ul> **Changed** <ul><li>spmm\_ex is now deprecated and will be removed in the next major release</li></ul> **Improved** <ul><li>Optimization for gtsv</li></ul> |
-| | |
-| **hipSPARSE** | **Added** <ul><li>Added (conjugate) transpose support for csrmv, hybmv and spmv routines</li></ul> |
-| | |
-| **rocALUTION** | **Changed** <ul><li>Removed deprecated GlobalPairwiseAMG class, please use PairwiseAMG instead.</li></ul> **Improved** <ul><li>Improved documentation</li></ul> |
-| | |
-| **rocTHRUST** | **Updates** <ul><li>Updated to match upstream Thrust 1.13.0</li><li>Updated to match upstream Thrust 1.14.0</li><li>Added async scan</li></ul> **Changed** <ul><li>Scan algorithms: inclusive\_scan now uses the input-type as accumulator-type, exclusive\_scan uses initial-value-type. This particularly changes behaviour of small-size input types with large-size output types (e.g. short input, int output). And low-res input with high-res output (e.g. float input, double output)</li></ul> |
-| | |
-| **rocSOLVER** | **Added** <ul><li>Symmetric matrix factorizations: <ul><li>LASYF</li><li>SYTF2, SYTRF (with batched and strided\_batched versions)</li></ul><li>Added rocsolver\_get\_version\_string\_size to help with version string queries</li><li>Added rocblas\_layer\_mode\_ex and the ability to print kernel calls in the trace and profile logs</li><li>Expanded batched and strided\_batched sample programs.</li></ul> **Optimizations** <ul><li>Improved general performance of LU factorization</li><li>Increased parallelism of specialized kernels when compiling from source, reducing build times on multi-core systems.</li></ul> **Changed** <ul><li>The rocsolver-test client now prints the rocSOLVER version used to run the tests, rather than the version used to build them</li><li>The rocsolver-bench client now prints the rocSOLVER version used in the benchmark</li></ul> **Fixed** <ul><li>Added missing stdint.h include to rocsolver.h</li></ul> |
-| | |
-| **hipSOLVER** | **Added** <ul><li>Added SYTRF functions: hipsolverSsytrf\_bufferSize, hipsolverDsytrf\_bufferSize, hipsolverCsytrf\_bufferSize, hipsolverZsytrf\_bufferSize, hipsolverSsytrf, hipsolverDsytrf, hipsolverCsytrf, hipsolverZsytrf</li></ul> **Fixed** <ul><li>Fixed use of incorrect `HIP_PATH` when building from source</li></ul> |
-| | |
-| **RCCL** | **Added** <ul><li>Compatibility with NCCL 2.10.3</li></ul> **Known issues** <ul><li>Managed memory is not currently supported for clique-based kernels</li></ul> |
-| | |
-| **hipCUB** | **Fixed** <ul><li>Added missing includes to hipcub.hpp</li></ul> **Added** <ul><li>Bfloat16 support to test cases (device\_reduce & device\_radix\_sort)</li><li>Device merge sort</li><li>Block merge sort</li><li>API update to CUB 1.14.0</li></ul> **Changed** <ul><li>The SetupNVCC.cmake automatic target selector select all of the capabalities of all available card for NVIDIA backend.</li></ul> |
-| | |
-| **rocPRIM** | **Fixed** <ul><li>Enable bfloat16 tests and reduce threshold for bfloat16</li><li>Fix device scan limit\_size feature</li><li>Non-optimized builds no longer trigger local memory limit errors</li></ul> **Added** <ul><li>Scan size limit feature</li><li>Reduce size limit feature</li><li>Transform size limit feature</li><li>Add block\_load\_striped and block\_store\_striped</li><li>Add gather\_to\_blocked to gather values from other threads into a blocked arrangement</li><li>The block sizes for device merge sorts initial block sort and its merge steps are now separate in its kernel config (the block sort step supports multiple items per thread)</li></ul> **Changed** <ul><li>size\_limit for scan, reduce and transform can now be set in the config struct instead of a parameter</li><li>device\_scan and device\_segmented\_scan: inclusive\_scan now uses the input-type as accumulator-type, exclusive\_scan uses initial-value-type. This particularly changes behaviour of small-size input types with large-size output types (e.g. short input, int output) and low-res input with high-res output (e.g. float input, double output)</li><li>Revert old Fiji workaround, because the issue was solved at compiler side</li><li>Update README cmake minimum version number</li><li>Block sort support multiple items per thread. Currently only powers of two block sizes, and items per threads are supported and only for full blocks</li><li>Bumped the minimum required version of CMake to 3.16</li></ul> **Known issues** <ul><li>Unit tests may soft hang on MI200 when running in hipMallocManaged mode.</li><li>device\_segmented\_radix\_sort, device\_scan unit tests failing for HIP on WindowsReduceEmptyInput cause random failure with bfloat16</li><li>Managed memory is not currently supported for clique-based kernels</li></ul> |
-
-## System Management Interface
-
-### Clock Throttling for GPU Events
-
-This feature lists GPU events as they occur in real-time and can be used with _kfdtest_ to produce _vm\_fault_ events for testing.
-
-The command can be called with either &quot; `-e` or `--showevents` like this:
-
-    -e [EVENT [EVENT ...]], --showevents [EVENT [EVENT ...]]  Show event list
-
-Where `EVENT` is any list combination of `VM_FAULT`, `THERMAL_THROTTLE`, or `GPU_RESET` and is NOT case sensitive.
-
-**Note:** If no event arguments are passed, all events will be watched by default.
-
-#### CLI Commands
-
-```
-$ rocm-smi --showevents vm_fault thermal_throttle gpu_reset
-
-======================= ROCm System Management Interface =======================
-================================= Show Events ==================================
-press 'q' or 'ctrl + c' to quit
-DEVICE		TIME		TYPE		DESCRIPTION
-
-============================= End of ROCm SMI Log ==============================
-```
-
-(Run kfdtest in another window to test for vm\_fault events.)
-
-**Note:** Unlike other rocm-smi CLI commands, this command does not quit unless specified by the user. Users may press either `q` or `ctrl + c` to quit.
-
-### Display XGMI Bandwidth Between Nodes
-
-The _rsmi\_minmax\_bandwidth\_get_ API reads the HW Topology file and displays bandwidth (min-max) between any two NUMA nodes in a matrix format.
-
-The Command Line Interface (CLI) command can be called as follows:
-
-```
-$ rocm-smi --shownodesbw
-
-======================= ROCm System Management Interface =======================
-================================== Bandwidth ===================================
-GPU0 GPU1 GPU2 GPU3 GPU4 GPU5 GPU6 GPU7
-GPU0 N/A 50000-200000 50000-50000 0-0 0-0 0-0 50000-100000 0-0
-GPU1 50000-200000 N/A 0-0 50000-50000 0-0 50000-50000 0-0 0-0
-GPU2 50000-50000 0-0 N/A 50000-200000 50000-100000 0-0 0-0 0-0
-GPU3 0-0 50000-50000 50000-200000 N/A 0-0 0-0 0-0 50000-50000
-GPU4 0-0 0-0 50000-100000 0-0 N/A 50000-200000 50000-50000 0-0
-GPU5 0-0 50000-50000 0-0 0-0 50000-200000 N/A 0-0 50000-50000
-GPU6 50000-100000 0-0 0-0 0-0 50000-50000 0-0 N/A 50000-200000
-GPU7 0-0 0-0 0-0 50000-50000 0-0 50000-50000 50000-200000 N/A
-Format: min-max; Units: mps
-============================= End of ROCm SMI Log ==============================
-```
-
-The sample output above shows the maximum theoretical xgmi bandwidth between 2 numa nodes,
-
-**Note:** "0-0" min-max bandwidth indicates devices are not connected directly.
-
-### P2P Connection Status
-
-The _rsmi\_is\_p2p\_accessible_ API returns "True" if P2P can be implemented between two nodes, and returns "False" if P2P cannot be implemented between the two nodes.
-
-The Command Line Interface command can be called as follows:
-
-    rocm-smi --showtopoaccess
-
-Sample Output:
-
-```
-$ rocm-smi --showtopoaccess
-======================= ROCm System Management Interface =======================
-===================== Link accessibility between two GPUs ======================
-GPU0 GPU1
-GPU0 True True
-GPU1 True True
-============================= End of ROCm SMI Log ==============================
-```
-
-# Breaking Changes
-
-## Runtime Breaking Change
-
-Re-ordering of the enumerated type in hip\_runtime\_api.h to better match NV.  See below for the difference in enumerated types.
-
-ROCm software will be affected if any of the defined enums listed below are used in the code.  Applications built with ROCm v5.0 enumerated types will work with a ROCm 4.5.2 driver. However, an undefined behavior error will occur with a ROCm v4.5.2 application that uses these enumerated types with a ROCm 5.0 runtime.
-
-```c
-typedef enum hipDeviceAttribute_t {
-  hipDeviceAttributeMaxThreadsPerBlock, // Maximum number of threads per block.
-  hipDeviceAttributeMaxBlockDimX, // Maximum x-dimension of a block.
-  hipDeviceAttributeMaxBlockDimY, // Maximum y-dimension of a block.
-  hipDeviceAttributeMaxBlockDimZ, // Maximum z-dimension of a block.
-  hipDeviceAttributeMaxGridDimX, // Maximum x-dimension of a grid.
-  hipDeviceAttributeMaxGridDimY, // Maximum y-dimension of a grid.
-  hipDeviceAttributeMaxGridDimZ, // Maximum z-dimension of a grid.
-  hipDeviceAttributeMaxSharedMemoryPerBlock, // Maximum shared memory available per block in bytes.
-  hipDeviceAttributeTotalConstantMemory, // Constant memory size in bytes.
-  hipDeviceAttributeWarpSize, // Warp size in threads.
-  hipDeviceAttributeMaxRegistersPerBlock, // Maximum number of 32-bit registers available to a
-                                          // thread block. This number is shared by all thread
-                                          // blocks simultaneously resident on a
-                                          // multiprocessor.
-  hipDeviceAttributeClockRate, // Peak clock frequency in kilohertz.
-  hipDeviceAttributeMemoryClockRate, // Peak memory clock frequency in kilohertz.
-  hipDeviceAttributeMemoryBusWidth, // Global memory bus width in bits.
-  hipDeviceAttributeMultiprocessorCount, // Number of multiprocessors on the device.
-  hipDeviceAttributeComputeMode, // Compute mode that device is currently in.
-  hipDeviceAttributeL2CacheSize, // Size of L2 cache in bytes. 0 if the device doesn't have L2
-                                 // cache.
-  hipDeviceAttributeMaxThreadsPerMultiProcessor, // Maximum resident threads per
-                                                 // multiprocessor.
-  hipDeviceAttributeComputeCapabilityMajor, // Major compute capability version number.
-  hipDeviceAttributeComputeCapabilityMinor, // Minor compute capability version number.
-  hipDeviceAttributeConcurrentKernels, // Device can possibly execute multiple kernels
-                                       // concurrently.
-  hipDeviceAttributePciBusId, // PCI Bus ID.
-  hipDeviceAttributePciDeviceId, // PCI Device ID.
-  hipDeviceAttributeMaxSharedMemoryPerMultiprocessor, // Maximum Shared Memory Per
-                                                      // Multiprocessor.
-  hipDeviceAttributeIsMultiGpuBoard, // Multiple GPU devices.
-  hipDeviceAttributeIntegrated, // iGPU
-  hipDeviceAttributeCooperativeLaunch, // Support cooperative launch
-  hipDeviceAttributeCooperativeMultiDeviceLaunch, // Support cooperative launch on multiple devices
-  hipDeviceAttributeMaxTexture1DWidth, // Maximum number of elements in 1D images
-  hipDeviceAttributeMaxTexture2DWidth, // Maximum dimension width of 2D images in image elements
-  hipDeviceAttributeMaxTexture2DHeight, // Maximum dimension height of 2D images in image elements
-  hipDeviceAttributeMaxTexture3DWidth, // Maximum dimension width of 3D images in image elements
-  hipDeviceAttributeMaxTexture3DHeight, // Maximum dimensions height of 3D images in image elements
-  hipDeviceAttributeMaxTexture3DDepth, // Maximum dimensions depth of 3D images in image elements
-  hipDeviceAttributeCudaCompatibleBegin = 0,
-  hipDeviceAttributeHdpMemFlushCntl, // Address of the HDP\_MEM\_COHERENCY\_FLUSH\_CNTL register
-  hipDeviceAttributeHdpRegFlushCntl, // Address of the HDP\_REG\_COHERENCY\_FLUSH\_CNTL register
-  hipDeviceAttributeEccEnabled = hipDeviceAttributeCudaCompatibleBegin, // Whether ECC support is enabled.
-  hipDeviceAttributeAccessPolicyMaxWindowSize, // Cuda only. The maximum size of the window policy in bytes.
-  hipDeviceAttributeAsyncEngineCount, // Cuda only. Asynchronous engines number.
-  hipDeviceAttributeCanMapHostMemory, // Whether host memory can be mapped into device address space
-  hipDeviceAttributeCanUseHostPointerForRegisteredMem, // Cuda only. Device can access host registered memory
-  // at the same virtual address as the CPU
-  hipDeviceAttributeClockRate, // Peak clock frequency in kilohertz.
-  hipDeviceAttributeComputeMode, // Compute mode that device is currently in.
-  hipDeviceAttributeComputePreemptionSupported, // Cuda only. Device supports Compute Preemption.
-  hipDeviceAttributeConcurrentKernels, // Device can possibly execute multiple kernels concurrently.
-  hipDeviceAttributeConcurrentManagedAccess, // Device can coherently access managed memory concurrently with the CPU
-  hipDeviceAttributeCooperativeLaunch, // Support cooperative launch
-  hipDeviceAttributeCooperativeMultiDeviceLaunch, // Support cooperative launch on multiple devices
-  hipDeviceAttributeDeviceOverlap, // Cuda only. Device can concurrently copy memory and execute a kernel.
-                                   // Deprecated. Use instead asyncEngineCount.
-  hipDeviceAttributeDirectManagedMemAccessFromHost, // Host can directly access managed memory on
-                                                    // the device without migration
-  hipDeviceAttributeGlobalL1CacheSupported, // Cuda only. Device supports caching globals in L1
-  hipDeviceAttributeHostNativeAtomicSupported, // Cuda only. Link between the device and the host supports native atomic operations
-  hipDeviceAttributeIntegrated, // Device is integrated GPU
-  hipDeviceAttributeIsMultiGpuBoard, // Multiple GPU devices.
-  hipDeviceAttributeKernelExecTimeout, // Run time limit for kernels executed on the device
-  hipDeviceAttributeL2CacheSize, // Size of L2 cache in bytes. 0 if the device doesn&#39;t have L2 cache.
-  hipDeviceAttributeLocalL1CacheSupported, // caching locals in L1 is supported
-  hipDeviceAttributeLuid, // Cuda only. 8-byte locally unique identifier in 8 bytes. Undefined on TCC and non-Windows platforms
-  hipDeviceAttributeLuidDeviceNodeMask, // Cuda only. Luid device node mask. Undefined on TCC and non-Windows platforms
-  hipDeviceAttributeComputeCapabilityMajor, // Major compute capability version number.
-  hipDeviceAttributeManagedMemory, // Device supports allocating managed memory on this system
-  hipDeviceAttributeMaxBlocksPerMultiProcessor, // Cuda only. Max block size per multiprocessor
-  hipDeviceAttributeMaxBlockDimX, // Max block size in width.
-  hipDeviceAttributeMaxBlockDimY, // Max block size in height.
-  hipDeviceAttributeMaxBlockDimZ, // Max block size in depth.
-  hipDeviceAttributeMaxGridDimX, // Max grid size in width.
-  hipDeviceAttributeMaxGridDimY, // Max grid size in height.
-  hipDeviceAttributeMaxGridDimZ, // Max grid size in depth.
-  hipDeviceAttributeMaxSurface1D, // Maximum size of 1D surface.
-  hipDeviceAttributeMaxSurface1DLayered, // Cuda only. Maximum dimensions of 1D layered surface.
-  hipDeviceAttributeMaxSurface2D, // Maximum dimension (width, height) of 2D surface.
-  hipDeviceAttributeMaxSurface2DLayered, // Cuda only. Maximum dimensions of 2D layered surface.
-  hipDeviceAttributeMaxSurface3D, // Maximum dimension (width, height, depth) of 3D surface.
-  hipDeviceAttributeMaxSurfaceCubemap, // Cuda only. Maximum dimensions of Cubemap surface.
-  hipDeviceAttributeMaxSurfaceCubemapLayered, // Cuda only. Maximum dimension of Cubemap layered surface.
-  hipDeviceAttributeMaxTexture1DWidth, // Maximum size of 1D texture.
-  hipDeviceAttributeMaxTexture1DLayered, // Cuda only. Maximum dimensions of 1D layered texture.
-  hipDeviceAttributeMaxTexture1DLinear, // Maximum number of elements allocatable in a 1D linear texture.
-                                        // Use cudaDeviceGetTexture1DLinearMaxWidth() instead on Cuda.
-  hipDeviceAttributeMaxTexture1DMipmap, // Cuda only. Maximum size of 1D mipmapped texture.
-  hipDeviceAttributeMaxTexture2DWidth, // Maximum dimension width of 2D texture.
-  hipDeviceAttributeMaxTexture2DHeight, // Maximum dimension hight of 2D texture.
-  hipDeviceAttributeMaxTexture2DGather, // Cuda only. Maximum dimensions of 2D texture if gather operations performed.
-  hipDeviceAttributeMaxTexture2DLayered, // Cuda only. Maximum dimensions of 2D layered texture.
-  hipDeviceAttributeMaxTexture2DLinear, // Cuda only. Maximum dimensions (width, height, pitch) of 2D textures bound to pitched memory.
-  hipDeviceAttributeMaxTexture2DMipmap, // Cuda only. Maximum dimensions of 2D mipmapped texture.
-  hipDeviceAttributeMaxTexture3DWidth, // Maximum dimension width of 3D texture.
-  hipDeviceAttributeMaxTexture3DHeight, // Maximum dimension height of 3D texture.
-  hipDeviceAttributeMaxTexture3DDepth, // Maximum dimension depth of 3D texture.
-  hipDeviceAttributeMaxTexture3DAlt, // Cuda only. Maximum dimensions of alternate 3D texture.
-  hipDeviceAttributeMaxTextureCubemap, // Cuda only. Maximum dimensions of Cubemap texture
-  hipDeviceAttributeMaxTextureCubemapLayered, // Cuda only. Maximum dimensions of Cubemap layered texture.
-  hipDeviceAttributeMaxThreadsDim, // Maximum dimension of a block
-  hipDeviceAttributeMaxThreadsPerBlock, // Maximum number of threads per block.
-  hipDeviceAttributeMaxThreadsPerMultiProcessor, // Maximum resident threads per multiprocessor.
-  hipDeviceAttributeMaxPitch, // Maximum pitch in bytes allowed by memory copies
-  hipDeviceAttributeMemoryBusWidth, // Global memory bus width in bits.
-  hipDeviceAttributeMemoryClockRate, // Peak memory clock frequency in kilohertz.
-  hipDeviceAttributeComputeCapabilityMinor, // Minor compute capability version number.
-  hipDeviceAttributeMultiGpuBoardGroupID, // Cuda only. Unique ID of device group on the same multi-GPU board
-  hipDeviceAttributeMultiprocessorCount, // Number of multiprocessors on the device.
-  hipDeviceAttributeName, // Device name.
-  hipDeviceAttributePageableMemoryAccess, // Device supports coherently accessing pageable memory
-                                          // without calling hipHostRegister on it
-  hipDeviceAttributePageableMemoryAccessUsesHostPageTables, // Device accesses pageable memory via the host&#39;s page tables
-  hipDeviceAttributePciBusId, // PCI Bus ID.
-  hipDeviceAttributePciDeviceId, // PCI Device ID.
-  hipDeviceAttributePciDomainID, // PCI Domain ID.
-  hipDeviceAttributePersistingL2CacheMaxSize, // Cuda11 only. Maximum l2 persisting lines capacity in bytes
-  hipDeviceAttributeMaxRegistersPerBlock, // 32-bit registers available to a thread block. This number is shared
-                                          // by all thread blocks simultaneously resident on a multiprocessor.
-  hipDeviceAttributeMaxRegistersPerMultiprocessor, // 32-bit registers available per block.
-  hipDeviceAttributeReservedSharedMemPerBlock, // Cuda11 only. Shared memory reserved by CUDA driver per block.
-  hipDeviceAttributeMaxSharedMemoryPerBlock, // Maximum shared memory available per block in bytes.
-  hipDeviceAttributeSharedMemPerBlockOptin, // Cuda only. Maximum shared memory per block usable by special opt in.
-  hipDeviceAttributeSharedMemPerMultiprocessor, // Cuda only. Shared memory available per multiprocessor.
-  hipDeviceAttributeSingleToDoublePrecisionPerfRatio, // Cuda only. Performance ratio of single precision to double precision.
-  hipDeviceAttributeStreamPrioritiesSupported, // Cuda only. Whether to support stream priorities.
-  hipDeviceAttributeSurfaceAlignment, // Cuda only. Alignment requirement for surfaces
-  hipDeviceAttributeTccDriver, // Cuda only. Whether device is a Tesla device using TCC driver
-  hipDeviceAttributeTextureAlignment, // Alignment requirement for textures
-  hipDeviceAttributeTexturePitchAlignment, // Pitch alignment requirement for 2D texture references bound to pitched memory;
-  hipDeviceAttributeTotalConstantMemory, // Constant memory size in bytes.
-  hipDeviceAttributeTotalGlobalMem, // Global memory available on devicice.
-  hipDeviceAttributeUnifiedAddressing, // Cuda only. An unified address space shared with the host.
-  hipDeviceAttributeUuid, // Cuda only. Unique ID in 16 byte.
-  hipDeviceAttributeWarpSize, // Warp size in threads.
-  hipDeviceAttributeMaxPitch, // Maximum pitch in bytes allowed by memory copies
-  hipDeviceAttributeTextureAlignment, //Alignment requirement for textures
-  hipDeviceAttributeTexturePitchAlignment, //Pitch alignment requirement for 2D texture references bound to pitched memory;
-  hipDeviceAttributeKernelExecTimeout, //Run time limit for kernels executed on the device
-  hipDeviceAttributeCanMapHostMemory, //Device can map host memory into device address space
-  hipDeviceAttributeEccEnabled, //Device has ECC support enabled
-  hipDeviceAttributeCudaCompatibleEnd = 9999,
-  hipDeviceAttributeAmdSpecificBegin = 10000,
-  hipDeviceAttributeCooperativeMultiDeviceUnmatchedFunc, // Supports cooperative launch on multiple
-                                                         // devices with unmatched functions
-  hipDeviceAttributeCooperativeMultiDeviceUnmatchedGridDim, // Supports cooperative launch on multiple
-                                                            // devices with unmatched grid dimensions
-  hipDeviceAttributeCooperativeMultiDeviceUnmatchedBlockDim, // Supports cooperative launch on multiple
-                                                             // devices with unmatched block dimensions
-  hipDeviceAttributeCooperativeMultiDeviceUnmatchedSharedMem, // Supports cooperative launch on multiple
-                                                              // devices with unmatched shared memories
-  hipDeviceAttributeAsicRevision, // Revision of the GPU in this device
-  hipDeviceAttributeManagedMemory, // Device supports allocating managed memory on this system
-  hipDeviceAttributeDirectManagedMemAccessFromHost, // Host can directly access managed memory on
-                                                    //  the device without migration
-  hipDeviceAttributeConcurrentManagedAccess, // Device can coherently access managed memory
-                                             // concurrently with the CPU
-  hipDeviceAttributePageableMemoryAccess, // Device supports coherently accessing pageable memory
-                                          // without calling hipHostRegister on it
-  hipDeviceAttributePageableMemoryAccessUsesHostPageTables, // Device accesses pageable memory via
-                                                            // the host's page tables
-  hipDeviceAttributeCanUseStreamWaitValue // '1' if Device supports hipStreamWaitValue32() and
-                                          // hipStreamWaitValue64(), '0' otherwise.
-  hipDeviceAttributeClockInstructionRate = hipDeviceAttributeAmdSpecificBegin, // Frequency in khz of the timer used by the device-side "clock"
-  hipDeviceAttributeArch, // Device architecture
-  hipDeviceAttributeMaxSharedMemoryPerMultiprocessor, // Maximum Shared Memory PerMultiprocessor.
-  hipDeviceAttributeGcnArch, // Device gcn architecture
-  hipDeviceAttributeGcnArchName, // Device gcnArch name in 256 bytes
-  hipDeviceAttributeHdpMemFlushCntl, // Address of the HDP_MEM_COHERENCY_FLUSH_CNTL register
-  hipDeviceAttributeHdpRegFlushCntl, // Address of the HDP_REG_COHERENCY_FLUSH_CNTL register
-  hipDeviceAttributeCooperativeMultiDeviceUnmatchedFunc, // Supports cooperative launch on multiple
-                                                         // devices with unmatched functions
-  hipDeviceAttributeCooperativeMultiDeviceUnmatchedGridDim, // Supports cooperative launch on multiple
-                                                            // devices with unmatched grid dimensions
-  hipDeviceAttributeCooperativeMultiDeviceUnmatchedBlockDim, // Supports cooperative launch on multiple
-                                                             // devices with unmatched block dimensions
-  hipDeviceAttributeCooperativeMultiDeviceUnmatchedSharedMem, // Supports cooperative launch on multiple
-                                                              // devices with unmatched shared memories
-  hipDeviceAttributeIsLargeBar, // Whether it is LargeBar
-  hipDeviceAttributeAsicRevision, // Revision of the GPU in this device
-  hipDeviceAttributeCanUseStreamWaitValue, // '1' if Device supports hipStreamWaitValue32() and
-                                           // hipStreamWaitValue64() , '0' otherwise.
-  hipDeviceAttributeAmdSpecificEnd = 19999,
-  hipDeviceAttributeVendorSpecificBegin = 20000,   // Extended attributes for vendors
-} hipDeviceAttribute_t;
-```
-
-# Known Issues in This Release
-
-## Incorrect dGPU Behavior When Using AMDVBFlash Tool
-
-The AMDVBFlash tool, used for flashing the VBIOS image to dGPU, does not communicate with the ROM Controller specifically when the driver is present. This is because the driver, as part of its runtime power management feature, puts the dGPU to a sleep state.
-
-As a workaround, users can run `amdgpu.runpm=0`, which temporarily disables the runtime power management feature from the driver and dynamically changes some power control-related sysfs files.
-
-## Issue with START Timestamp in ROCProfiler
-
-Users may encounter an issue with the enabled timestamp functionality for monitoring one or multiple counters. ROCProfiler outputs the following four timestamps for each kernel:
-
-- Dispatch
-- Start
-- End
-- Complete
-
-**Issue**
-
-This defect is related to the Start timestamp functionality, which incorrectly shows an earlier time than the Dispatch timestamp.
-
-To reproduce the issue,
-
-1. Enable timing using the `--timestamp on` flag.
-2. Use the `-i` option with the input filename that contains the name of the counter(s) to monitor.
-3. Run the program.
-4. Check the output result file.
-
-**Current behavior**
-
-BeginNS is lower than DispatchNS, which is incorrect.
-
-**Expected behavior**
-
-The correct order is:
-
-_Dispatch < Start < End < Complete_
-
-Users cannot use ROCProfiler to measure the time spent on each kernel because of the incorrect timestamp with counter collection enabled.
-
-**Recommended Workaround**
-
-Users are recommended to collect kernel execution timestamps without monitoring counters, as follows:
-
-1. Enable timing using the `--timestamp on` flag, and run the application.
-2. Rerun the application using the `-i` option with the input filename that contains the name of the counter(s) to monitor, and save this to a different output file using the `-o` flag.
-3. Check the output result file from step 1.
-4. The order of timestamps correctly displays as:
-
-_DispathNS < BeginNS < EndNS < CompleteNS_
-
-1. Users can find the values of the collected counters in the output file generated in step 2.
-
-## Radeon Pro V620 and W6800 Workstation GPUs
-
-### No Support for SMI and ROCDebugger on SRIOV
-
-System Management Interface (SMI) and ROCDebugger are not supported in the SRIOV environment on any GPU. For more information, refer to the Systems Management Interface documentation.
-
-# Deprecations and Warnings in This Release
-
-## ROCm Libraries Changes – Deprecations and Deprecation Removal
-
-- The hipfft.h header is now provided only by the hipfft package.  Up to ROCm 5.0, users would get hipfft.h in the rocfft package too.
-- The GlobalPairwiseAMG class is now entirely removed, users should use the PairwiseAMG class instead.
-- The rocsparse\_spmm signature in 5.0 was changed to match that of rocsparse\_spmm\_ex.  In 5.0, rocsparse\_spmm\_ex is still present, but deprecated.  Signature diff for rocsparse\_spmm
-
-### _rocsparse\_spmm_ in 5.0
-
-```c
-rocsparse_status rocsparse_spmm(rocsparse_handle            handle,
-                                rocsparse_operation         trans_A,
-                                rocsparse_operation         trans_B,
-                                const void*                 alpha,
-                                const rocsparse_spmat_descr mat_A,
-                                const rocsparse_dnmat_descr mat_B,
-                                const void*                 beta,
-                                const rocsparse_dnmat_descr mat_C,
-                                rocsparse_datatype          compute_type,
-                                rocsparse_spmm_alg          alg,
-                                rocsparse_spmm_stage        stage,
-                                size_t*                     buffer_size,
-                                void*                       temp_buffer);
-```
-
-### _rocsparse\_spmm_ in 4.0
-
-```c
-rocsparse_status rocsparse_spmm(rocsparse_handle            handle,
-                                rocsparse_operation         trans_A,
-                                rocsparse_operation         trans_B,
-                                const void*                 alpha,
-                                const rocsparse_spmat_descr mat_A,
-                                const rocsparse_dnmat_descr mat_B,
-                                const void*                 beta,
-                                const rocsparse_dnmat_descr mat_C,
-                                rocsparse_datatype          compute_type,
-                                rocsparse_spmm_alg          alg,
-                                size_t*                     buffer_size,
-                                void*                       temp_buffer);
-```
-
-## HIP API Deprecations and Warnings
-
-### Warning - Arithmetic Operators of HIP Complex and Vector Types
-
-In this release, arithmetic operators of HIP complex and vector types are deprecated.
-
-- As alternatives to arithmetic operators of HIP complex types, users can use arithmetic operators of std::complex types.
-- As alternatives to arithmetic operators of HIP vector types, users can use the operators of the native clang vector type associated with the data member of HIP vector types.
-
-During the deprecation, two macros `__HIP_ENABLE_COMPLEX_OPERATORS` and `__HIP_ENABLE_VECTOR_OPERATORS` are provided to allow users to conditionally enable arithmetic operators of HIP complex or vector types.
-
-Note, the two macros are mutually exclusive and, by default, set to off.
-
-The arithmetic operators of HIP complex and vector types will be removed in a future release.
-
-Refer to the HIP API Guide for more information.
-
-### Refactor of HIPCC/HIPCONFIG
-
-In prior ROCm releases, by default, the hipcc/hipconfig Perl scripts were used to identify and set target compiler options, target platform, compiler, and runtime appropriately.
-
-In ROCm v5.0, hipcc.bin and hipconfig.bin have been added as the compiled binary implementations of the hipcc and hipconfig. These new binaries are currently a work-in-progress, considered, and marked as experimental. ROCm plans to fully transition to hipcc.bin and hipconfig.bin in the a future ROCm release. The existing hipcc and hipconfig Perl scripts are renamed to hipcc.pl and hipconfig.pl respectively. New top-level hipcc and hipconfig Perl scripts are created, which can switch between the Perl script or the compiled binary based on the environment variable `HIPCC_USE_PERL_SCRIPT`.
-
-In ROCm 5.0, by default, this environment variable is set to use hipcc and hipconfig through the Perl scripts.
-
-Subsequently, Perl scripts will no longer be available in ROCm in a future release.
-
-## Warning - Compiler-Generated Code Object Version 4 Deprecation
-
-Support for loading compiler-generated code object version 4 will be deprecated in a future release with no release announcement and replaced with code object 5 as the default version.
-
-The current default is code object version 4.
-
-## Warning - MIOpenTensile Deprecation
-
-MIOpenTensile will be deprecated in a future release.
-
-
-
-
-
-# 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, 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.
-©[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. 
+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-5.2.1"
+    <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" />
@@ -49,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="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 name="rocWMMA" 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)

docs/data/deploy/quick_start_windows/image planning

@@ -0,0 +1 @@
+

docs/deploy.md

@@ -0,0 +1,44 @@
+# Deploy
+
+Please follow the guides below to begin your ROCm journey. ROCm can be consumed
+via many mechanisms.
+:::::{grid} 1 1 3 3
+:gutter: 1
+
+::::{grid-item-card}
+:padding: 2
+Quick Start
+^^^
+
+- [Linux](quick_start)
+- [Windows](hip_sdk_install_win/hip_sdk_install_win)
+
+::::
+
+::::{grid-item-card}
+:padding: 2
+Docker
+^^^
+
+- [Guide](deploy/docker)
+- [Dockerhub](https://hub.docker.com/u/rocm/)
+
+::::
+
+::::{grid-item-card}
+:padding: 2
+[Advanced](deploy/advanced)
+^^^
+
+- [Uninstall](deploy/advanced/uninstall)
+- [Multi-ROCm Installations](deploy/advanced/multi)
+- [spack](deploy/advanced/spack)
+- [Build from Source](deploy/advanced/build_source)
+
+::::
+
+:::::
+
+## Related Information
+
+[Release Information](release)

docs/deploy/docker.md

@@ -0,0 +1,90 @@
+# Deploy ROCm Docker containers
+
+## Prerequisites
+
+Docker containers share the kernel with the host operating system, therefore the
+ROCm kernel-mode driver must be installed on the host. Please refer to
+[](/deploy/linux/install) for details. The other user-space parts
+(like the HIP-runtime or math libraries) of the ROCm stack will be loaded from
+the container image and don't need to be installed to the host.
+
+(docker-access-gpus-in-container)=
+
+## Accessing GPUs in containers
+
+In order to access GPUs in a container (to run applications using HIP, OpenCL or
+OpenMP offloading) explicit access to the GPUs must be granted.
+
+The ROCm runtimes make use of multiple device files:
+
+- `/dev/kfd`: the main compute interface shared by all GPUs
+- `/dev/dri/renderD<node>`: direct rendering interface (DRI) devices for each
+  GPU. **`<node>`** is a number for each card in the system starting from 128.
+
+Exposing these devices to a container is done by using the
+[`--device`](https://docs.docker.com/engine/reference/commandline/run/#device)
+option, i.e. to allow access to all GPUs expose `/dev/kfd` and all
+`/dev/dri/renderD` devices:
+
+```shell
+docker run --device /dev/kfd --device /dev/renderD128 --device /dev/renderD129 ...
+```
+
+More conveniently, instead of listing all devices, the entire `/dev/dri` folder
+can be exposed to the new container:
+
+```shell
+docker run --device /dev/kfd --device /dev/dri
+```
+
+Note that this gives more access than strictly required, as it also exposes the
+other device files found in that folder to the container.
+
+(docker-restrict-gpus)=
+
+### Restricting a container to a subset of the GPUs
+
+If a `/dev/dri/renderD` device is not exposed to a container then it cannot use
+the GPU associated with it; this allows to restrict a container to any subset of
+devices.
+
+For example to allow the container to access the first and third GPU start it
+like:
+
+```shell
+docker run --device /dev/kfd --device /dev/dri/renderD128 --device /dev/dri/renderD130 <image>
+```
+
+### Additional Options
+
+The performance of an application can vary depending on the assignment of GPUs
+and CPUs to the task. Typically, `numactl` is installed as part of many HPC
+applications to provide GPU/CPU mappings. This Docker runtime option supports
+memory mapping and can improve performance.
+
+```shell
+--security-opt seccomp=unconfined
+```
+
+This option is recommended for Docker Containers running HPC applications.
+
+```shell
+docker run --device /dev/kfd --device /dev/dri --security-opt seccomp=unconfined ...
+```
+
+## Docker images in the ROCm ecosystem
+
+### Base images
+
+<https://github.com/RadeonOpenCompute/ROCm-docker> hosts images useful for users
+wishing to build their own containers leveraging ROCm. The built images are
+available from [Docker Hub](https://hub.docker.com/u/rocm). In particular
+`rocm/rocm-terminal` is a small image with the prerequisites to build HIP
+applications, but does not include any libraries.
+
+### Applications
+
+AMD provides pre-built images for various GPU-ready applications through its
+Infinity Hub at <https://www.amd.com/en/technologies/infinity-hub>.
+Examples for invoking each application and suggested parameters used for
+benchmarking are also provided there.

docs/deploy/linux/index.md

@@ -0,0 +1,55 @@
+# Deploy ROCm on Linux
+
+Please start with the [Quick Start Linux](quick_start) or follow the detailed instructions below.
+
+::::{grid} 2 3 3 3
+:gutter: 1
+
+:::{grid-item-card} Overview
+:link: install
+:link-type: doc
+
+Overview and comparison of the different ways to install ROCm.
+:::
+
+:::{grid-item-card} Prerequisites
+:link: prerequisites
+:link-type: doc
+
+The prerequisites page lists the required steps *before* installation.
+:::
+
+:::{grid-item-card} Installation
+:link: install
+:link-type: doc
+
+Detailed steps to install with the package manager or with the installation
+script, including multi-version installation. Recommended for most users.
+:::
+
+:::{grid-item-card} Upgrading
+:link: upgrade
+:link-type: doc
+
+Instructions for upgrading an existing ROCm installation.
+:::
+
+:::{grid-item-card} Uninstallation
+:link: uninstall
+:link-type: doc
+
+Steps for removing ROCm packages libraries and tools.
+:::
+
+:::{grid-item-card} Package Manager Integration
+:link: package_manager_integration
+:link-type: doc
+
+Information about (meta-)packages in the ROCm ecosystem.
+:::
+
+::::
+
+## See Also
+
+- [GPU and OS Support Linux](../../gpu_os_support.md)

docs/deploy/linux/install.md

@@ -0,0 +1,956 @@
+# Installation (Linux)
+
+Installing can be done in one of two ways, depending on your preference:
+
+- Using an installer script
+- Through your system's package manager
+
+```{attention}
+For information on installing ROCm on devices with NVIDIA GPUs, refer to the HIP
+Installation Guide.
+```
+
+(install-script-method)=
+
+## Installer Script Method
+
+The installer script method automates the installation process for the AMDGPU
+and ROCm stack. The installer script handles the complete installation process
+for ROCm, including setting up the repository, cleaning the system, updating,
+and installing the desired drivers and meta-packages. With this approach, the
+system has more control over the ROCm installation process. Thus, those who are
+less familiar with the Linux standard commands can choose this method for ROCm
+installation.
+
+For AMDGPU and ROCm installation using the installer script method on Linux
+distribution, follow these steps:
+
+1. **Meet prerequisites** – Ensure the Prerequisites are met before downloading
+   and installing the installer using the installer script method.
+
+2. **Download and install the installer script** – Ensure you download and
+   install the installer script from the recommended URL.
+
+   ```{tip}
+   The installer package is updated periodically to resolve known issues and add
+   new features. The links for each Linux distribution always point to the latest
+   available build.
+   ```
+
+3. **Use the installer script on Linux distributions** – Ensure you execute the
+   script for installing use cases.
+
+### Download and Install the Installer Script
+
+::::::{tab-set}
+:::::{tab-item} Ubuntu
+:sync: ubuntu
+
+<!-- markdownlint-disable-next-line MD013 -->
+::::{rubric} To download the amdgpu-install script on the system, use the following commands.
+::::
+
+::::{tab-set}
+:::{tab-item} Ubuntu 20.04
+:sync: ubuntu-20.04
+
+```shell
+sudo apt update
+wget https://repo.radeon.com/amdgpu-install/5.4.3/ubuntu/focal/amdgpu-install_5.4.50403-1_all.deb
+sudo apt install ./amdgpu-install_5.4.50403-1_all.deb
+```
+
+:::
+:::{tab-item} Ubuntu 22.04
+:sync: ubuntu-22.04
+
+```shell
+sudo apt update
+wget https://repo.radeon.com/amdgpu-install/5.4.3/ubuntu/jammy/amdgpu-install_5.4.50403-1_all.deb
+sudo apt install ./amdgpu-install_5.4.50403-1_all.deb
+```
+
+:::
+::::
+:::::
+:::::{tab-item} Red Hat Enterprise Linux
+:sync: RHEL
+
+<!-- markdownlint-disable-next-line MD013 -->
+::::{rubric} To download the amdgpu-install script on the system, use the following commands.
+::::
+
+::::{tab-set}
+:::{tab-item} RHEL 8.6
+:sync: RHEL-8.6
+
+```shell
+sudo yum install https://repo.radeon.com/amdgpu-install/5.4.3/rhel/8.6/amdgpu-install-5.4.50403-1.el8.noarch.rpm
+```
+
+:::
+:::{tab-item} RHEL 8.7
+:sync: RHEL-8.7
+
+```shell
+sudo yum install https://repo.radeon.com/amdgpu-install/5.4.3/rhel/8.7/amdgpu-install-5.4.50403-1.el8.noarch.rpm
+```
+
+:::
+:::{tab-item} RHEL 9.1
+:sync: RHEL-9.1
+
+```shell
+sudo yum install https://repo.radeon.com/amdgpu-install/5.4.3/rhel/9.1/amdgpu-install-5.4.50403-1.el9.noarch.rpm
+```
+
+:::
+::::
+:::::
+:::::{tab-item} SUSE Linux Enterprise Server 15
+:sync: SLES15
+
+<!-- markdownlint-disable-next-line MD013 -->
+::::{rubric} To download the amdgpu-install script on the system, use the following commands.
+::::
+
+::::{tab-set}
+:::{tab-item} Service Pack 4
+:sync: SLES15-SP4
+
+```shell
+sudo zypper --no-gpg-checks install https://repo.radeon.com/amdgpu-install/5.4.3/sle/15.4/amdgpu-install-5.4.50403-1.noarch.rpm
+```
+
+:::
+::::
+:::::
+::::::
+
+### Using the Installer Script for Single-version ROCm Installation
+
+To install use cases specific to your requirements, use the installer
+`amdgpu-install` as follows:
+
+- To install a single use case:
+
+  ```shell
+  sudo amdgpu-install --usecase=rocm
+  ```
+
+- To install kernel-mode driver:
+
+  ```shell
+  sudo amdgpu-install --usecase=dkms
+  ```
+
+- To install multiple use cases:
+
+  ```shell
+  sudo amdgpu-install --usecase=hiplibsdk,rocm
+  ```
+
+- To display a list of available use cases:
+
+  ```shell
+  sudo amdgpu-install --list-usecase
+  ```
+
+  Following is a sample of output listed by the command above:
+
+  ```{note}
+  The list in this section represents only a sample of available use cases for ROCm:
+  ```
+
+  ```none
+  If --usecase option is not present, the default selection is "graphics,opencl,hip"
+
+  Available use cases:
+  rocm(for users and developers requiring full ROCm stack)
+  - OpenCL (ROCr/KFD based) runtime
+  - HIP runtimes
+  - Machine learning framework
+  - All ROCm libraries and applications
+  - ROCm Compiler and device libraries
+  - ROCr runtime and thunk
+  lrt(for users of applications requiring ROCm runtime)
+  - ROCm Compiler and device libraries
+  - ROCr runtime and thunk
+  opencl(for users of applications requiring OpenCL on Vega or
+  later products)
+  - ROCr based OpenCL
+  - ROCm Language runtime
+
+  openclsdk (for application developers requiring ROCr based OpenCL)
+  - ROCr based OpenCL
+  - ROCm Language runtime
+  - development and SDK files for ROCr based OpenCL
+
+  hip(for users of HIP runtime on AMD products)
+  - HIP runtimes
+  hiplibsdk (for application developers requiring HIP on AMD products)
+  - HIP runtimes
+  - ROCm math libraries
+  - HIP development libraries
+  ```
+
+```{tip}
+Adding `-y` as a parameter to `amdgpu-install` skips user prompts (for
+automation). Example: `amdgpu-install -y --usecase=rocm`
+```
+
+### Using Installer Script in Docker
+
+When the installation is initiated in Docker, the installer tries to install the
+use case along with the kernel-mode driver. However, you cannot install the
+kernel-mode driver in a Docker container. To skip the installation of the
+kernel-mode driver, proceed with the `--no-dkms` option, as shown below:
+
+```shell
+sudo amdgpu-install --usecase=rocm --no-dkms
+```
+
+### Using the Installer Script for Multi-version ROCm Installation
+
+The multi-version ROCm installation requires you to download and install the
+latest ROCm release installer from the list of ROCm releases you want to install
+simultaneously on your system.
+
+**Example:** If you want to install ROCm releases 4.5.0, 4.5.1, and 5.4.3
+simultaneously, you are required to download the installer from the latest ROCm
+release v5.4.3.
+
+To download and install the installer, refer to the [Download and Install the
+Installer Script](#download-and-install-the-installer-script) section.
+
+```{attention}
+If the existing ROCm release contains non-versioned ROCm packages, uninstall
+those packages before proceeding with the multi-version installation to avoid
+conflicts.
+```
+
+#### Add Required ROCm Repositories
+
+Add the required repositories using the following steps:
+
+```{important}
+Add the AMDGPU and ROCm repositories manually for all ROCm releases you want to
+install except the latest one. The amdgpu-install script automatically adds the
+required repositories for the latest release.
+```
+
+::::::{tab-set}
+:::::{tab-item} Ubuntu
+:sync: ubuntu
+
+::::{tab-set}
+:::{tab-item} Ubuntu 20.04
+:sync: ubuntu-20.04
+
+```shell
+for ver in 5.0.2 5.1.4 5.2.5 5.3.3; do
+echo "deb [arch=amd64 signed-by=/etc/apt/trusted.gpg.d/rocm-keyring.gpg] https://repo.radeon.com/rocm/apt/$ver focal main" | sudo tee /etc/apt/sources.list.d/rocm.list
+done
+echo -e 'Package: *\nPin: release o=repo.radeon.com\nPin-Priority: 600' | sudo tee /etc/apt/preferences.d/rocm-pin-600
+sudo apt update
+```
+
+:::
+:::{tab-item} Ubuntu 22.04
+:sync: ubuntu-22.04
+
+```shell
+for ver in 5.0.2 5.1.4 5.2.5 5.3.3; do
+echo "deb [arch=amd64 signed-by=/etc/apt/trusted.gpg.d/rocm-keyring.gpg] https://repo.radeon.com/rocm/apt/$ver jammy main" | sudo tee /etc/apt/sources.list.d/rocm.list
+done
+echo -e 'Package: *\nPin: release o=repo.radeon.com\nPin-Priority: 600' | sudo tee /etc/apt/preferences.d/rocm-pin-600
+sudo apt update
+```
+
+:::
+::::
+:::::
+:::::{tab-item} Red Hat Enterprise Linux
+:sync: RHEL
+
+```shell
+for ver in 5.0.2 5.1.4 5.2.5 5.3.3; do
+sudo tee --append /etc/yum.repos.d/rocm.repo <<EOF
+[ROCm-$ver]
+Name=ROCm$ver
+baseurl=https://repo.radeon.com/rocm/$ver/main
+enabled=1
+priority=50
+gpgcheck=1
+gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
+EOF
+done
+sudo yum clean all
+```
+
+:::::
+:::::{tab-item} SUSE Linux Enterprise Server 15
+:sync: SLES15
+
+```shell
+for ver in 5.0.2 5.1.4 5.2.5 5.3.3; do
+sudo tee --append /etc/zypp/repos.d/rocm.repo <<EOF
+name=rocm
+baseurl=https://repo.radeon.com/amdgpu/$ver/sle/15.4/main/x86_64
+enabled=1
+gpgcheck=1
+gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
+EOF
+done
+sudo zypper ref
+```
+
+:::::
+::::::
+
+#### Use the Installer to Install Multi-version ROCm Meta-packages
+
+Use the installer script as given below:
+
+```none
+sudo amdgpu-install --usecase=rocm --rocmrelease=<release-number-1>
+sudo amdgpu-install --usecase=rocm --rocmrelease=<release-number-2>
+sudo amdgpu-install --usecase=rocm --rocmrelease=<release-number-3>
+```
+
+```{tip}
+If the kernel-mode driver is already present on the system and you do not want
+to upgrade it, use the `--no-dkms` option to skip the installation of the
+kernel-mode driver, as shown in the following samples:
+```
+
+```none
+sudo amdgpu-install --usecase=rocm --rocmrelease=4.5.0 --no-dkms
+sudo amdgpu-install --usecase=rocm --rocmrelease=5.4.3 --no-dkms
+```
+
+Following are examples of ROCm multi-version installation. The kernel-mode
+driver, associated with the ROCm release v5.4.3, will be installed as its latest
+release in the list.
+
+```none
+sudo amdgpu-install --usecase=rocm --rocmrelease=4.5.0
+sudo amdgpu-install --usecase=rocm --rocmrelease=4.5.2
+sudo amdgpu-install --usecase=rocm --rocmrelease=5.4.3
+```
+
+## Package Manager Method
+
+The package manager method involves a manual setup of the repository, which
+includes setting up the repository, updating, and installing/uninstalling
+meta-packages. This involves using standard commands such as yum, apt, and
+others respective to the Linux distribution.
+
+The functions of a package manager installation system are:
+
+- Grouping packages based on function
+- Extracting package archives
+- Ensuring a package is installed with all necessary packages and dependencies
+  are managed
+- From a remote repository, looking up, downloading, installing, or updating
+  existing packages
+- Ensuring the authenticity and integrity of the package
+
+### Installing ROCm on Linux Distributions
+
+For a fresh ROCm installation using the package manager method on a Linux
+distribution, follow the steps below:
+
+1. **Meet prerequisites** – Ensure the Prerequisites are met before the ROCm
+   installation.
+
+2. **Install kernel headers and development packages** – Ensure kernel headers
+   and development packages are installed on the system.
+
+3. **Select the base URLs for AMDGPU and ROCm stack repository** – Ensure the
+   base URLs for AMDGPU and ROCm stack repositories are selected.
+
+4. **Add the AMDGPU stack repository** – Ensure the AMDGPU stack repository is
+   added.
+
+5. **Install the kernel-mode driver and reboot the system** – Ensure the
+   kernel-mode driver is installed and the system is rebooted.
+
+6. **Add ROCm stack repository** – Ensure the ROCm stack repository is added.
+
+7. **Install single-version or multi-version ROCm meta-packages** – Install the
+   desired meta-packages.
+
+8. **Verify installation for the applicable distributions** – Verify if the
+   installation is successful.
+
+```{important}
+You cannot install a kernel-mode driver in a Docker container. Refer to the
+sections below for specific commands to install the AMDGPU and ROCm stack on
+various Linux distributions.
+```
+
+#### Understanding the Release-specific AMDGPU and ROCm Stack Repositories on Linux Distributions
+
+The release-specific repositories consist of packages from a specific release of
+the AMDGPU stack and ROCm stack. The repositories are not updated for the latest
+packages with subsequent releases. When a new ROCm release is available, the new
+repository, specific to that release, is added. You can select a specific
+release to install, update the previously installed single version to the later
+available release, or add the latest version of ROCm along with the currently
+installed version by using the multi-version ROCm packages.
+
+```{note}
+Users installing multiple versions of the ROCm stack must use the
+release-specific base URL.
+```
+
+#### Using the Package Manager
+
+::::::{tab-set}
+:::::{tab-item} Ubuntu
+:sync: ubuntu
+
+::::{rubric} Installation of Kernel Headers and Development Packages
+::::
+
+The following instructions to install kernel headers and development packages
+apply to all versions and kernels of Ubuntu. The ROCm installation requires you
+to install the Linux-headers and Linux-modules-extra package with the correct
+version corresponding to the kernel's version.
+
+**Example:** If the system is running the Linux kernel version
+`5.15.0-41-generic`, you must install the identical versions of Linux-headers
+and development packages. Refer to {ref}`check-kernel-info` on to how to check
+the system's kernel version.
+
+To check the `kernel-headers` and `linux-modules-extra` package versions,
+follow these steps:
+
+1. For the Ubuntu/Debian environment, execute the following command to verify
+   the kernel headers and development packages are installed with the
+   respective versions:
+
+   ```shell
+   sudo dpkg -l | grep linux-headers
+   ```
+
+   The command indicates if there are Linux headers installed as shown below:
+
+   ```none
+   ii  linux-headers-5.15.0-41-generic            5.15.0-41.44~20.04.1                    amd64        Linux kernel headers for version 5.15.0 on 64 bit x86 SMP
+   ```
+
+2. Execute the following command to check whether the development packages are
+   installed:
+
+   ```shell
+   sudo dpkg -l | grep linux-modules-extra
+   ```
+
+   The command mentioned above lists the installed `linux-modules-extra`
+   packages like the output below:
+
+   ```none
+   ii  linux-modules-extra-5.15.0-41-generic      5.15.0-41.44~20.04.1                    amd64        Linux kernel extra modules for version 5.15.0 on 64 bit x86 SMP
+   ```
+
+3. If the supported version installation of Linux headers and development
+   packages are not installed on the system, execute the following command
+   to install the packages:
+
+   ```shell
+   sudo apt install linux-headers-`uname -r` linux-modules-extra-`uname -r`
+   ```
+
+::::{rubric} Adding the AMDGPU and ROCm Stack Repositories
+::::
+
+1. Add GPG Key for AMDGPU and ROCm Stack
+
+   Add the GPG key for AMDGPU and ROCm repositories. For Debian-based systems
+   like Ubuntu, configure the Debian ROCm repository as follows:
+
+   ```shell
+   curl -fsSL https://repo.radeon.com/rocm/rocm.gpg.key | sudo gpg --dearmor -o /etc/apt/trusted.gpg.d/rocm-keyring.gpg
+   ```
+
+   ```{note}
+   The GPG key may change; ensure it is updated when installing a new release. If
+   the key signature verification fails while updating, re-add the key from the
+   ROCm to the apt repository as mentioned above. The current `rocm.gpg.key` is not
+   available in a standard key ring distribution but has the following SHA1 sum
+   hash: `73f5d8100de6048aa38a8b84cd9a87f05177d208 rocm.gpg.key`
+   ```
+
+2. Add the AMDGPU Stack Repository and Install the Kernel-mode Driver
+
+   ```{attention}
+   If you have a version of the kernel-mode driver installed, you may skip this
+   section.
+   ```
+
+   To add the AMDGPU stack repository, follow these steps:
+
+   ::::{tab-set}
+   :::{tab-item} Ubuntu 20.04
+   :sync: ubuntu-20.04
+
+   ```shell
+   echo 'deb [arch=amd64 signed-by=/etc/apt/trusted.gpg.d/rocm-keyring.gpg] https://repo.radeon.com/amdgpu/5.4.3/ubuntu focal main' | sudo tee /etc/apt/sources.list.d/amdgpu.list
+   sudo apt update
+   ```
+
+   :::
+   :::{tab-item} Ubuntu 22.04
+   :sync: ubuntu-22.04
+
+   ```shell
+   echo 'deb [arch=amd64 signed-by=/etc/apt/trusted.gpg.d/rocm-keyring.gpg] https://repo.radeon.com/amdgpu/5.4.3/ubuntu jammy main' | sudo tee /etc/apt/sources.list.d/amdgpu.list
+   sudo apt update
+   ```
+
+   :::
+   ::::
+
+   Install the kernel mode driver and reboot the system using the following
+   commands:
+
+   ```shell
+   sudo apt install amdgpu-dkms
+   sudo reboot
+   ```
+
+3. Add the ROCm Stack Repository and Install Meta-packages
+
+   To add the ROCm repository, use the following steps:
+
+   ::::{tab-set}
+   :::{tab-item} Ubuntu 20.04
+   :sync: ubuntu-20.04
+
+   ```shell
+   for ver in 5.0.2 5.1.4 5.2.5 5.3.3 5.4.3; do
+   echo "deb [arch=amd64 signed-by=/etc/apt/trusted.gpg.d/rocm-keyring.gpg] https://repo.radeon.com/rocm/apt/$ver focal main" | sudo tee /etc/apt/sources.list.d/rocm.list
+   done
+   echo -e 'Package: *\nPin: release o=repo.radeon.com\nPin-Priority: 600' | sudo tee /etc/apt/preferences.d/rocm-pin-600
+   sudo apt update
+   ```
+
+   :::
+   :::{tab-item} Ubuntu 22.04
+   :sync: ubuntu-22.04
+
+   ```shell
+   for ver in 5.0.2 5.1.4 5.2.5 5.3.3 5.4.3; do
+   echo "deb [arch=amd64 signed-by=/etc/apt/trusted.gpg.d/rocm-keyring.gpg] https://repo.radeon.com/rocm/apt/$ver jammy main" | sudo tee /etc/apt/sources.list.d/rocm.list
+   done
+   echo -e 'Package: *\nPin: release o=repo.radeon.com\nPin-Priority: 600' | sudo tee /etc/apt/preferences.d/rocm-pin-600
+   sudo apt update
+   ```
+
+   :::
+   ::::
+
+   Install packages of your choice in a single-version ROCm install or
+   in a multi-version ROCm install fashion. For more information on what
+   single/multi-version installations are, refer to {ref}`installation-types`.
+   For a comprehensive list of meta-packages, refer to
+   {ref}`meta-package-desc`.
+
+- Sample Single-version installation
+
+   ```shell
+   sudo apt install rocm-hip-sdk
+   ```
+
+- Sample Multi-version installation
+
+   ```{important}
+   If the existing ROCm release contains non-versioned ROCm packages, you must
+   uninstall those packages before proceeding to the multi-version installation
+   to avoid conflicts.
+   ```
+
+   ```shell
+   sudo apt install rocm-hip-sdk5.4.3 rocm-hip-sdk5.2.5
+   ```
+
+:::::
+:::::{tab-item} Red Hat Enterprise Linux
+:sync: RHEL
+
+::::{rubric} Installation of Kernel Headers and Development Packages
+::::
+
+The ROCm installation requires that you install the kernel headers and
+`linux-modules-extra` package with the correct version corresponding to the
+kernel's version.
+
+**Example:** If the system is running Linux kernel version
+`3.10.0-1160.el7.x86_64`, you must install the identical versions of kernel
+headers and development packages. Refer to {ref}`check-kernel-info` on to how to
+check the system's kernel version.
+
+To check the kernel headers and `linux-modules-extra` package versions,
+follow these steps:
+
+1. To verify you have the supported version of the installed kernel headers,
+   type the following on the command line:
+
+   ```shell
+   sudo yum list installed kernel-headers
+   ```
+
+   The command mentioned above displays the list of kernel headers versions
+   currently present on your system. Verify if the listed kernel headers have
+   the same versions as the kernel.
+
+2. The following command lists the development packages on your system. Verify
+   if the listed development package's version number matches the kernel
+   version number:
+
+   ```shell
+   sudo yum list installed kernel-devel
+   ```
+
+3. If the supported version installation of kernel headers and development
+   packages does not exist on the system, execute the command below to install:
+
+   ```shell
+   sudo yum install kernel-headers-`uname -r` kernel-devel-`uname -r`
+   ```
+
+::::{rubric} Adding the AMDGPU and ROCm Stack Repositories
+::::
+
+1. Add the AMDGPU Stack Repository and Install the Kernel-mode Driver
+
+   ```{attention}
+   If you have a version of the kernel-mode driver installed, you may skip this
+   section.
+   ```
+
+   ::::{tab-set}
+   :::{tab-item} RHEL 8.6
+   :sync: RHEL-8.6
+
+   ```shell
+   sudo tee --append /etc/yum.repos.d/amdgpu.repo <<EOF
+   [amdgpu]
+   Name=amdgpu
+   baseurl=https://repo.radeon.com/amdgpu/5.4.3/rhel/8.6/main/x86_64/
+   enabled=1
+   priority=50
+   gpgcheck=1
+   gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
+   EOF
+   sudo yum clean all
+   ```
+
+   :::
+
+   :::{tab-item} RHEL 8.7
+   :sync: RHEL-8.7
+
+   ```shell
+   sudo tee --append /etc/yum.repos.d/amdgpu.repo <<EOF
+   [amdgpu]
+   Name=amdgpu
+   baseurl=https://repo.radeon.com/amdgpu/5.4.3/rhel/8.7/main/x86_64/
+   enabled=1
+   priority=50
+   gpgcheck=1
+   gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
+   EOF
+   sudo yum clean all
+   ```
+
+   :::
+
+   :::{tab-item} RHEL 9.1
+   :sync: RHEL-9.1
+
+   ```shell
+   sudo tee --append /etc/yum.repos.d/amdgpu.repo <<EOF
+   [amdgpu]
+   Name=amdgpu
+   baseurl=https://repo.radeon.com/amdgpu/5.4.3/rhel/9.2/main/x86_64/
+   enabled=1
+   priority=50
+   gpgcheck=1
+   gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
+   EOF
+   sudo yum clean all
+   ```
+
+   :::
+   ::::
+
+   Install the kernel mode driver and reboot the system using the following
+   commands:
+
+   ```shell
+   sudo yum install amdgpu-dkms
+   sudo reboot
+   ```
+
+2. Add the ROCm Stack Repository and Install Meta-packages
+
+   To add the ROCm repository, use the following steps:
+
+   ```shell
+   for ver in 5.0.2 5.1.4 5.2.5 5.3.3 5.4.3; do
+   sudo tee --append /etc/yum.repos.d/rocm.repo <<EOF
+   [ROCm-$ver]
+   Name=ROCm$ver
+   baseurl=https://repo.radeon.com/rocm/$ver/main
+   enabled=1
+   priority=50
+   gpgcheck=1
+   gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
+   EOF
+   done
+   sudo yum clean all
+   ```
+
+   Install packages of your choice in a single-version ROCm install or
+   in a multi-version ROCm install fashion. For more information on what
+   single/multi-version installations are, refer to {ref}`installation-types`.
+   For a comprehensive list of meta-packages, refer to
+   {ref}`meta-package-desc`.
+
+- Sample Single-version installation
+
+   ```shell
+   sudo yum install rocm-hip-sdk
+   ```
+
+- Sample Multi-version installation
+
+   ```{important}
+   If the existing ROCm release contains non-versioned ROCm packages, you must
+   uninstall those packages before proceeding to the multi-version installation
+   to avoid conflicts.
+   ```
+
+   ```shell
+   sudo yum install rocm-hip-sdk5.4.3 rocm-hip-sdk5.2.5
+   ```
+
+:::::
+:::::{tab-item} SUSE Linux Enterprise Server 15
+:sync: SLES15
+
+::::{rubric} Installation of Kernel Headers and Development Packages
+::::
+
+ROCm installation requires you to install `linux-headers` and
+`linux-modules-extra` package with the correct version corresponding to the
+kernel's version.
+
+**Example:** If the system is running the Linux kernel version
+`5.3.18-57_11.0.18`, you must install the same versions of Linux headers and
+development packages. Refer to {ref}`check-kernel-info` on to how to check
+the system's kernel version.
+
+To check the `kernel-headers` and `linux-modules-extra` package versions, follow
+these steps:
+
+1. Ensure that the correct version of the latest `kernel-default-devel` and
+   `kernel-default` packages are installed. The following command lists the
+   installed `kernel-default-devel` and `kernel-default` package:
+
+   ```shell
+   sudo zypper info kernel-default-devel or kernel-default
+   ```
+
+   ```{note}
+   This next step is only required if you find from the above command that the
+   `kernel-default-devel` and `kernel-default` versions of the package,
+   corresponding to the kernel release version, do not exist on your system.
+   ```
+
+2. If the required version of packages does not exist on the system, install
+   with the command below:
+
+   ```shell
+   sudo zypper install kernel-default-devel or kernel-default
+   ```
+
+::::{rubric} Adding the AMDGPU and ROCm Stack Repositories
+::::
+
+1. Add the AMDGPU Stack Repository and Install the Kernel-mode Driver
+
+   ```{attention}
+   If you have a version of the kernel-mode driver installed, you may skip this
+   section.
+   ```
+
+   ```shell
+   sudo tee --append /etc/zypp/repos.d/amdgpu.repo <<EOF
+   [amdgpu]
+   name=amdgpu
+   baseurl=https://repo.radeon.com/amdgpu/5.4.3/sle/15.4/main/x86_64
+   enabled=1
+   gpgcheck=1
+   gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
+   EOF
+   sudo zypper ref
+   ```
+
+   Install the kernel mode driver and reboot the system using the following
+   commands:
+
+   ```shell
+   sudo zypper --gpg-auto-import-keys install amdgpu-dkms
+   sudo reboot
+   ```
+
+2. Add the ROCm Stack Repository and Install Meta-packages
+
+   To add the ROCm repository, use the following steps:
+
+   ```shell
+   for ver in 5.0.2 5.1.4 5.2.5 5.3.3 5.4.3; do
+   sudo tee --append /etc/zypp/repos.d/rocm.repo <<EOF
+   name=rocm
+   baseurl=https://repo.radeon.com/amdgpu/$ver/sle/15.4/main/x86_64
+   enabled=1
+   gpgcheck=1
+   gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
+   EOF
+   done
+   sudo zypper ref
+   ```
+
+   Install packages of your choice in a single-version ROCm install or
+   in a multi-version ROCm install fashion. For more information on what
+   single/multi-version installations are, refer to {ref}`installation-types`.
+   For a comprehensive list of meta-packages, refer to
+   {ref}`meta-package-desc`.
+
+- Sample Single-version installation
+
+   ```shell
+   sudo zypper --gpg-auto-import-keys install rocm-hip-sdk
+   ```
+
+- Sample Multi-version installation
+
+   ```{important}
+   If the existing ROCm release contains non-versioned ROCm packages, you must
+   uninstall those packages before proceeding to the multi-version installation
+   to avoid conflicts.
+   ```
+
+   ```shell
+   sudo zypper --gpg-auto-import-keys install rocm-hip-sdk5.4.3 rocm-hip-sdk5.2.5
+   ```
+
+:::::
+::::::
+
+(post-install-actions-linux)=
+
+## Post-install Actions and Verification Process
+
+The post-install actions listed here are optional and depend on your use case,
+but are generally useful. Verification of the install is advised.
+
+### Post-install Actions
+
+1. Instruct the system linker where to find the shared objects (`.so` files) for
+   ROCm applications.
+
+   ```shell
+   sudo tee --append /etc/ld.so.conf.d/rocm.conf <<EOF
+   /opt/rocm/lib
+   /opt/rocm/lib64
+   EOF
+   sudo ldconfig
+   ```
+
+   ```{note}
+   Multi-version installations require extra care. Having multiple versions on
+   the system linker library search path is unadvised. One must take care both
+   at compile-time and at run-time to assure that the proper libraries are
+   picked up. You can override `ld.so.conf` entries on a case-by-case basis
+   using the `LD_LIBRARY_PATH` environmental variable.
+   ```
+
+2. Add binary paths to the `PATH` environment variable.
+
+   ```shell
+   export PATH=$PATH:/opt/rocm-5.4.3/bin:/opt/rocm-5.4.3/opencl/bin
+   ```
+
+   ```{attention}
+   When using CMake to build applications, having the ROCm install location on
+   the PATH subtly affects how ROCm libraries are searched for. See [Config Mode
+   Search Procedure](https://cmake.org/cmake/help/latest/command/find_package.html#config-mode-search-procedure)
+   and [CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH](https://cmake.org/cmake/help/latest/variable/CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH.html)
+   for details.
+
+   (Entries in the `PATH` minus `bin` and `sbin` are added to library search
+   paths, therefore this convenience will affect builds and result in ROCm
+   libraries almost always being found. This may be an issue when you're
+   developing these libraries or want to use self-built versions of them.)
+   ```
+
+(verifying-kernel-mode-driver-installation)=
+
+### Verifying Kernel-mode Driver Installation
+
+Check the installation of the kernel-mode driver by typing the command given
+below:
+
+```shell
+dkms status
+```
+
+### Verifying ROCm Installation
+
+After completing the ROCm installation, execute the following commands on the
+system to verify if the installation is successful. If you see your GPUs listed
+by both commands, the installation is considered successful:
+
+```shell
+/opt/rocm/bin/rocminfo
+# OR
+/opt/rocm/opencl/bin/clinfo
+```
+
+### Verifying Package Installation
+
+To ensure the packages are installed successfully, use the following commands:
+
+::::{tab-set}
+:::{tab-item} Ubuntu
+:sync: ubuntu
+
+```shell
+sudo apt list --installed
+```
+
+:::
+
+:::{tab-item} Red Hat Enterprise Linux
+:sync: RHEL
+
+```shell
+sudo yum list installed
+```
+
+:::
+
+:::{tab-item} SUSE Linux Enterprise Server 15
+:sync: SLES15
+
+```shell
+sudo zypper search --installed-only
+```
+
+:::
+::::

docs/deploy/linux/install_overview.md

@@ -0,0 +1,138 @@
+# Installation Overview (Linux)
+
+This document is intended for users familiar with Linux and discusses the
+installation of ROCm on various distributions.
+
+The guide provides instructions for the following:
+
+- Kernel-mode driver installation
+- ROCm single-version and multi-version installation
+- ROCm and kernel-mode driver version upgrade
+- ROCm single-version and multi-version uninstallation
+- Kernel-mode driver uninstallation
+
+```{note}
+The rest of this document refers to _Radeon™ Software for Linux_ as the `amdgpu`
+stack and `amdgpu-dkms` driver as the kernel-mode driver.
+```
+
+## Installation Methods
+
+It is customary for Linux installers to integrate into the system's package
+manager. There are two notable groups of package sources:
+
+- AMD-hosted repositories maintained by AMD available to register on supported
+  Linux distribution versions. For a complete list of AMD-supported platforms,
+  refer to the article: [GPU and OS Support](/release/gpu_os_support).
+- Distribution-hosted repositories maintained by the developer of said Linux
+  distribution. These require little to no setup from the user, but aren't tested
+  by AMD. For support on these installations, contact the relevant maintainers.
+
+AMD also provides installer scripts for those that wish to drive installations
+in a more manual fashion.
+
+## Package Licensing
+
+```{attention}
+AQL Profiler and AOCC CPU optimization are both provided in binary form, each
+subject to the license agreement enclosed in the directory for the binary and is
+available here: `/opt/rocm/share/doc/rocm-llvm-alt/EULA`. By using, installing,
+copying or distributing AQL Profiler and/or AOCC CPU Optimizations, you agree to
+the terms and conditions of this license agreement. If you do not agree to the
+terms of this agreement, do not install, copy or use the AQL Profiler and/or the
+AOCC CPU Optimizations.
+```
+
+For the rest of the ROCm packages, you can find the licensing information at the
+following location: `/opt/rocm/share/doc/<component-name>/`
+
+For example, you can fetch the licensing information of the `_amd_comgr_`
+component (Code Object Manager) from the `amd_comgr` folder. A file named
+`LICENSE.txt` contains the license details at:
+`/opt/rocm-5.4.3/share/doc/amd_comgr/LICENSE.txt`
+
+### Package Manager Integration
+
+Integrating with the distribution's package manager let's the user install,
+upgrade and uninstall using familiar commands and workflows. The actual commands
+vary from distribution to distribution. For more information, refer to
+[Package Manager Integration](package_manager_integration).
+
+### Installer Script
+
+The `amdgpu-install` script streamlines the installation process by:
+
+- Abstracting the distribution-specific package installation logic
+- Performing the repository setup
+- Allowing you to specify the use case and automating the installation of all
+  the required packages
+- Installing multiple ROCm releases simultaneously on a system
+- Automating updating local repository information through enhanced
+  functionality of the `amdgpu-install` script
+- Performing post-install checks to verify whether the installation was
+  completed successfully
+- Upgrading the installed ROCm release
+- Uninstalling the installed single-version or multi-version ROCm releases
+
+```{tip}
+The installer script is provided for convenience. It doesn't do anything the
+user otherwise couldn't. It automates some tasks surrounding installation, such
+as registering/unregistering and driving the system's package manager, but the
+bulk of the work will still be done by the system's package manager. As is the
+case with most convenience wrappers, some degree of customization is lost for
+the sake of simplicity.
+```
+
+#### Use cases
+
+The installer script introduces the notion of "use cases", which denote usage
+patterns or reasons why someone installs ROCm. This is to allow users to install
+only a subset of the ROCm ecosystem, parts concerning them, resulting in
+smaller installation footprint and faster installs/upgrades.
+
+Some of the ROCm-specific use cases the installer supports are:
+
+- OpenCL (ROCr/KFD based) runtime
+- HIP runtimes
+- ROCm libraries and applications
+- ROCm Compiler and device libraries
+- Kernel-mode driver
+
+For more information, refer to the How to Install ROCm section in this guide.
+
+(installation-types)=
+
+## Installation types
+
+This section discusses the single-version and multi-version installation of the
+ROCm software stack.
+
+### Single-version Installation
+
+The single-version ROCm installation refers to the following:
+
+- Installation of a single instance of the ROCm release on a system
+- Use of non-versioned ROCm meta-packages
+
+### Multi-version Installation
+
+The multi-version installation refers to the following:
+
+- Installation of multiple instances of the ROCm stack on a system. Extending
+  the package name and its dependencies with the release version adds the
+  ability to support multiple versions of packages simultaneously.
+- Use of versioned ROCm meta-packages.
+
+```{note}
+Multiversion install is not available for the AMDGPU stack.
+```
+
+The following image demonstrates the difference between single-version and
+multi-version ROCm installation types:
+
+```{figure-md} install-types
+
+<img src="/data/deploy/linux/image.001.png" alt="">
+
+ROCm Installation Types
+```

docs/deploy/linux/package_manager_integration.md

@@ -0,0 +1,118 @@
+# Package Manager Integration
+
+This section provides information about the required meta-packages for the
+following AMD ROCm programming models:
+
+- Heterogeneous-Computing Interface for Portability (HIP)
+- OpenCL™
+- OpenMP™
+
+## ROCm Package Naming Conventions
+
+A meta-package is a grouping of related packages and dependencies used to
+support a specific use case.
+
+**Example:** Running HIP applications
+
+All meta-packages exist in both versioned and non-versioned forms.
+
+- Non-versioned packages – For a single-version installation of the ROCm stack
+- Versioned packages – For multi-version installations of the ROCm stack
+
+```{figure-md} package-naming
+
+<img src="/data/deploy/linux/image.002.png" alt="">
+
+ROCm Release Package Naming
+```
+
+{numref}`package-naming` demonstrates the single and multi-version ROCm packages' naming
+structure, including examples for various Linux distributions. See terms below:
+
+_Module_ - It is the part of the package that represents the name of the ROCm
+component.
+
+**Example:** The examples mentioned in the image represent the ROCm HIP module.
+
+_Module version_ - It is the version of the library released in that package. It
+should increase with a newer release.
+
+_Release version_ - It shows the ROCm release version when the package was
+released.
+
+**Example:** `50400` points to the ROCm 5.4.0 release.
+
+_Build id_ - It represents the Jenkins build number for that release.
+
+_Arch_ - It shows the architecture for which the package was created.
+
+_Distro_ - It describes the distribution for which the package was created. It is
+valid only for rpm packages.
+
+**Example:** `el8` represents RHEL 8.x packages.
+
+## Components of ROCm Programming Models
+
+{numref}`meta-packages` demonstrates the high-level layered architecture of ROCm
+programming models and their meta-packages. All meta-packages are a combination
+of required packages and libraries.
+
+**Example:**
+
+- `rocm-hip-runtime` is used to deploy on supported machines to execute HIP
+  applications.
+- `rocm-hip-sdk` contains runtime components to deploy and execute HIP
+  applications.
+
+```{figure-md} meta-packages
+
+<img src="/data/deploy/linux/image.003.png" alt="">
+
+ROCm Meta Packages
+```
+
+```{note}
+`rocm-llvm` is not a meta-package but a single package that installs the ROCm
+clang compiler files.
+```
+
+```{table} Meta-packages and Their Descriptions
+:name: meta-package-desc
+| **Meta-packages**          | **Description**                                                                                                                           |
+|:---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------:|
+| `rocm-language-runtime`  | The ROCm runtime                                                                                                                 |
+| `rocm-hip-runtime`       | Run HIP applications written for the AMD platform                                                     |
+| `rocm-opencl-runtime`    | Run OpenCL-based applications on the AMD platform                                                           |
+| `rocm-hip-runtime-devel` | Develop applications on HIP or port from CUDA                                                                   |
+| `rocm-opencl-sdk`        | Develop applications in OpenCL for the AMD platform                                                         |
+| `rocm-hip-libraries`     | HIP libraries optimized for the AMD platform                                                                                        |
+| `rocm-hip-sdk`           | Develop or port HIP applications and libraries for the AMD platform                                        |
+| `rocm-developer-tools`   | Debug and profile HIP applications                                                                    |
+| `rocm-ml-sdk`            | Develop and run Machine Learning applications with optimized for AMD |
+| `rocm-ml-libraries`      | Key Machine Learning libraries, specifically MIOpen                                                                 |
+| `rocm-openmp-sdk`        | Develop OpenMP-based applications for the AMD platform                                                        |
+| `rocm-openmp-runtime`    | Run OpenMP-based applications for the AMD platform                                                            |
+```
+
+## Packages in ROCm Programming Models
+
+This section discusses the available meta-packages and their packages. The
+following image visualizes the meta-packages and their associated packages in a
+ROCm programming model.
+
+```{figure-md} assoc-packages
+
+<img src="/data/deploy/linux/image.004.png" alt="">
+
+Associated Packages
+```
+
+- Meta-packages can include another meta-package.
+- `rocm-core` package is common across all the meta-packages.
+- Meta-packages and associated packages are represented in the same color.
+
+```{note}
+{numref}`assoc-packages` is for informational purposes only, as the individual
+packages in a meta-package are subject to change. Install meta-packages, and not
+individual packages, to avoid conflicts.
+```

docs/deploy/linux/prerequisites.md

@@ -0,0 +1,129 @@
+# Installation Prerequisites (Linux)
+
+You must perform the following steps before installing ROCm and check if the
+system meets all the requirements to proceed with the installation.
+
+## Confirm the System Has a Supported Linux Distribution Version
+
+The ROCm installation is supported only on specific Linux distributions and
+kernel versions.
+
+### Check the Linux Distribution and Kernel Version on Your System
+
+This section discusses obtaining information about the Linux distribution and
+kernel version.
+
+#### Linux Distribution Information
+
+Verify the Linux distribution using the following steps:
+
+1. To obtain the Linux distribution information, type the following command on
+   your system from the Command Line Interface (CLI):
+
+   ```shell
+   uname -m && cat /etc/*release
+   ```
+
+2. Confirm that the obtained Linux distribution information matches with those listed in {ref}`supported_distributions`.
+
+   **Example:** Running the command above on an Ubuntu system results in the
+   following output:
+
+   ```shell
+   x86_64
+   DISTRIB_ID=Ubuntu
+   DISTRIB_RELEASE=20.04
+   DISTRIB_CODENAME=focal
+   DISTRIB_DESCRIPTION="Ubuntu 20.04.5 LTS"
+   ```
+
+(check-kernel-info)=
+
+#### Kernel Information
+
+Verify the kernel version using the following steps:
+
+1. To check the kernel version of your Linux system, type the following command:
+
+   ```shell
+   uname -srmv
+   ```
+
+2. Confirm that the obtained kernel version information matches with System
+   Requirements.
+
+   **Example:** The output of the command above lists the kernel version in the
+   following format:
+
+   ```shell
+   Linux 5.15.0-46-generic #44~20.04.5-Ubuntu SMP Fri Jun 24 13:27:29 UTC 2022 x86_64
+   ```
+
+## Confirm the System has a ROCm-Capable GPU
+
+The ROCm platform is designed to support the following GPUs:
+
+```{table} GPU Support for ROCm Programming Models
+:name: gpu-support
+| **Classification** | **GPU Name**              | **GFX ID** | **Product Id** |
+|:------------------:|:-------------------------:|:----------:|:--------------:|
+| **GFX9 GPUs**      | AMD Radeon Instinct™ MI50 | gfx906     | Vega 20        |
+| **GFX9 GPUs**      | AMD Radeon Instinct™ MI60 | gfx906     | Vega 20        |
+| **GFX9 GPUs**      | AMD Radeon™ VII           | gfx906     | Vega 20        |
+| **GFX9 GPUs**      | AMD Radeon™ Pro VII       | gfx906     | Vega 20        |
+| **RDNA GPUs**      | AMD Radeon™ Pro W6800     | gfx1030    | Navi 21 GL-XL  |
+| **RDNA GPUs**      | AMD Radeon™ Pro V620      | gfx1030    | Navi 21 GL-XE  |
+| **CDNA GPUs**      | AMD Instinct™ MI100       | gfx908     | Arcturus       |
+| **CDNA GPUs**      | AMD Instinct™ MI200       | gfx90a     | Aldebaran      |
+```
+
+### Verify Your System Has a ROCm-Capable GPU
+
+To verify that your system has a ROCm-capable GPU, use these steps:
+
+1. Enter the following command:
+
+   ```shell
+   lspci | grep -i display
+   ```
+
+   The command displays the details of detected GPUs on the system in the
+   following format in the case of AMD Instinct™ MI200:
+
+   ```text
+   c1:00.0 Display controller: Advanced Micro Devices, Inc. [AMD/ATI] Aldebaran
+   c5:00.0 Display controller: Advanced Micro Devices, Inc. [AMD/ATI] Aldebaran
+   ```
+
+2. Verify from the output that the listed product names match with the Product
+   Id given in the table above.
+
+### Setting Permissions for Groups
+
+This section provides steps to add any current user to a video group to access
+GPU resources.
+
+1. To check the groups in your system, issue the following command:
+
+   ```shell
+   groups
+   ```
+
+2. Add yourself to the `render` or `video` group using the following instruction:
+
+   ```shell
+   sudo usermod -a -G render $LOGNAME
+   # OR
+   sudo usermod -a -G video $LOGNAME
+   ```
+
+3. Use of the video group is recommended for all ROCm-supported operating
+   systems.
+
+   To add all future users to the `video` and `render` groups by default, run the following commands:
+
+   ```shell
+   echo 'ADD_EXTRA_GROUPS=1' | sudo tee -a /etc/adduser.conf
+   echo 'EXTRA_GROUPS=video' | sudo tee -a /etc/adduser.conf
+   echo 'EXTRA_GROUPS=render' | sudo tee -a /etc/adduser.conf
+   ```

docs/deploy/linux/quick_start.md

@@ -0,0 +1,329 @@
+# Quick Start (Linux)
+
+## Install Prerequisites
+
+The driver package uses
+[{abbr}`DKMS (Dynamic Kernel Module Support)`][DKMS-wiki] to build
+the `amdgpu-dkms` module (driver) for the installed kernels. This requires the Linux
+kernel headers and modules to be installed for each. Usually these are
+automatically installed with the kernel, but if you have multiple kernel
+versions or you have downloaded the kernel images and not the kernel
+meta-packages then they must be manually installed.
+
+[DKMS-wiki]: https://en.wikipedia.org/wiki/Dynamic_Kernel_Module_Support
+
+To install for the currently active kernel run the command corresponding
+to your distribution.
+::::{tab-set}
+:::{tab-item} Ubuntu
+:sync: ubuntu
+
+```shell
+sudo apt install "linux-headers-$(uname -r)" "linux-modules-extra-$(uname -r)"
+```
+
+:::
+
+:::{tab-item} Red Hat Enterprise Linux
+:sync: RHEL
+
+```shell
+sudo yum install kernel-headers kernel-devel
+```
+
+:::
+
+:::{tab-item} SUSE Linux Enterprise Server
+:sync: SLES
+
+```shell
+sudo zypper install kernel-default-devel
+```
+
+:::
+::::
+
+## Add Repositories
+
+::::::{tab-set}
+:::::{tab-item} Ubuntu
+:sync: ubuntu
+
+::::{rubric} 1. Download and convert the package signing key
+::::
+
+```shell
+# Make the directory if it doesn't exist yet.
+# This location is recommended by the distribution maintainers.
+sudo mkdir --parents --mode=0755 /etc/apt/keyrings
+# Download the key, convert the signing-key to a full
+# keyring required by apt and store in the keyring directory
+wget https://repo.radeon.com/rocm/rocm.gpg.key -O - | \
+    gpg --dearmor | sudo tee /etc/apt/keyrings/rocm.gpg > /dev/null
+```
+
+::::{rubric} 2. Add the repositories
+::::
+
+::::{tab-set}
+:::{tab-item} Ubuntu 20.04
+:sync: ubuntu-20.04
+
+```shell
+# Kernel driver repository for focal
+sudo tee /etc/apt/sources.list.d/amdgpu.list <<'EOF'
+deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amdgpu/latest/ubuntu focal main
+EOF
+# ROCm repository for focal
+sudo tee /etc/apt/sources.list.d/rocm.list <<'EOF'
+deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/rocm/apt/debian focal main
+EOF
+```
+
+:::
+:::{tab-item} Ubuntu 22.04
+:sync: ubuntu-22.04
+
+```shell
+# Kernel driver repository for jammy
+sudo tee /etc/apt/sources.list.d/amdgpu.list <<'EOF'
+deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amdgpu/latest/ubuntu jammy main
+EOF
+# ROCm repository for jammy
+sudo tee /etc/apt/sources.list.d/rocm.list <<'EOF'
+deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/rocm/apt/debian jammy main
+EOF
+```
+
+:::
+::::
+
+::::{rubric} 3. Update the list of packages
+::::
+
+```shell
+sudo apt update
+```
+
+:::::
+
+:::::{tab-item} Red Hat Enterprise Linux
+:sync: RHEL
+
+::::{rubric} 1. Add the repositories
+::::
+
+::::{tab-set}
+:::{tab-item} RHEL 8.6
+:sync: RHEL-8.6
+
+```shell
+# Add the amdgpu module repository for RHEL 8.6
+sudo tee /etc/yum.repos.d/amdgpu.repo <<'EOF'
+[amdgpu]
+name=amdgpu
+baseurl=https://repo.radeon.com/amdgpu/latest/rhel/8.6/main/x86_64
+enabled=1
+gpgcheck=1
+gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
+EOF
+# Add the rocm repository for RHEL 8
+sudo tee /etc/yum.repos.d/rocm.repo <<'EOF'
+[rocm]
+name=rocm
+baseurl=https://repo.radeon.com/rocm/rhel8/latest/main
+enabled=1
+priority=50
+gpgcheck=1
+gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
+EOF
+```
+
+:::
+
+:::{tab-item} RHEL 8.7
+:sync: RHEL-8.7
+
+```shell
+# Add the amdgpu module repository for RHEL 8.7
+sudo tee /etc/yum.repos.d/amdgpu.repo <<'EOF'
+[amdgpu]
+name=amdgpu
+baseurl=https://repo.radeon.com/amdgpu/latest/rhel/8.7/main/x86_64
+enabled=1
+gpgcheck=1
+gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
+EOF
+# Add the rocm repository for RHEL 8
+sudo tee /etc/yum.repos.d/rocm.repo <<'EOF'
+[rocm]
+name=rocm
+baseurl=https://repo.radeon.com/rocm/rhel8/latest/main
+enabled=1
+priority=50
+gpgcheck=1
+gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
+EOF
+```
+
+:::
+
+:::{tab-item} RHEL 9.1
+:sync: RHEL-9.1
+
+```shell
+# Add the amdgpu module repository for RHEL 9.1
+sudo tee /etc/yum.repos.d/amdgpu.repo <<'EOF'
+[amdgpu]
+name=amdgpu
+baseurl=https://repo.radeon.com/amdgpu/latest/rhel/9.1/main/x86_64
+enabled=1
+gpgcheck=1
+gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
+EOF
+# Add the rocm repository for RHEL 9
+sudo tee /etc/yum.repos.d/rocm.repo <<'EOF'
+[rocm]
+name=rocm
+baseurl=https://repo.radeon.com/rocm/rhel9/latest/main
+enabled=1
+priority=50
+gpgcheck=1
+gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
+EOF
+```
+
+:::
+::::
+
+::::{rubric} 2. Clean cached files from enabled repositories
+::::
+
+```shell
+sudo yum clean all
+```
+
+:::::
+
+:::::{tab-item} SUSE Linux Enterprise Server
+:sync: SLES
+
+::::{rubric} 1. Add the repositories
+::::
+
+::::{tab-set}
+:::{tab-item} SLES 15 SP4
+:sync: SLES15-SP4
+
+```shell
+
+# Add the amdgpu module repository for SLES 15.4
+sudo tee /etc/zypp/repos.d/amdgpu.repo <<'EOF'
+[amdgpu]
+name=amdgpu
+baseurl=https://repo.radeon.com/amdgpu/latest/sle/15.4/main/x86_64
+enabled=1
+gpgcheck=1
+gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
+EOF
+# Add the rocm repository for SLES
+sudo tee /etc/zypp/repos.d/rocm.repo <<'EOF'
+[rocm]
+name=rocm
+baseurl=https://repo.radeon.com/rocm/zyp/zypper
+enabled=1
+priority=50
+gpgcheck=1
+gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
+EOF
+```
+
+:::
+::::
+
+::::{rubric} 2. Update the new repository
+::::
+
+```shell
+sudo zypper ref
+```
+
+:::::
+::::::
+
+## Install Drivers
+
+Install the `amdgpu-dkms` kernel module, aka driver, on your system.
+
+::::{tab-set}
+
+:::{tab-item} Ubuntu
+:sync: ubuntu
+
+```shell
+sudo apt install amdgpu-dkms
+```
+
+:::
+
+:::{tab-item} Red Hat Enterprise Linux
+:sync: RHEL
+
+```shell
+sudo yum install amdgpu-dkms
+```
+
+:::
+
+:::{tab-item} SUSE Linux Enterprise Server
+:sync: SLES
+
+```shell
+sudo zypper install amdgpu-dkms
+```
+
+:::
+
+::::
+
+## Install ROCm Runtimes
+
+Install the `rocm-hip-libraries` meta-package. This contains dependencies for most
+common ROCm applications.
+
+::::{tab-set}
+:::{tab-item} Ubuntu
+:sync: ubuntu
+
+```console shell
+sudo apt install rocm-hip-libraries
+```
+
+:::
+
+:::{tab-item} Red Hat Enterprise Linux
+:sync: RHEL
+
+```console shell
+sudo yum install rocm-hip-libraries
+```
+
+:::
+
+:::{tab-item} SUSE Linux Enterprise Server
+:sync: SLES
+
+```console shell
+sudo zypper install rocm-hip-libraries
+```
+
+:::
+::::
+
+## Reboot the system
+
+Loading the new driver requires a reboot of the system.
+
+```shell
+sudo reboot
+```