Update documentation requirements

* Update Linux and ROCm versions

* Update CI to use build.os

.github/CODEOWNERS

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

.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-cli2
+      uses: DavidAnson/markdownlint-cli2-action@v10.0.1
+      with:
+        globs: '**/*.md'
+
+  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,18 @@
+.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
+docs/CHANGELOG.md

.markdownlint-cli2.yaml

@@ -0,0 +1,14 @@
+config:
+  default: true
+  MD013: false
+  MD026:
+    punctuation: '.,;:!'
+  MD029:
+    style: ordered
+  MD033: false
+  MD034: false
+  MD041: false
+ignores:
+  - CHANGELOG.md
+  - "{,docs/}{RELEASE,release}.md"
+  - tools/autotag/templates/**/*.md

.readthedocs.yaml

@@ -0,0 +1,21 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+   os: ubuntu-22.04
+   tools:
+      python: "3.10"
+   apt_packages:
+     - "doxygen"
+     - "graphviz" # For dot graphs in doxygen
+
+python:
+   install:
+   - requirements: docs/sphinx/requirements.txt
+
+sphinx:
+   configuration: docs/conf.py
+
+formats: []

.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,782 +1,54 @@
-# AMD ROCm Release Notes v3.1.0
-This page describes the features, fixed issues, and information about downloading and installing the ROCm software.
-It also covers known issues and deprecated features in the ROCm v3.1 release.
+# AMD ROCm™ Platform
 
-- [What Is ROCm?](#What-Is-ROCm)
-  * [ROCm Components](#ROCm-Components)
-  * [Supported Operating Systems](#Supported-Operating-Systems)
-  * [Important ROCm Links](#Important-ROCm-Links)
-  
-- [What\'s New in This Release](#Whats-New-in-This-Release)
-  * [Change in ROCm Installation Directory Structure](#Change-in-ROCm-Installation-Directory-Structure)
-  * [Reliability, Accessibility, and Serviceability Support for Vega7nm](#Reliability-Accessibility-and-Serviceability-Support-for-Vega7nm)
-  * [SLURM Support for AMD GPU](#SLURM-Support-for-AMD-GPU)
-  
-  
-- [Known Issues](#Known-Issues)
-	* [MIVision MIGraphX Installation](#MIVision-MIGraphX-Installation)
-	* [Using TensorFlow](#Using-TensorFlow)
-	* [HIP Compiler Dependency Issue](#HIP-Compiler-Dependency-Issue)
-	* [Error Running ROC Profiler](#Error-Running-ROC-Profiler)
-    	
- 
-  
-- [Deploying ROCm](#Deploying-ROCm)
-  * [Ubuntu](#Ubuntu)
-  * [CentOS RHEL v7](#CentOS-RHEL-v7)
-  * [SLES 15 Service Pack 1](#SLES-15-Service-Pack-1)
+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.
 
+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.
 
-- [Getting the ROCm Source Code](#Getting-the-ROCm-Source-Code)
-- [Hardware and Software Support](#Hardware-and-Software-Support)
-- [Machine Learning and High Performance Computing Software Stack for AMD GPU](#Machine-Learning-and-High-Performance-Computing-Software-Stack-for-AMD-GPU)
-  * [ROCm Binary Package Structure](#ROCm-Binary-Package-Structure)
-  * [ROCm Platform Packages](#ROCm-Platform-Packages)
-  
+ROCm’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.
 
-## What Is ROCm?
-ROCm is designed to be a universal platform for gpu-accelerated computing. This modular design allows hardware vendors to build drivers that support the ROCm framework. ROCm is also designed to integrate multiple programming languages and makes it easy to add support for other languages. 
+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.
 
-Note: You can also clone the source code for individual ROCm components from the GitHub repositories.
+The default.xml file uses the repo Manifest format.
 
+The develop branch of this repository contains content for the next
+ROCm release.
 
-### ROCm Components
-The following components for the ROCm platform are released and available for the v3.1
-release:
+## ROCm Documentation
 
-• Drivers
+ROCm Documentation is available online at
+[rocm.docs.amd.com](https://rocm.docs.amd.com). Source code for the documenation
+is located in the docs folder of most repositories that are part of ROCm.
 
-• Tools
+### How to build documentation via Sphinx
 
-• Libraries
+```bash
+cd docs
 
-• Source Code
+pip3 install -r sphinx/requirements.txt
 
-You can access the latest supported version of drivers, tools, libraries, and source code for the ROCm platform at the following location:
-https://github.com/RadeonOpenCompute/ROCm
-
-### Supported Operating Systems
-The ROCm v3.1.x platform is designed to support the following operating systems:
-
-
-* Ubuntu 16.04.6(Kernel 4.15) and 18.04.3(Kernel 5.3)
-
-* CentOS v7.7 (Using devtoolset-7 runtime support)
-
-* RHEL v7.7 (Using devtoolset-7 runtime support)
-
-* SLES 15 SP1 
-
-
-For details about deploying the ROCm v3.1.0.x on these operating systems, see the Deploying ROCm section later in the document.
-
-### Important ROCm Links
-
-Access the following links for more information on:
-
-* ROCm documentation, see 
-https://rocm-documentation.readthedocs.io/en/latest/index.html
-
-* ROCm binary structure, see
-https://github.com/RadeonOpenCompute/ROCm/blob/master/README.md#rocm-binary-package-structure
-
-* Common ROCm installation issues, see
-https://rocm.github.io/install_issues.html
-
-* Instructions to install PyTorch after ROCm is installed – https://rocm-documentation.readthedocs.io/en/latest/Deep_learning/Deep-learning.html#pytorch
-
-Note: These instructions reference the rocm/pytorch:rocm3.0_ubuntu16.04_py2.7_pytorch image. However, you can substitute the Ubuntu 18.04 image listed at https://hub.docker.com/r/rocm/pytorch/tags
-
-
-## What\'s New in This Release
-
-### Change in ROCm Installation Directory Structure
-A fresh installation of the ROCm toolkit installs the packages in the */opt/rocm-\<version>* folder. 
-	
-Previously, ROCm toolkit packages were installed in the */opt/rocm* folder. 
-
-![ScreenShot](Versionchange1.png)
-
-## Reliability, Accessibility, and Serviceability Support for Vega7nm
-The Reliability, Accessibility, and Serviceability (RAS) support for Vega7nm is now available. The support includes:
-
-* UMC RAS – HBM ECC (uncorrectable error injection), page retirement, RAS recovery via GPU (BACO) reset
-* GFX RAS – GFX, MMHUB ECC (uncorrectable error injection), RAS recovery via GPU (BACO) reset
-* PCIE RAS – PCIE_BIF ECC (uncorrectable error injection), RAS recovery via GPU (BACO) reset
-
-## SLURM Support for AMD GPU
-SLURM (Simple Linux Utility for Resource Management) is an open source, fault-tolerant, and highly scalable cluster management and job scheduling system for large and small Linux clusters. The latest version 20.02.0 of SLURM includes AMD plugins that enable SLURM to detect and configure AMD GPUs automatically.  It also collects and reports the energy consumption of AMD GPUs.
-
-
-
-## Known Issues 
-
-### MIVision MIGraphX Installation
-
-* Install and use the latest version of the MIVision/MIGraphX code.  
-* Ensure the /opt/rocm symbolic link for the new version of ROCm is present and points to the right version of the ROCm toolkit. 
-
-### Using TensorFlow
-The TensorFlow build system requires the following additional changes to support the new installation path:
-
-* Ensure the /opt/rocm symbolic link is preset and points to the right version of the ROCm toolkit.
-* Modify the build configure file to include the header files from the respective ROCm version-specific folder
-
-### HIP Compiler Dependency Issue
-If the HIP compiler has a dependency on /opt/rocm, use the following workaround: 
-
-* Ensure the /opt/rocm symbolic link points to the right version of the ROCm software
-* Use the ROCM_PATH environment variable that points to the version of the ROCm software installed on the system. 
-* Use the rocm-dkms package to install required ROCm components.	
-
-### Error Running ROC Profiler
-**Issue:** Running ROC profiler results in the following error -
-“: hip / hsa trace due to "ImportError: No module named sqlite3" error”
-
-**Workaround:** Export the Python version before running ROC profiler: 
-
-	*export ROCP_PYTHON_VERSION=<python version>*
-	*ex: export ROCP_PYTHON_VERSION=python3*
-
-
-## Deploying ROCm
-AMD hosts both Debian and RPM repositories for the ROCm v3.1.0x packages. 
-
-The following directions show how to install ROCm on supported Debian-based systems such as Ubuntu 18.04.x. 
-
-Note: These directions may not work as written on unsupported Debian-based distributions. For example, newer versions of Ubuntu may not be compatible with the rock-dkms kernel driver. In this case, you can exclude the rocm-dkms and rock-dkms packages.
-
-For more information on the ROCm binary structure, see
-https://github.com/RadeonOpenCompute/ROCm/blob/master/README.md#rocm-binary-package-structure
-
-For information about upstream kernel drivers, see the Using Debian-based ROCm with Upstream Kernel Drivers section.
-
-## Ubuntu 
-### Installing a ROCm Package from a Debian Repository
-To install from a Debian Repository:
-1.	Run the following code to ensure that your system is up to date:
-      
-     	sudo apt update
- 
-     	sudo apt dist-upgrade
-    
-     	sudo apt install libnuma-dev
-    
-     	sudo reboot 
-          
-    
- 2. Add the ROCm apt repository.
-
-     For Debian-based systems like Ubuntu, configure the Debian ROCm repository as follows:
-   
-        wget -qO - http://repo.radeon.com/rocm/apt/debian/rocm.gpg.key | sudo apt-key add -
-        
-        echo 'deb [arch=amd64] http://repo.radeon.com/rocm/apt/debian/ xenial main' | sudo tee /etc/apt/sources.list.d/rocm.list
-
-      
-  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 apt repository. 
-
-  The current rocm.gpg.key is not available in a standard key ring distribution, but has the following sha1sum hash:
-
-  	e85a40d1a43453fe37d63aa6899bc96e08f2817a rocm.gpg.key
-	
-
-3. Install the ROCm meta-package.
-   Update the appropriate repository list and install the rocm-dkms meta-package:
-
-     	sudo apt update
-   
-     	sudo apt install rocm-dkms
-
-
-4. Set permissions.
-   To access the GPU, you must be a user in the video group. Ensure your user account is a member of the video group prior to using ROCm. To identify the groups you are a member of, use the following command:	   
-	
-		groups
-   
-   
-5. To add your user to the video group, use the following command for the sudo password:
-	
-		sudo usermod -a -G video $LOGNAME
-
-6. By default, add any future users to the video group. Run the following command to add users to the video group:
-
-   		echo 'ADD_EXTRA_GROUPS=1' 		
-		sudo tee -a /etc/adduser.conf   
-   		echo 'EXTRA_GROUPS=video' 		
-		sudo tee -a /etc/adduser.conf
-   
-7. Restart the system.
-
-8. Test the basic ROCm installation.
-
-9. After restarting the system, run the following commands to verify that the ROCm installation is successful. If you see your GPUs listed by both commands, the installation is considered successful.
-
-		/opt/rocm/bin/rocminfo
-		/opt/rocm/opencl/bin/x86_64/clinfo
-
-Note: To run the ROCm programs more efficiently, add the ROCm binaries in your PATH.
-
-		echo 'export PATH=$PATH:/opt/rocm/bin:/opt/rocm/profiler/bin:/opt/rocm/opencl/bin/x86_64' | 
-		sudo tee -a /etc/profile.d/rocm.sh
-
-If you have an installation issue, refer the FAQ at:
-https://rocm.github.io/install_issues.html
-
-
-
-### Uninstalling ROCm Packages from Ubuntu 
-To uninstall the ROCm packages from Ubuntu v16.04 or Ubuntu v18.04.x, run the following command:
-
-	sudo apt autoremove rocm-dkms 
-
-
-### Installing Development Packages for Cross Compilation
-It is recommended that you develop and test applications on different systems. For example, some development or build systems may not have an AMD GPU installed. In this scenario, you must avoid installing the ROCk kernel driver on the development system. 
-
-Instead, install the following development subset of applications:
-
-	sudo apt update
-	sudo apt install rocm-dev
-
-Note: To execute ROCm enabled applications, you must install the full ROCm driver stack on your system.
-
-
-### Using Debian-based ROCm with Upstream Kernel Drivers
-You can install the ROCm user-level software without installing the AMD's custom ROCk kernel driver. To use the upstream kernels, run the following commands instead of installing rocm-dkms:
-
-	sudo apt update	
-	sudo apt install rocm-dev	
-	echo 'SUBSYSTEM=="kfd", KERNEL=="kfd", TAG+="uaccess", GROUP="video"' 
-	sudo tee /etc/udev/rules.d/70-kfd.rules
-
-
-## CentOS RHEL v7 
-
-This section describes how to install ROCm on supported RPM-based systems such as CentOS v7.7. 
-
-For more details, refer:
-https://github.com/RadeonOpenCompute/ROCm/blob/master/README.md#rocm-binary-package-structure
-
-### Preparing RHEL v7 (7.7) for Installation
-RHEL is a subscription-based operating system. You must enable the external repositories to install on the devtoolset-7 environment and the dkms support files. 
-
-Note: The following steps do not apply to the CentOS installation.
-
-1. The subscription for RHEL must be enabled and attached to a pool ID. See the Obtaining an RHEL image and license page for instructions on registering your system with the RHEL subscription server and attaching to a pool id.
-
-2. Enable the following repositories:
-
-		sudo subscription-manager repos --enable rhel-server-rhscl-7-rpms
-	
-		sudo subscription-manager repos --enable rhel-7-server-optional-rpms
-	
-		sudo subscription-manager repos --enable rhel-7-server-extras-rpms
-
-3. Enable additional repositories by downloading and installing the epel-release-latest-7 repository RPM:
-
-		sudo rpm -ivh <repo>
-
-For more details, see
-https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm
-
-4. Install and set up Devtoolset-7.
-
-  To setup the Devtoolset-7 environment, follow the instructions on this page:
-  https://www.softwarecollections.org/en/scls/rhscl/devtoolset-7/
-
-  Note: devtoolset-7 is a software collections package and is not supported by AMD.
-
-### Installing CentOS/RHEL (v7.7) for DKMS
-
-Use the dkms tool to install the kernel drivers on CentOS/RHEL v7.7:
-
-	sudo yum install -y epel-release
-	sudo yum install -y dkms kernel-headers-`uname -r` kernel-devel-`uname -r`
-
-### Installing ROCm 
-
-To install ROCm on your system, follow the instructions below:
-
-1. Delete the previous versions of ROCm before installing the latest version.
-2. Create a /etc/yum.repos.d/rocm.repo file with the following contents:
-
-		[ROCm]
-		name=ROCm
-		baseurl=http://repo.radeon.com/rocm/yum/rpm
-		enabled=1
-		gpgcheck=0
-
-Note: The URL of the repository must point to the location of the repositories’ repodata database. 
-
-3. Install ROCm components using the following command:
-
-		sudo yum install rocm-dkms
-
-4. Restart the system.The rock-dkms component is installed and the /dev/kfd device is now available.
-
-5. Set permissions.
-To access the GPU, you must be a user in the video group. Ensure your user account is a member of the video group prior to using ROCm. To identify the groups you are a member of, use the following command:
-
-		groups
-	
-6. To add your user to the video group, use the following command for the sudo password:
-
-		sudo usermod -a -G video $LOGNAME
-	
-7. By default, add any future users to the video group. Run the following command to add users to the video group:
-
-	echo 'ADD_EXTRA_GROUPS=1' | sudo tee -a /etc/adduser.conf
-	echo 'EXTRA_GROUPS=video' | sudo tee -a /etc/adduser.conf
-
-
-8. Restart the system.
-
-9. Test the ROCm installation.
-
-### Testing ROCm Installation
-After restarting the system, run the following commands to verify that the ROCm installation is successful. If you see your GPUs listed, you are good to go!
-
-	/opt/rocm/bin/rocminfo
-	/opt/rocm/opencl/bin/x86_64/clinfo
-
-Note: To run the ROCm programs more efficiently, add the ROCm binaries in your PATH for easy implementation of the ROCm programs.
-
-	echo 'export PATH=$PATH:/opt/rocm/bin:/opt/rocm/profiler/bin:/opt/rocm/opencl/bin/x86_64' | 
-	sudo tee -a /etc/profile.d/rocm.sh
-
-
-#### Compiling Applications Using HCC, HIP, and Other ROCm Software
-To compile applications or samples, run the following command to use gcc-7.2 provided by the devtoolset-7 environment:
-
-	scl enable devtoolset-7 bash
-
-### Uninstalling ROCm from CentOS/RHEL v7.7
-To uninstall the ROCm packages, run the following command:
-
-	sudo yum autoremove rocm-dkms rock-dkms
-
-### Installing Development Packages for Cross Compilation
-You can develop and test ROCm packages on different systems. For example, some development or build systems may not have an AMD GPU installed. In this scenario, you can avoid installing the ROCm kernel driver on your development system. Instead, install the following development subset of packages:
-
-	sudo yum install rocm-dev
-	
-Note: To execute ROCm-enabled applications, you will require a system installed with the full ROCm driver stack.
-
-### Using ROCm with Upstream Kernel Drivers
-You can install ROCm user-level software without installing AMD's custom ROCk kernel driver. To use the upstream kernel drivers, run the following commands 
-
-	sudo yum install rocm-dev
-	echo 'SUBSYSTEM=="kfd", KERNEL=="kfd", TAG+="uaccess", GROUP="video"'  
-	sudo tee /etc/udev/rules.d/70-kfd.rules
-	
-Note: You can use these commands instead of installing rocm-dkms.
-
-## SLES 15 Service Pack 1
-
-The following section tells you how to perform an install and uninstall ROCm on SLES 15 SP 1. 
-
-### Installation
-1. Install the "dkms" package.
-
-	sudo SUSEConnect --product PackageHub/15.1/x86_64
-	sudo zypper install dkms
-	
-2. Add the ROCm repo.
- 
-	sudo zypper clean –all
-	sudo zypper addrepo --no-gpgcheck http://repo.radeon.com/rocm/zyp/zypper/ rocm 
-	sudo zypper ref
-	zypper install rocm-dkms
-	sudo zypper install rocm-dkms
-	sudo reboot
-
-3. Run the following command once
-
-	cat <<EOF | sudo tee /etc/modprobe.d/10-unsupported-modules.conf
-	allow_unsupported_modules 1
-	EOF
-	sudo modprobe amdgpu
-
-4. Verify the ROCm installation.
-
-5. Run /opt/rocm/bin/rocminfo and /opt/rocm/opencl/bin/x86_64/clinfo commands to list the GPUs and verify that the ROCm installation is successful.
-
-6. Set permissions. 
-
-To access the GPU, you must be a user in the video group. Ensure your user account is a member of the video group prior to using 	 ROCm. To identify the groups you are a member of, use the following command:
-
-		groups
-
-7. To add your user to the video group, use the following command for the sudo password:
-	
-		sudo usermod -a -G video $LOGNAME
-	
-8. By default, add any future users to the video group. Run the following command to add users to the video group:
-
-		echo 'ADD_EXTRA_GROUPS=1' | sudo tee -a /etc/adduser.conf
-		echo 'EXTRA_GROUPS=video' | sudo tee -a /etc/adduser.conf
-
-9. Restart the system.
-10. Test the basic ROCm installation.
-11. After restarting the system, run the following commands to verify that the ROCm installation is successful. If you see your GPUs listed by both commands, the installation is considered successful.
-
-		/opt/rocm/bin/rocminfo
-		/opt/rocm/opencl/bin/x86_64/clinfo
-
-Note: To run the ROCm programs more efficiently, add the ROCm binaries in your PATH.
-echo 'export PATH=$PATH:/opt/rocm/bin:/opt/rocm/profiler/bin:/opt/rocm/opencl/bin/x86_64' | 
-
-	sudo tee -a /etc/profile.d/rocm.sh
-
-### Uninstallation
-To uninstall, use the following command:
-
-	sudo zypper remove rocm-dkms rock-dkms
-
-Note: Ensure all other installed packages/components are removed.
-Note: Ensure all the content in the /opt/rocm directory is completely removed.
-
-
-## Performing an OpenCL-only Installation of ROCm
-Some users may want to install a subset of the full ROCm installation. If you are trying to install on a system with a limited amount of storage space, or which will only run a small collection of known applications, you may want to install only the packages that are required to run OpenCL applications. To do that, you can run the following installation command instead of the command to install rocm-dkms.
-
-	sudo yum install rock-dkms rocm-opencl-devel
-	
-## ROCm Installation - Known Issues and Workarounds 
-### Closed source components
-The ROCm platform relies on some closed source components to provide functionalities like HSA image support. These components are only available through the ROCm repositories, and they may be deprecated or become open source components in the future. These components are made available in the following packages:
-
-•	hsa-ext-rocr-dev
-
-
-## Getting the ROCm Source Code
-AMD ROCm is built from open source software. It is, therefore, possible to modify the various components of ROCm by downloading the source code and rebuilding the components. The source code for ROCm components can be cloned from each of the GitHub repositories using git.  For easy access to download the correct versions of each of these tools, the ROCm repository contains a repo manifest file called default.xml. You can use this manifest file to download the source code for ROCm software.
-
-### Installing the Repo
-The repo tool from Google® allows you to manage multiple git repositories simultaneously. Run the following commands to install the repo:
-
-	mkdir -p ~/bin/
-	curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
-	chmod a+x ~/bin/repo
-
-Note: You can choose a different folder to install the repo into if you desire. ~/bin/ is used as an example.
-
-### Downloading the ROCm Source Code
-The following example shows how to use the repo binary to download the ROCm source code. If you choose a directory other than ~/bin/ to install the repo, you must use that chosen directory in the code as shown below:
-
-	mkdir -p ~/ROCm/
-	cd ~/ROCm/
-	~/bin/repo init -u https://github.com/RadeonOpenCompute/ROCm.git -b roc-3.1.0
-	repo sync
-
-Note: Using this sample code will cause the repo to download the open source code associated with this ROCm release. Ensure that you have ssh-keys configured on your machine for your GitHub ID prior to the download.
-
-### Building the ROCm Source Code
-Each ROCm component repository contains directions for building that component. You can access the desired component for instructions to build the repository.
-
-
-### Hardware and Software Support
-ROCm is focused on using AMD GPUs to accelerate computational tasks such as machine learning, engineering workloads, and scientific computing.
-In order to focus our development efforts on these domains of interest, ROCm supports a targeted set of hardware configurations which are detailed further in this section.
-
-#### Supported GPUs
-Because the ROCm Platform has a focus on particular computational domains, we offer official support for a selection of AMD GPUs that are designed to offer good performance and price in these domains.
-
-ROCm officially supports AMD GPUs that use following chips:
-
-  * GFX8 GPUs
-    * "Fiji" chips, such as on the AMD Radeon R9 Fury X and Radeon Instinct MI8
-    * "Polaris 10" chips, such as on the AMD Radeon RX 580 and Radeon Instinct MI6
-  * GFX9 GPUs
-    * "Vega 10" chips, such as on the AMD Radeon RX Vega 64 and Radeon Instinct MI25
-    * "Vega 7nm" chips, such as on the Radeon Instinct MI50, Radeon Instinct MI60 or AMD Radeon VII
-
-ROCm is a collection of software ranging from drivers and runtimes to libraries and developer tools.
-Some of this software may work with more GPUs than the "officially supported" list above, though AMD does not make any official claims of support for these devices on the ROCm software platform.
-The following list of GPUs are enabled in the ROCm software, though full support is not guaranteed:
-
-  * GFX8 GPUs
-    * "Polaris 11" chips, such as on the AMD Radeon RX 570 and Radeon Pro WX 4100
-    * "Polaris 12" chips, such as on the AMD Radeon RX 550 and Radeon RX 540
-  * GFX7 GPUs
-    * "Hawaii" chips, such as the AMD Radeon R9 390X and FirePro W9100
-
-As described in the next section, GFX8 GPUs require PCI Express 3.1.0 (PCIe 3.1.0) with support for PCIe atomics. This requires both CPU and motherboard support. GFX9 GPUs require PCIe 3.1.0 with support for PCIe atomics by default, but they can operate in most cases without this capability.
-
-The integrated GPUs in AMD APUs are not officially supported targets for ROCm.
-As described [below](#limited-support), "Carrizo", "Bristol Ridge", and "Raven Ridge" APUs are enabled in our upstream drivers and the ROCm OpenCL runtime.
-However, they are not enabled in our HCC or HIP runtimes, and may not work due to motherboard or OEM hardware limitations.
-As such, they are not yet officially supported targets for ROCm.
-
-For a more detailed list of hardware support, please see [the following documentation](https://rocm.github.io/hardware.html).
-
-#### Supported CPUs
-As described above, GFX8 GPUs require PCIe 3.1.0 with PCIe atomics in order to run ROCm.
-In particular, the CPU and every active PCIe point between the CPU and GPU require support for PCIe 3.1.0 and PCIe atomics.
-The CPU root must indicate PCIe AtomicOp Completion capabilities and any intermediate switch must indicate PCIe AtomicOp Routing capabilities.
-
-Current CPUs which support PCIe Gen3 + PCIe Atomics are:
-
-  * AMD Ryzen CPUs
-  * The CPUs in AMD Ryzen APUs
-  * AMD Ryzen Threadripper CPUs
-  * AMD EPYC CPUs
-  * Intel Xeon E7 v3 or newer CPUs
-  * Intel Xeon E5 v3 or newer CPUs
-  * Intel Xeon E3 v3 or newer CPUs
-  * Intel Core i7 v4, Core i5 v4, Core i3 v4 or newer CPUs (i.e. Haswell family or newer)
-  * Some Ivy Bridge-E systems
-
-Beginning with ROCm 1.8, GFX9 GPUs (such as Vega 10) no longer require PCIe atomics.
-We have similarly opened up more options for number of PCIe lanes.
-GFX9 GPUs can now be run on CPUs without PCIe atomics and on older PCIe generations, such as PCIe 2.0.
-This is not supported on GPUs below GFX9, e.g. GFX8 cards in the Fiji and Polaris families.
-
-If you are using any PCIe switches in your system, please note that PCIe Atomics are only supported on some switches, such as Broadcom PLX.
-When you install your GPUs, make sure you install them in a PCIe 3.1.0 x16, x8, x4, or x1 slot attached either directly to the CPU's Root I/O controller or via a PCIe switch directly attached to the CPU's Root I/O controller.
-
-In our experience, many issues stem from trying to use consumer motherboards which provide physical x16 connectors that are electrically connected as e.g. PCIe 2.0 x4, PCIe slots connected via the Southbridge PCIe I/O controller, or PCIe slots connected through a PCIe switch that does
-not support PCIe atomics.
-
-If you attempt to run ROCm on a system without proper PCIe atomic support, you may see an error in the kernel log (`dmesg`):
-```
-kfd: skipped device 1002:7300, PCI rejects atomics
+python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
 ```
 
-Experimental support for our Hawaii (GFX7) GPUs (Radeon R9 290, R9 390, FirePro W9100, S9150, S9170)
-does not require or take advantage of PCIe Atomics. However, we still recommend that you use a CPU
-from the list provided above for compatibility purposes.
+## Older ROCm™ Releases
 
-#### Not supported or limited support under ROCm
-##### Limited support
-
-* ROCm 2.9.x should support PCIe 2.0 enabled CPUs such as the AMD Opteron, Phenom, Phenom II, Athlon, Athlon X2, Athlon II and older Intel Xeon and Intel Core Architecture and Pentium CPUs. However, we have done very limited testing on these configurations, since our test farm has been catering to CPUs listed above. This is where we need community support. _If you find problems on such setups, please report these issues_.
-* Thunderbolt 1, 2, and 3 enabled breakout boxes should now be able to work with ROCm. Thunderbolt 1 and 2 are PCIe 2.0 based, and thus are only supported with GPUs that do not require PCIe 3.1.0 atomics (e.g. Vega 10). However, we have done no testing on this configuration and would need community support due to limited access to this type of equipment.
-* AMD "Carrizo" and "Bristol Ridge" APUs are enabled to run OpenCL, but do not yet support HCC, HIP, or our libraries built on top of these compilers and runtimes.
-  * As of ROCm 2.1, "Carrizo" and "Bristol Ridge" require the use of upstream kernel drivers.
-  * In addition, various "Carrizo" and "Bristol Ridge" platforms may not work due to OEM and ODM choices when it comes to key configurations parameters such as inclusion of the required CRAT tables and IOMMU configuration parameters in the system BIOS.
-  * Before purchasing such a system for ROCm, please verify that the BIOS provides an option for enabling IOMMUv2 and that the system BIOS properly exposes the correct CRAT table. Inquire with your vendor about the latter.
-* AMD "Raven Ridge" APUs are enabled to run OpenCL, but do not yet support HCC, HIP, or our libraries built on top of these compilers and runtimes.
-  * As of ROCm 2.1, "Raven Ridge" requires the use of upstream kernel drivers.
-  * In addition, various "Raven Ridge" platforms may not work due to OEM and ODM choices when it comes to key configurations parameters such as inclusion of the required CRAT tables and IOMMU configuration parameters in the system BIOS.
-  * Before purchasing such a system for ROCm, please verify that the BIOS provides an option for enabling IOMMUv2 and that the system BIOS properly exposes the correct CRAT table. Inquire with your vendor about the latter.
-
-##### Not supported
-
-* "Tonga", "Iceland", "Vega M", and "Vega 12" GPUs are not supported in ROCm 2.9.x
-* We do not support GFX8-class GPUs (Fiji, Polaris, etc.) on CPUs that do not have PCIe 3.1.0 with PCIe atomics.
-  * As such, we do not support AMD Carrizo and Kaveri APUs as hosts for such GPUs.
-  * Thunderbolt 1 and 2 enabled GPUs are not supported by GFX8 GPUs on ROCm. Thunderbolt 1 & 2 are based on PCIe 2.0.
-
-### Supported Operating Systems - New operating systems available
-
-The ROCm 3.1.0.x platform supports the following operating systems:
-
- * Ubuntu 16.04.5(Kernel 4.15) and 18.04.3(Kernel 4.15 and Kernel 4.18)
- * CentOS 7.7 (Using devtoolset-7 runtime support)
- * RHEL 7.7 (Using devtoolset-7 runtime support)
-
-#### ROCm support in upstream Linux kernels
-
-As of ROCm 1.9.0, the ROCm user-level software is compatible with the AMD drivers in certain upstream Linux kernels.
-As such, users have the option of either using the ROCK kernel driver that are part of AMD's ROCm repositories or using the upstream driver and only installing ROCm user-level utilities from AMD's ROCm repositories.
-
-These releases of the upstream Linux kernel support the following GPUs in ROCm:
- * 4.17: Fiji, Polaris 10, Polaris 11
- * 4.18: Fiji, Polaris 10, Polaris 11, Vega10
- * 4.20: Fiji, Polaris 10, Polaris 11, Vega10, Vega 7nm
-
-The upstream driver may be useful for running ROCm software on systems that are not compatible with the kernel driver available in AMD's repositories.
-For users that have the option of using either AMD's or the upstreamed driver, there are various tradeoffs to take into consideration:
-
-|   | Using AMD's `rock-dkms` package | Using the upstream kernel driver |
-| ---- | ------------------------------------------------------------| ----- |
-| Pros | More GPU features, and they are enabled earlier | Includes the latest Linux kernel features |
-|      | Tested by AMD on supported distributions | May work on other distributions and with custom kernels |
-|      | Supported GPUs enabled regardless of kernel version | |
-|      | Includes the latest GPU firmware | |
-| Cons | May not work on all Linux distributions or versions | Features and hardware support varies depending on kernel version |
-|      | Not currently supported on kernels newer than 5.4 | Limits GPU's usage of system memory to 3/8 of system memory (before 5.6). For 5.6 and beyond, both DKMS and upstream kernels allow use of 15/16 of system memory. |
-|      |   | IPC and RDMA capabilities are not yet enabled |
-|      |   | Not tested by AMD to the same level as `rock-dkms` package |
-|      |   | Does not include most up-to-date firmware |
-
-
-## Software Support
-As of AMD ROCm v1.9.0, the ROCm user-level software is compatible with the AMD drivers in certain upstream Linux kernels. You have the following options:
-
-• Use the ROCk kernel driver that is a part of AMD’s ROCm repositories 
-or
-• Use the upstream driver and only install ROCm user-level utilities from AMD’s ROCm repositories
-
-The releases of the upstream Linux kernel support the following GPUs in ROCm:
-
-• Fiji, Polaris 10, Polaris 11
-• Fiji, Polaris 10, Polaris 11, Vega10
-• Fiji, Polaris 10, Polaris 11, Vega10, Vega 7nm
-
-
-
-## Machine Learning and High Performance Computing Software Stack for AMD GPU
-
-ROCm Version 3.1.0
-
-### ROCm Binary Package Structure
-
- ROCm is a collection of software ranging from drivers and runtimes to libraries and developer tools.
-In AMD's package distributions, these software projects are provided as a separate packages.
-This allows users to install only the packages they need, if they do not wish to install all of ROCm.
-These packages will install most of the ROCm software into `/opt/rocm/` by default.
-
-The packages for each of the major ROCm components are:
-
-* ROCm Core Components
-  - ROCk Kernel Driver: `rock-dkms`
-  - ROCr Runtime: `hsa-rocr-dev`, `hsa-ext-rocr-dev`
-  - ROCt Thunk Interface: `hsakmt-roct`, `hsakmt-roct-dev`
-* ROCm Support Software
-  - ROCm SMI: `rocm-smi`
-  - ROCm cmake: `rocm-cmake`
-  - rocminfo: `rocminfo`
-  - ROCm Bandwidth Test: `rocm_bandwidth_test`
-* ROCm Development Tools
-  - HCC compiler: `hcc`
-  - HIP: `hip_base`, `hip_doc`, `hip_hcc`, `hip_samples`
-  - ROCm Device Libraries: `rocm-device-libs`
-  - ROCm OpenCL: `rocm-opencl`, `rocm-opencl-devel` (on RHEL/CentOS), `rocm-opencl-dev` (on Ubuntu)
-  - ROCM Clang-OCL Kernel Compiler: `rocm-clang-ocl`
-  - Asynchronous Task and Memory Interface (ATMI): `atmi`
-  - ROCr Debug Agent: `rocr_debug_agent`
-  - ROCm Code Object Manager: `comgr`
-  - ROC Profiler: `rocprofiler-dev`
-  - ROC Tracer: `roctracer-dev`
-  - Radeon Compute Profiler: `rocm-profiler`
-* ROCm Libraries
-  - rocALUTION: `rocalution`
-  - rocBLAS: `rocblas`
-  - hipBLAS: `hipblas`
-  - hipCUB: `hipCUB`
-  - rocFFT: `rocfft`
-  - rocRAND: `rocrand`
-  - rocSPARSE: `rocsparse`
-  - hipSPARSE: `hipsparse`
-  - ROCm SMI Lib: `rocm_smi_lib64`
-  - rocThrust: `rocThrust`
-  - MIOpen: `MIOpen-HIP` (for the HIP version), `MIOpen-OpenCL` (for the OpenCL version)
-  - MIOpenGEMM: `miopengemm`
-  - MIVisionX: `mivisionx`
-  - RCCL: `rccl`
-
-To make it easier to install ROCm, the AMD binary repositories provide a number of meta-packages that will automatically install multiple other packages.
-For example, `rocm-dkms` is the primary meta-package that is used to install most of the base technology needed for ROCm to operate.
-It will install the `rock-dkms` kernel driver, and another meta-package (`rocm-dev`) which installs most of the user-land ROCm core components, support software, and development tools.
-
-The `rocm-utils` meta-package will install useful utilities that, while not required for ROCm to operate, may still be beneficial to have.
-Finally, the `rocm-libs` meta-package will install some (but not all) of the libraries that are part of ROCm.
-
-The chain of software installed by these meta-packages is illustrated below
-
-```
-  rocm-dkms
-    |--rock-dkms
-    \--rocm-dev
-       |--comgr
-       |--hcc
-       |--hip_base
-       |--hip_doc
-       |--hip_hcc
-       |--hip_samples
-       |--hsakmt-roct
-       |--hsakmt-roct-dev
-       |--hsa-amd-aqlprofile
-       |--hsa-ext-rocr-dev
-       |--hsa-rocr-dev
-       |--rocm-cmake
-       |--rocm-device-libs
-       |--rocm-smi
-       |--rocprofiler-dev
-       |--rocr_debug_agent
-       \--rocm-utils
-          |--rocminfo
-          \--rocm-clang-ocl # This will cause OpenCL to be installed
-
-  rocm-libs
-    |--hipblas
-    |--hipcub
-    |--hipsparse
-    |--rocalution
-    |--rocblas
-    |--rocfft
-    |--rocprim
-    |--rocrand
-    |--rocsparse
-    \--rocthrust
-```
-
-These meta-packages are not required but may be useful to make it easier to install ROCm on most systems.
-
-Note:Some users may want to skip certain packages. For instance, a user that wants to use the upstream kernel drivers (rather than those supplied by AMD) may want to skip the `rocm-dkms` and `rock-dkms` packages, and instead directly install `rocm-dev`.
-
-Similarly, a user that only wants to install OpenCL support instead of HCC and HIP may want to skip the `rocm-dkms` and `rocm-dev` packages. Instead, they could directly install `rock-dkms`, `rocm-opencl`, and `rocm-opencl-dev` and their dependencies.
-
-
-### ROCm Platform Packages
-
-Drivers, ToolChains, Libraries, and Source Code 
-
-The latest supported version of the drivers, tools, libraries and source code for the ROCm platform have been released and are available from the following GitHub repositories:
-
- #### ROCm Core Components
-  - [ROCk Kernel Driver](https://github.com/RadeonOpenCompute/ROCK-Kernel-Driver/tree/roc-3.1.0)
-  - [ROCr Runtime](https://github.com/RadeonOpenCompute/ROCR-Runtime/tree/roc-3.1.0)
-  - [ROCT Thunk Interface](https://github.com/RadeonOpenCompute/ROCT-Thunk-Interface/tree/roc-3.1.0)  
-
-  
-#### ROCm Support Software
-  - [ROCm SMI](https://github.com/RadeonOpenCompute/ROC-smi/tree/roc-3.1.0)
-  - [ROCm cmake](https://github.com/RadeonOpenCompute/rocm-cmake/tree/roc-3.0.0)
-  - [rocminfo](https://github.com/RadeonOpenCompute/rocminfo/tree/roc-3.1.0)
-  - [ROCm Bandwidth Test](https://github.com/RadeonOpenCompute/rocm_bandwidth_test/tree/roc-3.1.0)
-  
-#### ROCm Development ToolChains
-  - [HCC compiler](https://github.com/RadeonOpenCompute/hcc/tree/roc-hcc-3.1.0)
-  - [HIP](https://github.com/ROCm-Developer-Tools/HIP/tree/roc-3.1.0)
-  - [ROCm Device Libraries HCC](https://github.com/RadeonOpenCompute/ROCm-Device-Libs/tree/roc-hcc-3.1.0)
-  - ROCm OpenCL, which is created from the following components:
-    - [ROCm OpenCL Runtime](http://github.com/RadeonOpenCompute/ROCm-OpenCL-Runtime/tree/roc-3.1.0)
-     - The ROCm OpenCL compiler, which is created from the following components:
-      - [ROCm LLVM OCL](http://github.com/RadeonOpenCompute/llvm-project/tree/roc-ocl-3.1.0)                
-      - [ROCm Device Libraries OCL](https://github.com/RadeonOpenCompute/ROCm-Device-Libs/tree/roc-ocl-3.1.0)
-  - [ROCM Clang-OCL Kernel Compiler](https://github.com/RadeonOpenCompute/clang-ocl/tree/roc-3.1.0)
-  - [Asynchronous Task and Memory Interface (ATMI)](https://github.com/RadeonOpenCompute/atmi/tree/rocm_3.1.0)
-  - [ROCr Debug Agent](https://github.com/ROCm-Developer-Tools/rocr_debug_agent/tree/roc-3.1.0)
-  - [ROCm Code Object Manager](https://github.com/RadeonOpenCompute/ROCm-CompilerSupport/tree/roc-3.1.0)
-  - [ROC Profiler](https://github.com/ROCm-Developer-Tools/rocprofiler/tree/roc-3.1.0)
-  - [ROC Tracer](https://github.com/ROCm-Developer-Tools/roctracer/tree/roc-3.1.x)
-  - [AOMP](https://github.com/ROCm-Developer-Tools/aomp/tree/roc-3.1.0)
-  - [Radeon Compute Profiler](https://github.com/GPUOpen-Tools/RCP/tree/3a49405)
-  - [ROCmValidationSuite](https://github.com/ROCm-Developer-Tools/ROCmValidationSuite/tree/roc-3.1.0)
-  - Example Applications:
-    - [HCC Examples](https://github.com/ROCm-Developer-Tools/HCC-Example-Application/tree/ffd65333)
-    - [HIP Examples](https://github.com/ROCm-Developer-Tools/HIP-Examples/tree/roc-3.1.0)
-    
-#### ROCm Libraries
-  - [rocBLAS](https://github.com/ROCmSoftwarePlatform/rocBLAS/tree/rocm-3.1)
-  - [hipBLAS](https://github.com/ROCmSoftwarePlatform/hipBLAS/tree/rocm-3.1)
-  - [rocFFT](https://github.com/ROCmSoftwarePlatform/rocFFT/tree/rocm-3.1)
-  - [rocRAND](https://github.com/ROCmSoftwarePlatform/rocRAND/tree/3.1.0)
-  - [rocSPARSE](https://github.com/ROCmSoftwarePlatform/rocSPARSE/tree/rocm-3.1)
-  - [hipSPARSE](https://github.com/ROCmSoftwarePlatform/hipSPARSE/tree/rocm-3.1)
-  - [rocALUTION](https://github.com/ROCmSoftwarePlatform/rocALUTION/tree/rocm-3.1)
-  - [MIOpenGEMM](https://github.com/ROCmSoftwarePlatform/MIOpenGEMM/tree/b51a125)
-  - [MIOpen](https://github.com/ROCmSoftwarePlatform/MIOpen/tree/roc-3.1.0)
-  - [rocThrust](https://github.com/ROCmSoftwarePlatform/rocThrust/tree/3.1.0)
-  - [ROCm SMI Lib](https://github.com/RadeonOpenCompute/rocm_smi_lib/tree/roc-3.1.0)
-  - [RCCL](https://github.com/ROCmSoftwarePlatform/rccl/tree/3.1.0)
-  - [MIVisionX](https://github.com/GPUOpen-ProfessionalCompute-Libraries/MIVisionX/commit/755e7a08d5299a95c42def092af7c736d5eda90c)
-  - [hipCUB](https://github.com/ROCmSoftwarePlatform/hipCUB/tree/3.1.0)
-  - [AMDMIGraphX](https://github.com/ROCmSoftwarePlatform/AMDMIGraphX/tree/0.5.1)
-
-
-Features and enhancements introduced in previous versions of ROCm can be found in [version_history.md](version_history.md)
+For release information for older ROCm™ releases, refer to
+[CHANGELOG](./CHANGELOG.md).

RELEASE.md

@@ -0,0 +1,83 @@
+# 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.4.1
+<!-- markdownlint-disable first-line-h1 -->
+<!-- markdownlint-disable no-duplicate-header -->
+### What's New in This Release
+
+#### HIP Enhancements
+
+The ROCm v5.4.1 release consists of the following new HIP API:
+
+##### New HIP API - hipLaunchHostFunc
+
+The following new HIP API is introduced in the ROCm v5.4.1 release.
+
+> **Note**
+>
+> This is a pre-official version (beta) release of the new APIs.
+
+```h
+hipError_t hipLaunchHostFunc(hipStream_t stream, hipHostFn_t fn, void* userData);
+```
+
+This swaps the stream capture mode of a thread.
+
+```text
+@param [in] mode - Pointer to mode value to swap with the current mode
+```
+
+This parameter returns `#hipSuccess`, `#hipErrorInvalidValue`.
+
+For more information, refer to the HIP API documentation at /bundle/HIP_API_Guide/page/modules.html.
+
+### Deprecations and Warnings
+
+#### HIP Perl Scripts 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.
+
+### IFWI Fixes
+
+These defects were identified and documented as known issues in previous ROCm releases and are fixed in this release.
+AMD Instinct™ MI200 Firmware IFWI Maintenance Update #3
+
+This IFWI release fixes the following issue in AMD Instinct™ MI210/MI250 Accelerators.
+
+After prolonged periods of operation, certain MI200 Instinct™ Accelerators may perform in a degraded way resulting in application failures.
+
+In this package, AMD delivers a new firmware version for MI200 GPU accelerators and a firmware installation tool – AMD FW FLASH 1.2.
+
+| GPU   | Production Part Number | SKU | IFWI Name |
+|-------|------------|--------|---------------|
+| MI210 | 113-D673XX | D67302 | D6730200V.110 |
+| MI210 | 113-D673XX | D67301 | D6730100V.073 |
+| MI250 | 113-D652XX | D65209 | D6520900.073  |
+| MI250 | 113-D652XX | D65210 | D6521000.073  |
+
+Instructions on how to download and apply MI200 maintenance updates are available at:
+
+<https://www.amd.com/en/support/server-accelerators/amd-instinct/amd-instinct-mi-series/amd-instinct-mi210>
+
+#### AMD Instinct™ MI200 SRIOV Virtualization Support
+
+Maintenance update #3, combined with ROCm 5.4.1, now provides SRIOV virtualization support for all AMD Instinct™ MI200 devices.

default.xml

@@ -1,85 +1,79 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <manifest>
-
     <remote name="roc-github"
-            fetch="http://github.com/RadeonOpenCompute/" />
+fetch="https://github.com/RadeonOpenCompute/" />
     <remote name="rocm-devtools"
-            fetch="https://github.com/ROCm-Developer-Tools/" />
+fetch="https://github.com/ROCm-Developer-Tools/" />
     <remote name="rocm-swplat"
-            fetch="https://github.com/ROCmSoftwarePlatform/" />
+fetch="https://github.com/ROCmSoftwarePlatform/" />
     <remote name="gpuopen-libs"
-            fetch="https://github.com/GPUOpen-ProfessionalCompute-Libraries/" />
+fetch="https://github.com/GPUOpen-ProfessionalCompute-Libraries/" />
     <remote name="gpuopen-tools"
-            fetch="https://github.com/GPUOpen-Tools/" />
-
-    <default revision="refs/tags/roc-3.1.0"
-             remote="roc-github"
-             sync-c="true"
-             sync-j="4" />
-
+fetch="https://github.com/GPUOpen-Tools/" />
+    <remote name="KhronosGroup"
+fetch="https://github.com/KhronosGroup/" />
+    <default revision="refs/tags/rocm-5.5.1"
+     remote="roc-github"
+     sync-c="true"
+     sync-j="4" />
+<!--list of projects for ROCM-->
     <project name="ROCK-Kernel-Driver" />
     <project name="ROCT-Thunk-Interface" />
     <project name="ROCR-Runtime" />
-    <project name="ROC-smi" />
-    <project name="rocm_smi_lib" remote="roc-github" revision="refs/tags/roc-3.1.0" />
-    <project name="rocm-cmake" revision="1abe21258481d4cf92f5bab0ef5956636c52f735" />
+    <project name="rocm_smi_lib" />
+    <project name="rocm-core" />
+    <project name="rocm-cmake" />
     <project name="rocminfo" />
-
-    <project name="rocprofiler" remote="rocm-devtools" revision="refs/tags/roc-3.1.0" />
-    <project name="roctracer" remote="rocm-devtools" revision="roc-3.1.x" />
-    <!-- If you want to get the full OpenCL runtime, there is a separate repo
-         manifest that is more authoritative than the copy in this file. It can
-         be found at the following URL:
-         https://github.com/RadeonOpenCompute/ROCm-OpenCL-Runtime/blob/roc-2.0.0/opencl.xml -->
-    <remote name="KhronosGroup" fetch="https://github.com/KhronosGroup/" />
+    <project name="rocprofiler" remote="rocm-devtools" />
+    <project name="roctracer" remote="rocm-devtools" />
     <project name="ROCm-OpenCL-Runtime" />
-
     <project path="ROCm-OpenCL-Runtime/api/opencl/khronos/icd" name="OpenCL-ICD-Loader" remote="KhronosGroup" revision="6c03f8b58fafd9dd693eaac826749a5cfad515f8" />
     <project name="clang-ocl" />
-    <!-- HCC needs to be recursively synced to get it submodules -->
-    <project name="hcc" sync-s="true" revision="refs/tags/roc-hcc-3.1.0" />
-    <project name="HCC-Example-Application" remote="rocm-devtools" revision="ffd6533305e79eed667badd3c4cdb7879a1281b8" />
-    <project name="HIP" remote="rocm-devtools" revision="refs/tags/roc-3.1.0" />
+<!--HIP Projects-->
+    <project name="HIP" remote="rocm-devtools" />
+    <project name="hipamd" remote="rocm-devtools" />
     <project name="HIP-Examples" remote="rocm-devtools" />
-
-    <!-- The following projects are all associated with the AMDGPU LLVM compiler -->
-    <project name="llvm-project" path="llvm_amd-stg-open" revision="refs/tags/roc-ocl-3.1.0"/>
-    <project name="ROCm-Device-Libs" revision="refs/tags/roc-ocl-3.1.0"/>
-    <project name="atmi" revision="refs/tags/rocm_3.1.0" />
+    <project name="ROCclr" remote="rocm-devtools" />
+    <project name="HIPIFY" remote="rocm-devtools" />
+    <project name="HIPCC" remote="rocm-devtools" />
+<!-- The following projects are all associated with the AMDGPU LLVM compiler -->
+    <project name="llvm-project" />
+    <project name="ROCm-Device-Libs" />
+    <project name="atmi" />
     <project name="ROCm-CompilerSupport" />
     <project name="rocr_debug_agent" remote="rocm-devtools" />
     <project name="rocm_bandwidth_test" />
+    <project name="half" remote="rocm-swplat" revision="37742ce15b76b44e4b271c1e66d13d2fa7bd003e" />
     <project name="RCP" remote="gpuopen-tools" revision="3a49405a1500067c49d181844ec90aea606055bb" />
-
-    <!-- ROCm Libraries -->
-    <project name="rocBLAS" remote="rocm-swplat" revision="refs/tags/rocm-3.1" />
-    <project name="hipBLAS" remote="rocm-swplat" revision="refs/tags/rocm-3.1" />
-    <project name="rocFFT" remote="rocm-swplat" revision="refs/tags/rocm-3.1" />
-    <project name="rocRAND" remote="rocm-swplat" revision="refs/tags/3.1.0" />
-    <project name="rocSPARSE" remote="rocm-swplat" revision="refs/tags/rocm-3.1" />
-    <project name="hipSPARSE" remote="rocm-swplat" revision="refs/tags/rocm-3.1" />
-    <project name="rocALUTION" remote="rocm-swplat" revision="refs/tags/rocm-3.1" />
-    <project name="MIOpenGEMM" remote="rocm-swplat" revision="b51a12523676451bf38bfcf0506a0745e80ac64f" />
-    <project name="MIOpen" remote="rocm-swplat" revision="refs/tags/roc-3.1.0" />
-    <project name="rccl" remote="rocm-swplat" revision="refs/tags/3.1.0" />
-    <project name="MIVisionX" remote="gpuopen-libs" revision="755e7a08d5299a95c42def092af7c736d5eda90c" />
-    <project name="rocThrust" remote="rocm-swplat" revision="refs/tags/3.1.0" />
-    <project name="hipCUB" remote="rocm-swplat" revision="refs/tags/3.1.0" />
-    <project name="rocPRIM" remote="rocm-swplat" revision="refs/tags/3.1.0" />
-    <project name="AMDMIGraphX" remote="rocm-swplat" revision="79bfafc1b02dc276883fe5bab82eb9e481de8bc0" />
-    <project name="ROCmValidationSuite" remote="rocm-devtools" revision="refs/tags/roc-3.1.0" />
-
-    <!-- Projects for AOMP -->
-    <project name="ROCT-Thunk-Interface" path="aomp/roct-thunk-interface" remote="roc-github" revision="refs/tags/roc-3.1.0" />
-    <project name="ROCR-Runtime" path="aomp/rocr-runtime" remote="roc-github" revision="refs/tags/roc-3.1.0" />
-    <project name="hcc" path="aomp/hcc" remote="roc-github" revision="6d267cfb2895cb057e15b51a82c310bcc5f4462d" />
-    <project name="ROCm-Device-Libs" path="aomp/rocm-device-libs" remote="roc-github" revision="8f441a8aff556ff02fb2f501a3df0377dd58d15d" />
-    <project name="ROCm-CompilerSupport" path="aomp/rocm-compilersupport" remote="roc-github" revision="refs/tags/roc-3.1.0" />
-    <project name="rocminfo" path="aomp/rocminfo" remote="roc-github" revision="refs/tags/roc-3.1.0" />
-    <project name="atmi" path="aomp/atmi" remote="roc-github" revision="06e4962fab54b51cd5afa43b9118bca669e01fa3" />
-    <project name="HIP" path="aomp/hip" remote="rocm-devtools" revision="6edce9543de8621ccb6442bec9ef7314d123cc1a" />
-    <project name="aomp" path="aomp/aomp" remote="rocm-devtools" revision="refs/tags/roc-3.1.0" />
-    <project name="aomp-extras" path="aomp/aomp-extras" remote="rocm-devtools" revision="refs/tags/roc-3.1.0" />
-    <project name="flang" path="aomp/flang" remote="rocm-devtools" revision="refs/tags/roc-3.1.0" />
-    <project name="llvm-project" path="aomp/llvm-project" remote="rocm-devtools" revision="refs/tags/roc-aomp-3.1.0" />
+<!-- gdb projects -->
+    <project name="ROCgdb" remote="rocm-devtools" />
+    <project name="ROCdbgapi" remote="rocm-devtools" />
+<!-- ROCm Libraries -->
+    <project name="rdc" />
+    <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 groups="mathlibs" name="rccl" remote="rocm-swplat" />
+    <project name="MIVisionX" remote="gpuopen-libs" />
+    <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" />
+<!-- Projects for OpenMP-Extras -->
+    <project name="aomp" path="openmp-extras/aomp" remote="rocm-devtools" />
+    <project name="aomp-extras" path="openmp-extras/aomp-extras" remote="rocm-devtools" />
+    <project name="flang" path="openmp-extras/flang" remote="rocm-devtools" />
 </manifest>

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,76 @@
+# 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
+
+from rocm_docs import ROCmDocs
+
+
+shutil.copy2('../CONTRIBUTING.md','./contributing.md')
+shutil.copy2('../RELEASE.md','./release.md')
+# Keep capitalization due to similar linking on GitHub's markdown preview.
+shutil.copy2('../CHANGELOG.md','./CHANGELOG.md')
+
+# configurations for PDF output by Read the Docs
+project = "ROCm Documentation"
+author = "Advanced Micro Devices, Inc."
+copyright = "Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved."
+version = "5.4.1"
+release = "5.4.1"
+
+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/machine_learning", "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 5.4.1 Documentation Home")
+docs_core.setup()
+
+external_projects_current_project = "rocm"
+
+for sphinx_var in ROCmDocs.SPHINX_VARS:
+    globals()[sphinx_var] = getattr(docs_core, sphinx_var)
+html_theme_options = {
+    "link_main_doc": False
+}

docs/data/deploy/quick_start_windows/image planning

@@ -0,0 +1 @@
+

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
+{ref}`using-the-package-manager` on installing `amdgpu-dkms`. 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,53 @@
+# Deploy ROCm on Linux
+
+Start with {doc}`/deploy/linux/quick_start` or follow the detailed
+instructions below.
+
+## Prepare to Install
+
+::::{grid} 1 1 2 2
+:gutter: 1
+
+:::{grid-item-card} Prerequisites
+:link: prerequisites
+:link-type: doc
+
+The prerequisites page lists the required steps *before* installation.
+:::
+
+:::{grid-item-card} Install Choices
+:link: install_overview
+:link-type: doc
+
+Package manager vs AMDGPU Installer
+
+Standard Packages vs Multi-Version Packages
+:::
+
+::::
+
+## Choose your install method
+
+::::{grid} 1 1 2 2
+:gutter: 1
+
+:::{grid-item-card} Package Manager
+:link: os-native/index
+:link-type: doc
+
+Directly use your distribution's package manager to install ROCm.
+:::
+
+:::{grid-item-card} AMDGPU Installer
+:link: installer/index
+:link-type: doc
+
+Use an installer tool that orchestrates changes via the package
+manager.
+:::
+
+::::
+
+## See Also
+
+- {doc}`/release/gpu_os_support`

docs/deploy/linux/install_overview.md

@@ -0,0 +1,71 @@
+# ROCm Installation Options (Linux)
+
+Users installing ROCm must choose between various installation options. A new
+user should follow the [Quick Start guide](./quick_start).
+
+## Package Manager versus AMDGPU Installer?
+
+ROCm supports two methods for installation:
+
+- Directly using the Linux distribution's package manager
+- The `amdgpu-install` script
+
+There is no difference in the final installation state when choosing either
+option.
+
+Using the distribution's package manager lets the user install,
+upgrade and uninstall using familiar commands and workflows. Third party
+ecosystem support is the same as your OS package manager.
+
+The `amdgpu-install` script is a wrapper around the package manager. The same
+packages are installed by this script as the package manager system.
+
+The installer automates the installation process for the AMDGPU
+and ROCm stack. It handles the complete installation process
+for ROCm, including setting up the repository, cleaning the system, updating,
+and installing the desired drivers and meta-packages. Users who are
+less familiar with the package manager can choose this method for ROCm
+installation.
+
+(installation-types)=
+
+## Single Version ROCm install versus Multi-Version
+
+ROCm packages are versioned with both semantic versioning that is package
+specific and a ROCm release version.
+
+### 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.
+
+```{attention}
+ROCm packages that were previously installed from a single-version installation
+must be removed before proceeding with the multi-version installation to avoid
+conflicts.
+```
+
+```{note}
+Multiversion install is not available for the kernel driver module, also referred to as AMDGPU.
+```
+
+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/installer/index.md

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

docs/deploy/linux/installer/install.md

@@ -0,0 +1,299 @@
+# Installation with install script
+
+Prior to beginning, please ensure you have the [prerequisites](../prerequisites)
+installed.
+
+## Download the Installer Script
+
+To download and install the `amdgpu-install` script on the system, use the
+following commands based on your distribution.
+
+::::::{tab-set}
+:::::{tab-item} Ubuntu
+:sync: ubuntu
+
+::::{tab-set}
+:::{tab-item} Ubuntu 20.04
+:sync: ubuntu-20.04
+
+```shell
+sudo apt update
+wget https://repo.radeon.com/amdgpu-install/5.4.1/ubuntu/focal/amdgpu-install_5.4.50401-1_all.deb
+sudo apt install ./amdgpu-install_5.4.50401-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.1/ubuntu/jammy/amdgpu-install_5.4.50401-1_all.deb
+sudo apt install ./amdgpu-install_5.4.50401-1_all.deb
+```
+
+:::
+::::
+:::::
+:::::{tab-item} Red Hat Enterprise Linux
+:sync: RHEL
+
+::::{tab-set}
+:::{tab-item} RHEL 8.6
+:sync: RHEL-8.6
+:sync: RHEL-8
+
+```shell
+sudo yum install https://repo.radeon.com/amdgpu-install/5.4.1/rhel/8.6/amdgpu-install-5.4.50401-1.el8.noarch.rpm
+```
+
+:::
+:::{tab-item} RHEL 8.7
+:sync: RHEL-8.7
+:sync: RHEL-8
+
+```shell
+sudo yum install https://repo.radeon.com/amdgpu-install/5.4.1/rhel/8.7/amdgpu-install-5.4.50401-1.el8.noarch.rpm
+```
+
+:::
+:::{tab-item} RHEL 9.1
+:sync: RHEL-9.1
+:sync: RHEL-9
+
+```shell
+sudo yum install https://repo.radeon.com/amdgpu-install/5.4.1/rhel/9.1/amdgpu-install-5.4.50401-1.el9.noarch.rpm
+```
+
+:::
+::::
+:::::
+:::::{tab-item} SUSE Linux Enterprise Server 15
+:sync: SLES15
+
+::::{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.1/sle/15.4/amdgpu-install-5.4.50401-1.noarch.rpm
+```
+
+:::
+::::
+:::::
+::::::
+
+## Use cases
+
+Instead of installing individual applications or libraries the installer script
+groups packages into specific use cases, matching typical workflows and runtimes.
+
+To display a list of available use cases execute the command:
+
+```shell
+sudo amdgpu-install --list-usecase
+```
+
+The available use-cases will be printed in a format similar to the example
+output below.
+
+```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
+```
+
+To install use cases specific to your requirements, use the installer
+`amdgpu-install` as follows:
+
+- To install a single use case add it with the `--usecase` option:
+
+  ```shell
+  sudo amdgpu-install --usecase=rocm
+  ```
+
+- For multiple use cases separate them with commas:
+
+  ```shell
+  sudo amdgpu-install --usecase=hiplibsdk,rocm
+  ```
+
+## Single-version ROCm Installation
+
+By default (without the `--rocmrelease` option)
+the installer script will install packages in the single-version layout.
+
+## Multi-version ROCm Installation
+
+For the multi-version ROCm installation you must use the installer script from
+the latest release of ROCm that you wish to install.
+
+**Example:** If you want to install ROCm releases 5.3.3 and 5.4.1
+simultaneously, you are required to download the installer from the latest ROCm
+release v5.4.1.
+
+### Add Required Repositories
+
+You must add the 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.
+
+Run the following commands based on your distribution to add the repositories:
+
+::::::{tab-set}
+:::::{tab-item} Ubuntu
+:sync: ubuntu
+
+::::{tab-set}
+:::{tab-item} Ubuntu 20.04
+:sync: ubuntu-20.04
+
+```shell
+for ver in 5.3.3 5.4; 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.3.3 5.4; 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
+
+::::{tab-set}
+:::{tab-item} RHEL 8
+:sync: RHEL-8
+
+```shell
+for ver in 5.3.3 5.4; do
+sudo tee --append /etc/yum.repos.d/rocm.repo <<EOF
+[ROCm-$ver]
+name=ROCm$ver
+baseurl=https://repo.radeon.com/rocm/rhel8/$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} RHEL 9
+:sync: RHEL-9
+
+```shell
+for ver in 5.3.3 5.4; do
+sudo tee --append /etc/yum.repos.d/rocm.repo <<EOF
+[ROCm-$ver]
+name=ROCm$ver
+baseurl=https://repo.radeon.com/rocm/rhel9/$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.3.3 5.4; do
+sudo tee --append /etc/zypp/repos.d/rocm.repo <<EOF
+name=rocm
+baseurl=https://repo.radeon.com/rocm/$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
+
+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>
+```
+
+Following are examples of ROCm multi-version installation. The kernel-mode
+driver, associated with the ROCm release v5.4.1, will be installed as its latest
+release in the list.
+
+```none
+sudo amdgpu-install --usecase=rocm --rocmrelease=5.3.3
+sudo amdgpu-install --usecase=rocm --rocmrelease=5.4.1
+```
+
+## Additional options
+
+### Unattended installation
+
+Adding `-y` as a parameter to `amdgpu-install` skips user prompts (for
+automation). Example: `amdgpu-install -y --usecase=rocm`
+
+### Skipping kernel mode driver installation
+
+The installer script tries to install the kernel mode driver along with the
+requested use cases. This might be unnecessary as in the case of docker
+containers or you may wish to keep a specific version when using multi-version
+installation, and not have the last installed version overwrite the kernel mode
+driver.
+
+To skip the installation of the kernel-mode driver add the `--no-dkms` option
+when calling the installer script.