Update README

Merge 5.7 changes into Develop

.github/CODEOWNERS

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

.github/dependabot.yml

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

.gitignore

@@ -1,23 +0,0 @@
-.venv
-.vscode
-build
-
-# documentation artifacts
-_build/
-_images/
-_static/
-_templates/
-_toc.yml
-docBin/
-_doxygen/
-_readthedocs/
-
-# avoid duplicating contributing.md due to conf.py
-docs/contributing.md
-docs/release.md
-docs/CHANGELOG.md
-
-# auto-generated files
-docs/deploy/linux/installer/install.md
-docs/deploy/linux/os-native/install.md
-docs/deploy/linux/quick_start.md

.markdownlint-cli2.yaml

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

.readthedocs.yaml

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

.wordlist.txt

@@ -1,686 +0,0 @@
-AAC
-ABI
-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
-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
-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

@@ -1,71 +0,0 @@
-# Contributing to ROCm Docs
-
-AMD values and encourages the ROCm community to contribute to our code and
-documentation. This repository is focused on ROCm documentation and this
-contribution guide describes the recommended method for creating and modifying our
-documentation.
-
-While interacting with ROCm Documentation, we encourage you to be polite and
-respectful in your contributions, content or otherwise. Authors, maintainers of
-these docs act on good intentions and to the best of their knowledge.
-Keep that in mind while you engage. Should you have issues with contributing
-itself, refer to
-[discussions](https://github.com/RadeonOpenCompute/ROCm/discussions) on the
-GitHub repository.
-
-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 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 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
-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).
-  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 (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
-
-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
-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](https://github.com/RadeonOpenCompute/rocm-docs-core).
-Raise issues in `rocm-docs-core` for any formatting concerns and changes requested.
-
-## More
-
-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)

LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

README.md

@@ -1,50 +1,13 @@
-# AMD ROCm™ Platform
-
-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.
-
-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 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.
-
-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
-
-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
-
-```bash
-cd docs
-
-pip3 install -r sphinx/requirements.txt
-
-python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
-```
-
-## Older ROCm Releases
-
-For release information for older ROCm releases, refer to
-[`CHANGELOG`](./CHANGELOG.md).
+# rocm-docs-redirects
+
+Redirects ReadtheDocs Community documentation sites to Business
+
+## Building
+
+```shell
+cd docs
+
+pip3 install -r sphinx/requirements.txt
+
+python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
+```

RELEASE.md

@@ -1,77 +0,0 @@
-# Release Notes
-<!-- Do not edit this file! This file is autogenerated with -->
-<!--   tools/autotag/tag_script.py                          -->
-
-<!-- Disable lints since this is an auto-generated file.    -->
-<!-- markdownlint-disable blanks-around-headers             -->
-<!-- markdownlint-disable no-duplicate-header               -->
-<!-- markdownlint-disable no-blanks-blockquote              -->
-<!-- markdownlint-disable ul-indent                         -->
-<!-- markdownlint-disable no-trailing-spaces                -->
-
-<!-- spellcheck-disable -->
-
-The release notes for the ROCm platform.
-
--------------------
-
-## ROCm 5.7.1
-<!-- markdownlint-disable first-line-h1 -->
-<!-- markdownlint-disable no-duplicate-header -->
-
-### What's New in This Release
-
-### ROCm Libraries
-
-#### 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.
-
-*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.
-
-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).
-
-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.
-
-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.
-
-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)
-
-#### HIP 5.7.1 (for ROCm 5.7.1)
-
-ROCm 5.7.1 is a point release with several bug fixes in the HIP runtime.
-
-### Fixed defects
-The *hipPointerGetAttributes* API returns the correct HIP memory type as *hipMemoryTypeManaged* for managed memory.
-
-
-
-### Library Changes in ROCM 5.7.1
-
-| 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) |
-
-#### hipSOLVER 1.8.2
-
-hipSOLVER 1.8.2 for ROCm 5.7.1
-
-##### Fixed
-
-- Fixed conflicts between the hipsolver-dev and -asan packages by excluding
-  hipsolver_module.f90 from the latter

default.xml

@@ -1,79 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<manifest>
-    <remote name="roc-github"
-fetch="https://github.com/RadeonOpenCompute/" />
-    <remote name="rocm-devtools"
-fetch="https://github.com/ROCm-Developer-Tools/" />
-    <remote name="rocm-swplat"
-fetch="https://github.com/ROCmSoftwarePlatform/" />
-    <remote name="gpuopen-libs"
-fetch="https://github.com/GPUOpen-ProfessionalCompute-Libraries/" />
-    <remote name="gpuopen-tools"
-fetch="https://github.com/GPUOpen-Tools/" />
-    <remote name="KhronosGroup"
-fetch="https://github.com/KhronosGroup/" />
-    <default revision="refs/tags/rocm-5.7.1"
-     remote="roc-github"
-     sync-c="true"
-     sync-j="4" />
-<!--list of projects for ROCM-->
-    <project name="ROCK-Kernel-Driver" />
-    <project name="ROCT-Thunk-Interface" />
-    <project name="ROCR-Runtime" />
-    <project name="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 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="HIP-Examples" 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="ROCm-CompilerSupport" />
-    <project name="half" remote="rocm-swplat" revision="37742ce15b76b44e4b271c1e66d13d2fa7bd003e" />
-<!-- 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 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" />
-    <project groups="mathlibs" name="rocRAND" remote="rocm-swplat" />
-    <project groups="mathlibs" name="rocSPARSE" remote="rocm-swplat" />
-    <project groups="mathlibs" name="rocSOLVER" remote="rocm-swplat" />
-    <project groups="mathlibs" name="hipSOLVER" remote="rocm-swplat" />
-    <project groups="mathlibs" name="hipSPARSE" remote="rocm-swplat" />
-    <project groups="mathlibs" name="rocALUTION" remote="rocm-swplat" />
-    <project 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" />
-<!-- Projects for OpenMP-Extras -->
-    <project name="aomp" path="openmp-extras/aomp" remote="rocm-devtools" />
-    <project name="aomp-extras" path="openmp-extras/aomp-extras" remote="rocm-devtools" />
-    <project name="flang" path="openmp-extras/flang" remote="rocm-devtools" />
-</manifest>

docs/.gitignore

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

docs/about.md

@@ -1,74 +0,0 @@
-# About ROCm Documentation
-
-ROCm documentation is made available under open source [licenses](licensing.md).
-Documentation is built using open source toolchains. Contributions to our
-documentation is encouraged and welcome. As a contributor, please familiarize
-yourself with our documentation toolchain.
-
-## `rocm-docs-core`
-
-[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/).
-
-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 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 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
-
-[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
-example.
-
-### Sphinx Book Theme
-
-[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.
-
-### Sphinx Design
-
-[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.rst

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

docs/about/licensing.md

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

@@ -1,122 +1,11 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-import shutil
-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.7.1"
-release = "5.7.1"
-
-setting_all_article_info = True
-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"]},
-    {"file":"deploy/linux/quick_start", "os":["linux"]},
-    {"file":"deploy/linux/install", "os":["linux"]},
-    {"file":"deploy/linux/upgrade", "os":["linux"]},
-    {"file":"deploy/linux/uninstall", "os":["linux"]},
-    {"file":"deploy/linux/package_manager_integration", "os":["linux"]},
-    {"file":"deploy/docker", "os":["linux"]},
-    
-    {"file":"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"]},
-    {"file":"reference/ai_tools", "os":["linux"]},
-    {"file":"reference/management_tools", "os":["linux"]},
-    {"file":"reference/validation_tools", "os":["linux"]},
-    {"file":"reference/framework_compatibility/framework_compatibility", "os":["linux"]},
-    {"file":"reference/computer_vision", "os":["linux"]},
-    
-    {"file":"how_to/deep_learning_rocm", "os":["linux"]},
-    {"file":"how_to/gpu_aware_mpi", "os":["linux"]},
-    {"file":"how_to/magma_install/magma_install", "os":["linux"]},
-    {"file":"how_to/pytorch_install/pytorch_install", "os":["linux"]},
-    {"file":"how_to/system_debugging", "os":["linux"]},
-    {"file":"how_to/tensorflow_install/tensorflow_install", "os":["linux"]},
-
-    {"file":"examples/machine_learning", "os":["linux"]},
-    {"file":"examples/inception_casestudy/inception_casestudy", "os":["linux"]},
-    
-    {"file":"understand/file_reorg", "os":["linux"]},
-
-    {"file":"understand/isv_deployment_win", "os":["windows"]},
-]
-
-external_toc_path = "./sphinx/_toc.yml"
-
-docs_core = ROCmDocs("ROCm 5.7.1 Documentation Home")
-docs_core.setup()
-
-external_projects_current_project = "rocm"
-
-for sphinx_var in ROCmDocs.SPHINX_VARS:
-    globals()[sphinx_var] = getattr(docs_core, sphinx_var)
-html_theme_options = {
-    "link_main_doc": False
-}
+from rocm_docs import ROCmDocs
+
+external_toc_path = "./sphinx/_toc.yml"
+
+docs_core = ROCmDocs("rocm-docs-redirects")
+docs_core.setup()
+
+external_projects_current_project = "rocm"
+
+for sphinx_var in ROCmDocs.SPHINX_VARS:
+    globals()[sphinx_var] = getattr(docs_core, sphinx_var)

docs/contribute/building.md

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

@@ -1,27 +0,0 @@
-# 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/deploy/docker.md

@@ -1,90 +0,0 @@
-# Deploy ROCm Docker containers
-
-## Prerequisites
-
-Docker containers share the kernel with the host operating system, therefore the
-ROCm kernel-mode driver must be installed on the host. Please refer to
-{ref}`using-the-package-manager` on installing `amdgpu-dkms`. The other
-user-space parts (like the HIP-runtime or math libraries) of the ROCm stack will
-be loaded from the container image and don't need to be installed to the host.
-
-(docker-access-gpus-in-container)=
-
-## Accessing GPUs in containers
-
-In order to access GPUs in a container (to run applications using HIP, OpenCL or
-OpenMP offloading) explicit access to the GPUs must be granted.
-
-The ROCm runtimes make use of multiple device files:
-
-- `/dev/kfd`: the main compute interface shared by all GPUs
-- `/dev/dri/renderD<node>`: direct rendering interface (DRI) devices for each
-  GPU. **`<node>`** is a number for each card in the system starting from 128.
-
-Exposing these devices to a container is done by using the
-[`--device`](https://docs.docker.com/engine/reference/commandline/run/#device)
-option, i.e. to allow access to all GPUs expose `/dev/kfd` and all
-`/dev/dri/renderD` devices:
-
-```shell
-docker run --device /dev/kfd --device /dev/dri/renderD128 --device /dev/dri/renderD129 ...
-```
-
-More conveniently, instead of listing all devices, the entire `/dev/dri` folder
-can be exposed to the new container:
-
-```shell
-docker run --device /dev/kfd --device /dev/dri
-```
-
-Note that this gives more access than strictly required, as it also exposes the
-other device files found in that folder to the container.
-
-(docker-restrict-gpus)=
-
-### Restricting a container to a subset of the GPUs
-
-If a `/dev/dri/renderD` device is not exposed to a container then it cannot use
-the GPU associated with it; this allows to restrict a container to any subset of
-devices.
-
-For example to allow the container to access the first and third GPU start it
-like:
-
-```shell
-docker run --device /dev/kfd --device /dev/dri/renderD128 --device /dev/dri/renderD130 <image>
-```
-
-### Additional Options
-
-The performance of an application can vary depending on the assignment of GPUs
-and CPUs to the task. Typically, `numactl` is installed as part of many HPC
-applications to provide GPU/CPU mappings. This Docker runtime option supports
-memory mapping and can improve performance.
-
-```shell
---security-opt seccomp=unconfined
-```
-
-This option is recommended for Docker Containers running HPC applications.
-
-```shell
-docker run --device /dev/kfd --device /dev/dri --security-opt seccomp=unconfined ...
-```
-
-## Docker images in the ROCm ecosystem
-
-### Base images
-
-<https://github.com/RadeonOpenCompute/ROCm-docker> hosts images useful for users
-wishing to build their own containers leveraging ROCm. The built images are
-available from [Docker Hub](https://hub.docker.com/u/rocm). In particular
-`rocm/rocm-terminal` is a small image with the prerequisites to build HIP
-applications, but does not include any libraries.
-
-### Applications
-
-AMD provides pre-built images for various GPU-ready applications through its
-Infinity Hub at <https://www.amd.com/en/technologies/infinity-hub>.
-Examples for invoking each application and suggested parameters used for
-benchmarking are also provided there.