Update README

Merge 5.7 changes into Develop

.github/CODEOWNERS

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

@@ -0,0 +1,13 @@
+# 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"
+    versioning-strategy: increase

.github/workflows/linting.yml

@@ -0,0 +1,20 @@
+name: Linting
+
+on:
+  push:
+    branches: 
+    - develop
+    - main
+    - 'docs/*'
+    - 'roc**'
+  pull_request:
+    branches: 
+    - develop
+    - main
+    - 'docs/*'
+    - 'roc**'
+
+jobs:
+  call-workflow-passing-data:
+    name: Documentation
+    uses: RadeonOpenCompute/rocm-docs-core/.github/workflows/linting.yml@develop

.readthedocs.yaml

@@ -0,0 +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: []
+
+python:
+   install:
+   - requirements: docs/sphinx/requirements.txt
+
+build:
+   os: ubuntu-22.04
+   tools:
+      python: "3.8"

README.md

@@ -1,201 +1,13 @@
-## Are You Ready to ROCK!
-The ROCm Platform delivers on the vision of the  Boltzmann Initiative, bringing
-new opportunities in GPU Computing Research.
-
-On November 16th, 2015, the Radeon Technology Group rolled out Boltzmann
-Initiative with three core foundation elements:
-
-* New Linux(R) Driver and Runtime Stack optimized for HPC & Ultra-scale class
-  computing,
-* Heterogeneous C and C++ compiler which best address the whole system not just
-  a single device
-* HIP acknowledging the need for platform choice when utilizing GPU computing
-  API
-
-Using our knowledge of the HSA Standards and, more importantly, the HSA 1.1
-Runtime we have been able to successfully extended support to the dGPU with
-critical features for NUMA class acceleration. As a result, the ROCK driver is
-composed of several components based on our efforts to develop the
-Heterogeneous System Architecture for APUs, including the new AMDGPU driver,
-the Kernel Fusion Driver (KFD), the HSA+ Runtime and an LLVM based compilation
-stack for the building of key language support. This support starts with AMD’s
-FIJI Family of dGPU, but support is planned to expand to include future ASICS.
-
-### The Latest ROCm Platform - ROCm 1.1
-The latest tested version of the drivers, tools, libraries and source code for
-the ROCm platform have been released and are available under the roc-1.1.0 tag
-of the following GitHub repositories:
-
-* [ROCK-Kernel-Driver](https://github.com/RadeonOpenCompute/ROCK-Kernel-Driver/tree/roc-1.1.0)
-* [ROCR-Runtime](https://github.com/RadeonOpenCompute/ROCR-Runtime/tree/roc-1.1.0)
-* [ROCT-Thunk-Interface](https://github.com/RadeonOpenCompute/ROCT-Thunk-Interface/tree/roc-1.1.0)
-* [HCC compiler](https://github.com/RadeonOpenCompute/hcc/tree/roc-1.1.0)
-* [LLVM-AMDGPU-Assembler-Extra](https://github.com/RadeonOpenCompute/LLVM-AMDGPU-Assembler-Extra/tree/roc-1.1.0)
-* [ROC-smi](https://github.com/RadeonOpenCompute/ROC-smi/tree/roc-1.1.0)
-* [ROCnRDMA](https://github.com/RadeonOpenCompute/ROCnRDMA/tree/roc-1.1.0)
-* [HIP](https://github.com/GPUOpen-ProfessionalCompute-Tools/HIP/tree/roc-1.1.0)
-* [HIP-Examples](https://github.com/GPUOpen-ProfessionalCompute-Tools/HIP-Examples/tree/roc-1.1.0)
-
-In addition the following mirror repositories that support the HCC compiler are
-also available on GitHub, and frozen for the roc-1.1.0 release:
-
-* [llvm](https://github.com/RadeonOpenCompute/llvm/tree/roc-1.1.0)
-* [clang](https://github.com/RadeonOpenCompute/clang/tree/roc-1.1.0)
-
-### Installing from AMD ROCm Repositories
-AMD is hosting both debian and rpm repositories for the ROCm 1.1 packages. The
-packages in both repositories have been signed to ensure package integrity.
-Directions for each repository are given below:
-
-#### Supported Operating Systems
-
-The ROCm platform has been tested on the following operating systems:
- * Ubuntu 14.04.04
- * Fedora 23
-
-There is experimental support for the following operating systems:
- * Ubuntu 16.04
- * Fedora 22
-
-#### Debian repository - apt-get
-
-##### Add the ROCm apt repository
-For Debian based systems, like Ubuntu, configure the Debian ROCm repository as
-follows:
-
-```shell
-wget -qO - http://packages.amd.com/rocm/apt/debian/rocm.gpg.key | sudo apt-key add -
-sudo sh -c 'echo deb [arch=amd64] http://packages.amd.com/rocm/apt/debian/ trusty main > /etc/apt/sources.list.d/rocm.list'
-```
-
-##### Install or Update
-Next, update the apt-get repository list and install/update the rocm package:
-
->**Warning**: Before proceeding, make sure to completely
->[uninstall any pre-release ROCm packages](https://github.com/RadeonOpenCompute/ROCm#removing-pre-release-packages):
-
-```shell
-sudo apt-get update
-sudo apt-get install rocm
-```
-Then, make the ROCm kernel your default kernel. If using grub2 as your
-bootloader, you can edit the `GRUB_DEFAULT` variable in the following file:
-
-```shell
-sudo vi /etc/default/grub
-sudo update-grub
-```
-
-Once complete, reboot your system.
-
-We recommend you [verify your installation](https://github.com/RadeonOpenCompute/ROCm#verify-installation) to make sure everything completed successfully.
-
-##### Un-install
-To un-install the entire rocm-dev development package execute:
-
-```shell
-sudo apt-get autoremove rocm
-```
-
-##### Installing development packages for cross compilation
-It is often useful to develop and test on different systems. In this scenario,
-you may prefer to avoid installing the ROCm Kernel to your development system.
-
-In this case, install the development subset of packages:
-
-```shell
-sudo apt-get update
-sudo apt-get install rocm-dev
-```
-
->**Note:** To execute ROCm enabled apps you will require a system with the full
->ROCm driver stack installed
-
-##### Removing pre-release packages
-If you installed any of the ROCm pre-release packages from github, they will
-need to be manually un-installed:
-
-```shell
-sudo apt-get purge libhsakmt
-sudo apt-get purge radeon-firmware
-sudo apt-get purge $(dpkg -l | grep 'kfd\|rocm' | grep linux | grep -v libc | awk '{print $2}')
-```
-
-If possible, we would recommend starting with a fresh OS install.
-
-#### RPM repository - dnf (yum)
-
-A dnf (yum) repostiory is also available for installation of rpm packages. To configure a
-system to use the ROCm rpm directory create the file /etc/yum.repos.d/rocm.repo with
-the following contents:
-
-```shell
-[remote]
-
-name=ROCm Repo
-
-baseurl=http://packages.amd.com/rocm/yum/rpm/
-
-enabled=1
-
-gpgcheck=0
-```
-Execute the following commands:
-
-```shell
-sudo dnf clean all
-sudo dnf install rocm
-```
-
-As with the debian packages, it is possible to install rocm-dev or rocm-kernel individually.
-To uninstall the packages execute:
-
-```shell
-sudo dnf remove rocm
-```
-
-#### Verify Installation
-
-To verify that the ROCm stack completed successfully you can execute to HSA
-vectory\_copy sample application:
-
-```shell
-cd /opt/rocm/hsa/sample
-make
-./vector_copy
-```
-
-#### Closed Source Components
-The ROCm platform relies on a few closed source components to provide legacy
-functionality like HSAIL finalization and debugging/profiling support. These
-components are only available through the ROCm repositories, and will either be
-deprecated or become open source components in the future. These components are
-made available in the following packages:
-
-*  hsa-ext-rocr-dev
-
-### Getting ROCm Source Code
-Modifications can be made to the ROCm 1.1 components by modifying the open
-source code base and rebuilding the components. Source code can be cloned from
-each of the GitHub repositories using git, or users can use the repo command
-and the ROCm 1.1 manifest file to download the entire ROCm 1.1 source code.
-
-#### Installing repo
-Google's repo tool allows you to manage multiple git repositories
-simultaneously. You can install it by executing the following commands:
-
-```shell
-curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
-chmod a+x ~/bin/repo
-```
-Note: make sure ~/bin exists and it is part of your PATH
-
-#### Cloning the code
-```shell
-mkdir ROCm && cd ROCm
-repo init -u https://github.com/RadeonOpenCompute/ROCm.git -b roc-1.1.0
-repo sync
-```
-
-These series of commands will pull all of the open source code associated with
-the ROCm 1.1 release.
+# 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
+```

default.xml

@@ -1,27 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<manifest>
-
-    <remote name="roc-github"
-            fetch="ssh://git@github.com/RadeonOpenCompute/" />
-    <remote name="pctools-github"
-            fetch="ssh://git@github.com/GPUOpen-ProfessionalCompute-Tools/" />
-
-    <default revision="master"
-             remote="roc-github"
-             sync-j="4" />
-
-    <project path="llvm" name="llvm" />
-    <project path="llvm-amdgpu-assembler-extra" name="LLVM-AMDGPU-Assembler-Extra" />
-    <project path="clang" name="clang" />
-
-    <project path="hcc" name="hcc" />
-    <project path="ROCT-Thunk-Interface" name="ROCT-Thunk-Interface" />
-    <project path="ROCK-Kernel-Driver" name="ROCK-Kernel-Driver" />
-    <project path="ROC-smi" name="ROC-smi" />
-    <project path="ROCnRDMA" name="ROCnRDMA" />
-    <project path="rdma-perftest" name="rdma-perftest" />
-    <project path="ROCR-Runtime" name="ROCR-Runtime" />
-    <project path="HIP" remote="pctools-github" name="HIP" />
-    <project path="HIP-Examples" remote="pctools-github" name="HIP-Examples" />
-
-</manifest>

docs/.gitignore

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

docs/about.rst

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

docs/conf.py

@@ -0,0 +1,11 @@
+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/index.rst

@@ -0,0 +1,4 @@
+.. meta::
+   :http-equiv=Refresh: 0; url="https://rocm.docs.amd.com/en/latest/"
+
+For the latest ROCm documentation, see https://rocm.docs.amd.com/

docs/sphinx/.gitignore

@@ -0,0 +1 @@
+_toc.yml

docs/sphinx/_toc.yml.in

@@ -0,0 +1,9 @@
+# Anywhere {branch} is used, the branch name will be substituted.
+# These comments will also be removed.
+defaults:
+  numbered: False
+  maxdepth: 6
+root: index
+subtrees:
+- entries:
+  - file: about

docs/sphinx/requirements.in

@@ -0,0 +1 @@
+rocm-docs-core==0.26.0

docs/sphinx/requirements.txt

@@ -0,0 +1,159 @@
+#
+# This file is autogenerated by pip-compile with Python 3.8
+# by the following command:
+#
+#    pip-compile requirements.in
+#
+accessible-pygments==0.0.4
+    # via pydata-sphinx-theme
+alabaster==0.7.13
+    # via sphinx
+babel==2.13.1
+    # via
+    #   pydata-sphinx-theme
+    #   sphinx
+beautifulsoup4==4.12.2
+    # via pydata-sphinx-theme
+breathe==4.35.0
+    # via rocm-docs-core
+certifi==2023.7.22
+    # via requests
+cffi==1.16.0
+    # via
+    #   cryptography
+    #   pynacl
+charset-normalizer==3.3.1
+    # via requests
+click==8.1.7
+    # via sphinx-external-toc
+cryptography==41.0.5
+    # via pyjwt
+deprecated==1.2.14
+    # via pygithub
+docutils==0.19
+    # via
+    #   breathe
+    #   myst-parser
+    #   pydata-sphinx-theme
+    #   sphinx
+fastjsonschema==2.18.1
+    # via rocm-docs-core
+gitdb==4.0.11
+    # via gitpython
+gitpython==3.1.40
+    # via rocm-docs-core
+idna==3.4
+    # via requests
+imagesize==1.4.1
+    # via sphinx
+importlib-metadata==6.8.0
+    # via sphinx
+importlib-resources==6.1.0
+    # via rocm-docs-core
+jinja2==3.1.2
+    # via
+    #   myst-parser
+    #   sphinx
+markdown-it-py==2.2.0
+    # via
+    #   mdit-py-plugins
+    #   myst-parser
+markupsafe==2.1.3
+    # via jinja2
+mdit-py-plugins==0.3.5
+    # via myst-parser
+mdurl==0.1.2
+    # via markdown-it-py
+myst-parser==1.0.0
+    # via rocm-docs-core
+packaging==23.2
+    # via
+    #   pydata-sphinx-theme
+    #   sphinx
+pycparser==2.21
+    # via cffi
+pydata-sphinx-theme==0.14.3
+    # via
+    #   rocm-docs-core
+    #   sphinx-book-theme
+pygithub==2.1.1
+    # via rocm-docs-core
+pygments==2.16.1
+    # via
+    #   accessible-pygments
+    #   pydata-sphinx-theme
+    #   sphinx
+pyjwt[crypto]==2.8.0
+    # via pygithub
+pynacl==1.5.0
+    # via pygithub
+python-dateutil==2.8.2
+    # via pygithub
+pytz==2023.3.post1
+    # via babel
+pyyaml==6.0.1
+    # via
+    #   myst-parser
+    #   rocm-docs-core
+    #   sphinx-external-toc
+requests==2.31.0
+    # via
+    #   pygithub
+    #   sphinx
+rocm-docs-core==0.26.0
+    # via -r requirements.in
+six==1.16.0
+    # via python-dateutil
+smmap==5.0.1
+    # via gitdb
+snowballstemmer==2.2.0
+    # via sphinx
+soupsieve==2.5
+    # via beautifulsoup4
+sphinx==5.3.0
+    # via
+    #   breathe
+    #   myst-parser
+    #   pydata-sphinx-theme
+    #   rocm-docs-core
+    #   sphinx-book-theme
+    #   sphinx-copybutton
+    #   sphinx-design
+    #   sphinx-external-toc
+    #   sphinx-notfound-page
+sphinx-book-theme==1.0.1
+    # via rocm-docs-core
+sphinx-copybutton==0.5.2
+    # via rocm-docs-core
+sphinx-design==0.5.0
+    # via rocm-docs-core
+sphinx-external-toc==0.3.1
+    # via rocm-docs-core
+sphinx-notfound-page==1.0.0
+    # via rocm-docs-core
+sphinxcontrib-applehelp==1.0.4
+    # via sphinx
+sphinxcontrib-devhelp==1.0.2
+    # via sphinx
+sphinxcontrib-htmlhelp==2.0.1
+    # via sphinx
+sphinxcontrib-jsmath==1.0.1
+    # via sphinx
+sphinxcontrib-qthelp==1.0.3
+    # via sphinx
+sphinxcontrib-serializinghtml==1.1.5
+    # via sphinx
+typing-extensions==4.8.0
+    # via
+    #   pydata-sphinx-theme
+    #   pygithub
+urllib3==2.0.7
+    # via
+    #   pygithub
+    #   requests
+wrapt==1.15.0
+    # via deprecated
+zipp==3.17.0
+    # via
+    #   importlib-metadata
+    #   importlib-resources