Update README

Merge 5.7 changes into Develop

.github/CODEOWNERS

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

.github/ISSUE_TEMPLATE/0_issue_report.yml

@@ -0,0 +1,76 @@
+name: Issue Report
+description: File a report for something not working correctly.
+title: "[Issue]: "
+
+body:
+- type: markdown
+  attributes:
+    value: |
+      Thank you for taking the time to fill out this report!
+
+      On a Linux system, you can acquire your OS, CPU, GPU, and ROCm version (for filling out this report) with the following commands:
+      echo "OS:" && cat /etc/os-release | grep -E "^(NAME=|VERSION=)";
+      echo "CPU: " && cat /proc/cpuinfo | grep "model name" | sort --unique;
+      echo "GPU:" && /opt/rocm/bin/rocminfo | grep -E "^\s*(Name|Marketing Name)";
+      echo "ROCm in /opt:" && ls -1 /opt | grep -E "rocm-";
+- type: textarea
+  attributes:
+    label: Problem Description
+    description: Describe the issue you encountered.
+    placeholder: "The steps to reproduce can be included here, or in the dedicated section further below."
+  validations:
+    required: true
+- type: input
+  attributes:
+    label: Operating System
+    description: What is the name and version number of the OS?
+    placeholder: "e.g. Ubuntu 22.04.3 LTS (Jammy Jellyfish)"
+  validations:
+    required: true
+- type: input
+  attributes:
+    label: CPU
+    description: What CPU did you encounter the issue on?
+    placeholder: "e.g. AMD Ryzen 9 5900HX with Radeon Graphics"
+  validations:
+    required: true
+- type: input
+  attributes:
+    label: GPU
+    description: What GPU(s) did you encounter the issue on?
+    placeholder: "e.g. MI200"
+  validations:
+    required: true
+- type: input
+  attributes:
+    label: ROCm Version
+    description: What version(s) of ROCm did you encounter the issue on?
+    placeholder: "e.g. 5.7.0"
+  validations:
+    required: true
+- type: input
+  attributes:
+    label: ROCm Component
+    description: (Optional) If this issue relates to a specific ROCm component, it can be mentioned here.
+    placeholder: "e.g. rocBLAS"
+
+- type: textarea
+  attributes:
+    label: Steps to Reproduce
+    description: (Optional) Detailed steps to reproduce the issue.
+    placeholder: Please also include what you expected to happen, and what actually did, at the failing step(s).
+  validations:
+    required: false
+
+- type: textarea
+  attributes:
+    label: Output of /opt/rocm/bin/rocminfo --support
+    description: The output of rocminfo --support will help to better address the problem.
+    placeholder: |
+      ROCk module is loaded
+      =====================
+      HSA System Attributes
+      =====================
+      [...]
+  validations:
+    required: true

.github/ISSUE_TEMPLATE/1_feature_request.yml

@@ -0,0 +1,32 @@
+name: Feature Suggestion
+description: Suggest an additional functionality, or new way of handling an existing functionality.
+title: "[Feature]: "
+
+body:
+- type: markdown
+  attributes:
+    value: |
+      Thank you for taking the time to make a suggestion!
+
+- type: textarea
+  attributes:
+    label: Suggestion Description
+    description: Describe your suggestion.
+  validations:
+    required: true
+- type: input
+  attributes:
+    label: Operating System
+    description: (Optional) If this is for a specific OS, you can mention it here.
+    placeholder: "e.g. Ubuntu"
+- type: input
+  attributes:
+    label: GPU
+    description: (Optional) If this is for a specific GPU or GPU family, you can mention it here.
+    placeholder: "e.g. MI200"
+- type: input
+  attributes:
+    label: ROCm Component
+    description: (Optional) If this issue relates to a specific ROCm component, it can be mentioned here.
+    placeholder: "e.g. rocBLAS"
+

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: ROCm Community Discussions
+    url: https://github.com/RadeonOpenCompute/ROCm/discussions
+    about: Please ask and answer questions here for anything ROCm.

.github/dependabot.yml

@@ -10,3 +10,4 @@ updates:
     open-pull-requests-limit: 10
     schedule:
       interval: "daily"
+    versioning-strategy: increase

.github/workflows/linting.yml

@@ -5,52 +5,16 @@ on:
     branches: 
     - develop
     - main
+    - 'docs/*'
+    - 'roc**'
   pull_request:
     branches: 
     - develop
     - main
-
-concurrency:
-  group: ${{ github.ref }}-${{ github.workflow }}
-  cancel-in-progress: true
+    - 'docs/*'
+    - 'roc**'
 
 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."
+  call-workflow-passing-data:
+    name: Documentation
+    uses: RadeonOpenCompute/rocm-docs-core/.github/workflows/linting.yml@develop

.gitignore

@@ -1,18 +0,0 @@
-.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

@@ -1,14 +0,0 @@
-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

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

.wordlist.txt

@@ -1,29 +0,0 @@
-# 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

@@ -1,246 +0,0 @@
-# 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,21 +0,0 @@
-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,54 +1,13 @@
-# 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.
-
-The develop branch of this repository contains content for the next
-ROCm release.
-
-## ROCm Documentation
-
-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.
-
-### How to build documentation via Sphinx
-
-```bash
-cd docs
-
-pip3 install -r sphinx/requirements.txt
-
-python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
-```
-
-## Older ROCm™ Releases
-
-For release information for older ROCm™ releases, refer to
-[CHANGELOG](./CHANGELOG.md).
+# rocm-docs-redirects
+
+Redirects ReadtheDocs Community documentation sites to Business
+
+## Building
+
+```shell
+cd docs
+
+pip3 install -r sphinx/requirements.txt
+
+python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
+```

RELEASE.md

@@ -1,54 +0,0 @@
-# Release Notes
-<!-- Do not edit this file! This file is autogenerated with -->
-<!--   tools/autotag/tag_script.py                          -->
-
-<!-- Disable lints since this is an auto-generated file.    -->
-<!-- markdownlint-disable blanks-around-headers             -->
-<!-- markdownlint-disable no-duplicate-header               -->
-<!-- markdownlint-disable no-blanks-blockquote              -->
-<!-- markdownlint-disable ul-indent                         -->
-<!-- markdownlint-disable no-trailing-spaces                -->
-
-<!-- spellcheck-disable -->
-
-The release notes for the ROCm platform.
-
--------------------
-
-## ROCm 5.5.1
-<!-- markdownlint-disable first-line-h1 -->
-<!-- markdownlint-disable no-duplicate-header -->
-### What's New in This Release
-
-#### HIP API Change
-
-The following HIP API is updated in the ROCm v5.5.1 release,
-
-##### `hipDeviceSetCacheConfig`
-
-- The return value for `hipDeviceSetCacheConfig` is updated from `hipErrorNotSupported` to `hipSuccess`
-
-### Library Changes in ROCM 5.5.1
-
-| Library | Version |
-|---------|---------|
-| hipBLAS | [0.54.0](https://github.com/ROCmSoftwarePlatform/hipBLAS/releases/tag/rocm-5.5.1) |
-| hipCUB | [2.13.1](https://github.com/ROCmSoftwarePlatform/hipCUB/releases/tag/rocm-5.5.1) |
-| hipFFT | [1.0.11](https://github.com/ROCmSoftwarePlatform/hipFFT/releases/tag/rocm-5.5.1) |
-| hipSOLVER | [1.7.0](https://github.com/ROCmSoftwarePlatform/hipSOLVER/releases/tag/rocm-5.5.1) |
-| hipSPARSE | [2.3.5](https://github.com/ROCmSoftwarePlatform/hipSPARSE/releases/tag/rocm-5.5.1) |
-| rccl | [2.15.5](https://github.com/ROCmSoftwarePlatform/rccl/releases/tag/rocm-5.5.1) |
-| rocALUTION | [2.1.8](https://github.com/ROCmSoftwarePlatform/rocALUTION/releases/tag/rocm-5.5.1) |
-| rocBLAS | [2.47.0](https://github.com/ROCmSoftwarePlatform/rocBLAS/releases/tag/rocm-5.5.1) |
-| rocFFT | [1.0.22](https://github.com/ROCmSoftwarePlatform/rocFFT/releases/tag/rocm-5.5.1) |
-| rocPRIM | [2.13.0](https://github.com/ROCmSoftwarePlatform/rocPRIM/releases/tag/rocm-5.5.1) |
-| rocRAND | [2.10.17](https://github.com/ROCmSoftwarePlatform/rocRAND/releases/tag/rocm-5.5.1) |
-| rocSOLVER | [3.21.0](https://github.com/ROCmSoftwarePlatform/rocSOLVER/releases/tag/rocm-5.5.1) |
-| rocSPARSE | [2.5.1](https://github.com/ROCmSoftwarePlatform/rocSPARSE/releases/tag/rocm-5.5.1) |
-| rocThrust | [2.17.0](https://github.com/ROCmSoftwarePlatform/rocThrust/releases/tag/rocm-5.5.1) |
-| rocWMMA | [1.0](https://github.com/ROCmSoftwarePlatform/rocWMMA/releases/tag/rocm-5.5.1) |
-| Tensile | [4.36.0](https://github.com/ROCmSoftwarePlatform/Tensile/releases/tag/rocm-5.5.1) |
-
-## Older versions
-
-The release notes for older versions can be found in [the changelog](./CHANGELOG.md).

default.xml

@@ -1,79 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<manifest>
-    <remote name="roc-github"
-fetch="https://github.com/RadeonOpenCompute/" />
-    <remote name="rocm-devtools"
-fetch="https://github.com/ROCm-Developer-Tools/" />
-    <remote name="rocm-swplat"
-fetch="https://github.com/ROCmSoftwarePlatform/" />
-    <remote name="gpuopen-libs"
-fetch="https://github.com/GPUOpen-ProfessionalCompute-Libraries/" />
-    <remote name="gpuopen-tools"
-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="rocm_smi_lib" />
-    <project name="rocm-core" />
-    <project name="rocm-cmake" />
-    <project name="rocminfo" />
-    <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" />
-<!--HIP Projects-->
-    <project name="HIP" remote="rocm-devtools" />
-    <project name="hipamd" remote="rocm-devtools" />
-    <project name="HIP-Examples" remote="rocm-devtools" />
-    <project name="ROCclr" remote="rocm-devtools" />
-    <project name="HIPIFY" remote="rocm-devtools" />
-    <project name="HIPCC" remote="rocm-devtools" />
-<!-- The following projects are all associated with the AMDGPU LLVM compiler -->
-    <project name="llvm-project" />
-    <project name="ROCm-Device-Libs" />
-    <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" />
-<!-- 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/.gitignore

@@ -0,0 +1 @@
+_build/

docs/404.md

@@ -1,6 +0,0 @@
-# 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

@@ -1,74 +0,0 @@
-# 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/about.rst

@@ -0,0 +1,5 @@
+#####
+About
+#####
+
+For the latest ROCm documentation, see https://rocm.docs.amd.com/

docs/conf.py

@@ -1,69 +1,11 @@
-# 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')
-
-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 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
-}
+from rocm_docs import ROCmDocs
+
+external_toc_path = "./sphinx/_toc.yml"
+
+docs_core = ROCmDocs("rocm-docs-redirects")
+docs_core.setup()
+
+external_projects_current_project = "rocm"
+
+for sphinx_var in ROCmDocs.SPHINX_VARS:
+    globals()[sphinx_var] = getattr(docs_core, sphinx_var)

docs/data/deploy/quick_start_windows/image planning

@@ -1 +0,0 @@
-

docs/deploy/docker.md

@@ -1,90 +0,0 @@
-# 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

@@ -1,53 +0,0 @@
-# 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

@@ -1,71 +0,0 @@
-# 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
-```