Update documentation requirements

* Update Linux and ROCm versions

* Update CI to use build.os

.github/CODEOWNERS

@@ -1 +1 @@
-* @saadrahim
+* @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

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Advanced Micro Devices, Inc. All rights reserved.
+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

README.md

@@ -1,87 +1,54 @@
-# ROCm™ Repository Updates
-This repository contains the manifest file for ROCm™ releases, changelogs, and release information. The file default.xml contains information for all repositories and the associated commit used to build the current ROCm release.
+# AMD ROCm™ Platform
+
+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.
+
+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.
+
+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.
 
 The default.xml file uses the repo Manifest format.
 
-# ROCm v5.3.3 Release Notes
-ROCm v5.3.3 is now released. For ROCm v5.3.3 documentation, refer to https://docs.amd.com.
+The develop branch of this repository contains content for the next
+ROCm release.
 
-# ROCm v5.3.2 Release Notes
-ROCm v5.3.2 is now released. For ROCm v5.3.2 documentation, refer to https://docs.amd.com.
+## ROCm Documentation
 
-# ROCm v5.3 Release Notes
-ROCm v5.3 is now released. For ROCm v5.3 documentation, refer to https://docs.amd.com.
+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.
 
-# ROCm v5.2.3 Release Notes
-The ROCm v5.2.3 patch release is now available. The details are listed below. Highlights of this release include enhancements in RCCL version compatibility and minor bug fixes in the HIP Runtime.
+### How to build documentation via Sphinx
 
-Additionally, ROCm releases will return to use of the [ROCm](https://github.com/RadeonOpenCompute/ROCm) repository for version-controlled release notes henceforth.
+```bash
+cd docs
 
-**NOTE**: This release of ROCm is validated with the AMDGPU release v22.20.1.
-
-All users of the ROCm v5.2.1 release and below are encouraged to upgrade. Refer to https://docs.amd.com for documentation associated with this release.
-
-
-## Introducing Preview Support for Ubuntu 20.04.5 HWE
-
-Refer to the following article for information on the preview support for Ubuntu 20.04.5 HWE.
-
-https://www.amd.com/en/support/kb/release-notes/rn-amdgpu-unified-linux-22-20
-
-
-## Changes in This Release
-
-### Ubuntu 18.04 End of Life
-
-Support for Ubuntu 18.04 ends in this release. Future releases of ROCm will not provide prebuilt packages for Ubuntu 18.04.
-
-
-### HIP and Other Runtimes
-
-#### HIP Runtime
-
-##### Fixes
-
- - A bug was discovered in the HIP graph capture implementation in the ROCm v5.2.0 release. If the same kernel is called twice (with different argument values) in a graph capture, the implementation only kept the argument values for the second kernel call.
-
-- A bug was introduced in the hiprtc implementation in the ROCm v5.2.0 release. This bug caused the *hiprtcGetLoweredName* call to fail for named expressions with whitespace in it.
-
-**Example:** The named expression ```my_sqrt<complex<double>>``` passed but ```my_sqrt<complex<double>>``` failed.
-
-
-### ROCm Libraries
-
-#### RCCL
-
-##### Added
-- Compatibility with NCCL 2.12.10
-- Packages for test and benchmark executables on all supported OSes using CPack
-- Adding custom signal handler - opt-in with RCCL_ENABLE_SIGNALHANDLER=1
-  - Additional details provided if Binary File Descriptor library (BFD) is pre-installed.
-  - Adding experimental support for using multiple ranks per device
-    - Requires using a new interface to create communicator (ncclCommInitRankMulti),
-        refer to the interface documentation for details.
-	  - To avoid potential deadlocks, user might have to set an environment variables increasing
-	      the number of hardware queues. For example,
+pip3 install -r sphinx/requirements.txt
 
+python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
 ```
-    export GPU_MAX_HW_QUEUES=16
-
-```
-- Adding support for reusing ports in NET/IB channels
-  - Opt-in with NCCL_IB_SOCK_CLIENT_PORT_REUSE=1 and NCCL_IB_SOCK_SERVER_PORT_REUSE=1
-    - When "Call to bind failed: Address already in use" error happens in large-scale AlltoAll
-        (for example, >=64 MI200 nodes), users are suggested to opt-in either one or both of the options to resolve the massive port usage issue
-	  - Avoid using NCCL_IB_SOCK_SERVER_PORT_REUSE when NCCL_NCHANNELS_PER_NET_PEER is tuned >1
-
-##### Removed
-- Removed experimental clique-based kernels
-
-### Development Tools
-No notable changes in this release for development tools, including the compiler, profiler, and debugger.
-
-### Deployment and Management Tools
-No notable changes in this release for deployment and management tools.
 
 ## Older ROCm™ Releases
-For release information for older ROCm™ releases, refer to [CHANGELOG](CHANGELOG.md).
+
+For release information for older ROCm™ releases, refer to
+[CHANGELOG](./CHANGELOG.md).

RELEASE.md

@@ -0,0 +1,245 @@
+# 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.0
+<!-- markdownlint-disable first-line-h1 -->
+<!-- markdownlint-disable no-duplicate-header -->
+### What's New in This Release
+
+#### HIP Enhancements
+
+The ROCm v5.4 release consists of the following HIP enhancements:
+
+##### Support for Wall Clock64
+
+A new timer function wall_clock64() is supported, which returns wall clock count at a constant frequency on the device.
+
+```h
+long long int wall_clock64();
+```
+
+It returns wall clock count at a constant frequency on the device, which can be queried via HIP API with the hipDeviceAttributeWallClockRate attribute of the device in the HIP application code.
+
+Example:
+
+```h
+int wallClkRate = 0; //in kilohertz
++HIPCHECK(hipDeviceGetAttribute(&wallClkRate, hipDeviceAttributeWallClockRate, deviceId));
+```
+
+Where hipDeviceAttributeWallClockRate is a device attribute.
+
+> **Note**
+>
+> The wall clock frequency is a per-device attribute.
+
+##### New Registry Added for GPU_MAX_HW_QUEUES
+
+The GPU_MAX_HW_QUEUES registry defines the maximum number of independent hardware queues allocated per process per device.
+
+The environment variable controls how many independent hardware queues HIP runtime can create per process, per device. If the application allocates more HIP streams than this number, then the HIP runtime reuses the same hardware queues for the new streams in a round-robin manner.
+
+> **Note**
+>
+> This maximum number does not apply to hardware queues created for CU-masked HIP streams or cooperative queues for HIP Cooperative Groups (there is only one queue per device).
+
+For more details, refer to the HIP Programming Guide.
+
+#### New HIP APIs in This Release
+
+The following new HIP APIs are available in the ROCm v5.4 release.
+
+> **Note**
+>
+> This is a pre-official version (beta) release of the new APIs.
+
+##### Error Handling
+
+```h
+hipError_t hipDrvGetErrorName(hipError_t hipError, const char** errorString);
+```
+
+This returns HIP errors in the text string format.
+
+```h
+hipError_t hipDrvGetErrorString(hipError_t hipError, const char** errorString);
+```
+
+This returns text string messages with more details about the error.
+
+For more information, refer to the HIP API Guide.
+
+##### HIP Tests Source Separation
+
+With ROCm v5.4, a separate GitHub project is created at
+
+<https://github.com/ROCm-Developer-Tools/hip-tests>
+
+This contains HIP catch2 tests and samples, and new tests will continue to develop.
+
+In future ROCm releases, catch2 tests and samples will be removed from the HIP project.
+
+### OpenMP Enhancements
+
+This release consists of the following OpenMP enhancements:
+
+- Enable new device RTL in libomptarget as default.
+- New flag `-fopenmp-target-fast` to imply `-fopenmp-target-ignore-env-vars -fopenmp-assume-no-thread-state -fopenmp-assume-no-nested-parallelism`.
+- Support for the collapse clause and non-unit stride in cases where the No-Loop specialized kernel is generated.
+- Initial implementation of optimized cross-team sum reduction for float and double type scalars.
+- Pool-based optimization in the OpenMP runtime to reduce locking during data transfer.
+
+### 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.
+
+(5_4_0_filesystem_reorg_deprecation_notice)=
+
+##### 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:
+
+```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
+```
+
+### Fixed Defects
+
+The following defects are fixed in this release.
+
+These defects were identified and documented as known issues in previous ROCm releases and are fixed in this release.
+
+#### Memory Allocated Using hipHostMalloc() with Flags Did Not Exhibit Fine-Grain Behavior
+
+##### Issue
+
+The test was incorrectly using the `hipDeviceAttributePageableMemoryAccess` device attribute to determine coherent support.
+
+##### Fix
+
+`hipHostMalloc()` allocates memory with fine-grained access by default when the environment variable `HIP_HOST_COHERENT=1` is used.
+
+For more information, refer to {doc}`hip:.doxygen/docBin/html/index`.
+
+
+#### SoftHang with `hipStreamWithCUMask` test on AMD Instinct™
+
+##### Issue
+
+On GFX10 GPUs, kernel execution hangs when it is launched on streams created using `hipStreamWithCUMask`.
+
+##### Fix
+
+On GFX10 GPUs, each workgroup processor encompasses two compute units, and the compute units must be enabled as a pair. The `hipStreamWithCUMask` API unit test cases are updated to set compute unit mask (cuMask) in pairs for GFX10 GPUs.
+
+#### ROCm Tools GPU IDs
+
+The HIP language device IDs are not the same as the GPU IDs reported by the tools. GPU IDs are globally unique and guaranteed to be consistent across APIs and processes.
+
+GPU IDs reported by ROCTracer and ROCProfiler or ROCm Tools are HSA Driver Node ID of that GPU, as it is a unique ID for that device in that particular node.

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.3.3"
+    <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,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.0"
+release = "5.4.0"
+
+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.0 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/ubuntu/focal/amdgpu-install_5.4.50400-1_all.deb
+sudo apt install ./amdgpu-install_5.4.50400-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/ubuntu/jammy/amdgpu-install_5.4.50400-1_all.deb
+sudo apt install ./amdgpu-install_5.4.50400-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/rhel/8.6/amdgpu-install-5.4.50400-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/rhel/8.7/amdgpu-install-5.4.50400-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/rhel/9.1/amdgpu-install-5.4.50400-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/sle/15.4/amdgpu-install-5.4.50400-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
+simultaneously, you are required to download the installer from the latest ROCm
+release v5.4.
+
+### 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; 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; 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; 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; 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, 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.0
+```
+
+## 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.

docs/deploy/linux/installer/uninstall.md

@@ -0,0 +1,25 @@
+# Installer Script Uninstallation (Linux)
+
+To uninstall all ROCm packages and the kernel-mode driver the following commands
+can be used.
+
+::::{rubric} Uninstalling Single-Version Install
+::::
+
+```console shell
+sudo amdgpu-install --uninstall
+```
+
+::::{rubric} Uninstalling a Specific ROCm Release
+::::
+
+```console shell
+sudo amdgpu-install --uninstall --rocmrelease=<release-number>
+```
+
+::::{rubric} Uninstalling all ROCm Releases
+::::
+
+```console shell
+sudo amdgpu-install --uninstall --rocmrelease=all
+```

docs/deploy/linux/installer/upgrade.md

@@ -0,0 +1,5 @@
+# Upgrading with the Installer Script (Linux)
+
+The upgrade procedure with the installer script is exactly the same as
+installing for 1st time use. Refer to the {doc}`install`
+section on the exact procedure to follow.

docs/deploy/linux/os-native/index.md

@@ -0,0 +1,38 @@
+# Installation via Package manager
+
+::::{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.
+:::
+
+:::{grid-item-card} Package Manager Integration
+:link: package_manager_integration
+:link-type: doc
+
+Information about packages.
+:::
+
+::::
+
+## See Also
+
+- {doc}`/release/gpu_os_support`