Update documentation requirements

* update SLES 15.4 prerequisites

* match SLES prerequisite URLs

* update wordlist

* fix spelling

.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/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

@@ -16,3 +16,8 @@ _readthedocs/
 docs/contributing.md
 docs/release.md
 docs/CHANGELOG.md
+
+# auto-generated files
+docs/deploy/linux/installer/install.md
+docs/deploy/linux/os-native/install.md
+docs/deploy/linux/quick_start.md

.wordlist.txt

@@ -1,29 +1,686 @@
-# isv_deployment_win
+AAC
 ABI
-# gpu_aware_mpi
+ACE
+ACEs
+AccVGPR
+AccVGPRs
+ALU
+AMD
+AMDGPU
+AMDGPUs
+AMDMIGraphX
+AMI
+AOCC
+AOMP
+APIC
+APIs
+APU
+ASIC
+ASICs
+ASan
+ASm
+ATI
+AddressSanitizer
+AlexNet
+Arb
+BLAS
+BMC
+BitCode
+Blit
+Bluefield
+CCD
+CDNA
+CIFAR
+CLI
+CLion
+CMake
+CMakeLists
+CMakePackage
+CP
+CPC
+CPF
+CPP
+CPU
+CPUs
+CSC
+CSE
+CSV
+CSn
+CTests
+CU
+CUDA
+CUs
+CXX
+Cavium
+CentOS
+ChatGPT
+CoRR
+Codespaces
+Commitizen
+CommonMark
+Concretized
+Conda
+ConnectX
+DGEMM
+DKMS
+DL
 DMA
+DNN
+DNNL
+DPM
+DRI
+DW
+DWORD
+Dask
+DataFrame
+DataLoader
+DataParallel
+DeepSpeed
+Dependabot
+DevCap
+Dockerfile
+Doxygen
+ELMo
+ENDPGM
+EPYC
+ESXi
+FFT
+FFTs
+FFmpeg
+FHS
+FMA
+FP
+Filesystem
+Flang
+Fortran
+Fuyu
+GALB
+GCD
+GCDs
+GCN
+GDB
+GDDR
 GDR
+GDS
+GEMM
+GEMMs
+GFortran
+GiB
+GIM
+GL
+GLXT
+GMI
+GPG
+GPR
+GPT
+GPU
+GPU's
+GPUs
+GRBM
+GenAI
+GenZ
+GitHub
+Gitpod
+HBM
 HCA
-MPI
-MVAPICH
-Mellanox's
-NIC
-OFED
-OSU
-OpenFabrics
-PeerDirect
-RDMA
-UCX
-ib_core
-# linear algebra
+HIPCC
+HIPExtension
+HIPIFY
+HPC
+HPCG
+HPE
+HPL
+HSA
+HWE
+Haswell
+Higgs
+Hyperparameters
+ICV
+IDE
+IDEs
+IMDb
+IOMMU
+IOP
+IOPM
+IOV
+IRQ
+ISA
+ISV
+ISVs
+ImageNet
+InfiniBand
+Inlines
+IntelliSense
+Intersphinx
+Intra
+Ioffe
+JSON
+Jupyter
+KFD
+KiB
+KVM
+Keras
+Khronos
 LAPACK
+LCLK
+LDS
+LLM
+LLMs
+LLVM
+LM
+LSAN
+LTS
+LoRA
+MEM
+MERCHANTABILITY
+MFMA
+MiB
+MIGraphX
+MIOpen
+MIOpenGEMM
+MIVisionX
+MLM
 MMA
+MMIO
+MMIOH
+MNIST
+MPI
+MSVC
+MVAPICH
+MVFFR
+Makefile
+Makefiles
+Matplotlib
+Megatron
+Mellanox
+Mellanox's
+Meta's
+MirroredStrategy
+Multicore
+Multithreaded
+MyEnvironment
+MyST
+NBIO
+NBIOs
+NIC
+NICs
+NLI
+NLP
+NPS
+NSP
+NUMA
+NVCC
+NVIDIA
+NVPTX
+NaN
+Nano
+Navi
+Noncoherently
+NousResearch's
+NumPy
+OAM
+OAMs
+OCP
+OEM
+OFED
+OMP
+OMPI
+OMPT
+OMPX
+ONNX
+OSS
+OSU
+OpenCL
+OpenCV
+OpenFabrics
+OpenGL
+OpenMP
+OpenSSL
+OpenVX
+PCI
+PCIe
+PEFT
+PIL
+PILImage
+PRNG
+PRs
+PaLM
+Pageable
+PeerDirect
+Perfetto
+PipelineParallel
+PnP
+PowerShell
+PyPi
+PyTorch
+Qcycles
+RAII
+RCCL
+RDC
+RDMA
+RDNA
+RHEL
+ROC
+ROCProfiler
+ROCTracer
+ROCclr
+ROCdbgapi
+ROCgdb
+ROCk
+ROCm
+ROCmCC
+ROCmSoftwarePlatform
+ROCmValidationSuite
+ROCr
+RST
+RW
+Radeon
+RelWithDebInfo
+Req
+Rickle
+RoCE
+Ryzen
+SALU
+SBIOS
+SCA
+SDK
+SDMA
+SDRAM
+SENDMSG
+SGPR
+SGPRs
+SHA
+SIGQUIT
+SIMD
+SIMDs
+SKU
+SKUs
+SLES
+SMEM
+SMI
+SMT
+SPI
+SQs
+SRAM
+SRAMECC
+SVD
+SWE
+SerDes
+Shlens
+Skylake
+Softmax
+Spack
+Supermicro
+Szegedy
+TCA
+TCC
+TCI
+TCIU
+TCP
+TCR
+TF
+TFLOPS
+TPU
+TPUs
+TensorBoard
+TensorFlow
+TensorParallel
+ToC
+TorchAudio
+TorchMIGraphX
+TorchScript
+TorchServe
+TorchVision
+TransferBench
+TrapStatus
+UAC
+UC
+UCC
+UCX
+UIF
+USM
+UTCL
+UTIL
+Uncached
+Unhandled
+VALU
+VBIOS
+VGPR
+VGPRs
+VM
+VMEM
+VMWare
+VRAM
+VSIX
+VSkipped
+Vanhoucke
+Vulkan
+WGP
+WGPs
+WX
+WikiText
+Wojna
+Workgroups
+Writebacks
+XCD
+XCDs
+XGBoost
+XGBoost's
+XGMI
+XT
+XTX
+Xeon
+Xilinx
+Xnack
+Xteam
+YAML
+YML
+YModel
+ZeRO
+ZenDNN
+accuracies
+activations
+addr
+alloc
+allocator
+allocators
+amdgpu
+api
+atmi
+atomics
+autogenerated
+avx
+awk
+backend
 backends
+benchmarking
+bfloat
+bilinear
+bitsandbytes
+blit
+boson
+bosons
+buildable
+bursty
+bzip
+cacheable
+cd
+centos
+centric
+changelog
+chiplet
+cmake
+cmd
+coalescable
+codename
+collater
+comgr
+completers
+composable
+concretization
+config
+conformant
+convolutional
+convolves
+cpp
+csn
+cuBLAS
+cuFFT
+cuLIB
+cuRAND
 cuSOLVER
 cuSPARSE
-# tuning_guides
-BMC
-DGEMM
-HPCG
-HPL
-IOPM
+dataset
+datasets
+dataspace
+datatype
+datatypes
+dbgapi
+de
+deallocation
+denoise
+denoised
+denoises
+denormalize
+deserializers
+detections
+dev
+devicelibs
+devsel
+dimensionality
+disambiguates
+distro
+el
+embeddings
+enablement
+endpgm
+encodings
+env
+epilog
+etcetera
+ethernet
+exascale
+executables
+ffmpeg
+filesystem
+fortran
+galb
+gcc
+gdb
+gfortran
+gfx
+githooks
+github
+gnupg
+grayscale
+gzip
+heterogenous
+hipBLAS
+hipBLASLt
+hipCUB
+hipFFT
+hipLIB
+hipRAND
+hipSOLVER
+hipSPARSE
+hipSPARSELt
+hipTensor
+hipamd
+hipblas
+hipcub
+hipfft
+hipfort
+hipify
+hipsolver
+hipsparse
+hpp
+hsa
+hsakmt
+hyperparameter
+ib_core
+inband
+incrementing
+inferencing
+inflight
+init
+initializer
+inlining
+installable
+interprocedural
+intra
+invariants
+invocating
+ipo
+kdb
+latencies
+libfabric
+libjpeg
+libs
+linearized
+linter
+linux
+llvm
+localscratch
+logits
+lossy
+macOS
+matchers
+microarchitecture
+migraphx
+miopen
+miopengemm
+mivisionx
+mkdir
+mlirmiopen
+mtypes
+mvffr
+namespace
+namespaces
+numref
+ocl
+opencl
+opencv
+openmp
+openssl
+optimizers
+os
+pageable
+parallelization
+parameterization
+passthrough
+perfcounter
+performant
+perl
+pragma
+pre
+prebuilt
+precompiled
+prefetch
+prefetchable
+preprocess
+preprocessed
+preprocessing
+prequantized
+prerequisites
+profiler
+protobuf
+pseudorandom
+py
+quasirandom
+queueing
+rccl
+rdc
+reStructuredText
+reformats
+repos
+representativeness
+req
+resampling
+rescaling
+reusability
+roadmap
+roc
+rocAL
+rocALUTION
+rocBLAS
+rocFFT
+rocLIB
+rocMLIR
+rocPRIM
+rocRAND
+rocSOLVER
+rocSPARSE
+rocThrust
+rocWMMA
+rocalution
+rocblas
+rocclr
+rocfft
+rocm
+rocminfo
+rocprim
+rocprof
+rocprofiler
+rocr
+rocrand
+rocsolver
+rocsparse
+rocthrust
+roctracer
+runtime
+runtimes
+sL
+scalability
+scalable
+sendmsg
+serializers
+shader
+sharding
+sigmoid
+sm
+smi
+softmax
+spack
+src
+stochastically
+strided
+subdirectory
+subexpression
+subfolder
+subfolders
+supercomputing
+tensorfloat
+th
+tokenization
+tokenize
+tokenized
+tokenizer
+tokenizes
+toolchain
+toolchains
+toolset
+toolsets
+torchvision
+tqdm
+tracebacks
+txt
+uarch
+uncached
+uncorrectable
+uninstallation
+unsqueeze
+unstacking
+unswitching
+untrusted
+untuned
+upvote
+USM
+UTCL
+UTIL
+utils
+vL
+variational
+vdi
+vectorizable
+vectorization
+vectorize
+vectorized
+vectorizer
+vectorizes
+vjxb
+walkthrough
+walkthroughs
+wavefront
+wavefronts
+whitespaces
+workgroup
+workgroups
+writeback
+writebacks
+wrreq
+wzo
+xargs
+xz
+yaml
+ysvmadyb
+zypper

CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 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
+contribution guide describes the recommended method for creating and modifying our
 documentation.
 
 While interacting with ROCm Documentation, we encourage you to be polite and
@@ -13,59 +13,47 @@ itself, refer to
 [discussions](https://github.com/RadeonOpenCompute/ROCm/discussions) on the
 GitHub repository.
 
+For additional information on documentation functionalities,
+see the user and developer guides for rocm-docs-core
+at {doc}`rocm-docs-core documentation <rocm-docs-core:index>`.
+
 ## 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
+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 renders 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
+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 use Breathe syntax for Doxygen documentation
+in our Markdown files. 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
+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).
+  our automated GitHub action on a Pull Request (PR).
+  See the {doc}`rocm-docs-core linting user guide <rocm-docs-core:user_guide/linting>` for more details.
 
 ## 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
+Please use snake case (all lower case letters and underscores instead of spaces)
+for file names. For example, `example_file_name.md`.
+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
+placed in the `/docs/data` folder.
 
 ## Language and Style
 
-Adopting Microsoft CPP-Docs guidelines for [Voice and Tone
-](https://github.com/MicrosoftDocs/cpp-docs/blob/main/styleguide/voice-tone.md).
+Adopt 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
@@ -73,174 +61,11 @@ 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.
+details are controlled via [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core).
+Raise issues in `rocm-docs-core` for any formatting concerns and changes requested.
 
-## Building Documentation
+## More
 
-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 -->
+For more topics, such as submitting feedback and ways to build documentation,
+see the [Contributing Section](https://rocm.docs.amd.com/en/latest/contributing.html)
+at [rocm.docs.amd.com](https://rocm.docs.amd.com)

README.md

@@ -1,42 +1,38 @@
 # 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 an open-source stack, composed primarily of open-source software (OSS), designed for
+graphics processing unit (GPU) computation. ROCm consists of a collection of drivers, development
+tools, and APIs that enable GPU programming from low-level kernel to end-user applications.
 
-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.
+With ROCm, you can customize your GPU software to meet your specific needs. You can develop,
+collaborate, test, and deploy your applications in a free, open-source, integrated, and secure software
+ecosystem. ROCm is particularly well-suited to GPU-accelerated high-performance computing (HPC),
+artificial intelligence (AI), scientific computing, and computer aided design (CAD).
 
-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.
+ROCm is powered by AMD’s
+[Heterogeneous-computing Interface for Portability (HIP)](https://github.com/ROCm-Developer-Tools/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.
 
-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 supports programming models, such as OpenMP and OpenCL, and includes all necessary OSS
+compilers, debuggers, and libraries. ROCm is fully integrated into machine learning (ML) frameworks,
+such as PyTorch and TensorFlow.
 
 ## 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.
+The ROCm Documentation site is [rocm.docs.amd.com](https://rocm.docs.amd.com).
+
+Source code for the documentation is located in the docs folder of most repositories that are part of
+ROCm.
+
+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.
 
 ### How to build documentation via Sphinx
 
@@ -48,7 +44,7 @@ pip3 install -r sphinx/requirements.txt
 python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
 ```
 
-## Older ROCm™ Releases
+## 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

@@ -15,231 +15,63 @@ The release notes for the ROCm platform.
 
 -------------------
 
-## ROCm 5.4.0
+## ROCm 5.7.1
 <!-- markdownlint-disable first-line-h1 -->
 <!-- markdownlint-disable no-duplicate-header -->
+
 ### What's New in This Release
 
-#### HIP Enhancements
+### ROCm Libraries
 
-The ROCm v5.4 release consists of the following HIP enhancements:
+#### rocBLAS
+A new functionality rocblas-gemm-tune and an environment variable ROCBLAS_TENSILE_GEMM_OVERRIDE_PATH are added to rocBLAS in the ROCm 5.7.1 release.
 
-##### Support for Wall Clock64
+*rocblas-gemm-tune* is used to find the best-performing GEMM kernel for each GEMM problem set. It has a command line interface, which mimics the --yaml input used by rocblas-bench. To generate the expected --yaml input, profile logging can be used, by setting the environment variable ROCBLAS_LAYER4.
 
-A new timer function wall_clock64() is supported, which returns wall clock count at a constant frequency on the device.
+For more information on rocBLAS logging, see Logging in rocBLAS, in the [API Reference Guide](https://rocm.docs.amd.com/projects/rocBLAS/en/docs-5.7.1/API_Reference_Guide.html#logging-in-rocblas).
 
-```h
-long long int wall_clock64();
-```
+An example input file: Expected output (note selected GEMM idx may differ): Where the far right values (solution_index) are the indices of the best-performing kernels for those GEMMs in the rocBLAS kernel library. These indices can be directly used in future GEMM calls. See rocBLAS/samples/example_user_driven_tuning.cpp for sample code of directly using kernels via their indices.
 
-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.
+If the output is stored in a file, the results can be used to override default kernel selection with the kernels found, by setting the environment variable ROCBLAS_TENSILE_GEMM_OVERRIDE_PATH, where points to the stored file.
 
-Example:
+For more details, refer to the [rocBLAS Programmer's Guide.](https://rocm.docs.amd.com/projects/rocBLAS/en/latest/Programmers_Guide.html#rocblas-gemm-tune)
 
-```h
-int wallClkRate = 0; //in kilohertz
-+HIPCHECK(hipDeviceGetAttribute(&wallClkRate, hipDeviceAttributeWallClockRate, deviceId));
-```
+#### HIP 5.7.1 (for ROCm 5.7.1)
 
-Where hipDeviceAttributeWallClockRate is a device attribute.
+ROCm 5.7.1 is a point release with several bug fixes in the HIP runtime.
 
-> **Note**
->
-> The wall clock frequency is a per-device attribute.
+### Fixed defects
+The *hipPointerGetAttributes* API returns the correct HIP memory type as *hipMemoryTypeManaged* for managed memory.
 
-##### 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.
+### Library Changes in ROCM 5.7.1
 
-> **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).
+| Library | Version |
+|---------|---------|
+| hipBLAS | [1.1.0](https://github.com/ROCmSoftwarePlatform/hipBLAS/releases/tag/rocm-5.7.1) |
+| hipCUB | [2.13.1](https://github.com/ROCmSoftwarePlatform/hipCUB/releases/tag/rocm-5.7.1) |
+| hipFFT | [1.0.12](https://github.com/ROCmSoftwarePlatform/hipFFT/releases/tag/rocm-5.7.1) |
+| hipSOLVER | 1.8.1 ⇒ [1.8.2](https://github.com/ROCmSoftwarePlatform/hipSOLVER/releases/tag/rocm-5.7.1) |
+| hipSPARSE | [2.3.8](https://github.com/ROCmSoftwarePlatform/hipSPARSE/releases/tag/rocm-5.7.1) |
+| MIOpen | [2.19.0](https://github.com/ROCmSoftwarePlatform/MIOpen/releases/tag/rocm-5.7.1) |
+| rocALUTION | [2.1.11](https://github.com/ROCmSoftwarePlatform/rocALUTION/releases/tag/rocm-5.7.1) |
+| rocBLAS | [3.1.0](https://github.com/ROCmSoftwarePlatform/rocBLAS/releases/tag/rocm-5.7.1) |
+| rocFFT | [1.0.24](https://github.com/ROCmSoftwarePlatform/rocFFT/releases/tag/rocm-5.7.1) |
+| rocm-cmake | [0.10.0](https://github.com/RadeonOpenCompute/rocm-cmake/releases/tag/rocm-5.7.1) |
+| rocPRIM | [2.13.1](https://github.com/ROCmSoftwarePlatform/rocPRIM/releases/tag/rocm-5.7.1) |
+| rocRAND | [2.10.17](https://github.com/ROCmSoftwarePlatform/rocRAND/releases/tag/rocm-5.7.1) |
+| rocSOLVER | [3.23.0](https://github.com/ROCmSoftwarePlatform/rocSOLVER/releases/tag/rocm-5.7.1) |
+| rocSPARSE | [2.5.4](https://github.com/ROCmSoftwarePlatform/rocSPARSE/releases/tag/rocm-5.7.1) |
+| rocThrust | [2.18.0](https://github.com/ROCmSoftwarePlatform/rocThrust/releases/tag/rocm-5.7.1) |
+| rocWMMA | [1.2.0](https://github.com/ROCmSoftwarePlatform/rocWMMA/releases/tag/rocm-5.7.1) |
+| Tensile | [4.38.0](https://github.com/ROCmSoftwarePlatform/Tensile/releases/tag/rocm-5.7.1) |
 
-For more details, refer to the HIP Programming Guide.
+#### hipSOLVER 1.8.2
 
-#### New HIP APIs in This Release
+hipSOLVER 1.8.2 for ROCm 5.7.1
 
-The following new HIP APIs are available in the ROCm v5.4 release.
+##### Fixed
 
-> **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.
+- Fixed conflicts between the hipsolver-dev and -asan packages by excluding
+  hipsolver_module.f90 from the latter

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.5.1"
+    <default revision="refs/tags/rocm-5.7.1"
      remote="roc-github"
      sync-c="true"
      sync-j="4" />
@@ -20,38 +20,36 @@ fetch="https://github.com/KhronosGroup/" />
     <project name="ROCK-Kernel-Driver" />
     <project name="ROCT-Thunk-Interface" />
     <project name="ROCR-Runtime" />
+    <project name="amdsmi" />
     <project name="rocm_smi_lib" />
     <project name="rocm-core" />
     <project name="rocm-cmake" />
     <project name="rocminfo" />
+    <project name="rocm_bandwidth_test" />
     <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" />
+    <project name="rdc" />
 <!--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="clr" 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" />
+    <project name="rocr_debug_agent" 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="hipTensor" 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" />
@@ -61,14 +59,16 @@ fetch="https://github.com/KhronosGroup/" />
     <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 groups="mathlibs" name="rccl" remote="rocm-swplat" />
+    <project name="rocMLIR" remote="rocm-swplat" />
+    <project name="MIOpen" remote="rocm-swplat" />
+    <project name="composable_kernel" remote="rocm-swplat" />
+    <project name="MIVisionX" remote="gpuopen-libs" />
+    <project name="rpp" remote="gpuopen-libs" />
     <project name="hipfort" remote="rocm-swplat" />
     <project name="AMDMIGraphX" remote="rocm-swplat" />
     <project name="ROCmValidationSuite" remote="rocm-devtools" />

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

@@ -5,70 +5,70 @@ 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
+## `rocm-docs-core`
 
-[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.
+[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 use as part of the documentation
+build. It is also available as a [pip package on PyPI](https://pypi.org/project/rocm-docs-core/).
 
-## 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).
+See the user and developer guides for rocm-docs-core at {doc}`rocm-docs-core documentation <rocm-docs-core:index>`.
 
 ## 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
+originally used for Python. It is now widely used in the Open Source community.
+Originally, Sphinx supported reStructuredText (RST) based documentation, but
+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.
 
+## Read the Docs
+
+[Read the Docs](https://docs.readthedocs.io/en/stable/) is the service that builds
+and hosts the HTML documentation generated using Sphinx to our end users.
+
+## Doxygen
+
+[Doxygen](https://www.doxygen.nl/) is a documentation generator that extracts
+information from inline code.
+ROCm projects typically use Doxygen for public API documentation unless the
+upstream project uses a different tool.
+
+### Breathe
+
+[Breathe](https://www.breathe-doc.org/) is a Sphinx plugin to integrate Doxygen
+content.
+
 ### 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.
+It is integrated into ROCm documentation by the Sphinx extension [`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 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
+[Sphinx External Table of Contents (TOC)](https://sphinx-external-toc.readthedocs.io/en/latest/intro.html)
+is a Sphinx extension used for ROCm documentation navigation. This tool generates a navigation menu on the left
+based on a YAML file that specifies the table of contents.
+It 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
+see the `_toc.yml.in` file in this repository in the `docs/sphinx` folder for an
 example.
 
-### Breathe
+### Sphinx Book Theme
 
-Sphinx uses [Breathe](https://www.breathe-doc.org/) to integrate Doxygen
-content.
+[Sphinx Book Theme](https://sphinx-book-theme.readthedocs.io/en/latest/) is a Sphinx theme
+that defines the base appearance for ROCm documentation.
+ROCm documentation applies some customization,
+such as a custom header and footer on top of the Sphinx Book Theme.
 
-## `rocm-docs-core` pip package
+### Sphinx Design
 
-[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.
+[Sphinx Design](https://sphinx-design.readthedocs.io/en/latest/index.html) is a Sphinx extension that adds design
+functionality.
+ROCm documentation uses Sphinx Design for grids, cards, and synchronized tabs.

docs/about/licensing.md

@@ -0,0 +1,125 @@
+# ROCm licensing terms
+
+ROCm™ is released by Advanced Micro Devices, Inc. and is licensed per component separately.
+The following table is a list of ROCm components with links to their respective license
+terms. These components may include third party components subject to
+additional licenses. Please review individual repositories for more information.
+The table shows ROCm components, license name, and link to the license terms.
+
+<!-- spellcheck-disable -->
+| Component | License |
+|:------------------------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------------------------------------------------:|
+| [AMDMIGraphX](https://github.com/ROCmSoftwarePlatform/AMDMIGraphX/) | [MIT](https://github.com/ROCmSoftwarePlatform/AMDMIGraphX/blob/develop/LICENSE) |
+| [HIPCC](https://github.com/ROCm-Developer-Tools/HIPCC/blob/develop/LICENSE.txt) | [MIT](https://github.com/ROCm-Developer-Tools/HIPCC/blob/develop/LICENSE.txt) |
+| [HIPIFY](https://github.com/ROCm-Developer-Tools/HIPIFY/) | [MIT](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/amd-staging/LICENSE.txt) |
+| [HIP](https://github.com/ROCm-Developer-Tools/HIP/) | [MIT](https://github.com/ROCm-Developer-Tools/HIP/blob/develop/LICENSE.txt) |
+| [MIOpenGEMM](https://github.com/ROCmSoftwarePlatform/MIOpenGEMM/) | [MIT](https://github.com/ROCmSoftwarePlatform/MIOpenGEMM/blob/master/LICENSE.txt) |
+| [MIOpen](https://github.com/ROCmSoftwarePlatform/MIOpen/) | [MIT](https://github.com/ROCmSoftwarePlatform/MIOpen/blob/master/LICENSE.txt) |
+| [MIVisionX](https://github.com/GPUOpen-ProfessionalCompute-Libraries/MIVisionX/) | [MIT](https://github.com/GPUOpen-ProfessionalCompute-Libraries/MIVisionX/blob/master/LICENSE.txt) |
+| [RCP](https://github.com/GPUOpen-Tools/radeon_compute_profiler/) | [MIT](https://github.com/GPUOpen-Tools/radeon_compute_profiler/blob/master/LICENSE) |
+| [ROCK-Kernel-Driver](https://github.com/RadeonOpenCompute/ROCK-Kernel-Driver/) | [GPL 2.0 WITH Linux-syscall-note](https://github.com/RadeonOpenCompute/ROCK-Kernel-Driver/blob/master/COPYING) |
+| [ROCR-Runtime](https://github.com/RadeonOpenCompute/ROCR-Runtime/) | [The University of Illinois/NCSA](https://github.com/RadeonOpenCompute/ROCR-Runtime/blob/master/LICENSE.txt) |
+| [ROCT-Thunk-Interface](https://github.com/RadeonOpenCompute/ROCT-Thunk-Interface/) | [MIT](https://github.com/RadeonOpenCompute/ROCT-Thunk-Interface/blob/master/LICENSE.md) |
+| [ROCclr](https://github.com/ROCm-Developer-Tools/ROCclr/) | [MIT](https://github.com/ROCm-Developer-Tools/ROCclr/blob/develop/LICENSE.txt) |
+| [ROCdbgapi](https://github.com/ROCm-Developer-Tools/ROCdbgapi/) | [MIT](https://github.com/ROCm-Developer-Tools/ROCdbgapi/blob/amd-master/LICENSE.txt) |
+| [ROCgdb](https://github.com/ROCm-Developer-Tools/ROCgdb/) | [GNU General Public License v2.0](https://github.com/ROCm-Developer-Tools/ROCgdb/blob/amd-master/COPYING) |
+| [ROCm-CompilerSupport](https://github.com/RadeonOpenCompute/ROCm-CompilerSupport/) | [The University of Illinois/NCSA](https://github.com/RadeonOpenCompute/ROCm-CompilerSupport/blob/amd-stg-open/LICENSE.txt) |
+| [ROCm-Device-Libs](https://github.com/RadeonOpenCompute/ROCm-Device-Libs/) | [The University of Illinois/NCSA](https://github.com/RadeonOpenCompute/ROCm-Device-Libs/blob/amd-stg-open/LICENSE.TXT) |
+| [ROCm-OpenCL-Runtime/api/opencl/khronos/icd](https://github.com/KhronosGroup/OpenCL-ICD-Loader/) | [Apache 2.0](https://github.com/KhronosGroup/OpenCL-ICD-Loader/blob/main/LICENSE) |
+| [ROCm-OpenCL-Runtime](https://github.com/RadeonOpenCompute/ROCm-OpenCL-Runtime/) | [MIT](https://github.com/RadeonOpenCompute/ROCm-OpenCL-Runtime/blob/develop/LICENSE.txt) |
+| [ROCmValidationSuite](https://github.com/ROCm-Developer-Tools/ROCmValidationSuite/) | [MIT](https://github.com/ROCm-Developer-Tools/ROCmValidationSuite/blob/master/LICENSE) |
+| [Tensile](https://github.com/ROCmSoftwarePlatform/Tensile/) | [MIT](https://github.com/ROCmSoftwarePlatform/Tensile/blob/develop/LICENSE.md) |
+| [aomp-extras](https://github.com/ROCm-Developer-Tools/aomp-extras/) | [MIT](https://github.com/ROCm-Developer-Tools/aomp-extras/blob/aomp-dev/LICENSE) |
+| [aomp](https://github.com/ROCm-Developer-Tools/aomp/) | [Apache 2.0](https://github.com/ROCm-Developer-Tools/aomp/blob/aomp-dev/LICENSE) |
+| [atmi](https://github.com/RadeonOpenCompute/atmi/) | [MIT](https://github.com/RadeonOpenCompute/atmi/blob/master/LICENSE.txt) |
+| [clang-ocl](https://github.com/RadeonOpenCompute/clang-ocl/) | [MIT](https://github.com/RadeonOpenCompute/clang-ocl/blob/master/LICENSE) |
+| [flang](https://github.com/ROCm-Developer-Tools/flang/) | [Apache 2.0](https://github.com/ROCm-Developer-Tools/flang/blob/master/LICENSE.txt) |
+| [half](https://github.com/ROCmSoftwarePlatform/half/) | [MIT](https://github.com/ROCmSoftwarePlatform/half/blob/master/LICENSE.txt) |
+| [hipBLAS](https://github.com/ROCmSoftwarePlatform/hipBLAS/) | [MIT](https://github.com/ROCmSoftwarePlatform/hipBLAS/blob/develop/LICENSE.md) |
+| [hipCUB](https://github.com/ROCmSoftwarePlatform/hipCUB/) | [Custom](https://github.com/ROCmSoftwarePlatform/hipCUB/blob/develop/LICENSE.txt) |
+| [hipFFT](https://github.com/ROCmSoftwarePlatform/hipFFT/) | [MIT](https://github.com/ROCmSoftwarePlatform/hipFFT/blob/develop/LICENSE.md) |
+| [hipSOLVER](https://github.com/ROCmSoftwarePlatform/hipSOLVER/) | [MIT](https://github.com/ROCmSoftwarePlatform/hipSOLVER/blob/develop/LICENSE.md) |
+| [hipSPARSELt](https://github.com/ROCmSoftwarePlatform/hipSPARSELt/) | [MIT](https://github.com/ROCmSoftwarePlatform/hipSPARSELt/blob/develop/LICENSE.md) |
+| [hipSPARSE](https://github.com/ROCmSoftwarePlatform/hipSPARSE/) | [MIT](https://github.com/ROCmSoftwarePlatform/hipSPARSE/blob/develop/LICENSE.md) |
+| [hipTensor](https://github.com/ROCmSoftwarePlatform/hipTensor) | [MIT](https://github.com/ROCmSoftwarePlatform/hipTensor/blob/develop/LICENSE) |
+| [hipamd](https://github.com/ROCm-Developer-Tools/hipamd/) | [MIT](https://github.com/ROCm-Developer-Tools/hipamd/blob/develop/LICENSE.txt) |
+| [hipfort](https://github.com/ROCmSoftwarePlatform/hipfort/) | [MIT](https://github.com/ROCmSoftwarePlatform/hipfort/blob/master/LICENSE) |
+| [llvm-project](https://github.com/ROCm-Developer-Tools/llvm-project/) | [Apache](https://github.com/ROCm-Developer-Tools/llvm-project/blob/main/LICENSE.TXT) |
+| [rccl](https://github.com/ROCmSoftwarePlatform/rccl/) | [Custom](https://github.com/ROCmSoftwarePlatform/rccl/blob/develop/LICENSE.txt) |
+| [rdc](https://github.com/RadeonOpenCompute/rdc/) | [MIT](https://github.com/RadeonOpenCompute/rdc/blob/master/LICENSE) |
+| [rocALUTION](https://github.com/ROCmSoftwarePlatform/rocALUTION/) | [MIT](https://github.com/ROCmSoftwarePlatform/rocALUTION/blob/develop/LICENSE.md) |
+| [rocBLAS](https://github.com/ROCmSoftwarePlatform/rocBLAS/) | [MIT](https://github.com/ROCmSoftwarePlatform/rocBLAS/blob/develop/LICENSE.md) |
+| [rocFFT](https://github.com/ROCmSoftwarePlatform/rocFFT/) | [MIT](https://github.com/ROCmSoftwarePlatform/rocFFT/blob/develop/LICENSE.md) |
+| [rocPRIM](https://github.com/ROCmSoftwarePlatform/rocPRIM/) | [MIT](https://github.com/ROCmSoftwarePlatform/rocPRIM/blob/develop/LICENSE.txt) |
+| [rocRAND](https://github.com/ROCmSoftwarePlatform/rocRAND/) | [MIT](https://github.com/ROCmSoftwarePlatform/rocRAND/blob/develop/LICENSE.txt) |
+| [rocSOLVER](https://github.com/ROCmSoftwarePlatform/rocSOLVER/) | [BSD-2-Clause](https://github.com/ROCmSoftwarePlatform/rocSOLVER/blob/develop/LICENSE.md) |
+| [rocSPARSE](https://github.com/ROCmSoftwarePlatform/rocSPARSE/) | [MIT](https://github.com/ROCmSoftwarePlatform/rocSPARSE/blob/develop/LICENSE.md) |
+| [rocThrust](https://github.com/ROCmSoftwarePlatform/rocThrust/) | [Apache 2.0](https://github.com/ROCmSoftwarePlatform/rocThrust/blob/develop/LICENSE) |
+| [rocWMMA](https://github.com/ROCmSoftwarePlatform/rocWMMA/) | [MIT](https://github.com/ROCmSoftwarePlatform/rocWMMA/blob/develop/LICENSE.md) |
+| [rocm-cmake](https://github.com/RadeonOpenCompute/rocm-cmake/) | [MIT](https://github.com/RadeonOpenCompute/rocm-cmake/blob/develop/LICENSE) |
+| [rocm_bandwidth_test](https://github.com/RadeonOpenCompute/rocm_bandwidth_test/) | [The University of Illinois/NCSA](https://github.com/RadeonOpenCompute/rocm_bandwidth_test/blob/master/LICENSE.txt) |
+| [rocm_smi_lib](https://github.com/RadeonOpenCompute/rocm_smi_lib/) | [The University of Illinois/NCSA](https://github.com/RadeonOpenCompute/rocm_smi_lib/blob/master/License.txt) |
+| [rocminfo](https://github.com/RadeonOpenCompute/rocminfo/) | [The University of Illinois/NCSA](https://github.com/RadeonOpenCompute/rocminfo/blob/master/License.txt) |
+| [rocprofiler](https://github.com/ROCm-Developer-Tools/rocprofiler/) | [MIT](https://github.com/ROCm-Developer-Tools/rocprofiler/blob/amd-master/LICENSE) |
+| [rocr_debug_agent](https://github.com/ROCm-Developer-Tools/rocr_debug_agent/) | [The University of Illinois/NCSA](https://github.com/ROCm-Developer-Tools/rocr_debug_agent/blob/master/LICENSE.txt) |
+| [roctracer](https://github.com/ROCm-Developer-Tools/roctracer/) | [MIT](https://github.com/ROCm-Developer-Tools/roctracer/blob/amd-master/LICENSE) |
+| rocm-llvm-alt | [AMD Proprietary License](https://www.amd.com/en/support/amd-software-eula)
+
+Open sourced ROCm components are released via public GitHub
+repositories, packages on https://repo.radeon.com and other distribution channels.
+Proprietary products are only available on https://repo.radeon.com. Currently, only
+one component of ROCm, rocm-llvm-alt is governed by a proprietary license.
+Proprietary components are organized in a proprietary subdirectory in the package
+repositories to distinguish from open sourced packages.
+
+The additional terms and conditions below apply to your use of ROCm technical
+documentation.
+
+©2023 Advanced Micro Devices, Inc. All rights reserved.
+
+The information presented in this document is for informational purposes only
+and may contain technical inaccuracies, omissions, and typographical errors. The
+information contained herein is subject to change and may be rendered inaccurate
+for many reasons, including but not limited to product and roadmap changes,
+component and motherboard version changes, new model and/or product releases,
+product differences between differing manufacturers, software changes, BIOS
+flashes, firmware upgrades, or the like. Any computer system has risks of
+security vulnerabilities that cannot be completely prevented or mitigated. AMD
+assumes no obligation to update or otherwise correct or revise this information.
+However, AMD reserves the right to revise this information and to make changes
+from time to time to the content hereof without obligation of AMD to notify any
+person of such revisions or changes.
+
+THIS INFORMATION IS PROVIDED “AS IS.” AMD MAKES NO REPRESENTATIONS OR WARRANTIES
+WITH RESPECT TO THE CONTENTS HEREOF AND ASSUMES NO RESPONSIBILITY FOR ANY
+INACCURACIES, ERRORS, OR OMISSIONS THAT MAY APPEAR IN THIS INFORMATION. AMD
+SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT,
+MERCHANTABILITY, OR FITNESS FOR ANY PARTICULAR PURPOSE. IN NO EVENT WILL AMD BE
+LIABLE TO ANY PERSON FOR ANY RELIANCE, DIRECT, INDIRECT, SPECIAL, OR OTHER
+CONSEQUENTIAL DAMAGES ARISING FROM THE USE OF ANY INFORMATION CONTAINED HEREIN,
+EVEN IF AMD IS EXPRESSLY ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+AMD, the AMD Arrow logo, ROCm, and combinations thereof are trademarks of
+Advanced Micro Devices, Inc. Other product names used in this publication are
+for identification purposes only and may be trademarks of their respective
+companies.
+
+## Package licensing
+
+```{attention}
+AQL Profiler and AOCC CPU optimization are both provided in binary form, each
+subject to the license agreement enclosed in the directory for the binary and is
+available here: `/opt/rocm/share/doc/rocm-llvm-alt/EULA`. By using, installing,
+copying or distributing AQL Profiler and/or AOCC CPU Optimizations, you agree to
+the terms and conditions of this license agreement. If you do not agree to the
+terms of this agreement, do not install, copy or use the AQL Profiler and/or the
+AOCC CPU Optimizations.
+```
+
+For the rest of the ROCm packages, you can find the licensing information at the
+following location: `/opt/rocm/share/doc/<component-name>/`
+
+For example, you can fetch the licensing information of the `_amd_comgr_`
+component (Code Object Manager) from the `amd_comgr` folder. A file named
+`LICENSE.txt` contains the license details at:
+`/opt/rocm-5.4.3/share/doc/amd_comgr/LICENSE.txt`

docs/conf.py

@@ -5,28 +5,61 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 import shutil
+import jinja2
+import os
 
 from rocm_docs import ROCmDocs
 
+# Environement to process Jinja templates.
+jinja_env = jinja2.Environment(loader=jinja2.FileSystemLoader("."))
+
+# Jinja templates to render out.
+templates = [
+    "./deploy/linux/quick_start.md.jinja",
+    "./deploy/linux/installer/install.md.jinja",
+    "./deploy/linux/os-native/install.md.jinja"
+]
+
+# Render templates and output files without the last extension.
+# For example: 'install.md.jinja' becomes 'install.md'.
+for template in templates:
+    rendered = jinja_env.get_template(template).render()
+    with open(os.path.splitext(template)[0], 'w') as file:
+        file.write(rendered)
 
 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')
 
+latex_engine = "xelatex"
+latex_elements = {
+    "fontpkg": r"""
+\usepackage{tgtermes}
+\usepackage{tgheros}
+\renewcommand\ttdefault{txtt}
+"""
+}
+
 # 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"
+version = "5.7.1"
+release = "5.7.1"
 
 setting_all_article_info = True
-all_article_info_os = ["linux"]
+all_article_info_os = ["linux", "windows"]
 all_article_info_author = ""
 
 # pages with specific settings
 article_pages = [
+    {
+        "file":"release",
+        "os":["linux", "windows"],
+        "date":"2023-07-27"
+    },
+
     {"file":"deploy/linux/index", "os":["linux"]},
     {"file":"deploy/linux/install_overview", "os":["linux"]},
     {"file":"deploy/linux/prerequisites", "os":["linux"]},
@@ -37,7 +70,20 @@ article_pages = [
     {"file":"deploy/linux/package_manager_integration", "os":["linux"]},
     {"file":"deploy/docker", "os":["linux"]},
     
+    {"file":"deploy/windows/cli/index", "os":["windows"]},
+    {"file":"deploy/windows/cli/install", "os":["windows"]},
+    {"file":"deploy/windows/cli/uninstall", "os":["windows"]},
+    {"file":"deploy/windows/cli/upgrade", "os":["windows"]},
+    {"file":"deploy/windows/gui/index", "os":["windows"]},
+    {"file":"deploy/windows/gui/install", "os":["windows"]},
+    {"file":"deploy/windows/gui/uninstall", "os":["windows"]},
+    {"file":"deploy/windows/gui/upgrade", "os":["windows"]},
+    {"file":"deploy/windows/index", "os":["windows"]},
+    {"file":"deploy/windows/prerequisites", "os":["windows"]},
+    {"file":"deploy/windows/quick_start", "os":["windows"]},
+
     {"file":"release/gpu_os_support", "os":["linux"]},
+    {"file":"release/windows_support", "os":["windows"]},
     {"file":"release/docker_support_matrix", "os":["linux"]},
     
     {"file":"reference/gpu_libraries/communication", "os":["linux"]},
@@ -64,7 +110,7 @@ article_pages = [
 
 external_toc_path = "./sphinx/_toc.yml"
 
-docs_core = ROCmDocs("ROCm 5.4.0 Documentation Home")
+docs_core = ROCmDocs("ROCm 5.7.1 Documentation Home")
 docs_core.setup()
 
 external_projects_current_project = "rocm"

docs/contribute/building.md

@@ -0,0 +1,165 @@
+# 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.
+
+## Pull Request 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 a URL of the form
+  `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 documentation from the Command Line
+
+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.
+
+## Build documentation using Visual Studio (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-served 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 above are used for the following reasons:
+    - `liveServer.settings.root`: Sets the root of the output website for live previews. Must be changed
+      alongside the `tasks.json` command.
+    - `liveServer.settings.wait`: Tells live server to wait with the update to give time for Sphinx to
+      regenerate site contents and not refresh before all is done. (Empirical value)
+    - `python.terminal.activateEnvInCurrentTerminal`: Automatic virtual environment 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 drop down 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.

docs/contribute/feedback.md

@@ -0,0 +1,27 @@
+# How to provide feedback for ROCm documentation
+
+There are four 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)
+targeting the develop branch of the repository. If you are unable to contribute
+via the GitHub Flow, feel free to email us.
+
+## GitHub Discussions
+
+To ask questions or view answers to frequently asked questions, refer to
+[GitHub Discussions](https://github.com/RadeonOpenCompute/ROCm/discussions).
+On GitHub Discussions, in addition to asking and answering questions,
+members can share updates, have open-ended conversations,
+and follow along on via public announcements.
+
+## GitHub Issue
+
+Issues on existing or absent docs can be filed as
+[GitHub Issues](https://github.com/RadeonOpenCompute/ROCm/issues).
+
+## Email
+
+Send other feedback or questions to [rocm-feedback@amd.com](rocm-feedback@amd.com)

docs/data/deploy/quick_start_windows/image planning

@@ -1 +0,0 @@
-

docs/deploy/docker.md

@@ -27,7 +27,7 @@ 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 ...
+docker run --device /dev/kfd --device /dev/dri/renderD128 --device /dev/dri/renderD129 ...
 ```
 
 More conveniently, instead of listing all devices, the entire `/dev/dri` folder

docs/deploy/linux/install_overview.md

@@ -3,6 +3,11 @@
 Users installing ROCm must choose between various installation options. A new
 user should follow the [Quick Start guide](./quick_start).
 
+```{note}
+See {doc}`Radeon Software for Linux installation instructions <radeon:docs/install/install-radeon>`
+for those using select RDNA™ 3 GPU with graphical applications and ROCm.
+```
+
 ## Package Manager versus AMDGPU Installer?
 
 ROCm supports two methods for installation:

docs/deploy/linux/installer/index.md

@@ -21,7 +21,7 @@ Instructions for upgrading an existing ROCm installation.
 :link: uninstall
 :link-type: doc
 
-Steps for removing ROCm packages libraries and tools.
+Steps for removing ROCm packages, libraries and tools.
 :::
 
 ::::

docs/deploy/linux/installer/install.md.jinja

@@ -1,88 +1,64 @@
+{%- import "deploy/linux/linux.template.jinja" as linux %}
+<!-- markdownlint-disable no-duplicate-header blanks-around-headings no-multiple-blanks -->
 # Installation with install script
 
 Prior to beginning, please ensure you have the [prerequisites](../prerequisites)
 installed.
 
+```{warning}
+ROCm currently doesn't support integrated graphics. Should your system have an
+AMD IGP installed, disable it in the BIOS prior to using ROCm. If the driver can
+enumerate the IGP, the ROCm runtime may crash the system, even if told to omit
+it via {ref}`hip_visible_devices`.
+```
+
 ## 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
+{% call(family) linux.for_family_in(linux.supported_family) %}
+{%- call(os) linux.for_os_in(linux.supported_os) %}
 
-::::{tab-set}
-:::{tab-item} Ubuntu 20.04
-:sync: ubuntu-20.04
+{%- if os.tag == "ubuntu" %}
+{%- call(version) linux.for_version_in(os) %}
+
+```{important}
+Instructions for {{ family.name }}, {{ os.name }} {{ version.number }}
+```
 
 ```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
+wget https://repo.radeon.com/amdgpu-install/{{ family.amdgpu_version }}/ubuntu/{{ version.release }}/amdgpu-install_{{ family.amdgpu_install_version }}_all.deb
+sudo apt install ./amdgpu-install_{{ family.amdgpu_install_version }}_all.deb
 ```
+{%- endcall -%}
+{%- elif os.tag == "rhel" %}
+{%- call(version) linux.for_version_in(os) %}
 
-:::
-:::{tab-item} Ubuntu 22.04
-:sync: ubuntu-22.04
+```{important}
+Instructions for {{ family.name }}, {{ os.name }} {{ version.number }}
+```
 
 ```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
+sudo yum install https://repo.radeon.com/amdgpu-install/{{ family.amdgpu_version }}/rhel/{{ version.number }}/amdgpu-install-{{ family.amdgpu_install_version }}.{{ version.release | trim("rh") }}.noarch.rpm
 ```
+{%- endcall -%}
+{%- elif os.tag == "sle" %}
+{%- call(version) linux.for_version_in(os) %}
 
-:::
-::::
-:::::
-:::::{tab-item} Red Hat Enterprise Linux
-:sync: RHEL
-
-::::{tab-set}
-:::{tab-item} RHEL 8.6
-:sync: RHEL-8.6
-:sync: RHEL-8
+```{important}
+Instructions for {{ family.name }}, {{ os.name }} {{ version.number }}
+```
 
 ```shell
-sudo yum install https://repo.radeon.com/amdgpu-install/5.4/rhel/8.6/amdgpu-install-5.4.50400-1.el8.noarch.rpm
+sudo zypper --no-gpg-checks install https://repo.radeon.com/amdgpu-install/{{ family.amdgpu_version }}/sle/{{ version.number }}/amdgpu-install-{{ family.amdgpu_install_version }}.noarch.rpm
 ```
+{%- endcall -%}
+{%- endif %}
 
-:::
-:::{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
-```
-
-:::
-::::
-:::::
-::::::
+{%- endcall -%}
+{%- endcall %}
 
 ## Use cases
 
@@ -145,6 +121,18 @@ To install use cases specific to your requirements, use the installer
   sudo amdgpu-install --usecase=hiplibsdk,rocm
   ```
 
+- For graphical workloads using the open-source driver add `graphics`. For example:
+
+  ```shell
+  sudo amdgpu-install --usecase=graphics,rocm
+  ```
+
+- For workstation workloads using the proprietary driver add `workstation`. For example:
+
+  ```shell
+  sudo amdgpu-install --usecase=workstation,rocm
+  ```
+
 ## Single-version ROCm Installation
 
 By default (without the `--rocmrelease` option)
@@ -155,9 +143,9 @@ the installer script will install packages in the single-version layout.
 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
+**Example:** If you want to install ROCm releases 5.5.3, 5.6.1 and {{ linux.supported_family[0].rocm_version }}
 simultaneously, you are required to download the installer from the latest ROCm
-release v5.4.
+release {{ linux.supported_family[0].rocm_version }}.
 
 ### Add Required Repositories
 
@@ -167,50 +155,37 @@ 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
+{% call(family) linux.for_family_in(linux.supported_family) %}
+{%- call(os) linux.for_os_in(linux.supported_os) %}
 
-::::{tab-set}
-:::{tab-item} Ubuntu 20.04
-:sync: ubuntu-20.04
+{%- if os.tag == "ubuntu" %}
+{%- call(version) linux.for_version_in(os) %}
+
+```{important}
+Instructions for {{ family.name }}, {{ os.name }} {{ version.number }}
+```
 
 ```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
+for ver in 5.5.3 5.6.1 {{ linux.supported_family[0].rocm_version }}; do
+echo "deb [arch=amd64 signed-by=/etc/apt/trusted.gpg.d/rocm-keyring.gpg] https://repo.radeon.com/rocm/apt/$ver {{ version.release }} 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
 ```
+{%- endcall -%}
+{%- elif os.tag == "rhel" %}
+{%- call(version) linux.for_version_in(os) %}
 
-:::
-:::{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
+```{important}
+Instructions for {{ family.name }}, {{ os.name }} {{ version.number }}
 ```
 
-:::
-::::
-:::::
-:::::{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
+for ver in 5.5.3 5.6.1 {{ linux.supported_family[0].rocm_version }}; 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
+baseurl=https://repo.radeon.com/rocm/{{ version.release }}/$ver/main
 enabled=1
 priority=50
 gpgcheck=1
@@ -219,37 +194,13 @@ EOF
 done
 sudo yum clean all
 ```
-
-:::
-:::{tab-item} RHEL 9
-:sync: RHEL-9
-
+{%- endcall -%}
+{%- elif os.tag == "sle" %}
 ```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
+for ver in 5.5.3 5.6.1 {{ linux.supported_family[0].rocm_version }}; 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
+baseurl=https://repo.radeon.com/rocm/zyp/$ver/main
 enabled=1
 gpgcheck=1
 gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
@@ -257,27 +208,29 @@ EOF
 done
 sudo zypper ref
 ```
+{%- endif %}
 
-:::::
-::::::
+{%- endcall -%}
+{%- endcall %}
 
 ### Install packages
 
 Use the installer script as given below:
 
-```none
+```shell
 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
+driver, associated with the ROCm release {{ linux.supported_family[0].rocm_version }}, 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
+```shell
+sudo amdgpu-install --usecase=rocm --rocmrelease={{ linux.supported_family[0].rocm_version }}
+sudo amdgpu-install --usecase=rocm --rocmrelease=5.6.1
+sudo amdgpu-install --usecase=rocm --rocmrelease=5.5.3
 ```
 
 ## Additional options

docs/deploy/linux/linux.template.jinja

@@ -0,0 +1,116 @@
+{%- set supported_family = ([
+    {
+        "tag": "instinct",
+        "name": "Select OS",
+        "amdgpu_version": "5.7.1",
+        "amdgpu_install_version": "5.7.50701-1",
+        "rocm_version":  "5.7.1",
+        "rocm_install_version": "5.7.50701-1",
+    }
+]) -%}
+
+{%- set supported_os = ([
+    {
+        "tag": "ubuntu",
+        "name": "Ubuntu",
+        "shortname" : "Ubuntu",
+        "version": [
+            {
+                "number": "22.04",
+                "release": "jammy"
+            },
+            {
+                "number": "20.04",
+                "release": "focal"
+            }
+        ]
+    },
+    {
+        "tag": "rhel",
+        "name": "Red Hat Enterprise Linux",
+        "shortname" : "RHEL",
+        "version": [
+            {
+                "number": "9.2",
+                "release": "rhel9"
+            },
+            {
+                "number": "9.1",
+                "release": "rhel9"
+            },
+            {
+                "number": "8.8",
+                "release": "rhel8"
+            },
+            {
+                "number": "8.7",
+                "release": "rhel8"
+            },
+        ]
+    },
+    {
+        "tag": "sle",
+        "name": "SUSE Linux Enterprise Server",
+        "shortname" : "SLES",
+        "version": [
+            {
+                "number": "15.5"
+            },
+            {
+                "number": "15.4"
+            },
+        ]
+    }
+]) -%}
+
+{%- macro for_family_in(supported_family) %}
+::::::::{tab-set}
+{%- for family in supported_family %}
+:::::::{tab-item} {{ family.name }}
+:sync: {{ family.tag }}
+{{ caller(family) }}
+
+:::::::
+{%- endfor %}
+::::::::
+{%- endmacro -%}
+
+{%- macro for_os_in(supported_os) %}
+::::::{tab-set}
+{%- for os in supported_os %}
+:::::{tab-item} {{ os.name }}
+:sync: {{ os.tag }}
+{{ caller(os) }}
+
+:::::
+{%- endfor %}
+::::::
+{%- endmacro -%}
+
+{%- macro for_version_in(os) %}
+::::{tab-set}
+{%- for version in os.version %}
+:::{tab-item} {{ os.shortname }} {{ version.number }}
+:sync: {{ os.tag }}-{{ version.number }}
+{{ caller(version) }}
+
+:::
+{%- endfor %}
+::::
+{%- endmacro -%}
+
+{%- macro install(os, argument) %}
+```shell
+{%- if os.tag == "ubuntu" %}
+sudo apt install {{ argument }}
+{%- elif os.tag == "rhel" %}
+sudo yum install {{ argument }}
+{%- elif os.tag == "sle" %}
+sudo zypper install {{ argument }}
+{%- endif %}
+```
+{%- endmacro -%}
+
+{%- macro header_anchor(family, os) -%}
+({{ caller() | lower | replace('#', '') | trim | replace(' ', '-')}}-{{ family.tag }}-{{ os.tag }})= {{ caller() }}
+{%- endmacro -%}

docs/deploy/linux/os-native/install.md.jinja

@@ -1,5 +1,14 @@
+{%- import "deploy/linux/linux.template.jinja" as linux %}
+<!-- markdownlint-disable no-duplicate-header blanks-around-headings no-multiple-blanks -->
 # Installation (Linux)
 
+```{warning}
+ROCm currently doesn't support integrated graphics. Should your system have an
+AMD IGP installed, disable it in the BIOS prior to using ROCm. If the driver can
+enumerate the IGP, the ROCm runtime may crash the system, even if told to omit
+it via {ref}`hip_visible_devices`.
+```
+
 ## Understanding the Release-specific AMDGPU and ROCm Repositories on Linux Distributions
 
 The release-specific repositories consist of packages from a specific release of
@@ -12,10 +21,9 @@ installed version by using the multi-version ROCm packages.
 
 ## Step by Step Instructions
 
-::::::{tab-set}
-:::::{tab-item} Ubuntu
-:sync: ubuntu
+{%- call(os) linux.for_os_in(linux.supported_os) %}
 
+{%- if os.tag == "ubuntu" %}
 ::::{rubric} 1. Download and convert the package signing key
 ::::
 
@@ -46,31 +54,22 @@ section.
 ```
 
 To add the AMDGPU repository, follow these steps:
+{% call(version) linux.for_version_in(os) %}
 
-::::{tab-set}
-:::{tab-item} Ubuntu 20.04
-:sync: ubuntu-20.04
+```{important}
+Instructions for {{ os.name }} {{ version.number }}
+```
 
 ```shell
+# version
+ver={{ linux.supported_family[0].amdgpu_version }}
+
 # amdgpu repository for focal
-echo 'deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amdgpu/5.4/ubuntu focal main' \
+echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amdgpu/$ver/ubuntu {{ version.release }} main" \
     | sudo tee /etc/apt/sources.list.d/amdgpu.list
 sudo apt update
 ```
-
-:::
-:::{tab-item} Ubuntu 22.04
-:sync: ubuntu-22.04
-
-```shell
-# amdgpu repository for jammy
-echo 'deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amdgpu/5.4/ubuntu jammy main' \
-    | sudo tee /etc/apt/sources.list.d/amdgpu.list
-sudo apt update
-```
-
-:::
-::::
+{%- endcall %}
 
 Install the kernel mode driver and reboot the system using the following
 commands:
@@ -85,38 +84,23 @@ sudo reboot
 
 To add the ROCm repository, use the following steps:
 
-::::{tab-set}
-:::{tab-item} Ubuntu 20.04
-:sync: ubuntu-20.04
+{%- call(version) linux.for_version_in(os) %}
+
+```{important}
+Instructions for {{ os.name }} {{ version.number }}
+```
 
 ```shell
-# ROCm repositories for focal
-for ver in 5.3.3 5.4; do
-echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/rocm/apt/$ver focal main" \
+# ROCm repositories for {{ version.release }}
+for ver in 5.3.3 5.4.6 5.5.3 5.6.1 {{ linux.supported_family[0].rocm_version }}; do
+echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/rocm/apt/$ver {{ version.release }} main" \
     | sudo tee --append /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
-# ROCm repositories for jammy
-for ver in 5.3.3 5.4; do
-echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/rocm/apt/$ver jammy main" \
-    | sudo tee --append /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
-```
-
-:::
-::::
+{%- endcall %}
 
 ::::{rubric} 4. Install packages
 ::::
@@ -136,13 +120,9 @@ For a comprehensive list of meta-packages, refer to
 - Sample Multi-version installation
 
    ```shell
-   sudo apt install rocm-hip-sdk5.4.0 rocm-hip-sdk5.3.3
+   sudo apt install rocm-hip-sdk{{ linux.supported_family[0].rocm_version }} rocm-hip-sdk5.6.1 rocm-hip-sdk5.5.3
    ```
-
-:::::
-:::::{tab-item} Red Hat Enterprise Linux
-:sync: RHEL
-
+{%- elif os.tag == "rhel" %}
 ::::{rubric} 1. Add the AMDGPU Stack Repository and Install the Kernel-mode Driver
 ::::
 
@@ -150,17 +130,20 @@ For a comprehensive list of meta-packages, refer to
 If you have a version of the kernel-mode driver installed, you may skip this
 section.
 ```
+{% call(version) linux.for_version_in(os) %}
 
-::::{tab-set}
-:::{tab-item} RHEL 8.6
-:sync: RHEL-8.6
-:sync: RHEL-8
+```{important}
+Instructions for {{ os.name }} {{ version.number }}
+```
 
 ```shell
+# version
+ver={{ linux.supported_family[0].amdgpu_version }}
+
 sudo tee /etc/yum.repos.d/amdgpu.repo <<EOF
 [amdgpu]
 name=amdgpu
-baseurl=https://repo.radeon.com/amdgpu/5.4/rhel/8.6/main/x86_64/
+baseurl=https://repo.radeon.com/amdgpu/$ver/rhel/{{ version.number }}/main/x86_64/
 enabled=1
 priority=50
 gpgcheck=1
@@ -168,48 +151,7 @@ gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
 EOF
 sudo yum clean all
 ```
-
-:::
-
-:::{tab-item} RHEL 8.7
-:sync: RHEL-8.7
-:sync: RHEL-8
-
-```shell
-sudo tee /etc/yum.repos.d/amdgpu.repo <<EOF
-[amdgpu]
-name=amdgpu
-baseurl=https://repo.radeon.com/amdgpu/5.4/rhel/8.7/main/x86_64/
-enabled=1
-priority=50
-gpgcheck=1
-gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
-EOF
-sudo yum clean all
-```
-
-:::
-
-:::{tab-item} RHEL 9.1
-:sync: RHEL-9.1
-:sync: RHEL-9
-
-```shell
-sudo tee /etc/yum.repos.d/amdgpu.repo <<EOF
-[amdgpu]
-name=amdgpu
-baseurl=https://repo.radeon.com/amdgpu/5.4/rhel/9.1/main/x86_64/
-enabled=1
-priority=50
-gpgcheck=1
-gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
-EOF
-sudo yum clean all
-```
-
-:::
-::::
-
+{%- endcall %}
 Install the kernel mode driver and reboot the system using the following
 commands:
 
@@ -228,7 +170,7 @@ To add the ROCm repository, use the following steps, based on your distribution:
 :sync: RHEL-8
 
 ```shell
-for ver in 5.3.3 5.4; do
+for ver in 5.3.3 5.4.6 5.5.3 5.6.1 {{ linux.supported_family[0].rocm_version }}; do
 sudo tee --append /etc/yum.repos.d/rocm.repo <<EOF
 [ROCm-$ver]
 name=ROCm$ver
@@ -239,6 +181,7 @@ gpgcheck=1
 gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
 EOF
 done
+
 sudo yum clean all
 ```
 
@@ -247,7 +190,7 @@ sudo yum clean all
 :sync: RHEL-9
 
 ```shell
-for ver in 5.3.3 5.4; do
+for ver in 5.3.3 5.4.6 5.5.3 5.6.1 {{ linux.supported_family[0].rocm_version }}; do
 sudo tee --append /etc/yum.repos.d/rocm.repo <<EOF
 [ROCm-$ver]
 name=ROCm$ver
@@ -282,13 +225,9 @@ For a comprehensive list of meta-packages, refer to
 - Sample Multi-version installation
 
    ```shell
-   sudo yum install rocm-hip-sdk5.4.0 rocm-hip-sdk5.3.3
+   sudo yum install rocm-hip-sdk{{ linux.supported_family[0].rocm_version }} rocm-hip-sdk5.6.1
    ```
-
-:::::
-:::::{tab-item} SUSE Linux Enterprise Server 15
-:sync: SLES15
-
+{%- elif os.tag == "sle" %}
 ::::{rubric} 1. Add the AMDGPU Repository and Install the Kernel-mode Driver
 ::::
 
@@ -296,18 +235,27 @@ For a comprehensive list of meta-packages, refer to
 If you have a version of the kernel-mode driver installed, you may skip this
 section.
 ```
+{% call(version) linux.for_version_in(os) %}
+
+```{important}
+Instructions for {{ os.name }} {{ version.number }}
+```
 
 ```shell
+# version
+ver={{ linux.supported_family[0].amdgpu_version }}
+
 sudo tee /etc/zypp/repos.d/amdgpu.repo <<EOF
 [amdgpu]
 name=amdgpu
-baseurl=https://repo.radeon.com/amdgpu/5.4/sle/15.4/main/x86_64
+baseurl=https://repo.radeon.com/amdgpu/$ver/sle/{{ version.number }}/main/x86_64
 enabled=1
 gpgcheck=1
 gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
 EOF
 sudo zypper ref
 ```
+{%- endcall %}
 
 Install the kernel mode driver and reboot the system using the following
 commands:
@@ -323,7 +271,7 @@ sudo reboot
 To add the ROCm repository, use the following steps:
 
 ```shell
-for ver in 5.3.3 5.4; do
+for ver in 5.3.3 5.4.6 5.5.3 5.6.1 {{ linux.supported_family[0].rocm_version }}; do
 sudo tee --append /etc/zypp/repos.d/rocm.repo <<EOF
 [ROCm-$ver]
 name=ROCm$ver
@@ -355,14 +303,12 @@ For a comprehensive list of meta-packages, refer to
 - Sample Multi-version installation
 
    ```shell
-   sudo zypper --gpg-auto-import-keys install rocm-hip-sdk5.4.0 rocm-hip-sdk5.3.3
+   sudo zypper --gpg-auto-import-keys install rocm-hip-sdk{{ linux.supported_family[0].rocm_version }} rocm-hip-sdk5.6.1
    ```
-
-:::::
-::::::
+{%- endif %}
+{%- endcall %}
 
 (post-install-actions-linux)=
-
 ## Post-install Actions and Verification Process
 
 The post-install actions listed here are optional and depend on your use case,
@@ -392,7 +338,8 @@ but are generally useful. Verification of the install is advised.
 2. Add binary paths to the `PATH` environment variable.
 
    ```shell
-   export PATH=$PATH:/opt/rocm-5.4.0/bin:/opt/rocm-5.4.0/opencl/bin
+   export PATH=$PATH:/opt/rocm-{{ linux.supported_family[0].rocm_version }}/bin:/opt/rocm-{{ linux.supported_family[0].rocm_version }}/opencl/bin
+
    ```
 
    ```{attention}
@@ -435,31 +382,18 @@ by both commands, the installation is considered successful:
 
 To ensure the packages are installed successfully, use the following commands:
 
-::::{tab-set}
-:::{tab-item} Ubuntu
-:sync: ubuntu
-
+{%- call(os) linux.for_os_in(linux.supported_os) %}
+{%- if os.tag == "ubuntu" %}
 ```shell
 sudo apt list --installed
 ```
-
-:::
-
-:::{tab-item} Red Hat Enterprise Linux
-:sync: RHEL
-
+{%- elif os.tag == "rhel" %}
 ```shell
 sudo yum list installed
 ```
-
-:::
-
-:::{tab-item} SUSE Linux Enterprise Server
-:sync: SLES
-
+{%- elif os.tag == "sle" %}
 ```shell
 sudo zypper search --installed-only
 ```
-
-:::
-::::
+{%- endif %}
+{%- endcall %}

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

@@ -12,8 +12,6 @@ following AMD ROCm programming models:
 A meta-package is a grouping of related packages and dependencies used to
 support a specific use case.
 
-**Example:** Running HIP applications
-
 All meta-packages exist in both versioned and non-versioned forms.
 
 - Non-versioned packages – For a single-version installation of the ROCm stack

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

@@ -114,8 +114,8 @@ sudo yum autoremove amdgpu-dkms
    ```
 
 :::::
-:::::{tab-item} SUSE Linux Enterprise Server 15
-:sync: SLES15
+:::::{tab-item} SUSE Linux Enterprise Server
+:sync: SLES
 
 ::::{rubric} Uninstalling Specific Meta-packages
 ::::

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

@@ -25,8 +25,12 @@ repository to the new release.
 :sync: ubuntu-20.04
 
 ```shell
+# version
+version=5.7
+
+
 # amdgpu repository for focal
-echo 'deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amdgpu/5.4/ubuntu focal main' \
+echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amdgpu/$version/ubuntu focal main" \
     | sudo tee /etc/apt/sources.list.d/amdgpu.list
 sudo apt update
 ```
@@ -36,8 +40,12 @@ sudo apt update
 :sync: ubuntu-22.04
 
 ```shell
+# version
+version=5.7
+
+
 # amdgpu repository for jammy
-echo 'deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amdgpu/5.4/ubuntu jammy main' \
+echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amdgpu/$version/ubuntu jammy main" \
     | sudo tee /etc/apt/sources.list.d/amdgpu.list
 sudo apt update
 ```
@@ -49,33 +57,19 @@ sudo apt update
 :sync: RHEL
 
 ::::{tab-set}
-:::{tab-item} RHEL 8.6
-:sync: RHEL-8.6
-:sync: RHEL-8
+:::{tab-item} RHEL 9.2
+:sync: RHEL-9.2
+:sync: RHEL-9
 
 ```shell
+# version
+version=5.7
+
+
 sudo tee /etc/yum.repos.d/amdgpu.repo <<EOF
 [amdgpu]
 name=amdgpu
-baseurl=https://repo.radeon.com/amdgpu/5.4/rhel/8.6/main/x86_64/
-enabled=1
-priority=50
-gpgcheck=1
-gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
-EOF
-sudo yum clean all
-```
-
-:::
-:::{tab-item} RHEL 8.7
-:sync: RHEL-8.7
-:sync: RHEL-8
-
-```shell
-sudo tee /etc/yum.repos.d/amdgpu.repo <<EOF
-[amdgpu]
-name=amdgpu
-baseurl=https://repo.radeon.com/amdgpu/5.4/rhel/8.7/main/x86_64/
+baseurl=https://repo.radeon.com/amdgpu/$version/rhel/9.2/main/x86_64/
 enabled=1
 priority=50
 gpgcheck=1
@@ -90,10 +84,58 @@ sudo yum clean all
 :sync: RHEL-9
 
 ```shell
+# version
+version=5.7
+
+
 sudo tee /etc/yum.repos.d/amdgpu.repo <<EOF
 [amdgpu]
 name=amdgpu
-baseurl=https://repo.radeon.com/amdgpu/5.4/rhel/9.1/main/x86_64/
+baseurl=https://repo.radeon.com/amdgpu/$version/rhel/9.1/main/x86_64/
+enabled=1
+priority=50
+gpgcheck=1
+gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
+EOF
+sudo yum clean all
+```
+
+:::
+:::{tab-item} RHEL 8.8
+:sync: RHEL-8.8
+:sync: RHEL-8
+
+```shell
+# version
+version=5.7
+
+
+sudo tee /etc/yum.repos.d/amdgpu.repo <<EOF
+[amdgpu]
+name=amdgpu
+baseurl=https://repo.radeon.com/amdgpu/$version/rhel/8.8/main/x86_64/
+enabled=1
+priority=50
+gpgcheck=1
+gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
+EOF
+sudo yum clean all
+```
+
+:::
+:::{tab-item} RHEL 8.7
+:sync: RHEL-8.7
+:sync: RHEL-8
+
+```shell
+# version
+version=5.7
+
+
+sudo tee /etc/yum.repos.d/amdgpu.repo <<EOF
+[amdgpu]
+name=amdgpu
+baseurl=https://repo.radeon.com/amdgpu/$version/rhel/8.7/main/x86_64/
 enabled=1
 priority=50
 gpgcheck=1
@@ -105,14 +147,22 @@ sudo yum clean all
 :::
 ::::
 :::::
-:::::{tab-item} SUSE Linux Enterprise Server 15
-:sync: SLES15
+:::::{tab-item} SUSE Linux Enterprise Server
+:sync: SLES
+
+::::{tab-set}
+:::{tab-item} SLES 15.5
+:sync: SLES-15.5
 
 ```shell
+# version
+version=5.7
+
+
 sudo tee /etc/zypp/repos.d/amdgpu.repo <<EOF
 [amdgpu]
 name=amdgpu
-baseurl=https://repo.radeon.com/amdgpu/5.4/sle/15.4/main/x86_64
+baseurl=https://repo.radeon.com/amdgpu/$version/sle/15.5/main/x86_64
 enabled=1
 gpgcheck=1
 gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
@@ -120,6 +170,28 @@ EOF
 sudo zypper ref
 ```
 
+:::
+:::{tab-item} SLES 15.4
+:sync: SLES-15.4
+
+```shell
+# version
+version=5.7
+
+
+sudo tee /etc/zypp/repos.d/amdgpu.repo <<EOF
+[amdgpu]
+name=amdgpu
+baseurl=https://repo.radeon.com/amdgpu/$version/sle/15.4/main/x86_64
+enabled=1
+gpgcheck=1
+gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
+EOF
+sudo zypper ref
+```
+
+:::
+::::
 :::::
 ::::::
 
@@ -147,8 +219,8 @@ sudo reboot
 ```
 
 :::
-:::{tab-item} SUSE Linux Enterprise Server 15
-:sync: SLES15
+:::{tab-item} SUSE Linux Enterprise Server
+:sync: SLES
 
 ```shell
 sudo zypper --gpg-auto-import-keys install amdgpu-dkms
@@ -172,7 +244,11 @@ repository to the new release.
 :sync: ubuntu-20.04
 
 ```shell
-echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/rocm/apt/5.4 focal main" \
+# version
+version=5.7
+
+
+echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/rocm/apt/$version focal main" \
     | sudo tee /etc/apt/sources.list.d/rocm.list
 echo -e 'Package: *\nPin: release o=repo.radeon.com\nPin-Priority: 600' \
     | sudo tee /etc/apt/preferences.d/rocm-pin-600
@@ -184,7 +260,11 @@ sudo apt update
 :sync: ubuntu-22.04
 
 ```shell
-echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/rocm/apt/5.4 jammy main" \
+# version
+version=5.7
+
+
+echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/rocm/apt/$version jammy main" \
     | sudo tee /etc/apt/sources.list.d/rocm.list
 echo -e 'Package: *\nPin: release o=repo.radeon.com\nPin-Priority: 600' \
     | sudo tee /etc/apt/preferences.d/rocm-pin-600
@@ -202,10 +282,14 @@ sudo apt update
 :sync: RHEL-8
 
 ```shell
+# version
+version=5.7
+
+
 sudo tee /etc/yum.repos.d/rocm.repo <<EOF
-[ROCm-5.4]
-name=ROCm5.4
-baseurl=https://repo.radeon.com/rocm/rhel8/5.4/main
+[ROCm-$ver]
+name=ROCm$ver
+baseurl=https://repo.radeon.com/rocm/rhel8/$version/main
 enabled=1
 priority=50
 gpgcheck=1
@@ -219,10 +303,14 @@ sudo yum clean all
 :sync: RHEL-9
 
 ```shell
+# version
+version=5.7
+
+
 sudo tee /etc/yum.repos.d/rocm.repo <<EOF
-[ROCm-5.4]
-name=ROCm5.4
-baseurl=https://repo.radeon.com/rocm/rhel9/5.4/main
+[ROCm-$ver]
+name=ROCm$ver
+baseurl=https://repo.radeon.com/rocm/rhel9/$version/main
 enabled=1
 priority=50
 gpgcheck=1
@@ -234,15 +322,18 @@ sudo yum clean all
 :::
 ::::
 :::::
-:::::{tab-item} SUSE Linux Enterprise Server 15
-:sync: SLES15
+:::::{tab-item} SUSE Linux Enterprise Server
+:sync: SLES
 
 ```shell
+# version
+version=5.7
+
 sudo tee /etc/zypp/repos.d/rocm.repo <<EOF
-[ROCm-5.4]
-name=ROCm5.4
+[ROCm-$ver]
+name=ROCm$ver
 name=rocm
-baseurl=https://repo.radeon.com/rocm/zyp/5.4/main
+baseurl=https://repo.radeon.com/rocm/zyp/$version/main
 enabled=1
 gpgcheck=1
 gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
@@ -275,8 +366,8 @@ sudo yum update rocm-hip-sdk
 ```
 
 :::
-:::{tab-item} Suse Linux Enterprise Server 15
-:sync: SLES15
+:::{tab-item} Suse Linux Enterprise Server
+:sync: SLES
 
 ```shell
 sudo zypper --gpg-auto-import-keys update rocm-hip-sdk

docs/deploy/linux/prerequisites.md

@@ -91,6 +91,7 @@ sudo rpm -ivh epel-release-latest-8.noarch.rpm
 
 :::
 :::{tab-item} RHEL 9
+:sync: RHEL-9
 
 ```shell
 wget https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm
@@ -110,14 +111,33 @@ sudo crb enable
 ```
 
 :::::
-:::::{tab-item} SUSE Linux Enterprise Server 15
+:::::{tab-item} SUSE Linux Enterprise Server
+:sync: SLES
 
 Add the perl languages repository.
 
-```shell
-zypper addrepo https://download.opensuse.org/repositories/devel:languages:perl/SLE_15_SP4/devel:languages:perl.repo
+```{note}
+Mar 25, 2024: We currently need to install the Perl module from SLES 15 SP5 as a workaround. The module was removed for SLES 15 SP4.
 ```
 
+::::{tab-set}
+:::{tab-item} SLES 15.4
+:sync: SLES-15.4
+
+```shell
+zypper addrepo https://download.opensuse.org/repositories/devel:/languages:/perl/15.5/devel:languages:perl.repo
+```
+
+:::
+:::{tab-item} SLES 15.5
+:sync: SLES-15.5
+
+```shell
+zypper addrepo https://download.opensuse.org/repositories/devel:/languages:/perl/15.5/devel:languages:perl.repo
+```
+
+:::
+::::
 :::::
 ::::::
 

docs/deploy/linux/quick_start.md

@@ -1,287 +0,0 @@
-# Quick Start (Linux)
-
-## Add Repositories
-
-::::::{tab-set}
-:::::{tab-item} Ubuntu
-:sync: ubuntu
-
-::::{rubric} 1. Download and convert the package signing key
-::::
-
-```shell
-# Make the directory if it doesn't exist yet.
-# This location is recommended by the distribution maintainers.
-sudo mkdir --parents --mode=0755 /etc/apt/keyrings
-# Download the key, convert the signing-key to a full
-# keyring required by apt and store in the keyring directory
-wget https://repo.radeon.com/rocm/rocm.gpg.key -O - | \
-    gpg --dearmor | sudo tee /etc/apt/keyrings/rocm.gpg > /dev/null
-```
-
-::::{rubric} 2. Add the repositories
-::::
-
-::::{tab-set}
-:::{tab-item} Ubuntu 20.04
-:sync: ubuntu-20.04
-
-```shell
-# Kernel driver repository for focal
-sudo tee /etc/apt/sources.list.d/amdgpu.list <<'EOF'
-deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amdgpu/5.4/ubuntu focal main
-EOF
-# ROCm repository for focal
-sudo tee /etc/apt/sources.list.d/rocm.list <<'EOF'
-deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/rocm/apt/5.4 focal main
-EOF
-```
-
-:::
-:::{tab-item} Ubuntu 22.04
-:sync: ubuntu-22.04
-
-```shell
-# Kernel driver repository for jammy
-sudo tee /etc/apt/sources.list.d/amdgpu.list <<'EOF'
-deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amdgpu/5.4/ubuntu jammy main
-EOF
-# ROCm repository for jammy
-sudo tee /etc/apt/sources.list.d/rocm.list <<'EOF'
-deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/rocm/apt/5.4 jammy main
-echo -e 'Package: *\nPin: release o=repo.radeon.com\nPin-Priority: 600' | sudo tee /etc/apt/preferences.d/rocm-pin-600
-EOF
-```
-
-:::
-::::
-
-::::{rubric} 3. Update the list of packages
-::::
-
-```shell
-sudo apt update
-```
-
-:::::
-
-:::::{tab-item} Red Hat Enterprise Linux
-:sync: RHEL
-
-::::{rubric} 1. Add the repositories
-::::
-
-::::{tab-set}
-:::{tab-item} RHEL 8.6
-:sync: RHEL-8.6
-
-```shell
-# Add the amdgpu module repository for RHEL 8.6
-sudo tee /etc/yum.repos.d/amdgpu.repo <<'EOF'
-[amdgpu]
-name=amdgpu
-baseurl=https://repo.radeon.com/amdgpu/5.4/rhel/8.6/main/x86_64
-enabled=1
-gpgcheck=1
-gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
-EOF
-# Add the rocm repository for RHEL 8
-sudo tee /etc/yum.repos.d/rocm.repo <<'EOF'
-[rocm]
-name=rocm
-baseurl=https://repo.radeon.com/rocm/rhel8/5.4/main
-enabled=1
-priority=50
-gpgcheck=1
-gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
-EOF
-```
-
-:::
-
-:::{tab-item} RHEL 8.7
-:sync: RHEL-8.7
-
-```shell
-# Add the amdgpu module repository for RHEL 8.7
-sudo tee /etc/yum.repos.d/amdgpu.repo <<'EOF'
-[amdgpu]
-name=amdgpu
-baseurl=https://repo.radeon.com/amdgpu/5.4/rhel/8.7/main/x86_64
-enabled=1
-gpgcheck=1
-gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
-EOF
-# Add the rocm repository for RHEL 8
-sudo tee /etc/yum.repos.d/rocm.repo <<'EOF'
-[rocm]
-name=rocm
-baseurl=https://repo.radeon.com/rocm/rhel8/5.4/main
-enabled=1
-priority=50
-gpgcheck=1
-gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
-EOF
-```
-
-:::
-
-:::{tab-item} RHEL 9.1
-:sync: RHEL-9.1
-
-```shell
-# Add the amdgpu module repository for RHEL 9.1
-sudo tee /etc/yum.repos.d/amdgpu.repo <<'EOF'
-[amdgpu]
-name=amdgpu
-baseurl=https://repo.radeon.com/amdgpu/5.4/rhel/9.1/main/x86_64
-enabled=1
-gpgcheck=1
-gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
-EOF
-# Add the rocm repository for RHEL 9
-sudo tee /etc/yum.repos.d/rocm.repo <<'EOF'
-[rocm]
-name=rocm
-baseurl=https://repo.radeon.com/rocm/rhel9/5.4/main
-enabled=1
-priority=50
-gpgcheck=1
-gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
-EOF
-```
-
-:::
-::::
-
-::::{rubric} 2. Clean cached files from enabled repositories
-::::
-
-```shell
-sudo yum clean all
-```
-
-:::::
-
-:::::{tab-item} SUSE Linux Enterprise Server
-:sync: SLES
-
-::::{rubric} 1. Add the repositories
-::::
-
-::::{tab-set}
-:::{tab-item} SLES 15 SP4
-:sync: SLES15-SP4
-
-```shell
-
-# Add the amdgpu module repository for SLES 15.4
-sudo tee /etc/zypp/repos.d/amdgpu.repo <<'EOF'
-[amdgpu]
-name=amdgpu
-baseurl=https://repo.radeon.com/amdgpu/5.4/sle/15.4/main/x86_64
-enabled=1
-gpgcheck=1
-gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
-EOF
-# Add the rocm repository for SLES
-sudo tee /etc/zypp/repos.d/rocm.repo <<'EOF'
-[rocm]
-name=rocm
-baseurl=https://repo.radeon.com/rocm/zyp/zypper
-enabled=1
-priority=50
-gpgcheck=1
-gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
-EOF
-```
-
-:::
-::::
-
-::::{rubric} 2. Update the new repository
-::::
-
-```shell
-sudo zypper ref
-```
-
-:::::
-::::::
-
-## Install Drivers
-
-Install the `amdgpu-dkms` kernel module, aka driver, on your system.
-
-::::{tab-set}
-
-:::{tab-item} Ubuntu
-:sync: ubuntu
-
-```shell
-sudo apt install amdgpu-dkms
-```
-
-:::
-
-:::{tab-item} Red Hat Enterprise Linux
-:sync: RHEL
-
-```shell
-sudo yum install amdgpu-dkms
-```
-
-:::
-
-:::{tab-item} SUSE Linux Enterprise Server
-:sync: SLES
-
-```shell
-sudo zypper install amdgpu-dkms
-```
-
-:::
-
-::::
-
-## Install ROCm Runtimes
-
-Install the `rocm-hip-libraries` meta-package. This contains dependencies for most
-common ROCm applications.
-
-::::{tab-set}
-:::{tab-item} Ubuntu
-:sync: ubuntu
-
-```console shell
-sudo apt install rocm-hip-libraries
-```
-
-:::
-
-:::{tab-item} Red Hat Enterprise Linux
-:sync: RHEL
-
-```console shell
-sudo yum install rocm-hip-libraries
-```
-
-:::
-
-:::{tab-item} SUSE Linux Enterprise Server
-:sync: SLES
-
-```console shell
-sudo zypper install rocm-hip-libraries
-```
-
-:::
-::::
-
-## Reboot the system
-
-Loading the new driver requires a reboot of the system.
-
-```shell
-sudo reboot
-```

docs/deploy/linux/quick_start.md.jinja

@@ -0,0 +1,162 @@
+{%- import "deploy/linux/linux.template.jinja" as linux %}
+<!-- markdownlint-disable no-duplicate-header blanks-around-headings no-multiple-blanks -->
+# Quick Start (Linux)
+
+:::{note}
+See {doc}`Radeon Software for Linux installation instructions <radeon:docs/install/install-radeon>`
+for those using select RDNA™ 3 GPU with graphical applications and ROCm.
+:::
+
+## Add Repositories
+{% set family = linux.supported_family[0] %}
+
+{%- call(os) linux.for_os_in(linux.supported_os) %}
+
+{%- if os.tag == "ubuntu" %}
+::::{rubric} 1. Download and convert the package signing key
+::::
+
+```shell
+# Make the directory if it doesn't exist yet.
+# This location is recommended by the distribution maintainers.
+sudo mkdir --parents --mode=0755 /etc/apt/keyrings
+# Download the key, convert the signing-key to a full
+# keyring required by apt and store in the keyring directory
+wget https://repo.radeon.com/rocm/rocm.gpg.key -O - | \
+    gpg --dearmor | sudo tee /etc/apt/keyrings/rocm.gpg > /dev/null
+```
+
+::::{rubric} 2. Add the repositories
+::::
+{%- call(version) linux.for_version_in(os) %}
+
+```{important}
+Instructions for {{ family.name }}, {{ os.name }} {{ version.number }}
+```
+
+```shell
+# Kernel driver repository for {{ version.release }}
+sudo tee /etc/apt/sources.list.d/amdgpu.list <<'EOF'
+deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amdgpu/{{ family.amdgpu_version }}/ubuntu {{ version.release }} main
+EOF
+# ROCm repository for {{ version.release }}
+sudo tee /etc/apt/sources.list.d/rocm.list <<'EOF'
+deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/rocm/apt/{{ family.amdgpu_version }} {{ version.release }} main
+EOF
+# Prefer packages from the rocm repository over system packages
+echo -e 'Package: *\nPin: release o=repo.radeon.com\nPin-Priority: 600' | sudo tee /etc/apt/preferences.d/rocm-pin-600
+```
+
+{%- endcall %}
+
+::::{rubric} 3. Update the list of packages
+::::
+
+```shell
+sudo apt update
+```
+{%- elif os.tag == "rhel" %}
+::::{rubric} 1. Add the repositories
+::::
+{%- call(version) linux.for_version_in(os) %}
+
+```{important}
+Instructions for {{ family.name }}, {{ os.name }} {{ version.number }}
+```
+
+```shell
+# Add the amdgpu module repository for RHEL {{ version.number }}
+sudo tee /etc/yum.repos.d/amdgpu.repo <<'EOF'
+[amdgpu]
+name=amdgpu
+baseurl=https://repo.radeon.com/amdgpu/{{ family.amdgpu_version }}/rhel/{{ version.number }}/main/x86_64
+enabled=1
+gpgcheck=1
+gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
+EOF
+# Add the rocm repository for {{ version.release | upper }}
+sudo tee /etc/yum.repos.d/rocm.repo <<'EOF'
+[rocm]
+name=rocm
+baseurl=https://repo.radeon.com/rocm/{{ version.release }}/latest/main
+enabled=1
+priority=50
+gpgcheck=1
+gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
+EOF
+```
+
+{%- endcall %}
+
+::::{rubric} 2. Clean cached files from enabled repositories
+::::
+
+```shell
+sudo yum clean all
+```
+{%- elif os.tag == "sle" %}
+::::{rubric} 1. Add the repositories
+::::
+{%- call(version) linux.for_version_in(os) %}
+
+```{important}
+Instructions for {{ family.name }}, {{ os.name }} {{ version.number }}
+```
+
+```shell
+# Add the amdgpu module repository for SLES {{ version.number }}
+sudo tee /etc/zypp/repos.d/amdgpu.repo <<'EOF'
+[amdgpu]
+name=amdgpu
+baseurl=https://repo.radeon.com/amdgpu/{{ family.amdgpu_version }}/sle/{{ version.number }}/main/x86_64
+enabled=1
+gpgcheck=1
+gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
+EOF
+# Add the rocm repository for SLES
+sudo tee /etc/zypp/repos.d/rocm.repo <<'EOF'
+[rocm]
+name=rocm
+baseurl=https://repo.radeon.com/rocm/zyp/zypper
+enabled=1
+priority=50
+gpgcheck=1
+gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
+EOF
+```
+
+{%- endcall %}
+
+::::{rubric} 2. Update the new repository
+::::
+
+```shell
+sudo zypper ref
+```
+{%- endif %}
+{%- endcall -%}
+
+{%- call(os) linux.for_os_in(linux.supported_os) %}
+## Install drivers
+
+Install the `amdgpu-dkms` kernel module, aka driver, on your system.
+
+{{ linux.install(os, "amdgpu-dkms")}}
+{%- endcall %}
+
+## Install ROCm runtimes
+
+Install the `rocm-hip-libraries` meta-package. This contains dependencies for most
+common ROCm applications.
+
+{%- call(os) linux.for_os_in(linux.supported_os) %}
+{{ linux.install(os, "rocm-hip-libraries")}}
+{%- endcall %}
+
+## Reboot the system
+
+Loading the new driver requires a reboot of the system.
+
+```shell
+sudo reboot
+```

docs/deploy/windows/cli/index.md

@@ -0,0 +1,31 @@
+# Command Line Installation
+
+::::{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 and libraries.
+:::
+
+::::
+
+## See Also
+
+- {doc}`/release/gpu_os_support`

docs/deploy/windows/cli/install.md

@@ -0,0 +1,56 @@
+# Installation Using the Command Line Interface
+
+The steps to install the HIP SDK for Windows are described in this document.
+
+## System Requirements
+
+The HIP SDK is supported on Windows 10 and 11. The HIP SDK may be installed on a
+system without AMD GPUs to use the build toolchains. To run HIP applications, a
+compatible GPU is required. Please see the supported GPU guide for more details.
+
+## HIP SDK Installation
+
+The command line installer is the same executable which is used by the graphical
+front-end. Download the installer from the
+[HIP-SDK download page](https://www.amd.com/en/developer/rocm-hub/hip-sdk.html).
+The options supported by the command line interface are summarized in
+{numref}`hip-sdk-cli-options`.
+
+```{table} HIP SDK Command Line Options
+:name: hip-sdk-cli-options
+| **Install Option** | **Description** |
+|:------------------:|:---------------:|
+| `-install` | Command used to install packages, both driver and applications. No output to the screen. |
+| `-install -boot` | Silent install with auto reboot. |
+| `-install -log <absolute path>` | Write install result code to the specified log file. The specified log file must be on a local machine. Double quotes are needed if there are spaces in the log file path. |
+| `-uninstall` | Command to uninstall all packages installed by this installer on the system. There is no option to specify which packages to uninstall. |
+| `-uninstall -boot` | Silent uninstall with auto reboot. |
+| `/?` or /help | Shows a brief description of all switch commands. |
+```
+
+```{note}
+Unlike the graphical installer, the command line interface doesn't support
+selectively installing parts of the SDK bundle. It's all or nothing.
+```
+
+### Launching the Installer From the Command Line
+
+The installer is still a graphical application with a `WinMain` entry point, even
+when called on the command line. This means that the application lifetime is
+tied to a window, even on headless systems where that window may not be visible.
+To launch the installer from PowerShell that will block until the installer
+exits, one may use the following pattern:
+
+```pwsh
+Start-Process $InstallerExecutable -ArgumentList $InstallerArgs -NoNewWindow -Wait
+```
+
+```{important}
+Running the installer requires Administrator Privileges.
+```
+
+For example, installing all components and
+
+```pwsh
+Start-Process ~\Downloads\Setup.exe -ArgumentList '-install','-log',"${env:USERPROFILE}\installer_log.txt" -NoNewWindow -Wait
+```

docs/deploy/windows/cli/uninstall.md

@@ -0,0 +1,48 @@
+# Uninstallation Using the Command Line Interface
+
+The steps to uninstall the HIP SDK for Windows are described in this document.
+
+## HIP SDK Uninstallation
+
+The command line installer is the same executable which is used by the graphical
+front-end. The options supported by the command line interface are summarized in
+{numref}`hip-sdk-cli-options`.
+
+```{table} HIP SDK Command Line Options
+:name: hip-sdk-cli-options
+| **Install Option** | **Description** |
+|:------------------:|:---------------:|
+| `-install` | Command used to install packages, both driver and applications. No output to the screen. |
+| `-install -boot` | Silent install with auto reboot. |
+| `-install -log <absolute path>` | Write install result code to the specified log file. The specified log file must be on a local machine. Double quotes are needed if there are spaces in the log file path. |
+| `-uninstall` | Command to uninstall all packages installed by this installer on the system. There is no option to specify which packages to uninstall. |
+| `-uninstall -boot` | Silent uninstall with auto reboot. |
+| `/?` or /help | Shows a brief description of all switch commands. |
+```
+
+```{note}
+Unlike the graphical installer, the command line interface doesn't support
+selectively installing parts of the SDK bundle. It's all or nothing.
+```
+
+### Launching the Installer From the Command Line
+
+The installer is still a graphical application with a `WinMain` entry point, even
+when called on the command line. This means that the application lifetime is
+tied to a window, even on headless systems where that window may not be visible.
+To launch the installer from PowerShell that will block until the installer
+exits, one may use the following pattern:
+
+```pwsh
+Start-Process $InstallerExecutable -ArgumentList $InstallerArgs -NoNewWindow -Wait
+```
+
+```{important}
+Running the installer requires Administrator Privileges.
+```
+
+For example, uninstalling all components and
+
+```pwsh
+Start-Process ~\Downloads\Setup.exe -ArgumentList '-uninstall' -NoNewWindow -Wait
+```

docs/deploy/windows/cli/upgrade.md

@@ -0,0 +1,14 @@
+# Upgrading Using the Graphical Interface
+
+The steps to uninstall the HIP SDK for Windows are described in this document.
+
+## HIP SDK Upgrade
+
+To upgrade an existing installation of the HIP SDK without preserving the
+previous version, first uninstall it, then install the new version following the
+instructions in {doc}`/deploy/windows/cli/uninstall` and
+{doc}`/deploy/windows/cli/install` using the old and new installers
+respectively.
+
+To upgrade by installing both versions side-by-side, just run the installer of
+the newer version.

docs/deploy/windows/gui/index.md

@@ -0,0 +1,31 @@
+# Graphical Installation
+
+::::{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 and libraries.
+:::
+
+::::
+
+## See Also
+
+- {doc}`/release/gpu_os_support`

docs/deploy/windows/gui/install.md

@@ -0,0 +1,163 @@
+# Installation Using the Graphical Interface
+
+The steps to install the HIP SDK for Windows are described in this document.
+
+## System Requirements
+
+The HIP SDK is supported on Windows 10 and 11. The HIP SDK may be installed on a
+system without AMD GPUs to use the build toolchains. To run HIP applications, a
+compatible GPU is required. Please see the supported GPU guide for more details.
+
+## HIP SDK Installation
+
+### Download the installer
+
+Download the installer from the
+[HIP-SDK download page](https://www.amd.com/en/developer/rocm-hub/hip-sdk.html).
+
+### Launching the installer
+
+To launch the AMD HIP SDK Installer, click the **Setup** icon shown in
+{numref}`setup-icon`.
+
+```{figure} /data/deploy/windows/000-setup-icon.png
+:name: setup-icon
+:alt: Icon with AMD arrow logo and User Access Control Shield overlayed.
+Setup Icon
+```
+
+The installer requires Administrator Privileges, so you may be greeted with a
+User Access Control (UAC) pop-up. Click Yes.
+
+```{figure} /data/deploy/windows/001-uac-dark.png
+:name: uac-dark
+:class: only-dark
+:alt: User Access Control pop-up
+User Access Control pop-up
+```
+
+```{figure} /data/deploy/windows/001-uac-light.png
+:name: uac-light
+:class: only-light
+:alt: User Access Control pop-up
+User Access Control pop-up
+```
+
+The installer executable will temporarily extract installer packages to `C:\AMD`
+which it will remove after installation completes. This extraction is signified
+by the "Initializing install" window in {numref}`init-install`.
+
+```{figure} /data/deploy/windows/002-initializing.png
+:name: init-install
+:alt: Window with AMD arrow logo, futuristic background and progress counter.
+Installer initialization window
+```
+
+The installer will then detect your system configuration as per
+{numref}`detecting-system-components` to decide, which installable components
+are applicable to your system.
+
+```{figure} /data/deploy/windows/003-detecting-system-config.png
+:name: detecting-system-components
+:alt: Window with AMD arrow logo, futuristic background and activity indicator.
+Installer initialization window.
+```
+
+### Customizing the install
+
+When the installer launches, it displays a window that lets the user customize
+the installation. By default, all components are selected for installation.
+Refer to {numref}`installer-window` for an instance when the Select All option
+is turned on.
+
+```{figure} /data/deploy/windows/004-installer-window.png
+:name: installer-window
+:alt: Window with AMD arrow logo, futuristic background and activity indicator.
+Installer initialization window.
+```
+
+#### HIP SDK Installer
+
+The HIP SDK installation options are listed in {numref}`hip-sdk-options`.
+
+```{table} HIP SDK Components for Installation
+:name: hip-sdk-options
+| **HIP Components** | **Install Type** | **Additional Options** |
+|:------------------:|:----------------:|:----------------------:|
+| HIP SDK Core         | 5.5.0               | Install location                        |
+| HIP Libraries        | Full, Partial, None | Runtime, Development (Libs and headers) |
+| HIP Runtime Compiler | Full, Partial, None | Runtime, Development (Headers)          |
+| HIP Ray Tracing      | Full, Partial, None | Runtime, Development (Headers)          |
+| Visual Studio Plugin | Full, Partial, None | Visual Studio 2017, 2019, 2022 Plugin   |
+```
+
+```{note}
+The Select/DeSelect All option only applies to the installation of HIP SDK
+components. To install the bundled AMD Display Driver, manually select the
+install type.
+```
+
+```{tip}
+Should you only wish to install a few select components,
+DeSelecting All and then picking the individual components may be more
+convenient.
+```
+
+#### AMD Display Driver
+
+The HIP SDK installer bundles an AMD Radeon Software PRO 23.10 installer. The
+supported install options are summarized by
+{numref}`display-driver-install-options`:
+
+```{table} AMD Display Driver Install Options
+:name: display-driver-install-options
+| **Install Option** | **Description** |
+|:------------------:|:---------------:|
+| Install Location         | Location on disk to store driver files. |
+| Install Type             | The breadth of components to be installed. Refer to {numref}`display-driver-install-types` for details. |
+| Factory Reset (Optional) | A Factory Reset will remove all prior versions of AMD HIP SDK and drivers. You will not be able to roll back to previously installed drivers. |
+```
+
+```{table} AMD Display Driver Install Types
+:name: display-driver-install-types
+| **Install Type** | **Description** |
+|:----------------:|:---------------:|
+| Full Install     | Provides all AMD Software features and controls for gaming, recording, streaming, and tweaking the performance on your graphics hardware. |
+| Minimal Install  | Provides only the basic controls for AMD Software features and does not include advanced features such as performance tweaking or recording and capturing content. |
+| Driver Only      | Provides no user interface for AMD Software features. |
+```
+
+```{note}
+You must perform a system restart for a complete installation of the
+Display Driver.
+```
+
+### Installing Components
+
+Please wait for the installation to complete during as shown in
+{numref}`install-progress`.
+
+```{figure} /data/deploy/windows/012-install-progress.png
+:name: install-progress
+:alt: Window with AMD arrow logo, futuristic background and progress meter.
+Installation Progress
+```
+
+### Installation Complete
+
+Once the installation is complete, the installer window may prompt you for a
+system restart. Click **Restart** at the lower right corner, shown in
+{numref}`install-complete`
+
+```{figure} /data/deploy/windows/013-install-complete.png
+:name: install-complete
+:alt: Window with AMD arrow logo, futuristic background and completion notice.
+Installation Complete
+```
+
+```{error}
+Should the installer terminate due to unexpcted circumstances, or the user
+forcibly terminates the installer, the temporary directory created under
+`C:\AMD` may be safely removed. Installed components will not depend on this
+folder (unless the user specifies `C:\AMD` as an install folder explicitly).
+```

docs/deploy/windows/gui/uninstall.md

@@ -0,0 +1,27 @@
+# Uninstallation Using the Graphical Interface
+
+The steps to uninstall the HIP SDK for Windows are described in this document.
+
+## Uninstallation
+
+All components, except visual studio plug-in should be uninstalled through
+control panel -> Add/Remove Program. For visual studio extension uninstallation,
+please refer to
+<https://github.com/ROCm-Developer-Tools/HIP-VS/blob/master/README.md>.
+Uninstallation of the HIP SDK components can be done through the Windows
+Settings app. Navigate to "Apps > Installed apps", click the "..." on the far
+right next to the component to uninstall, and click "Uninstall".
+
+```{figure} /data/deploy/windows/014-uninstall-dark.png
+:name: uninstall-dark
+:class: only-dark
+:alt: Installed apps section of the Setting app showing installed HIP SDK components.
+Removing the SDK via the Setting app
+```
+
+```{figure} /data/deploy/windows/014-uninstall-light.png
+:name: uninstall-light
+:class: only-light
+:alt: Installed apps section of the Setting app showing installed HIP SDK components.
+Removing the SDK via the Setting app
+```

docs/deploy/windows/gui/upgrade.md

@@ -0,0 +1,4 @@
+# Upgrading Using the Graphical Interface
+
+The steps to upgrade an existing HIP SDK installation for Windows are described
+in this document.

docs/deploy/windows/index.md

@@ -0,0 +1,65 @@
+# Install ROCm (HIP SDK) on Windows
+
+Start with {doc}`/deploy/windows/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 to verify that the system
+supports ROCm.
+:::
+
+::::
+
+## Choose your install method
+
+::::{grid} 1 1 2 2
+:gutter: 1
+
+:::{grid-item-card} Graphical Installation
+:link: gui/index
+:link-type: doc
+
+Use the graphical front-end of the installer.
+:::
+
+:::{grid-item-card} Command Line Installation
+:link: cli/index
+:link-type: doc
+
+Use the command line front-end of the installer.
+:::
+
+::::
+
+## Post Installation
+
+::::{grid} 1 1 2 2
+:gutter: 1
+
+:::{grid-item-card} ROCm-Examples
+:link: https://github.com/amd/rocm-examples
+:link-type: url
+
+Learn how to use ROCm with descriptive examples for novice to intermediate users.
+:::
+
+:::{grid-item-card} Windows App Deployment Guidelines
+:link: ../../understand/windows-app-deployment-guidelines
+:link-type: doc
+
+Discusses strategies on how to bundle HIP libraries with an end user application.
+:::
+
+::::
+
+## See Also
+
+- {doc}`/release/gpu_os_support`

docs/deploy/windows/prerequisites.md

@@ -0,0 +1,74 @@
+# Installation Prerequisites (Windows)
+
+You must perform the following steps before installing ROCm and check if the
+system meets all the requirements to proceed with the installation.
+
+## Confirm the System Is Supported
+
+The ROCm installation is supported only on specific host architectures, Windows
+Editions and update versions.
+
+### Check the Windows Editions and Update Version on Your System
+
+This section discusses obtaining information about the host architecture,
+Windows Edition and update version.
+
+#### Command Line Check
+
+Verify the Windows Edition using the following steps:
+
+1. To obtain the Linux distribution information, type the following command on
+   your system from a PowerShell Command Line Interface (CLI):
+
+   ```pwsh
+   Get-ComputerInfo | Format-Table CsSystemType,OSName,OSDisplayVersion
+   ```
+
+2. Confirm that the obtained information matches with those listed in
+   {ref}`supported_skus`.
+
+   **Example:** Running the command above on a Windows system may result in the
+   following output:
+
+   ```output
+   CsSystemType OsName                   OSDisplayVersion
+   ------------ ------                   ----------------
+   x64-based PC Microsoft Windows 11 Pro 22H2
+   ```
+
+#### Graphical Check
+
+1. Open the Setting app.
+
+   ```{figure} /data/deploy/windows/000-settings-dark.png
+   :name: settings-dark
+   :class: only-dark
+   :alt: Gear icon of the Windows Settings app
+   Windows Settings app icon
+   ```
+
+   ```{figure} /data/deploy/windows/000-settings-light.png
+   :name: settings-light
+   :class: only-light
+   :alt: Gear icon of the Windows Settings app
+   Windows Settings app icon
+   ```
+
+2. Navigate to **System > About**.
+
+   ```{figure} /data/deploy/windows/001-about-dark.png
+   :name: about-dark
+   :class: only-dark
+   :alt: Settings app panel showing Device and OS information
+   Settings > About page
+   ```
+
+   ```{figure} /data/deploy/windows/001-about-light.png
+   :name: about-light
+   :class: only-light
+   :alt: Settings app panel showing Device and OS information
+   Settings > About page
+   ```
+
+3. Confirm that the obtained information matches with those listed in
+   {ref}`supported_skus`.

docs/deploy/windows/quick_start.md

@@ -0,0 +1,187 @@
+# Quick Start (Windows)
+
+The steps to install the HIP SDK for Windows are described in this document.
+
+## System Requirements
+
+The HIP SDK is supported on Windows 10 and 11. The HIP SDK may be installed on a
+system without AMD GPUs to use the build toolchains. To run HIP applications, a
+compatible GPU is required. Please see the supported GPU guide for more details.
+
+## HIP SDK Installation
+
+### Download the installer
+
+Download the installer from the
+[HIP-SDK download page](https://www.amd.com/en/developer/rocm-hub/hip-sdk.html).
+
+### Launching the installer
+
+To launch the AMD HIP SDK Installer, click the **Setup** icon shown in
+{numref}`setup-icon`.
+
+```{figure} /data/deploy/windows/000-setup-icon.png
+:name: setup-icon
+:alt: Icon with AMD arrow logo and User Access Control Shield overlayed.
+Setup Icon
+```
+
+The installer requires Administrator Privileges, so you may be greeted with a
+User Access Control (UAC) pop-up. Click Yes.
+
+```{figure} /data/deploy/windows/001-uac-dark.png
+:name: uac-dark
+:class: only-dark
+:alt: User Access Control pop-up
+User Access Control pop-up
+```
+
+```{figure} /data/deploy/windows/001-uac-light.png
+:name: uac-light
+:class: only-light
+:alt: User Access Control pop-up
+User Access Control pop-up
+```
+
+The installer executable will temporarily extract installer packages to `C:\AMD`
+which it will remove after installation completes. This extraction is signified
+by the "Initializing install" window in {numref}`init-install`.
+
+```{figure} /data/deploy/windows/002-initializing.png
+:name: init-install
+:alt: Window with AMD arrow logo, futuristic background and progress counter.
+Installer initialization window
+```
+
+The installer will then detect your system configuration as per
+{numref}`detecting-system-components` to decide, which installable components
+are applicable to your system.
+
+```{figure} /data/deploy/windows/003-detecting-system-config.png
+:name: detecting-system-components
+:alt: Window with AMD arrow logo, futuristic background and activity indicator.
+Installer initialization window.
+```
+
+### Customizing the install
+
+When the installer launches, it displays a window that lets the user customize
+the installation. By default, all components are selected for installation.
+Refer to {numref}`installer-window` for an instance when the Select All option
+is turned on.
+
+```{figure} /data/deploy/windows/004-installer-window.png
+:name: installer-window
+:alt: Window with AMD arrow logo, futuristic background and activity indicator.
+Installer initialization window.
+```
+
+#### HIP SDK Installer
+
+The HIP SDK installation options are listed in {numref}`hip-sdk-options`.
+
+```{table} HIP SDK Components for Installation
+:name: hip-sdk-options
+| **HIP Components** | **Install Type** | **Additional Options** |
+|:------------------:|:----------------:|:----------------------:|
+| HIP SDK Core         | 5.5.0               | Install location                        |
+| HIP Libraries        | Full, Partial, None | Runtime, Development (Libs and headers) |
+| HIP Runtime Compiler | Full, Partial, None | Runtime, Development (Headers)          |
+| HIP Ray Tracing      | Full, Partial, None | Runtime, Development (Headers)          |
+| Visual Studio Plugin | Full, Partial, None | Visual Studio 2017, 2019, 2022 Plugin   |
+```
+
+```{note}
+The Select/DeSelect All option only applies to the installation of HIP SDK
+components. To install the bundled AMD Display Driver, manually select the
+install type.
+```
+
+```{tip}
+Should you only wish to install a few select components,
+DeSelecting All and then picking the individual components may be more
+convenient.
+```
+
+#### AMD Display Driver
+
+The HIP SDK installer bundles an AMD Radeon Software PRO 23.10 installer. The
+supported install options are summarized by
+{numref}`display-driver-install-options`:
+
+```{table} AMD Display Driver Install Options
+:name: display-driver-install-options
+| **Install Option** | **Description** |
+|:------------------:|:---------------:|
+| Install Location         | Location on disk to store driver files. |
+| Install Type             | The breadth of components to be installed. Refer to {numref}`display-driver-install-types` for details. |
+| Factory Reset (Optional) | A Factory Reset will remove all prior versions of AMD HIP SDK and drivers. You will not be able to roll back to previously installed drivers. |
+```
+
+```{table} AMD Display Driver Install Types
+:name: display-driver-install-types
+| **Install Type** | **Description** |
+|:----------------:|:---------------:|
+| Full Install     | Provides all AMD Software features and controls for gaming, recording, streaming, and tweaking the performance on your graphics hardware. |
+| Minimal Install  | Provides only the basic controls for AMD Software features and does not include advanced features such as performance tweaking or recording and capturing content. |
+| Driver Only      | Provides no user interface for AMD Software features. |
+```
+
+```{note}
+You must perform a system restart for a complete installation of the
+Display Driver.
+```
+
+### Installing Components
+
+Please wait for the installation to complete during as shown in
+{numref}`install-progress`.
+
+```{figure} /data/deploy/windows/012-install-progress.png
+:name: install-progress
+:alt: Window with AMD arrow logo, futuristic background and progress meter.
+Installation Progress
+```
+
+### Installation Complete
+
+Once the installation is complete, the installer window may prompt you for a
+system restart. Click **Restart** at the lower right corner, shown in
+{numref}`install-complete`
+
+```{figure} /data/deploy/windows/013-install-complete.png
+:name: install-complete
+:alt: Window with AMD arrow logo, futuristic background and completion notice.
+Installation Complete
+```
+
+```{error}
+Should the installer terminate due to unexpcted circumstances, or the user
+forcibly terminates the installer, the temporary directory created under
+`C:\AMD` may be safely removed. Installed components will not depend on this
+folder (unless the user specifies `C:\AMD` as an install folder explicitly).
+```
+
+## Uninstallation
+
+All components, except visual studio plug-in should be uninstalled through
+control panel -> Add/Remove Program. For visual studio extension uninstallation,
+please refer to
+<https://github.com/ROCm-Developer-Tools/HIP-VS/blob/master/README.md>.
+Uninstallation of the HIP SDK components can be done through the Windows
+Settings app. Navigate to "Apps > Installed apps", click the "..." on the far
+right next to the component to uninstall, and click "Uninstall".
+
+```{figure} /data/deploy/windows/014-uninstall-dark.png
+:name: uninstall-dark
+:class: only-dark
+:alt: Installed apps section of the Setting app showing installed HIP SDK components.
+Removing the SDK via the Setting app
+```
+
+```{figure} /data/deploy/windows/014-uninstall-light.png
+:name: uninstall-light
+:class: only-light
+:alt: Installed apps section of the Setting app showing installed HIP SDK components.
+Removing the SDK via the Setting app
+```

docs/examples/machine_learning/migraphx_optimization.md

@@ -24,7 +24,7 @@ MIGraphX is a graph compiler focused on accelerating the Machine Learning infere
 
 After doing all these transformations, MIGraphX emits code for the AMD GPU by calling to MIOpen or rocBLAS or creating HIP kernels for a particular operator. MIGraphX can also target CPUs using DNNL or ZenDNN libraries.
 
-MIGraphX provides easy-to-use APIs in C++ and Python to import machine models in ONNX or TensorFlow. Users can compile, save, load, and run these models using MIGraphX's C++ and Python APIs. Internally, MIGraphX parses ONNX or TensorFlow models into internal graph representation where each operator in the model gets mapped to an operator within MIGraphX. Each of these operators defines various attributes such as:
+MIGraphX provides easy-to-use APIs in C++ and Python to import machine models in ONNX or TensorFlow. Users can compile, save, load, and run these models using the MIGraphX C++ and Python APIs. Internally, MIGraphX parses ONNX or TensorFlow models into internal graph representation where each operator in the model gets mapped to an operator within MIGraphX. Each of these operators defines various attributes such as:
 
 - Number of arguments
 
@@ -187,7 +187,7 @@ Follow these steps:
     }
     ```
 
-2. To compile this program, you can use CMake and you only need to link the `migraphx::c` library to use MIGraphX's C++ API. The following is the `CMakeLists.txt` file that can build the earlier example:
+2. To compile this program, you can use CMake and you only need to link the `migraphx::c` library to use the MIGraphX C++ API. The following is the `CMakeLists.txt` file that can build the earlier example:
 
     ```cmake
     cmake_minimum_required(VERSION 3.5)
@@ -327,7 +327,7 @@ To run generated `.mxr` files through `migraphx-driver`, use the following:
 ./path/to/migraphx-driver run --migraphx resnet50.mxr --enable-offload-copy
 ```
 
-Alternatively, you can use MIGraphX's C++ or Python API to generate `.mxr` file. Refer to {numref}`image018` for an example.
+Alternatively, you can use the MIGraphX C++ or Python API to generate `.mxr` file. Refer to {numref}`image018` for an example.
 
 ```{figure} ../../data/understand/deep_learning/image.018.png
 :name: image018

docs/how_to/all.md

@@ -3,6 +3,14 @@
 :::::{grid} 1 1 2 2
 :gutter: 1
 
+:::{grid-item-card} ROCm using Radeon
+:link: {doc}`ROCm using Radeon <radeon:index>`
+:link-type: url
+ROCm and PyTorch installation processes to pair with the Radeon RX 7900 XTX GPU or the Radeon PRO W7900 GPU,
+and get started on a fully-functional environment for AI and ML development.
+
+:::
+
 :::{grid-item-card} Tuning Guides
 :link: tuning_guides/index
 :link-type: doc

docs/how_to/gpu_aware_mpi.md

@@ -22,7 +22,7 @@ MPI project is an open source implementation of the Message Passing Interface
 and industry partners.
 
 Several MPI implementations can be made ROCm-aware by compiling them with
-[Unified Communication Framework](http://www.openucx.org/) (UCX) support. One
+[Unified Communication Framework](https://www.openucx.org/) (UCX) support. One
 notable exception is MVAPICH2: It directly supports AMD GPUs without using UCX,
 and you can download it [here](http://mvapich.cse.ohio-state.edu/downloads/).
 Use the latest version of the MVAPICH2-GDR package.
@@ -32,7 +32,7 @@ whose goal is to provide a common set of communication interfaces that targets a
 broad set of network programming models and interfaces. UCX is ROCm-aware, and
 ROCm technologies are used directly to implement various network operation
 primitives. For more details on the UCX design, refer to it's
-[documentation](http://www.openucx.org/documentation).
+[documentation](https://www.openucx.org/documentation).
 
 ## Building UCX
 
@@ -66,11 +66,8 @@ cd ucx
 ./autogen.sh
 mkdir build
 cd build
-../contrib/configure-release -prefix=$UCX_DIR \
-    --with-rocm=/opt/rocm \
-    --without-cuda -enable-optimizations -disable-logging \
-    --disable-debug -disable-assertions \
-    --disable-params-check -without-java
+../configure -prefix=$UCX_DIR \
+    --with-rocm=/opt/rocm
 make -j $(nproc)
 make -j $(nproc) install
 ```
@@ -93,9 +90,7 @@ cd ompi
 mkdir build
 cd build
 ../configure --prefix=$OMPI_DIR --with-ucx=$UCX_DIR \
-    --with-rocm=/opt/rocm \
-    --enable-mca-no-build=btl-uct --enable-mpi1-compatibility \
-    CC=clang CXX=clang++ FC=flang
+    --with-rocm=/opt/rocm
 make -j $(nproc)
 make -j $(nproc) install
 ```
@@ -165,7 +160,12 @@ Inter-GPU bandwidth with various payload sizes.
 Collective Operations on GPU buffers are best handled through the
 Unified Collective Communication Library (UCC) component in Open MPI.
 For this, the UCC library has to be configured and compiled with ROCm
-support. An example for configuring UCC and Open MPI with ROCm support
+support.
+
+Please note the compatibility [table](../release/3rd_party_support_matrix.md#communication-libraries)
+for UCC versions with the various ROCm versions.
+
+An example for configuring UCC and Open MPI with ROCm support
 is shown below:
 
 ```shell

docs/how_to/pytorch_install/pytorch_install.md

@@ -59,16 +59,7 @@ Follow these steps:
 
 PyTorch supports the ROCm platform by providing tested wheels packages. To
 access this feature, refer to
-[https://pytorch.org/get-started/locally/](https://pytorch.org/get-started/locally/)
-and choose the "ROCm" compute platform. {numref}`Installation-Matrix-from-Pytorch` is a matrix from <http://pytorch.org/> that illustrates the installation compatibility between ROCm and the PyTorch build.
-
-```{figure} ../../data/how_to/magma_install/image.006.png
-:name: Installation-Matrix-from-Pytorch
----
-align: center
----
-Installation Matrix from Pytorch
-```
+[https://pytorch.org/get-started/locally/](https://pytorch.org/get-started/locally/). For the correct wheels command, you must select 'Linux', 'Python', 'pip', and 'ROCm' in the matrix.
 
 To install PyTorch using the wheels package, follow these installation steps:
 
@@ -83,7 +74,7 @@ To install PyTorch using the wheels package, follow these installation steps:
       installation directions in the section
       [Installation](../../deploy/linux/install.md). ROCm 5.2 is installed in
       this example, as supported by the installation matrix from
-      <http://pytorch.org/>.
+      <https://pytorch.org/>.
 
    or
 
@@ -299,7 +290,7 @@ USE_ROCM=1 MAX_JOBS=4 python3 setup.py install --user
 ### Test the PyTorch Installation
 
 You can use PyTorch unit tests to validate a PyTorch installation. If using a
-prebuilt PyTorch Docker image from AMD ROCm DockerHub or installing an official
+prebuilt PyTorch Docker image from AMD ROCm Docker Hub or installing an official
 wheels package, these tests are already run on those configurations.
 Alternatively, you can manually run the unit tests to validate the PyTorch
 installation fully.
@@ -405,6 +396,22 @@ Follow these steps:
    python3 main.py
    ```
 
+## Using MIOpen kdb files with ROCm PyTorch wheels
+
+PyTorch uses MIOpen for machine learning primitives. These primitives are compiled into kernels at runtime. Runtime compilation causes a small warm-up phase when starting PyTorch. MIOpen kdb files contain precompiled kernels that can speed up the warm-up phase of an application. More information is available in the {doc}`MIOpeninstallation page <miopen:install>`.
+
+MIOpen kdb files can be used with ROCm PyTorch wheels. However, the kdb files need to be placed in a specific location with respect to the PyTorch installation path. A helper script simplifies this task for the user. The script takes in the ROCm version and user's GPU architecture as inputs, and works for Ubuntu and CentOS.
+
+Helper script: [install_kdb_files_for_pytorch_wheels.sh](https://raw.githubusercontent.com/wiki/ROCmSoftwarePlatform/pytorch/files/install_kdb_files_for_pytorch_wheels.sh)
+
+Usage:
+
+After installing ROCm PyTorch wheels:
+
+1. [Optional] `export GFX_ARCH=gfx90a`
+2. [Optional] `export ROCM_VERSION=5.5`
+3. `./install_kdb_files_for_pytorch_wheels.sh`
+
 ## References
 
 C. Szegedy, V. Vanhoucke, S. Ioffe, J. Shlens and Z. Wojna, "Rethinking the Inception Architecture for Computer Vision," CoRR, p. abs/1512.00567, 2015

docs/how_to/system_debugging.md

@@ -64,5 +64,4 @@ Debug messages when developing/debugging base ROCm driver. You could enable the
 
 ## PCIe-Debug
 
-Refer to ROCm PCIe Debug, <a href="https://rocmdocs.amd.com/en/latest/Other_Solutions/PCIe-Debug.html#pcie-debug" target="_blank">https://rocmdocs.amd.com/en/latest/Other_Solutions/PCIe-Debug.html#pcie-debug</a>.
 For information on how to debug and profile HIP applications, see {doc}`hip:how_to_guides/debugging`

docs/how_to/tensorflow_install/tensorflow_install.md

@@ -9,6 +9,19 @@ training and inference in neural networks. It is one of the most popular and
 in-demand frameworks and is very active in open source contribution and
 development.
 
+:::{warning}
+ROCm 5.6 and 5.7 deviates from the standard practice of supporting the last three
+TensorFlow versions. This is due to incompatibilities between earlier TensorFlow
+versions and changes introduced in the ROCm 5.6 compiler. Refer to the following
+version support matrix:
+
+| ROCm  | TensorFlow |
+|:-----:|:----------:|
+| 5.6.x | 2.12       |
+| 5.7.0 | 2.12, 2.13 |
+| Post-5.7.0 | Last three versions at ROCm release. |
+:::
+
 ### Installing TensorFlow
 
 The following sections contain options for installing TensorFlow.
@@ -33,8 +46,8 @@ Follow these steps:
 2. Once you have pulled the image, run it by using the command below:
 
    ```bash
-   docker run -it --network=host --device=/dev/kfd --device=/dev/dri
-   --ipc=host --shm-size 16G --group-add video --cap-add=SYS_PTRACE
+   docker run -it --network=host --device=/dev/kfd --device=/dev/dri \
+   --ipc=host --shm-size 16G --group-add video --cap-add=SYS_PTRACE \
    --security-opt seccomp=unconfined rocm/tensorflow:latest
    ```
 

docs/how_to/tuning_guides/mi100.md

@@ -275,7 +275,7 @@ sudo yum install cpupowerutils
 
 :::
 
-:::{tab-item} SUSE Linux Enterprise Server 15
+:::{tab-item} SUSE Linux Enterprise Server
 :sync: SLES
 
 ```shell
@@ -453,7 +453,7 @@ sudo yum install rocm-bandwidth-test
 
 :::
 
-:::{tab-item} SUSE Linux Enterprise Server 15
+:::{tab-item} SUSE Linux Enterprise Server
 :sync: SLES
 
 ```shell

docs/how_to/tuning_guides/mi200.md

@@ -258,7 +258,7 @@ sudo yum install cpupowerutils
 
 :::
 
-:::{tab-item} SUSE Linux Enterprise Server 15
+:::{tab-item} SUSE Linux Enterprise Server
 :sync: SLES
 
 ```shell
@@ -436,7 +436,7 @@ sudo yum install rocm-bandwidth-test
 
 :::
 
-:::{tab-item} SUSE Linux Enterprise Server 15
+:::{tab-item} SUSE Linux Enterprise Server
 :sync: SLES
 
 ```shell

docs/index.md

@@ -5,11 +5,10 @@
 
 ::::{grid-item}
 :::{dropdown} [What is ROCm?](rocm)
-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. [more...](rocm)
+ROCm is an open-source stack, composed primarily of open-source software (OSS), designed for
+graphics processing unit (GPU) computation. ROCm consists of a collection of drivers, development
+tools, and APIs that enable GPU programming from low-level kernel to end-user applications.
+[more...](rocm)
 
 ::::
 
@@ -18,6 +17,7 @@ agile, flexible, rapid and secure manner. [more...](rocm)
 
 - {doc}`/deploy/linux/index`
 - {doc}`/deploy/docker`
+- {doc}`Deploy ROCm using Radeon <radeon:index>`
 
 :::
 ::::

docs/license.md

@@ -0,0 +1,6 @@
+# License
+
+> Note: This license applies to the [ROCm repository](https://github.com/RadeonOpenCompute/ROCm) that contains documentation primarily. For other licensing information, see the [Licensing Terms page](./release/licensing).
+
+```{include} ../LICENSE
+```

docs/reference/ai_tools.md

@@ -7,6 +7,8 @@
 AMD's library for high performance machine learning primitives.
 
 - {doc}`Documentation <miopen:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/MIOpen)
+- [Changelog](https://github.com/ROCmSoftwarePlatform/MIOpen/blob/develop/CHANGELOG.md)
 
 :::
 
@@ -14,6 +16,8 @@ AMD's library for high performance machine learning primitives.
 Composable Kernel: Performance Portable Programming Model for Machine Learning Tensor Operators
 
 - {doc}`Documentation <composable_kernel:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/composable_kernel)
+- [Changelog](https://github.com/ROCmSoftwarePlatform/composable_kernel/blob/develop/CHANGELOG.md)
 
 :::
 
@@ -21,6 +25,8 @@ Composable Kernel: Performance Portable Programming Model for Machine Learning T
 AMD MIGraphX is AMD's graph inference engine that accelerates machine learning model inference.
 
 - {doc}`Documentation <amdmigraphx:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/AMDMIGraphX)
+- [Changelog](https://github.com/ROCmSoftwarePlatform/AMDMIGraphX/blob/develop/CHANGELOG.md)
 
 :::
 

docs/reference/all.md

@@ -8,8 +8,9 @@
 :::{grid-item-card} [HIP](./hip)
 HIP is both AMD's GPU programming language extension and the GPU runtime.
 
-- {doc}`hip:doxygen/html/index`
-- [Examples](https://github.com/amd/rocm-examples/tree/develop/HIP-Basic)
+- {doc}`HIP <hip:index>`
+- [HIP Examples](https://github.com/amd/rocm-examples/tree/develop/HIP-Basic)
+- {doc}`HIPIFY <hipify:index>`
 
 :::
 
@@ -28,6 +29,7 @@ ROCm template libraries for C++ primitives and algorithms are as follows:
 - {doc}`rocPRIM <rocprim:index>`
 - {doc}`rocThrust <rocthrust:index>`
 - {doc}`hipCUB <hipcub:index>`
+- {doc}`hipTensor <hiptensor:index>`
 
 :::
 
@@ -64,6 +66,7 @@ Computer vision related projects.
 :::{grid-item-card} [Compilers and Tools](compilers)
 
 - [ROCmCC](/reference/rocmcc/rocmcc)
+- {doc}`ROCdbgapi <rocdbgapi:index>`
 - {doc}`ROCgdb <rocgdb:index>`
 - {doc}`ROCProfiler <rocprofiler:rocprof>`
 - {doc}`ROCTracer <roctracer:index>`
@@ -72,9 +75,9 @@ Computer vision related projects.
 
 :::{grid-item-card} [Management Tools](management_tools)
 
-- AMD SMI
-- [ROCm SMI](https://rocmdocs.amd.com/projects/rocm_smi_lib/en/latest/)
-- {doc}`ROCm Datacenter Tool <rdc:index>`
+- {doc}`AMD SMI <amdsmi:index>`
+- {doc}`ROCm SMI <rocm_smi_lib:index>`
+- {doc}`ROCm Data Center Tool <rdc:index>`
 
 :::
 

docs/reference/compilers.md

@@ -3,42 +3,46 @@
 :::::{grid} 1 1 2 2
 :gutter: 1
 
-:::{grid-item-card} ROCmCC
-:link: /reference/rocmcc/rocmcc
-:link-type: doc
+:::{grid-item-card} {doc}`ROCdbgapi <rocdbgapi:index>`
+The AMD Debugger API is a library that provides all the support necessary for a
+debugger and other tools to perform low level control of the execution and
+inspection of execution state of AMD's commercially available GPU architectures.
+
+- {doc}`Documentation <rocdbgapi:index>`
+- [GitHub](https://github.com/ROCm-Developer-Tools/ROCdbgapi/)
+
+:::
+
+:::{grid-item-card} [ROCmCC](./rocmcc/rocmcc)
 ROCmCC is a Clang/LLVM-based compiler. It is optimized for high-performance
 computing on AMD GPUs and CPUs and supports various heterogeneous programming
 models such as HIP, OpenMP, and OpenCL.
 
+- [Documentation](./rocmcc/rocmcc)
+
 :::
 
-:::{grid-item-card} ROCgdb
-:link: rocgdb:index
-:link-type: doc
+:::{grid-item-card} {doc}`ROCgdb <rocgdb:index>`
 This is ROCgdb, the ROCm source-level debugger for Linux, based on GDB, the GNU source-level debugger.
 
+- {doc}`Documentation <rocgdb:index>`
+- [GitHub](https://github.com/ROCm-Developer-Tools/ROCgdb/)
+
 :::
 
-:::{grid-item-card} ROCProfiler
-:link: rocprofiler:rocprof
-:link-type: doc
+:::{grid-item-card} {doc}`ROCProfiler <rocprofiler:rocprof>`
 ROC profiler library. Profiling with performance counters and derived metrics. Library supports GFX8/GFX9. Hardware specific low-level performance analysis interface for profiling of GPU compute applications. The profiling includes hardware performance counters with complex performance metrics.
 
-:::
-
-:::{grid-item-card} ROCTracer
-:link: roctracer:index
-:link-type: doc
-Callback/Activity Library for Performance tracing AMD GPU's
+- {doc}`Documentation <rocprofiler:rocprof>`
+- [GitHub](https://github.com/ROCm-Developer-Tools/rocprofiler/)
 
 :::
 
-:::{grid-item-card} ROCdbgapi
-:link: rocdbgapi:index
-:link-type: doc
-The AMD Debugger API is a library that provides all the support necessary for a
-debugger and other tools to perform low level control of the execution and
-inspection of execution state of AMD's commercially available GPU architectures.
+:::{grid-item-card} {doc}`ROCTracer <roctracer:index>`
+Callback/Activity Library for Performance tracing AMD GPUs
+
+- {doc}`Documentation <roctracer:index>`
+- [GitHub](https://github.com/ROCm-Developer-Tools/roctracer)
 
 :::
 

docs/reference/computer_vision.md

@@ -7,6 +7,8 @@
 MIVisionX toolkit is a set of comprehensive computer vision and machine intelligence libraries, utilities, and applications bundled into a single toolkit. AMD MIVisionX also delivers a highly optimized open-source implementation of the Khronos OpenVX™ and OpenVX™ Extensions.
 
 - {doc}`Documentation <mivisionx:README>`
+- [GitHub](https://github.com/GPUOpen-ProfessionalCompute-Libraries/MIVisionX/)
+- [Changelog](https://github.com/GPUOpen-ProfessionalCompute-Libraries/MIVisionX/blob/master/CHANGELOG.md)
 
 :::
 

docs/reference/docker.md

@@ -1 +0,0 @@
-# Docker

docs/reference/gpu_libraries/c++_primitives.md

@@ -11,6 +11,7 @@ transforms, reductions, scans, etc. It also serves as a common back-end for
 similar libraries found inside ROCm.
 
 - {doc}`Documentation <rocprim:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/rocPRIM/)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/rocPRIM/blob/develop/CHANGELOG.md)
 - [Examples](https://github.com/amd/rocm-examples/tree/develop/Libraries/rocPRIM)
 
@@ -22,6 +23,7 @@ interface. Their CPU back-ends are identical, while the GPU back-end calls into
 rocPRIM.
 
 - {doc}`Documentation <rocthrust:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/rocThrust)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/rocThrust/blob/develop/CHANGELOG.md)
 - [Examples](https://github.com/amd/rocm-examples/tree/develop/Libraries/rocThrust)
 
@@ -32,9 +34,20 @@ hipCUB is a template library of algorithm primitives with a CUB-compatible
 interface. It's back-end is rocPRIM.
 
 - {doc}`Documentation <hipcub:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/hipCUB)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/hipCUB/blob/develop/CHANGELOG.md)
 - [Examples](https://github.com/amd/rocm-examples/tree/develop/Libraries/hipCUB)
 
 :::
 
+:::{grid-item-card} {doc}`hipTensor <hiptensor:index>`
+hipTensor is AMD's C++ library for accelerating tensor primitives
+based on the composable kernel library,
+through general purpose kernel languages, like HIP C++.
+
+- {doc}`Documentation <hiptensor:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/hipTensor)
+
+:::
+
 :::::

docs/reference/gpu_libraries/communication.md

@@ -10,6 +10,7 @@ The collective operations are implemented using ring and tree algorithms and hav
 throughput and latency.
 
 - {doc}`Documentation <rccl:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/rccl)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/rocFFT/blob/develop/CHANGELOG.md)
 - [Examples](https://github.com/ROCmSoftwarePlatform/rccl/tree/develop/tools)
 

docs/reference/gpu_libraries/fft.md

@@ -9,6 +9,7 @@ ROCm libraries for FFT are as follows:
 rocFFT is an AMD GPU optimized library for FFT.
 
 - {doc}`Documentation <rocfft:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/rocFFT)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/rocFFT/blob/develop/CHANGELOG.md)
 
 :::
@@ -19,6 +20,7 @@ using rocFFT. hipFFT allows for a common interface for other non AMD GPU
 FFT libraries.
 
 - {doc}`Documentation <hipfft:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/hipFFT)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/hipFFT/blob/develop/CHANGELOG.md)
 
 :::

docs/reference/gpu_libraries/linear_algebra.md

@@ -9,6 +9,7 @@ ROCm libraries for linear algebra are as follows:
 `rocBLAS` is an AMD GPU optimized library for BLAS (Basic Linear Algebra Subprograms).
 
 - {doc}`Documentation <rocblas:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/rocBLAS)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/rocBLAS/blob/develop/CHANGELOG.md)
 - [Examples](https://github.com/amd/rocm-examples/tree/develop/Libraries/rocBLAS)
 
@@ -20,6 +21,7 @@ via `rocBLAS` and `rocSOLVER`. `hipBLAS` allows for a common interface for other
 BLAS libraries.
 
 - {doc}`Documentation <hipblas:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/hipBLAS)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/hipBLAS/blob/develop/CHANGELOG.md)
 
 :::
@@ -31,6 +33,7 @@ flexible API and extends functionalities beyond traditional BLAS library.
 optimized generator as a back-end kernel provider.
 
 - {doc}`Documentation <hipblaslt:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/hipBLASLt)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/hipBLASLt/blob/develop/CHANGELOG.md)
 
 :::
@@ -41,6 +44,7 @@ fine-grained parallelism on top of AMD's ROCm runtime and toolchains, targeting
 modern CPU and GPU platforms.
 
 - {doc}`Documentation <rocalution:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/rocALUTION)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/rocALUTION/blob/develop/CHANGELOG.md)
 
 :::
@@ -50,6 +54,7 @@ modern CPU and GPU platforms.
 (MMA) problems into fragments and distributes these over GPU wavefronts.
 
 - {doc}`Documentation <rocwmma:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/rocWMMA)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/rocWMMA/blob/develop/CHANGELOG.md)
 
 :::
@@ -58,6 +63,7 @@ modern CPU and GPU platforms.
 `rocSOLVER` provides a subset of LAPACK (Linear Algebra Package) functionality on the ROCm platform.
 
 - {doc}`Documentation <rocsolver:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/rocSOLVER)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/rocSOLVER/blob/develop/CHANGELOG.md)
 
 :::
@@ -67,6 +73,7 @@ modern CPU and GPU platforms.
 as backends whilst exporting a unified interface.
 
 - {doc}`Documentation <hipsolver:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/hipSOLVER)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/hipSOLVER/blob/develop/CHANGELOG.md)
 
 :::
@@ -75,6 +82,7 @@ as backends whilst exporting a unified interface.
 `rocSPARSE` is a library to provide BLAS for sparse computations.
 
 - {doc}`Documentation <rocsparse:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/rocSPARSE)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/rocSOLVER/blob/develop/CHANGELOG.md)
 
 :::
@@ -84,8 +92,18 @@ as backends whilst exporting a unified interface.
 supporting both `rocSPARSE` and `cuSPARSE` as backends.
 
 - {doc}`Documentation <hipsparse:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/hipSPARSE)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/hipSOLVER/blob/develop/CHANGELOG.md)
 
 :::
 
+:::{grid-item-card} {doc}`hipSPARSELt <hipsparselt:index>`
+`hipSPARSE` is a marshalling library to provide sparse BLAS functionality,
+supporting both `rocSPARSELt` and `cuSPARSELt` as backends.
+
+- {doc}`Documentation <hipsparselt:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/hipSPARSELt)
+
+:::
+
 :::::

docs/reference/gpu_libraries/math.md

@@ -1,6 +1,6 @@
 # Math Libraries
 
-AMD provides various math domain and support libraries as part of the ROCm.
+AMD provides various math domain and support libraries as part of ROCm.
 
 ## rocLIB vs. hipLIB
 
@@ -26,6 +26,7 @@ at compile-time of the hipLIB in question. For dynamic dispatch between vendor i
 - {doc}`hipSOLVER <hipsolver:index>`
 - {doc}`rocSPARSE <rocsparse:index>`
 - {doc}`hipSPARSE <hipsparse:index>`
+- {doc}`hipSPARSELt <hipsparselt:index>`
 
 :::
 

docs/reference/gpu_libraries/rand.md

@@ -7,6 +7,7 @@
 rocRAND is an AMD GPU optimized library for pseudo-random number generators (PRNG).
 
 - {doc}`Documentation <rocrand:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/rocRAND/)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/rocRAND/blob/develop/CHANGELOG.md)
 - [Examples](https://github.com/amd/rocm-examples/tree/develop/Libraries/rocRAND)
 
@@ -18,6 +19,7 @@ generation (PRNG) optimized for AMD GPUs using rocRAND. hipRAND allows for a
 common interface for other non AMD GPU PRNG libraries.
 
 - {doc}`Documentation <hiprand:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/hipRAND/)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/hipRAND/blob/develop/CHANGELOG.md)
 
 :::