Update documentation requirements

The hip-devel package depends on perl modules not distributed by default
on RHEL and SLES distriubutions, these can be installed from EPEL and
the `devel:languages:perl` repository respectively.

Ideally in the future these dependencies would be replaced with packages
available from default repositories, but in the meanwhile this should
be at least documented.

.github/CODEOWNERS

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

.github/dependabot.yml

@@ -0,0 +1,12 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/docs/sphinx" # Location of package manifests
+    open-pull-requests-limit: 10
+    schedule:
+      interval: "daily"

.github/workflows/linting.yml

@@ -0,0 +1,56 @@
+name: Linting
+
+on:
+  push:
+    branches: 
+    - develop
+    - main
+  pull_request:
+    branches: 
+    - develop
+    - main
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+  lint-rest:
+    name: "RestructuredText"
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+    - name: Install rst-lint
+      run: pip install restructuredtext-lint
+    - name: Lint ResT files
+      run: rst-lint ${{ join(github.workspace, '/docs') }}
+
+  lint-md:
+    name: "Markdown"
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+    - name: Use markdownlint-cli2
+      uses: DavidAnson/markdownlint-cli2-action@v10.0.1
+      with:
+        globs: '**/*.md'
+
+  spelling:
+    name: "Spelling"
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+    - name: Fetch config
+      shell: sh
+      run: |
+        curl --silent --show-error --fail --location https://raw.github.com/RadeonOpenCompute/rocm-docs-core/develop/.spellcheck.yaml -O
+        curl --silent --show-error --fail --location https://raw.github.com/RadeonOpenCompute/rocm-docs-core/develop/.wordlist.txt >> .wordlist.txt
+    - name: Run spellcheck
+      uses: rojopolis/spellcheck-github-actions@0.30.0
+    - name: On fail
+      if: failure()
+      run: |
+        echo "Please check for spelling mistakes or add them to '.wordlist.txt' in either the root of this project or in rocm-docs-core."

.gitignore

@@ -0,0 +1,18 @@
+.venv
+.vscode
+build
+
+# documentation artifacts
+_build/
+_images/
+_static/
+_templates/
+_toc.yml
+docBin/
+_doxygen/
+_readthedocs/
+
+# avoid duplicating contributing.md due to conf.py
+docs/contributing.md
+docs/release.md
+docs/CHANGELOG.md

.markdownlint-cli2.yaml

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

.readthedocs.yaml

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

.wordlist.txt

@@ -0,0 +1,29 @@
+# isv_deployment_win
+ABI
+# gpu_aware_mpi
+DMA
+GDR
+HCA
+MPI
+MVAPICH
+Mellanox's
+NIC
+OFED
+OSU
+OpenFabrics
+PeerDirect
+RDMA
+UCX
+ib_core
+# linear algebra
+LAPACK
+MMA
+backends
+cuSOLVER
+cuSPARSE
+# tuning_guides
+BMC
+DGEMM
+HPCG
+HPL
+IOPM

CHANGELOG.md

@@ -0,0 +1,771 @@
+# 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.0.1
+<!-- markdownlint-disable first-line-h1 -->
+### Deprecations and Warnings
+
+#### Refactor of HIPCC/HIPCONFIG
+
+In prior ROCm releases, by default, the hipcc/hipconfig Perl scripts were used to identify and set target compiler options, target platform, compiler, and runtime appropriately.
+
+In ROCm v5.0.1, hipcc.bin and hipconfig.bin have been added as the compiled binary implementations of the hipcc and hipconfig. These new binaries are currently a work-in-progress, considered, and marked as experimental. ROCm plans to fully transition to hipcc.bin and hipconfig.bin in the a future ROCm release. The existing hipcc and hipconfig Perl scripts are renamed to hipcc.pl and hipconfig.pl respectively. New top-level hipcc and hipconfig Perl scripts are created, which can switch between the Perl script or the compiled binary based on the environment variable HIPCC_USE_PERL_SCRIPT.
+
+In ROCm 5.0.1, by default, this environment variable is set to use hipcc and hipconfig through the Perl scripts.
+
+Subsequently, Perl scripts will no longer be available in ROCm in a future release.
+
+### Library Changes in ROCM 5.0.1
+
+| Library | Version |
+|---------|---------|
+| hipBLAS | [0.49.0](https://github.com/ROCmSoftwarePlatform/hipBLAS/releases/tag/rocm-5.0.1) |
+| hipCUB | [2.10.13](https://github.com/ROCmSoftwarePlatform/hipCUB/releases/tag/rocm-5.0.1) |
+| hipFFT | [1.0.4](https://github.com/ROCmSoftwarePlatform/hipFFT/releases/tag/rocm-5.0.1) |
+| hipSOLVER | [1.2.0](https://github.com/ROCmSoftwarePlatform/hipSOLVER/releases/tag/rocm-5.0.1) |
+| hipSPARSE | [2.0.0](https://github.com/ROCmSoftwarePlatform/hipSPARSE/releases/tag/rocm-5.0.1) |
+| rccl | [2.10.3](https://github.com/ROCmSoftwarePlatform/rccl/releases/tag/rocm-5.0.1) |
+| rocALUTION | [2.0.1](https://github.com/ROCmSoftwarePlatform/rocALUTION/releases/tag/rocm-5.0.1) |
+| rocBLAS | [2.42.0](https://github.com/ROCmSoftwarePlatform/rocBLAS/releases/tag/rocm-5.0.1) |
+| rocFFT | [1.0.13](https://github.com/ROCmSoftwarePlatform/rocFFT/releases/tag/rocm-5.0.1) |
+| rocPRIM | [2.10.12](https://github.com/ROCmSoftwarePlatform/rocPRIM/releases/tag/rocm-5.0.1) |
+| rocRAND | [2.10.12](https://github.com/ROCmSoftwarePlatform/rocRAND/releases/tag/rocm-5.0.1) |
+| rocSOLVER | [3.16.0](https://github.com/ROCmSoftwarePlatform/rocSOLVER/releases/tag/rocm-5.0.1) |
+| rocSPARSE | [2.0.0](https://github.com/ROCmSoftwarePlatform/rocSPARSE/releases/tag/rocm-5.0.1) |
+| rocThrust | [2.13.0](https://github.com/ROCmSoftwarePlatform/rocThrust/releases/tag/rocm-5.0.1) |
+| Tensile | [4.31.0](https://github.com/ROCmSoftwarePlatform/Tensile/releases/tag/rocm-5.0.1) |
+
+-------------------
+
+## ROCm 5.0.0
+<!-- markdownlint-disable first-line-h1 -->
+<!-- markdownlint-disable no-blanks-blockquote -->
+### What's New in This Release
+
+#### HIP Enhancements
+
+The ROCm v5.0 release consists of the following HIP enhancements.
+
+##### HIP Installation Guide Updates
+
+The HIP Installation Guide is updated to include building HIP from source on the NVIDIA platform.
+
+Refer to the HIP Installation Guide v5.0 for more details.
+
+##### Managed Memory Allocation
+
+Managed memory, including the `__managed__` keyword, is now supported in the HIP combined host/device compilation. Through unified memory allocation, managed memory allows data to be shared and accessible to both the CPU and GPU using a single pointer. The allocation is managed by the AMD GPU driver using the Linux Heterogeneous Memory Management (HMM) mechanism. The user can call managed memory API hipMallocManaged to allocate a large chunk of HMM memory, execute kernels on a device, and fetch data between the host and device as needed.
+
+> **Note**
+>
+> In a HIP application,  it is recommended to do a capability check before calling the managed memory APIs. For example,
+>
+> ```cpp
+> int managed_memory = 0;
+> HIPCHECK(hipDeviceGetAttribute(&managed_memory,
+>   hipDeviceAttributeManagedMemory,p_gpuDevice));
+> if (!managed_memory ) {
+>   printf ("info: managed memory access not supported on the device %d\n Skipped\n", p_gpuDevice);
+> }
+> else {
+>   HIPCHECK(hipSetDevice(p_gpuDevice));
+>   HIPCHECK(hipMallocManaged(&Hmm, N * sizeof(T)));
+> . . .
+> }
+> ```
+
+> **Note**
+>
+> The managed memory capability check may not be necessary; however, if HMM is not supported, managed malloc will fall back to using system memory. Other managed memory API calls will, then, have
+
+Refer to the HIP API documentation for more details on managed memory APIs.
+
+For the application, see
+
+<https://github.com/ROCm-Developer-Tools/HIP/blob/rocm-4.5.x/tests/src/runtimeApi/memory/hipMallocManaged.cpp>
+
+#### New Environment Variable
+
+The following new environment variable is added in this release:
+
+| Environment Variable | Value                 | Description |
+|----------------------|-----------------------|-------------|
+| HSA_COOP_CU_COUNT    | 0 or 1 (default is 0) | Some processors support more CUs than can reliably be used in a cooperative dispatch. Setting the environment variable HSA_COOP_CU_COUNT to 1 will cause ROCr to return the correct CU count for cooperative groups through the HSA_AMD_AGENT_INFO_COOPERATIVE_COMPUTE_UNIT_COUNT attribute of hsa_agent_get_info(). Setting HSA_COOP_CU_COUNT to other values, or leaving it unset, will cause ROCr to return the same CU count for the attributes HSA_AMD_AGENT_INFO_COOPERATIVE_COMPUTE_UNIT_COUNT and HSA_AMD_AGENT_INFO_COMPUTE_UNIT_COUNT. Future ROCm releases will make HSA_COOP_CU_COUNT=1 the default. |
+
+### Breaking Changes
+
+#### Runtime Breaking Change
+
+Re-ordering of the enumerated type in hip_runtime_api.h to better match NV.  See below for the difference in enumerated types.
+
+ROCm software will be affected if any of the defined enums listed below are used in the code.  Applications built with ROCm v5.0 enumerated types will work with a ROCm 4.5.2 driver. However, an undefined behavior error will occur with a ROCm v4.5.2 application that uses these enumerated types with a ROCm 5.0 runtime.
+
+```diff
+typedef enum hipDeviceAttribute_t {
+-    hipDeviceAttributeMaxThreadsPerBlock,       ///< Maximum number of threads per block.
+-    hipDeviceAttributeMaxBlockDimX,             ///< Maximum x-dimension of a block.
+-    hipDeviceAttributeMaxBlockDimY,             ///< Maximum y-dimension of a block.
+-    hipDeviceAttributeMaxBlockDimZ,             ///< Maximum z-dimension of a block.
+-    hipDeviceAttributeMaxGridDimX,              ///< Maximum x-dimension of a grid.
+-    hipDeviceAttributeMaxGridDimY,              ///< Maximum y-dimension of a grid.
+-    hipDeviceAttributeMaxGridDimZ,              ///< Maximum z-dimension of a grid.
+-    hipDeviceAttributeMaxSharedMemoryPerBlock,  ///< Maximum shared memory available per block in
+-                                                ///< bytes.
+-    hipDeviceAttributeTotalConstantMemory,      ///< Constant memory size in bytes.
+-    hipDeviceAttributeWarpSize,                 ///< Warp size in threads.
+-    hipDeviceAttributeMaxRegistersPerBlock,  ///< Maximum number of 32-bit registers available to a
+-                                             ///< thread block. This number is shared by all thread
+-                                             ///< blocks simultaneously resident on a
+-                                             ///< multiprocessor.
+-    hipDeviceAttributeClockRate,             ///< Peak clock frequency in kilohertz.
+-    hipDeviceAttributeMemoryClockRate,       ///< Peak memory clock frequency in kilohertz.
+-    hipDeviceAttributeMemoryBusWidth,        ///< Global memory bus width in bits.
+-    hipDeviceAttributeMultiprocessorCount,   ///< Number of multiprocessors on the device.
+-    hipDeviceAttributeComputeMode,           ///< Compute mode that device is currently in.
+-    hipDeviceAttributeL2CacheSize,  ///< Size of L2 cache in bytes. 0 if the device doesn't have L2
+-                                    ///< cache.
+-    hipDeviceAttributeMaxThreadsPerMultiProcessor,  ///< Maximum resident threads per
+-                                                    ///< multiprocessor.
+-    hipDeviceAttributeComputeCapabilityMajor,       ///< Major compute capability version number.
+-    hipDeviceAttributeComputeCapabilityMinor,       ///< Minor compute capability version number.
+-    hipDeviceAttributeConcurrentKernels,  ///< Device can possibly execute multiple kernels
+-                                          ///< concurrently.
+-    hipDeviceAttributePciBusId,           ///< PCI Bus ID.
+-    hipDeviceAttributePciDeviceId,        ///< PCI Device ID.
+-    hipDeviceAttributeMaxSharedMemoryPerMultiprocessor,  ///< Maximum Shared Memory Per
+-                                                         ///< Multiprocessor.
+-    hipDeviceAttributeIsMultiGpuBoard,                   ///< Multiple GPU devices.
+-    hipDeviceAttributeIntegrated,                        ///< iGPU
+-    hipDeviceAttributeCooperativeLaunch,                 ///< Support cooperative launch
+-    hipDeviceAttributeCooperativeMultiDeviceLaunch,      ///< Support cooperative launch on multiple devices
+-    hipDeviceAttributeMaxTexture1DWidth,    ///< Maximum number of elements in 1D images
+-    hipDeviceAttributeMaxTexture2DWidth,    ///< Maximum dimension width of 2D images in image elements
+-    hipDeviceAttributeMaxTexture2DHeight,   ///< Maximum dimension height of 2D images in image elements
+-    hipDeviceAttributeMaxTexture3DWidth,    ///< Maximum dimension width of 3D images in image elements
+-    hipDeviceAttributeMaxTexture3DHeight,   ///< Maximum dimensions height of 3D images in image elements
+-    hipDeviceAttributeMaxTexture3DDepth,    ///< Maximum dimensions depth of 3D images in image elements
++    hipDeviceAttributeCudaCompatibleBegin = 0,
+
+-    hipDeviceAttributeHdpMemFlushCntl,      ///< Address of the HDP_MEM_COHERENCY_FLUSH_CNTL register
+-    hipDeviceAttributeHdpRegFlushCntl,      ///< Address of the HDP_REG_COHERENCY_FLUSH_CNTL register
++    hipDeviceAttributeEccEnabled = hipDeviceAttributeCudaCompatibleBegin, ///< Whether ECC support is enabled.
++    hipDeviceAttributeAccessPolicyMaxWindowSize,        ///< Cuda only. The maximum size of the window policy in bytes.
++    hipDeviceAttributeAsyncEngineCount,                 ///< Cuda only. Asynchronous engines number.
++    hipDeviceAttributeCanMapHostMemory,                 ///< Whether host memory can be mapped into device address space
++    hipDeviceAttributeCanUseHostPointerForRegisteredMem,///< Cuda only. Device can access host registered memory
++                                                        ///< at the same virtual address as the CPU
++    hipDeviceAttributeClockRate,                        ///< Peak clock frequency in kilohertz.
++    hipDeviceAttributeComputeMode,                      ///< Compute mode that device is currently in.
++    hipDeviceAttributeComputePreemptionSupported,       ///< Cuda only. Device supports Compute Preemption.
++    hipDeviceAttributeConcurrentKernels,                ///< Device can possibly execute multiple kernels concurrently.
++    hipDeviceAttributeConcurrentManagedAccess,          ///< Device can coherently access managed memory concurrently with the CPU
++    hipDeviceAttributeCooperativeLaunch,                ///< Support cooperative launch
++    hipDeviceAttributeCooperativeMultiDeviceLaunch,     ///< Support cooperative launch on multiple devices
++    hipDeviceAttributeDeviceOverlap,                    ///< Cuda only. Device can concurrently copy memory and execute a kernel.
++                                                        ///< Deprecated. Use instead asyncEngineCount.
++    hipDeviceAttributeDirectManagedMemAccessFromHost,   ///< Host can directly access managed memory on
++                                                        ///< the device without migration
++    hipDeviceAttributeGlobalL1CacheSupported,           ///< Cuda only. Device supports caching globals in L1
++    hipDeviceAttributeHostNativeAtomicSupported,        ///< Cuda only. Link between the device and the host supports native atomic operations
++    hipDeviceAttributeIntegrated,                       ///< Device is integrated GPU
++    hipDeviceAttributeIsMultiGpuBoard,                  ///< Multiple GPU devices.
++    hipDeviceAttributeKernelExecTimeout,                ///< Run time limit for kernels executed on the device
++    hipDeviceAttributeL2CacheSize,                      ///< Size of L2 cache in bytes. 0 if the device doesn't have L2 cache.
++    hipDeviceAttributeLocalL1CacheSupported,            ///< caching locals in L1 is supported
++    hipDeviceAttributeLuid,                             ///< Cuda only. 8-byte locally unique identifier in 8 bytes. Undefined on TCC and non-Windows platforms
++    hipDeviceAttributeLuidDeviceNodeMask,               ///< Cuda only. Luid device node mask. Undefined on TCC and non-Windows platforms
++    hipDeviceAttributeComputeCapabilityMajor,           ///< Major compute capability version number.
++    hipDeviceAttributeManagedMemory,                    ///< Device supports allocating managed memory on this system
++    hipDeviceAttributeMaxBlocksPerMultiProcessor,       ///< Cuda only. Max block size per multiprocessor
++    hipDeviceAttributeMaxBlockDimX,                     ///< Max block size in width.
++    hipDeviceAttributeMaxBlockDimY,                     ///< Max block size in height.
++    hipDeviceAttributeMaxBlockDimZ,                     ///< Max block size in depth.
++    hipDeviceAttributeMaxGridDimX,                      ///< Max grid size  in width.
++    hipDeviceAttributeMaxGridDimY,                      ///< Max grid size  in height.
++    hipDeviceAttributeMaxGridDimZ,                      ///< Max grid size  in depth.
++    hipDeviceAttributeMaxSurface1D,                     ///< Maximum size of 1D surface.
++    hipDeviceAttributeMaxSurface1DLayered,              ///< Cuda only. Maximum dimensions of 1D layered surface.
++    hipDeviceAttributeMaxSurface2D,                     ///< Maximum dimension (width, height) of 2D surface.
++    hipDeviceAttributeMaxSurface2DLayered,              ///< Cuda only. Maximum dimensions of 2D layered surface.
++    hipDeviceAttributeMaxSurface3D,                     ///< Maximum dimension (width, height, depth) of 3D surface.
++    hipDeviceAttributeMaxSurfaceCubemap,                ///< Cuda only. Maximum dimensions of Cubemap surface.
++    hipDeviceAttributeMaxSurfaceCubemapLayered,         ///< Cuda only. Maximum dimension of Cubemap layered surface.
++    hipDeviceAttributeMaxTexture1DWidth,                ///< Maximum size of 1D texture.
++    hipDeviceAttributeMaxTexture1DLayered,              ///< Cuda only. Maximum dimensions of 1D layered texture.
++    hipDeviceAttributeMaxTexture1DLinear,               ///< Maximum number of elements allocatable in a 1D linear texture.
++                                                        ///< Use cudaDeviceGetTexture1DLinearMaxWidth() instead on Cuda.
++    hipDeviceAttributeMaxTexture1DMipmap,               ///< Cuda only. Maximum size of 1D mipmapped texture.
++    hipDeviceAttributeMaxTexture2DWidth,                ///< Maximum dimension width of 2D texture.
++    hipDeviceAttributeMaxTexture2DHeight,               ///< Maximum dimension hight of 2D texture.
++    hipDeviceAttributeMaxTexture2DGather,               ///< Cuda only. Maximum dimensions of 2D texture if gather operations  performed.
++    hipDeviceAttributeMaxTexture2DLayered,              ///< Cuda only. Maximum dimensions of 2D layered texture.
++    hipDeviceAttributeMaxTexture2DLinear,               ///< Cuda only. Maximum dimensions (width, height, pitch) of 2D textures bound to pitched memory.
++    hipDeviceAttributeMaxTexture2DMipmap,               ///< Cuda only. Maximum dimensions of 2D mipmapped texture.
++    hipDeviceAttributeMaxTexture3DWidth,                ///< Maximum dimension width of 3D texture.
++    hipDeviceAttributeMaxTexture3DHeight,               ///< Maximum dimension height of 3D texture.
++    hipDeviceAttributeMaxTexture3DDepth,                ///< Maximum dimension depth of 3D texture.
++    hipDeviceAttributeMaxTexture3DAlt,                  ///< Cuda only. Maximum dimensions of alternate 3D texture.
++    hipDeviceAttributeMaxTextureCubemap,                ///< Cuda only. Maximum dimensions of Cubemap texture
++    hipDeviceAttributeMaxTextureCubemapLayered,         ///< Cuda only. Maximum dimensions of Cubemap layered texture.
++    hipDeviceAttributeMaxThreadsDim,                    ///< Maximum dimension of a block
++    hipDeviceAttributeMaxThreadsPerBlock,               ///< Maximum number of threads per block.
++    hipDeviceAttributeMaxThreadsPerMultiProcessor,      ///< Maximum resident threads per multiprocessor.
++    hipDeviceAttributeMaxPitch,                         ///< Maximum pitch in bytes allowed by memory copies
++    hipDeviceAttributeMemoryBusWidth,                   ///< Global memory bus width in bits.
++    hipDeviceAttributeMemoryClockRate,                  ///< Peak memory clock frequency in kilohertz.
++    hipDeviceAttributeComputeCapabilityMinor,           ///< Minor compute capability version number.
++    hipDeviceAttributeMultiGpuBoardGroupID,             ///< Cuda only. Unique ID of device group on the same multi-GPU board
++    hipDeviceAttributeMultiprocessorCount,              ///< Number of multiprocessors on the device.
++    hipDeviceAttributeName,                             ///< Device name.
++    hipDeviceAttributePageableMemoryAccess,             ///< Device supports coherently accessing pageable memory
++                                                        ///< without calling hipHostRegister on it
++    hipDeviceAttributePageableMemoryAccessUsesHostPageTables, ///< Device accesses pageable memory via the host's page tables
++    hipDeviceAttributePciBusId,                         ///< PCI Bus ID.
++    hipDeviceAttributePciDeviceId,                      ///< PCI Device ID.
++    hipDeviceAttributePciDomainID,                      ///< PCI Domain ID.
++    hipDeviceAttributePersistingL2CacheMaxSize,         ///< Cuda11 only. Maximum l2 persisting lines capacity in bytes
++    hipDeviceAttributeMaxRegistersPerBlock,             ///< 32-bit registers available to a thread block. This number is shared
++                                                        ///< by all thread blocks simultaneously resident on a multiprocessor.
++    hipDeviceAttributeMaxRegistersPerMultiprocessor,    ///< 32-bit registers available per block.
++    hipDeviceAttributeReservedSharedMemPerBlock,        ///< Cuda11 only. Shared memory reserved by CUDA driver per block.
++    hipDeviceAttributeMaxSharedMemoryPerBlock,          ///< Maximum shared memory available per block in bytes.
++    hipDeviceAttributeSharedMemPerBlockOptin,           ///< Cuda only. Maximum shared memory per block usable by special opt in.
++    hipDeviceAttributeSharedMemPerMultiprocessor,       ///< Cuda only. Shared memory available per multiprocessor.
++    hipDeviceAttributeSingleToDoublePrecisionPerfRatio, ///< Cuda only. Performance ratio of single precision to double precision.
++    hipDeviceAttributeStreamPrioritiesSupported,        ///< Cuda only. Whether to support stream priorities.
++    hipDeviceAttributeSurfaceAlignment,                 ///< Cuda only. Alignment requirement for surfaces
++    hipDeviceAttributeTccDriver,                        ///< Cuda only. Whether device is a Tesla device using TCC driver
++    hipDeviceAttributeTextureAlignment,                 ///< Alignment requirement for textures
++    hipDeviceAttributeTexturePitchAlignment,            ///< Pitch alignment requirement for 2D texture references bound to pitched memory;
++    hipDeviceAttributeTotalConstantMemory,              ///< Constant memory size in bytes.
++    hipDeviceAttributeTotalGlobalMem,                   ///< Global memory available on devicice.
++    hipDeviceAttributeUnifiedAddressing,                ///< Cuda only. An unified address space shared with the host.
++    hipDeviceAttributeUuid,                             ///< Cuda only. Unique ID in 16 byte.
++    hipDeviceAttributeWarpSize,                         ///< Warp size in threads.
+
+-    hipDeviceAttributeMaxPitch,             ///< Maximum pitch in bytes allowed by memory copies
+-    hipDeviceAttributeTextureAlignment,     ///<Alignment requirement for textures
+-    hipDeviceAttributeTexturePitchAlignment, ///<Pitch alignment requirement for 2D texture references bound to pitched memory;
+-    hipDeviceAttributeKernelExecTimeout,    ///<Run time limit for kernels executed on the device
+-    hipDeviceAttributeCanMapHostMemory,     ///<Device can map host memory into device address space
+-    hipDeviceAttributeEccEnabled,           ///<Device has ECC support enabled
++    hipDeviceAttributeCudaCompatibleEnd = 9999,
++    hipDeviceAttributeAmdSpecificBegin = 10000,
+
+-    hipDeviceAttributeCooperativeMultiDeviceUnmatchedFunc,        ///< Supports cooperative launch on multiple
+-                                                                  ///devices with unmatched functions
+-    hipDeviceAttributeCooperativeMultiDeviceUnmatchedGridDim,     ///< Supports cooperative launch on multiple
+-                                                                  ///devices with unmatched grid dimensions
+-    hipDeviceAttributeCooperativeMultiDeviceUnmatchedBlockDim,    ///< Supports cooperative launch on multiple
+-                                                                  ///devices with unmatched block dimensions
+-    hipDeviceAttributeCooperativeMultiDeviceUnmatchedSharedMem,   ///< Supports cooperative launch on multiple
+-                                                                  ///devices with unmatched shared memories
+-    hipDeviceAttributeAsicRevision,         ///< Revision of the GPU in this device
+-    hipDeviceAttributeManagedMemory,        ///< Device supports allocating managed memory on this system
+-    hipDeviceAttributeDirectManagedMemAccessFromHost, ///< Host can directly access managed memory on
+-                                                      /// the device without migration
+-    hipDeviceAttributeConcurrentManagedAccess,  ///< Device can coherently access managed memory
+-                                                /// concurrently with the CPU
+-    hipDeviceAttributePageableMemoryAccess,     ///< Device supports coherently accessing pageable memory
+-                                                /// without calling hipHostRegister on it
+-    hipDeviceAttributePageableMemoryAccessUsesHostPageTables, ///< Device accesses pageable memory via
+-                                                              /// the host's page tables
+-    hipDeviceAttributeCanUseStreamWaitValue ///< '1' if Device supports hipStreamWaitValue32() and
+-                                            ///< hipStreamWaitValue64() , '0' otherwise.
++    hipDeviceAttributeClockInstructionRate = hipDeviceAttributeAmdSpecificBegin,  ///< Frequency in khz of the timer used by the device-side "clock*"
++    hipDeviceAttributeArch,                                     ///< Device architecture
++    hipDeviceAttributeMaxSharedMemoryPerMultiprocessor,         ///< Maximum Shared Memory PerMultiprocessor.
++    hipDeviceAttributeGcnArch,                                  ///< Device gcn architecture
++    hipDeviceAttributeGcnArchName,                              ///< Device gcnArch name in 256 bytes
++    hipDeviceAttributeHdpMemFlushCntl,                          ///< Address of the HDP_MEM_COHERENCY_FLUSH_CNTL register
++    hipDeviceAttributeHdpRegFlushCntl,                          ///< Address of the HDP_REG_COHERENCY_FLUSH_CNTL register
++    hipDeviceAttributeCooperativeMultiDeviceUnmatchedFunc,      ///< Supports cooperative launch on multiple
++                                                                ///< devices with unmatched functions
++    hipDeviceAttributeCooperativeMultiDeviceUnmatchedGridDim,   ///< Supports cooperative launch on multiple
++                                                                ///< devices with unmatched grid dimensions
++    hipDeviceAttributeCooperativeMultiDeviceUnmatchedBlockDim,  ///< Supports cooperative launch on multiple
++                                                                ///< devices with unmatched block dimensions
++    hipDeviceAttributeCooperativeMultiDeviceUnmatchedSharedMem, ///< Supports cooperative launch on multiple
++                                                                ///< devices with unmatched shared memories
++    hipDeviceAttributeIsLargeBar,                               ///< Whether it is LargeBar
++    hipDeviceAttributeAsicRevision,                             ///< Revision of the GPU in this device
++    hipDeviceAttributeCanUseStreamWaitValue,                    ///< '1' if Device supports hipStreamWaitValue32() and
++                                                                ///< hipStreamWaitValue64() , '0' otherwise.
+
++    hipDeviceAttributeAmdSpecificEnd = 19999,
++    hipDeviceAttributeVendorSpecificBegin = 20000,
++    // Extended attributes for vendors
+ } hipDeviceAttribute_t;
+
+ enum hipComputeMode {
+```
+
+### Known Issues
+
+#### Incorrect dGPU Behavior When Using AMDVBFlash Tool
+
+The AMDVBFlash tool, used for flashing the VBIOS image to dGPU, does not communicate with the ROM Controller specifically when the driver is present. This is because the driver, as part of its runtime power management feature, puts the dGPU to a sleep state.
+
+As a workaround, users can run amdgpu.runpm=0, which temporarily disables the runtime power management feature from the driver and dynamically changes some power control-related sysfs files.
+
+#### Issue with START Timestamp in ROCProfiler
+
+Users may encounter an issue with the enabled timestamp functionality for monitoring one or multiple counters. ROCProfiler outputs the following four timestamps for each kernel:
+
+- Dispatch
+
+- Start
+
+- End
+
+- Complete
+
+##### Issue
+
+This defect is related to the Start timestamp functionality, which incorrectly shows an earlier time than the Dispatch timestamp.
+
+To reproduce the issue,
+
+1. Enable timing using the --timestamp on flag.
+
+2. Use the -i option with the input filename that contains the name of the counter(s) to monitor.
+
+3. Run the program.
+
+4. Check the output result file.
+
+##### Current behavior
+
+BeginNS is lower than DispatchNS, which is incorrect.
+
+##### Expected behavior
+
+The correct order is:
+
+Dispatch < Start < End < Complete
+
+Users cannot use ROCProfiler to measure the time spent on each kernel because of the incorrect timestamp with counter collection enabled.
+
+##### Recommended Workaround
+
+Users are recommended to collect kernel execution timestamps without monitoring counters, as follows:
+
+1. ​Enable timing using the --timestamp on flag, and run the application.
+
+2. Rerun the application using the -i option with the input filename that contains the name of the counter(s) to monitor, and save this to a different output file using the -o flag.
+
+3. Check the output result file from step 1.
+
+4. The order of timestamps correctly displays as:
+  DispathNS < BeginNS < EndNS < CompleteNS
+
+5. Users can find the values of the collected counters in the output file generated in step 2.
+
+#### Radeon Pro V620 and W6800 Workstation GPUs
+
+##### No Support for SMI and ROCDebugger on SRIOV
+
+System Management Interface (SMI) and ROCDebugger are not supported in the SRIOV environment on any GPU. For more information, refer to the Systems Management Interface documentation.
+
+### Deprecations and Warnings
+
+#### ROCm Libraries Changes – Deprecations and Deprecation Removal
+
+- The hipFFT.h header is now provided only by the hipFFT package.  Up to ROCm 5.0, users would get hipFFT.h in the rocFFT package too.
+
+- The GlobalPairwiseAMG class is now entirely removed, users should use the PairwiseAMG class instead.
+
+- The rocsparse_spmm signature in 5.0 was changed to match that of rocsparse_spmm_ex.  In 5.0, rocsparse_spmm_ex is still present, but deprecated. Signature diff for rocsparse_spmm
+  rocsparse_spmm in 5.0
+
+  ```h
+  rocsparse_status rocsparse_spmm(rocsparse_handle            handle,
+                                  rocsparse_operation         trans_A,
+                                  rocsparse_operation         trans_B,
+                                  const void*                 alpha,
+                                  const rocsparse_spmat_descr mat_A,
+                                  const rocsparse_dnmat_descr mat_B,
+                                  const void*                 beta,
+                                  const rocsparse_dnmat_descr mat_C,
+                                  rocsparse_datatype          compute_type,
+                                  rocsparse_spmm_alg          alg,
+                                  rocsparse_spmm_stage        stage,
+                                  size_t*                     buffer_size,
+                                  void*                       temp_buffer);
+  ```
+
+  rocSPARSE_spmm in 4.0
+
+  ```h
+  rocsparse_status rocsparse_spmm(rocsparse_handle            handle,
+                                  rocsparse_operation         trans_A,
+                                  rocsparse_operation         trans_B,
+                                  const void*                 alpha,
+                                  const rocsparse_spmat_descr mat_A,
+                                  const rocsparse_dnmat_descr mat_B,
+                                  const void*                 beta,
+                                  const rocsparse_dnmat_descr mat_C,
+                                  rocsparse_datatype          compute_type,
+                                  rocsparse_spmm_alg          alg,
+                                  size_t*                     buffer_size,
+                                  void*                       temp_buffer);
+  ```
+
+#### HIP API Deprecations and Warnings
+
+##### Warning - Arithmetic Operators of HIP Complex and Vector Types
+
+In this release, arithmetic operators of HIP complex and vector types are deprecated.
+
+- As alternatives to arithmetic operators of HIP complex types, users can use arithmetic operators of `std::complex` types.
+
+- As alternatives to arithmetic operators of HIP vector types, users can use the operators of the native clang vector type associated with the data member of HIP vector types.
+
+During the deprecation, two macros `_HIP_ENABLE_COMPLEX_OPERATORS` and `_HIP_ENABLE_VECTOR_OPERATORS` are provided to allow users to conditionally enable arithmetic operators of HIP complex or vector types.
+
+Note, the two macros are mutually exclusive and, by default, set to Off.
+
+The arithmetic operators of HIP complex and vector types will be removed in a future release.
+
+Refer to the HIP API Guide for more information.
+
+#### Warning - Compiler-Generated Code Object Version 4 Deprecation
+
+Support for loading compiler-generated code object version 4 will be deprecated in a future release with no release announcement and replaced with code object 5 as the default version.
+
+The current default is code object version 4.
+
+#### Warning - MIOpenTensile Deprecation
+
+MIOpenTensile will be deprecated in a future release.
+
+### Library Changes in ROCM 5.0.0
+
+| Library | Version |
+|---------|---------|
+| hipBLAS |  ⇒ [0.49.0](https://github.com/ROCmSoftwarePlatform/hipBLAS/releases/tag/rocm-5.0.0) |
+| hipCUB |  ⇒ [2.10.13](https://github.com/ROCmSoftwarePlatform/hipCUB/releases/tag/rocm-5.0.0) |
+| hipFFT |  ⇒ [1.0.4](https://github.com/ROCmSoftwarePlatform/hipFFT/releases/tag/rocm-5.0.0) |
+| hipSOLVER |  ⇒ [1.2.0](https://github.com/ROCmSoftwarePlatform/hipSOLVER/releases/tag/rocm-5.0.0) |
+| hipSPARSE |  ⇒ [2.0.0](https://github.com/ROCmSoftwarePlatform/hipSPARSE/releases/tag/rocm-5.0.0) |
+| rccl |  ⇒ [2.10.3](https://github.com/ROCmSoftwarePlatform/rccl/releases/tag/rocm-5.0.0) |
+| rocALUTION |  ⇒ [2.0.1](https://github.com/ROCmSoftwarePlatform/rocALUTION/releases/tag/rocm-5.0.0) |
+| rocBLAS |  ⇒ [2.42.0](https://github.com/ROCmSoftwarePlatform/rocBLAS/releases/tag/rocm-5.0.0) |
+| rocFFT |  ⇒ [1.0.13](https://github.com/ROCmSoftwarePlatform/rocFFT/releases/tag/rocm-5.0.0) |
+| rocPRIM |  ⇒ [2.10.12](https://github.com/ROCmSoftwarePlatform/rocPRIM/releases/tag/rocm-5.0.0) |
+| rocRAND |  ⇒ [2.10.12](https://github.com/ROCmSoftwarePlatform/rocRAND/releases/tag/rocm-5.0.0) |
+| rocSOLVER |  ⇒ [3.16.0](https://github.com/ROCmSoftwarePlatform/rocSOLVER/releases/tag/rocm-5.0.0) |
+| rocSPARSE |  ⇒ [2.0.0](https://github.com/ROCmSoftwarePlatform/rocSPARSE/releases/tag/rocm-5.0.0) |
+| rocThrust |  ⇒ [2.13.0](https://github.com/ROCmSoftwarePlatform/rocThrust/releases/tag/rocm-5.0.0) |
+| Tensile |  ⇒ [4.31.0](https://github.com/ROCmSoftwarePlatform/Tensile/releases/tag/rocm-5.0.0) |
+
+#### hipBLAS 0.49.0
+
+hipBLAS 0.49.0 for ROCm 5.0.0
+
+##### Added
+
+- Added rocSOLVER functions to hipblas-bench
+- Added option ROCM_MATHLIBS_API_USE_HIP_COMPLEX to opt-in to use hipFloatComplex and hipDoubleComplex
+- Added compilation warning for future trmm changes
+- Added documentation to hipblas.h
+- Added option to forgo pivoting for getrf and getri when ipiv is nullptr
+- Added code coverage option
+
+##### Fixed
+
+- Fixed use of incorrect &#39;HIP_PATH&#39; when building from source.
+- Fixed windows packaging
+- Allowing negative increments in hipblas-bench
+- Removed boost dependency
+
+#### hipCUB 2.10.13
+
+hipCUB 2.10.13 for ROCm 5.0.0
+
+##### Fixed
+
+- Added missing includes to hipcub.hpp
+
+##### Added
+
+- Bfloat16 support to test cases (device_reduce &amp; device_radix_sort)
+- Device merge sort
+- Block merge sort
+- API update to CUB 1.14.0
+
+##### Changed
+
+- The SetupNVCC.cmake automatic target selector select all of the capabalities of all available card for NVIDIA backend.
+
+#### hipFFT 1.0.4
+
+hipFFT 1.0.4 for ROCm 5.0.0
+
+##### Fixed
+
+- Add calls to rocFFT setup/cleanup.
+- Cmake fixes for clients and backend support.
+
+##### Added
+
+- Added support for Windows 10 as a build target.
+
+#### hipSOLVER 1.2.0
+
+hipSOLVER 1.2.0 for ROCm 5.0.0
+
+##### Added
+
+- Added functions
+  - sytrf
+    - hipsolverSsytrf_bufferSize, hipsolverDsytrf_bufferSize, hipsolverCsytrf_bufferSize, hipsolverZsytrf_bufferSize
+    - hipsolverSsytrf, hipsolverDsytrf, hipsolverCsytrf, hipsolverZsytrf
+
+##### Fixed
+
+- Fixed use of incorrect `HIP_PATH` when building from source (#40).
+  Thanks [@jakub329homola](https://github.com/jakub329homola)!
+
+#### hipSPARSE 2.0.0
+
+hipSPARSE 2.0.0 for ROCm 5.0.0
+
+##### Added
+
+- Added (conjugate) transpose support for csrmv, hybmv and spmv routines
+
+#### rccl 2.10.3
+
+RCCL 2.10.3 for ROCm 5.0.0
+
+##### Added
+
+- Compatibility with NCCL 2.10.3
+
+##### Known Issues
+
+- Managed memory is not currently supported for clique-based kernels
+
+#### rocALUTION 2.0.1
+
+rocALUTION 2.0.1 for ROCm 5.0.0
+
+##### Changed
+
+- Removed deprecated GlobalPairwiseAMG class, please use PairwiseAMG instead.
+- Changed to C++ 14 Standard
+
+##### Improved
+
+- Added sanitizer option
+- Improved documentation
+
+#### rocBLAS 2.42.0
+
+rocBLAS 2.42.0 for ROCm 5.0.0
+
+##### Added
+
+- Added rocblas_get_version_string_size convenience function
+- Added rocblas_xtrmm_outofplace, an out-of-place version of rocblas_xtrmm
+- Added hpl and trig initialization for gemm_ex to rocblas-bench
+- Added source code gemm. It can be used as an alternative to Tensile for debugging and development
+- Added option ROCM_MATHLIBS_API_USE_HIP_COMPLEX to opt-in to use hipFloatComplex and hipDoubleComplex
+
+##### Optimizations
+
+- Improved performance of non-batched and batched single-precision GER for size m &gt; 1024. Performance enhanced by 5-10% measured on a MI100 (gfx908) GPU.
+- Improved performance of non-batched and batched HER for all sizes and data types. Performance enhanced by 2-17% measured on a MI100 (gfx908) GPU.
+
+##### Changed
+
+- Instantiate templated rocBLAS functions to reduce size of librocblas.so
+- Removed static library dependency on msgpack
+- Removed boost dependencies for clients
+
+##### Fixed
+
+- Option to install script to build only rocBLAS clients with a pre-built rocBLAS library
+- Correctly set output of nrm2_batched_ex and nrm2_strided_batched_ex when given bad input
+- Fix for dgmm with side == rocblas_side_left and a negative incx
+- Fixed out-of-bounds read for small trsm
+- Fixed numerical checking for tbmv_strided_batched
+
+#### rocFFT 1.0.13
+
+rocFFT 1.0.13 for ROCm 5.0.0
+
+##### Optimizations
+
+- Improved many plans by removing unnecessary transpose steps.
+- Optimized scheme selection for 3D problems.
+  - Imposed less restrictions on 3D_BLOCK_RC selection. More problems can use 3D_BLOCK_RC and
+    have some performance gain.
+  - Enabled 3D_RC. Some 3D problems with SBCC-supported z-dim can use less kernels and get benefit.
+  - Force --length 336 336 56 (dp) use faster 3D_RC to avoid it from being skipped by conservative
+    threshold test.
+- Optimized some even-length R2C/C2R cases by doing more operations
+  in-place and combining pre/post processing into Stockham kernels.
+- Added radix-17.
+
+##### Added
+
+- Added new kernel generator for select fused-2D transforms.
+
+##### Fixed
+
+- Improved large 1D transform decompositions.
+
+#### rocPRIM 2.10.12
+
+rocPRIM 2.10.12 for ROCm 5.0.0
+
+##### Fixed
+
+- Enable bfloat16 tests and reduce threshold for bfloat16
+- Fix device scan limit_size feature
+- Non-optimized builds no longer trigger local memory limit errors
+
+##### Added
+
+- Added scan size limit feature
+- Added reduce size limit feature
+- Added transform size limit feature
+- Add block_load_striped and block_store_striped
+- Add gather_to_blocked to gather values from other threads into a blocked arrangement
+- The block sizes for device merge sorts initial block sort and its merge steps are now separate in its kernel config
+    - the block sort step supports multiple items per thread
+
+##### Changed
+
+- size_limit for scan, reduce and transform can now be set in the config struct instead of a parameter
+- Device_scan and device_segmented_scan: `inclusive_scan` now uses the input-type as accumulator-type, `exclusive_scan` uses initial-value-type.
+  - This particularly changes behaviour of small-size input types with large-size output types (e.g. `short` input, `int` output).
+  - And low-res input with high-res output (e.g. `float` input, `double` output)
+- Revert old Fiji workaround, because they solved the issue at compiler side
+- Update README cmake minimum version number
+- Block sort support multiple items per thread
+    - currently only powers of two block sizes, and items per threads are supported and only for full blocks
+- Bumped the minimum required version of CMake to 3.16
+
+##### Known Issues
+
+- Unit tests may soft hang on MI200 when running in hipMallocManaged mode.
+- device_segmented_radix_sort, device_scan unit tests failing for HIP on Windows
+- ReduceEmptyInput cause random faulire with bfloat16
+
+#### rocRAND 2.10.12
+
+rocRAND 2.10.12 for ROCm 5.0.0
+
+##### Changed
+
+- No updates or changes for ROCm 5.0.0.
+
+#### rocSOLVER 3.16.0
+
+rocSOLVER 3.16.0 for ROCm 5.0.0
+
+##### Added
+
+- Symmetric matrix factorizations:
+    - LASYF
+    - SYTF2, SYTRF (with batched and strided\_batched versions)
+- Added `rocsolver_get_version_string_size` to help with version string queries
+- Added `rocblas_layer_mode_ex` and the ability to print kernel calls in the trace and profile logs
+- Expanded batched and strided\_batched sample programs.
+
+##### Optimized
+
+- Improved general performance of LU factorization
+- Increased parallelism of specialized kernels when compiling from source, reducing build times on multi-core systems.
+
+##### Changed
+
+- The rocsolver-test client now prints the rocSOLVER version used to run the tests,
+  rather than the version used to build them
+- The rocsolver-bench client now prints the rocSOLVER version used in the benchmark
+
+##### Fixed
+
+- Added missing stdint.h include to rocsolver.h
+
+#### rocSPARSE 2.0.0
+
+rocSPARSE 2.0.0 for ROCm 5.0.0
+
+##### Added
+
+- csrmv, coomv, ellmv, hybmv for (conjugate) transposed matrices
+- csrmv for symmetric matrices
+
+##### Changed
+
+- spmm\_ex is now deprecated and will be removed in the next major release
+
+##### Improved
+
+- Optimization for gtsv
+
+#### rocThrust 2.13.0
+
+rocThrust 2.13.0 for ROCm 5.0.0
+
+##### Added
+
+- Updated to match upstream Thrust 1.13.0
+- Updated to match upstream Thrust 1.14.0
+- Added async scan
+
+##### Changed
+
+- Scan algorithms: `inclusive_scan` now uses the input-type as accumulator-type, `exclusive_scan` uses initial-value-type.
+    - This particularly changes behaviour of small-size input types with large-size output types (e.g. `short` input, `int` output).
+    - And low-res input with high-res output (e.g. `float` input, `double` output)
+
+#### Tensile 4.31.0
+
+Tensile 4.31.0 for ROCm 5.0.0
+
+##### Added
+
+- DirectToLds support (x2/x4)
+- DirectToVgpr support for DGEMM
+- Parameter to control number of files kernels are merged into to better parallelize kernel compilation
+- FP16 alternate implementation for HPA HGEMM on aldebaran
+
+##### Optimized
+
+- Add DGEMM NN custom kernel for HPL on aldebaran
+
+##### Changed
+
+- Update tensile_client executable to std=c++14
+
+##### Removed
+
+- Remove unused old Tensile client code
+
+##### Fixed
+
+- Fix hipErrorInvalidHandle during benchmarks
+- Fix addrVgpr for atomic GSU
+- Fix for Python 3.8: add case for Constant nodeType
+- Fix architecture mapping for gfx1011 and gfx1012
+- Fix PrintSolutionRejectionReason verbiage in KernelWriter.py
+- Fix vgpr alignment problem when enabling flat buffer load

CONTRIBUTING.md

@@ -0,0 +1,246 @@
+# Contributing to ROCm Docs
+
+AMD values and encourages the ROCm community to contribute to our code and
+documentation. This repository is focused on ROCm documentation and this
+contribution guide describes the recommend method for creating and modifying our
+documentation.
+
+While interacting with ROCm Documentation, we encourage you to be polite and
+respectful in your contributions, content or otherwise. Authors, maintainers of
+these docs act on good intentions and to the best of their knowledge.
+Keep that in mind while you engage. Should you have issues with contributing
+itself, refer to
+[discussions](https://github.com/RadeonOpenCompute/ROCm/discussions) on the
+GitHub repository.
+
+## Supported Formats
+
+Our documentation includes both markdown and rst files. Markdown is encouraged
+over rst due to the lower barrier to participation. GitHub flavored markdown is preferred
+for all submissions as it will render accurately on our GitHub repositories. For existing documentation,
+[MyST](https://myst-parser.readthedocs.io/en/latest/intro.html) markdown
+is used to implement certain features unsupported in GitHub markdown. This is
+not encouraged for new documentation. AMD will transition
+to stricter use of GitHub flavored markdown with a few caveats. ROCm documentation
+also uses [sphinx-design](https://sphinx-design.readthedocs.io/en/latest/index.html)
+in our markdown and rst files. We also will use breathe syntax for doxygen documentation
+in our markdown files. Other design elements for effective HTML rendering of the documents
+may be added to our markdown files. Please see
+[GitHub](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github)'s
+guide on writing and formatting on GitHub as a starting point.
+
+ROCm documentation adds additional requirements to markdown and rst based files
+as follows:
+
+- Level one headers are only used for page titles. There must be only one level
+  1 header per file for both Markdown and Restructured Text.
+- Pass [markdownlint](https://github.com/markdownlint/markdownlint) check via
+  our automated github action on a Pull Request (PR).
+
+## Filenames and folder structure
+
+Please use snake case for file names. Our documentation follows pitchfork for
+folder structure. All documentation is in /docs except for special files like
+the contributing guide in the / folder. All images used in the documentation are
+place in the /docs/data folder.
+
+## How to provide feedback for for ROCm documentation
+
+There are three standard ways to provide feedback for this repository.
+
+### Pull Request
+
+All contributions to ROCm documentation should arrive via the
+[GitHub Flow](https://docs.github.com/en/get-started/quickstart/github-flow)
+targetting the develop branch of the repository. If you are unable to contribute
+via the GitHub Flow, feel free to email us. TODO, confirm email address.
+
+### GitHub Issue
+
+Issues on existing or absent docs can be filed as [GitHub issues
+](https://github.com/RadeonOpenCompute/ROCm/issues).
+
+### Email Feedback
+
+## Language and Style
+
+Adopting Microsoft CPP-Docs guidelines for [Voice and Tone
+](https://github.com/MicrosoftDocs/cpp-docs/blob/main/styleguide/voice-tone.md).
+
+ROCm documentation templates to be made public shortly. ROCm templates dictate
+the recommended structure and flow of the documentation. Guidelines on how to
+integrate figures, equations, and tables are all based off
+[MyST](https://myst-parser.readthedocs.io/en/latest/intro.html).
+
+Font size and selection, page layout, white space control, and other formatting
+details are controlled via rocm-docs-core, sphinx extention. Please raise issues
+in rocm-docs-core for any formatting concerns and changes requested.
+
+## Building Documentation
+
+While contributing, one may build the documentation locally on the command-line
+or rely on Continuous Integration for previewing the resulting HTML pages in a
+browser.
+
+### Command line documentation builds
+
+Python versions known to build documentation:
+
+- 3.8
+
+To build the docs locally using Python Virtual Environment (`venv`), execute the
+following commands from the project root:
+
+```sh
+python3 -mvenv .venv
+# Windows
+.venv/Scripts/python -m pip install -r docs/sphinx/requirements.txt
+.venv/Scripts/python -m sphinx -T -E -b html -d _build/doctrees -D language=en docs _build/html
+# Linux
+.venv/bin/python     -m pip install -r docs/sphinx/requirements.txt
+.venv/bin/python     -m sphinx -T -E -b html -d _build/doctrees -D language=en docs _build/html
+```
+
+Then open up `_build/html/index.html` in your favorite browser.
+
+### Pull Requests documentation builds
+
+When opening a PR to the `develop` branch on GitHub, the page corresponding to
+the PR (`https://github.com/RadeonOpenCompute/ROCm/pull/<pr_number>`) will have
+a summary at the bottom. This requires the user be logged in to GitHub.
+
+- There, click `Show all checks` and `Details` of the Read the Docs pipeline. It
+  will take you to `https://readthedocs.com/projects/advanced-micro-devices-rocm/
+  builds/<some_build_num>/`
+  - The list of commands shown are the exact ones used by CI to produce a render
+    of the documentation.
+- There, click on the small blue link `View docs` (which is not the same as the
+  bigger button with the same text). It will take you to the built HTML site with
+  a URL of the form `https://
+  advanced-micro-devices-demo--<pr_number>.com.readthedocs.build/projects/alpha/en
+  /<pr_number>/`.
+
+### Build the docs using VS Code
+
+One can put together a productive environment to author documentation and also
+test it locally using VS Code with only a handful of extensions. Even though the
+extension landscape of VS Code is ever changing, here is one example setup that
+proved useful at the time of writing. In it, one can change/add content, build a
+new version of the docs using a single VS Code Task (or hotkey), see all errors/
+warnings emitted by Sphinx in the Problems pane and immediately see the
+resulting website show up on a locally serving web server.
+
+#### Configuring VS Code
+
+1. Install the following extensions:
+
+    - Python (ms-python.python)
+    - Live Server (ritwickdey.LiveServer)
+
+2. Add the following entries in `.vscode/settings.json`
+
+    ```json
+    {
+      "liveServer.settings.root": "/.vscode/build/html",
+      "liveServer.settings.wait": 1000,
+      "python.terminal.activateEnvInCurrentTerminal": true
+    }
+    ```
+
+    The settings in order are set for the following reasons:
+    - Sets the root of the output website for live previews. Must be changed
+      alongside the `tasks.json` command.
+    - Tells live server to wait with the update to give time for Sphinx to
+      regenerate site contents and not refresh before all is don. (Empirical value)
+    - Automatic virtual env activation is a nice touch, should you want to build
+      the site from the integrated terminal.
+
+3. Add the following tasks in `.vscode/tasks.json`
+
+    ```json
+    {
+      "version": "2.0.0",
+      "tasks": [
+        {
+          "label": "Build Docs",
+          "type": "process",
+          "windows": {
+            "command": "${workspaceFolder}/.venv/Scripts/python.exe"
+          },
+          "command": "${workspaceFolder}/.venv/bin/python3",
+          "args": [
+            "-m",
+            "sphinx",
+            "-j",
+            "auto",
+            "-T",
+            "-b",
+            "html",
+            "-d",
+            "${workspaceFolder}/.vscode/build/doctrees",
+            "-D",
+            "language=en",
+            "${workspaceFolder}/docs",
+            "${workspaceFolder}/.vscode/build/html"
+          ],
+          "problemMatcher": [
+            {
+              "owner": "sphinx",
+              "fileLocation": "absolute",
+              "pattern": {
+                "regexp": "^(?:.*\\.{3}\\s+)?(\\/[^:]*|[a-zA-Z]:\\\\[^:]*):(\\d+):\\s+(WARNING|ERROR):\\s+(.*)$",
+                "file": 1,
+                "line": 2,
+                "severity": 3,
+                "message": 4
+              },
+            },
+            {
+              "owner": "sphinx",
+              "fileLocation": "absolute",
+              "pattern": {
+                "regexp": "^(?:.*\\.{3}\\s+)?(\\/[^:]*|[a-zA-Z]:\\\\[^:]*):{1,2}\\s+(WARNING|ERROR):\\s+(.*)$",
+                "file": 1,
+                "severity": 2,
+                "message": 3
+              }
+            }
+          ],
+          "group": {
+            "kind": "build",
+            "isDefault": true
+          }
+        },
+      ],
+    }
+    ```
+
+    > (Implementation detail: two problem matchers were needed to be defined,
+    > because VS Code doesn't tolerate some problem information being potentially
+    > absent. While a single regex could match all types of errors, if a capture
+    > group remains empty (the line number doesn't show up in all warning/error
+    > messages) but the `pattern` references said empty capture group, VS Code
+    > discards the message completely.)
+
+4. Configure Python virtual environment (venv)
+
+    - From the Command Palette, run `Python: Create Environment`
+      - Select `venv` environment and the `docs/sphinx/requirements.txt` file.
+      _(Simply pressing enter while hovering over the file from the dropdown is
+      insufficient, one has to select the radio button with the 'Space' key if
+      using the keyboard.)_
+
+5. Build the docs
+
+    - Launch the default build Task using either:
+      - a hotkey _(default is 'Ctrl+Shift+B')_ or
+      - by issuing the `Tasks: Run Build Task` from the Command Palette.
+
+6. Open the live preview
+
+    - Navigate to the output of the site within VS Code, right-click on
+    `.vscode/build/html/index.html` and select `Open with Live Server`. The
+    contents should update on every rebuild without having to refresh the
+    browser.
+
+<!-- markdownlint-restore -->

LICENSE

@@ -0,0 +1,21 @@
+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,750 +1,54 @@
-# AMD ROCm™ v4.1.1 Patch Release Notes 
+# AMD ROCm™ Platform
 
-The ROCm v4.1.1 release consists of the following updates:
+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.
 
-* Changed Environment Variables for HIP
+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.
 
-* Updated HIP Instructions for ROCm Installation
+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.
 
-## Changed Environment Variables for HIP 
+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.
 
-In the ROCm v3.5 release, the Heterogeneous Compute Compiler (HCC) compiler was deprecated, and the HIP-Clang compiler was introduced for compiling Heterogeneous-Compute Interface for Portability (HIP) programs. In addition, the HIP runtime API was implemented on top of Radeon Open Compute Common Language Runtime (ROCclr). ROCclr is an abstraction layer that provides the ability to interact with different runtime backends such as ROCr. 
+The default.xml file uses the repo Manifest format.
 
-While the *HIP_PLATFORM=hcc* environment variable was functional in subsequent releases, in the ROCm v4.1 release, the following environment variables were changed: 
+The develop branch of this repository contains content for the next
+ROCm release.
 
-* *HIP_PLATFORM=hcc to HIP_PLATFORM=amd*
+## ROCm Documentation
 
-* *HIP_PLATFORM=nvcc to HIP_PLATFORM=nvidia*
+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.
 
-Therefore, any applications continuing to use the *HIP_PLATFORM=hcc* variable will fail. You must update the environment variables to reflect the changes as mentioned above.
+### How to build documentation via Sphinx
 
+```bash
+cd docs
 
-## Updated HIP Instructions for ROCm Installation
+pip3 install -r sphinx/requirements.txt
 
-The hip-base package has a dependency on Perl modules that some operating systems may not have in their default package repositories.  Use the following commands to add repositories that have the required Perl packages:
-
-* For SLES 15 SP2
-
-		sudo zypper addrepo 
-
-  https://download.opensuse.org/repositories/devel:languages:perl/SLE_15/devel:languages:perl.repo
-
-* For CentOS8.3 
-
-		sudo yum config-manager --set-enabled powertools
-
-* For RHEL8.3
-
-		sudo subscription-manager repos --enable codeready-builder-for-rhel-8-x86_64-rpms
-
-
-# AMD ROCm™ v4.1 Release Notes 
-This document describes the features, fixed issues, and information about downloading and installing the AMD ROCm™ software. It also covers known issues and deprecations in the AMD ROCm v4.1 release.
-
-- [Supported Operating Systems and Documentation Updates](#Supported-Operating-Systems-and-Documentation-Updates)
-  * [Supported Operating Systems](#Supported-Operating-Systems)
-  * [ROCm Installation Updates](#ROCm-Installation-Updates)
-  * [AMD ROCm Documentation Updates](#AMD-ROCm-Documentation-Updates)
-
-- [Driver Compatibility Issue in This Release](#Driver-Compatibility-Issue-in-This-Release)
-   
-- [What\'s New in This Release](#Whats-New-in-This-Release)
-  * [TargetID for Multiple Configurations](#TargetID-for-Multiple-Configurations)
-  * [ROCm Data Center Tool](#ROCm-Data-Center-Tool)
-  * [ROCm Math and Communication Libraries](#ROCm-Math-and-Communication-Libraries)
-  * [HIP Enhancements](#HIP-Enhancements)
-  * [OpenMP Enhancements and Fixes](#OpenMP-Enhancements-and-Fixes)
-  * [MIOpen Tensile Integration](#MIOpen-Tensile-Integration)
-
-    
-- [Known Issues](#Known-Issues)
-
-- [Deprecations](#Deprecations)
-
-  * [Compiler Generated Code Object Version 2 Deprecation ](#Compiler-Generated-Code-Object-Version-2-Deprecation)
-
-- [Deploying ROCm](#Deploying-ROCm)
- 
-- [Hardware and Software Support](#Hardware-and-Software-Support)
-
-- [Machine Learning and High Performance Computing Software Stack for AMD GPU](#Machine-Learning-and-High-Performance-Computing-Software-Stack-for-AMD-GPU)
-  * [ROCm Binary Package Structure](#ROCm-Binary-Package-Structure)
-  * [ROCm Platform Packages](#ROCm-Platform-Packages)
-  
-
-
-
-## ROCm Installation Updates 
-
-### List of Supported Operating Systems
-
-The AMD ROCm platform is designed to support the following operating systems:
-
-* Ubuntu 20.04.1 (5.4 and 5.6-oem) and 18.04.5 (Kernel 5.4)	
-* CentOS 7.9 (3.10.0-1127) & RHEL 7.9 (3.10.0-1160.6.1.el7) (Using devtoolset-7 runtime support)
-* CentOS 8.3 (4.18.0-193.el8) and RHEL 8.3 (4.18.0-193.1.1.el8) (devtoolset is not required)
-* SLES 15 SP2
-
-### Fresh Installation of AMD ROCM V4.1 Recommended
-
-A complete uninstallation of previous ROCm versions is required before installing a new version of ROCm. An upgrade from previous releases to AMD ROCm v4.1 is not supported. For more information, refer to the AMD ROCm Installation Guide at
-
-https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html
-
-**Note**: AMD ROCm release v3.3 or prior releases are not fully compatible with AMD ROCm v3.5 and higher versions. You must perform a fresh ROCm installation if you want to upgrade from AMD ROCm v3.3 or older to 3.5 or higher versions and vice-versa.
-
-**Note**: *render* group is required only for Ubuntu v20.04. For all other ROCm supported operating systems, continue to use video group. 
-
-* For ROCm v3.5 and releases thereafter, the clinfo path is changed to /opt/rocm/opencl/bin/clinfo. 
-
-* For ROCm v3.3 and older releases, the clinfo path remains /opt/rocm/opencl/bin/x86_64/clinfo. 
- 
-### ROCm Multi-Version Installation Update
-
-With the AMD ROCm v4.1 release, the following ROCm multi-version installation changes apply:
-
-The meta packages rocm-dkms<version> are now deprecated for multi-version ROCm installs.  For example, rocm-dkms3.7.0, rocm-dkms3.8.0.
- 
-* Multi-version installation of ROCm should be performed by installing rocm-dev<version> using each of the desired ROCm versions. For example, rocm-dev3.7.0, rocm-dev3.8.0, rocm-dev3.9.0.   
-
-* Version files must be created for each multi-version rocm <= 4.1.0
-
- * Command: echo <version> | sudo tee /opt/rocm-<version>/.info/version
-
- * Example: echo 4.1.0 | sudo tee /opt/rocm-4.1.0/.info/version
-
-* The rock-dkms loadable kernel modules should be installed using a single rock-dkms package. 
-
-* ROCm v3.9 and above will not set any ldconfig entries for ROCm libraries for multi-version installation.  Users must set LD_LIBRARY_PATH to load the ROCm library version of choice.
-
-**NOTE**: The single version installation of the ROCm stack remains the same. The rocm-dkms package can be used for single version installs and is not deprecated at this time.
-
-
-### Updated HIP Instructions for ROCm Installation
-
-The hip-base package has a dependency on Perl modules that some operating systems may not have in their default package repositories.  Use the following commands to add repositories that have the required Perl packages:
-
-
-#### For SLES 15 SP2
-
-		sudo zypper addrepo 
-
-
-For more information, see
-
-https://download.opensuse.org/repositories/devel:languages:perl/SLE_15/devel:languages:perl.repo
-
-
-
-#### For CentOS8.3
-
-		sudo yum config-manager --set-enabled powertools
-	
-
-#### For RHEL8.3
-
-		sudo subscription-manager repos --enable codeready-builder-for-rhel-8-x86_64-rpms
- 
-
-# Driver Compatibility Issue in This Release
-
-In certain scenarios, the ROCm 4.1 run-time and userspace environment are not compatible with ROCm v4.0 and older driver implementations for 7nm-based (Vega 20) hardware (MI50 and MI60). 
-
-To mitigate issues, the ROCm v4.1 or newer userspace prevents running older drivers for these GPUs.
-
-Users are notified in the following scenarios:
-
-* Bare Metal 
-* Containers
- 
-## Bare Metal
-
-In the bare-metal environment, the following error message displays in the console: 
-
-*“HSA Error: Incompatible kernel and userspace, Vega 20 disabled. Upgrade amdgpu.”*
-
-To test the compatibility, run the ROCm v4.1 version of rocminfo using the following instruction: 
-
-*/opt/rocm-4.1.0/bin/rocminfo 2>&1 | less*
-
-## Containers
-
-A container (built with error detection for this issue) using a ROCm v4.1 or newer run-time is initiated to execute on an older kernel. The container fails to start and the following warning appears:
-
-*Error: Incompatible ROCm environment. The Docker container requires the latest kernel driver to operate correctly.
-Upgrade the ROCm kernel to v4.1 or newer, or use a container tagged for v4.0.1 or older.*
-
-To inspect the version of the installed kernel driver,  run either: 
-
-* dpkg --status rock-dkms [Debian-based]
-
-or
-
-* rpm -ql rock-dkms [RHEL, SUSE, and others]
-
-To install or update the driver, follow the installation instructions at:
-
-https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html
-
-
-# AMD ROCm Documentation Updates
-
-## AMD ROCm Installation Guide 
-
-The AMD ROCm Installation Guide in this release includes:
-
-* Supported Environments
-
-* Installation Instructions for v4.1
-
-* HIP Installation Instructions 
-
-For more information, refer to the ROCm documentation website at:
-
-https://rocmdocs.amd.com/en/latest/
-
-
-## AMD ROCm - HIP Documentation Updates
-
-* HIP Programming Guide v4.1 
-
-  https://github.com/RadeonOpenCompute/ROCm/blob/master/AMD_HIP_Programming_Guide_v4.1.pdf
-
-* HIP API Guide v4.1
-
-  https://github.com/RadeonOpenCompute/ROCm/blob/master/AMD_HIP_API_Guide_v4.1.pdf
-  
-
-* HIP-Supported CUDA API Reference Guide v4.1
-
-  https://github.com/RadeonOpenCompute/ROCm/blob/master/HIP_Supported_CUDA_API_Reference_Guide_v4.1.pdf
-
-* HIP FAQ  
-
-  For more information, refer to
-
-  https://rocmdocs.amd.com/en/latest/Programming_Guides/HIP-FAQ.html#hip-faq
-
-
-## ROCm Data Center User and API Guide
-
-* ROCm Data Center Tool User Guide
-
-   - Grafana Plugin Integration
-
-  For more information, refer to the ROCm Data Center User Guide at,
-
-  https://github.com/RadeonOpenCompute/ROCm/blob/master/AMD_ROCm_DataCenter_Tool_User_Guide_v4.1.pdf
-  
-
-* ROCm Data Center Tool API Guide
-
-  For more information, refer to the ROCm Data Center API Guide at,
-
-  https://github.com/RadeonOpenCompute/ROCm/blob/master/ROCm_Data_Center_Tool_API_Manual_4.1.pdf
-
-
-## ROCm SMI API Documentation Updates 
-
-* ROCm SMI API Guide 
-
-  For more information, refer to the ROCm SMI API Guide at,
-
-  https://github.com/RadeonOpenCompute/ROCm/blob/master/ROCm_SMI_API_GUIDE_v4.1.pdf
-  
-## ROC Debugger User and API Guide 
-
-* ROC Debugger User Guide 
-
-  https://github.com/RadeonOpenCompute/ROCm/blob/master/Debugging%20with%20ROCGDB%20User%20Guide%20v4.1.pdf
-  
-
-* Debugger API Guide 
-
-  https://github.com/RadeonOpenCompute/ROCm/blob/master/AMD-Debugger%20API%20Guide%20v4.1.pdf
-
-
-## General AMD ROCm Documentation Links
-
-Access the following links for more information:
-
-* For AMD ROCm documentation, see 
-
-  https://rocmdocs.amd.com/en/latest/
-
-* For installation instructions on supped platforms, see
-
-  https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html
-
-* For AMD ROCm binary structure, see
-
-  https://rocmdocs.amd.com/en/latest/Installation_Guide/Software-Stack-for-AMD-GPU.html
-  
-
-* For AMD ROCm Release History, see
-
- https://rocmdocs.amd.com/en/latest/Current_Release_Notes/ROCm-Version-History.html
-
-
-
-# What\'s New in This Release
-
-## TargetID for Multiple Configurations
-
-The new TargetID functionality allows compilations to specify various configurations of the supported hardware. 
-
-Previously, ROCm supported only a single configuration per target. 
-
-With the TargetID enhancement, ROCm supports configurations for Linux, PAL and associated configurations such as XNACK. This feature addresses configurations for the same target in different modes and allows applications to build executables that specify the supported configurations, including the option to be agnostic for the desired setting.
-
-
-### New Code Object Format Version for TargetID
-
-* A new clang option -mcode-object-version can be used to request the legacy code object version 3 or code object version 2. For more information, refer to
-
-  https://llvm.org/docs/AMDGPUUsage.html#elf-code-object
-
-* A new clang --offload-arch= option is introduced to specify the offload target architecture(s) for the HIP language.
-
-* The clang --offload-arch= and -mcpu options accept a new Target ID syntax. This allows both the processor and target feature settings to be specified. For more details, refer to
-
-  https://llvm.org/docs/AMDGPUUsage.html#amdgpu-target-id
-
-    - If a target feature is not specified, it defaults to a new concept of "any". The compiler, then, produces code, 
-      which executes on a target configured for either value of the setting impacting the overall performance. 
-      
-      It is recommended to explicitly specify the setting for more efficient performance. 
-
-    - In particular, the setting for XNACK now defaults to produce less performant code than previous ROCm releases.
-
-    - The legacy clang -mxnack, -mno-xnack, -msram-ecc, and -mno-sram-ecc options are deprecated. They are still 
-      supported, however, they will be removed in a future release. 
-
-    - The new Target ID syntax renames the SRAM ECC feature from sram-ecc to sramecc.
-
-* The clang offload bundler uses the new offload hipv4 for HIP code object version 4. For more information, see 
-https://clang.llvm.org/docs/ClangOffloadBundler.html
-
-* ROCm v4.1 corrects code object loading to enforce target feature settings of the code object to match the setting of the agent. It also corrects the recording of target feature settings in the code object. As a consequence, the legacy code objects may no longer load due to mismatches.
-
-* gfx802, gfx803, and gfx805 do not support the XNACK target feature in the ROCm v4.1 release.
-
-
-### New Code Object Tools
-
-AMD ROCm v4.1 provides new code object tools *roc-obj-ls* and *roc-obj-extract*. These tools allow for the listing and extraction of AMD GPU ROCm code objects that are embedded in HIP executables and shared objects. Each tool supports a --help option that provides more information. 
-
-Refer to the HIP Programming Guide v4.1 for additional information and examples.
-
-https://github.com/RadeonOpenCompute/ROCm/blob/master/AMD_HIP_Programming_Guide_v4.1.pdf
-
-**Note**
-
-The extractkernel tool in previous AMD ROCm releases has been removed from the AMD ROCm v4.1 release 
-and will no longer be  supported.
-
-**Note**
- 
- The roc-obj-ls and roc-obj-extract tools may generate an error about the following missing Perl modules: 
-
-* File::Which
-* File::BaseDir
-* File::Copy
-* URI::Encode
-
-This error is due to the missing dependencies in the hip-base installer package.  As a workaround, you may use the 
-following instructions to install the Perl modules:  
-
-*Ubuntu*
-     
-     apt-get install libfile-which-perl libfile-basedir-perl libfile-copy-recursive-perl liburi-encode-perl
-   
-*CentOS*
-            
-    “sudo yum install perl-File-Which perl-File-BaseDir perl-File-Copy-Recursive perl-URI-Encode” 
-    
-
-Repo for CentOS8.3: 
-
-    sudo yum config-manager --set-enabled powertools
-
-
-*RHEL*
-
-    sudo yum install perl-File-Which perl-File-BaseDir perl-File-Copy-Recursive perl-URI-Encode 
-    
-
-Repo for RHEL8.3: 
-
-    sudo subscription-manager repos --enable codeready-builder-for-rhel-8-x86_64-rpms
-
-
-*SLES 15 SP2*
-
-       sudo zypper addrepo https://download.opensuse.org/repositories/devel:languages:perl/SLE_15/devel:languages:perl.repo
-
-
-## ROCm Data Center Tool 
-
-### Grafana Integration
-
-The ROCm Data Center (RDC) Tool is enhanced with the Grafana plugin. Grafana is a common monitoring stack used for storing and visualizing time series data. Prometheus acts as the storage backend, and Grafana is used as the interface for analysis and visualization. Grafana has a plethora of visualization options and can be integrated with Prometheus for the ROCm Data Center (RDC) dashboard. 
-
-For more information about Grafana integration and installation, refer to the ROCm Data Center Tool User guide at:
-
-https://github.com/RadeonOpenCompute/ROCm/blob/master/AMD_ROCm_DataCenter_Tool_User_Guide_v4.1.pdf
-
-
-
-## ROCm Math and Communication Libraries 
-
-### rocSPARSE
-
-rocSPARSE extends support for:
-
-* gebsrmm
-* gebsrmv
-* gebsrsv
-* coo2dense and dense2coo
-* generic API including axpby, gather, scatter, rot, spvv, spmv, spgemm, sparsetodense, densetosparse
-* mixed indexing types in matrix formats
-
-For more information, see 
-
-https://rocsparse.readthedocs.io/en/latest/
-
-
-### rocSOLVER
-
-rocSOLVER extends support for:
-
-* Eigensolver routines for symmetric/hermitian matrices:
-  - STERF, STEQR
-  
-* Linear solvers for general non-square systems:
-  - GELS (API added with batched and strided_batched versions. Only the overdetermined non-transpose case is implemented in 
-    this release. Other cases will return rocblas_status_not_implemented status for now.)
-    
-* Extended test coverage for functions returning information
-
-* Changelog file
-
-* Tridiagonalization routines for symmetric and hermitian matrices:
-  - LATRD
-  - SYTD2, SYTRD (with batched and strided_batched versions)
-  - HETD2, HETRD (with batched and strided_batched versions)
-  
-* Sample code and unit test for unified memory model/Heterogeneous Memory Management (HMM)
-
-For more information, see
-
-https://rocsolver.readthedocs.io/en/latest/
-
-### hipCUB
-
-The new iterator DiscardOutputIterator in hipCUB represents a special kind of pointer that ignores values written to it upon dereference.  It is useful for ignoring the output of certain algorithms without wasting memory capacity or bandwidth.  DiscardOutputIterator may also be used to count the size of an algorithm's output, which was not known previously.
-
-For more information, see
-
-https://hipcub.readthedocs.io/en/latest/
-
-
-## HIP Enhancements
-
-### Support for hipEventDisableTiming Flag
-
-HIP now supports the hipEventDisableTiming flag for hipEventCreateWithFlags. Note, events created with this flag do not record profiling data and provide optimal performance when used for synchronization.
-
-### Cooperative Group Functions
-
-Cooperative Groups defines, synchronizes, and communicates between groups of threads and blocks for efficiency and ease of management. HIP now supports the following kernel language Cooperative Groups types and functions:
-
-![Screenshot](images/CGMain.PNG)
-
-
-
-###  Support for Extern Shared Declarations
-
-Previously, it was required to declare dynamic shared memory using the HIP_DYNAMIC_SHARED macro for accuracy as using static shared memory in the same kernel could result in overlapping memory ranges and data-races.
-Now, the HIP-Clang compiler provides support for extern shared declarations, and the HIP_DYNAMIC_SHARED option is no longer required. 
-
-You may use the standard extern definition:
-
-    extern __shared__ type var[];
-
-
-## OpenMP Enhancements and Fixes
-
-This release includes the following OpenMP changes:
-
-* Usability Enhancements
-* Fixes to Internal Clang Math Headers
-* OpenMP Defect Fixes
-
-### Usability Enhancements
-
-* OMPD updates for flang
-* To support OpenMP debugging, the selected OpenMP runtime sources are included in lib-debug/src/openmp. The ROCgdb debugger 
-  will find these automatically.
-* Threadsafe hsa plugin for libomptarget
-* Support multiple devices with malloc and hostrpc
-* Improve hostrpc version check
-* Add max reduction offload feature to flang
-* Integration of changes to support HPC Toolkit
-* Support for fprintf
-* Initial support for GPU malloc and Free. The internal (device rtl) is required for GPU malloc and Free for nested parallelism.  
-  GPU malloc and Free are now replaced, which improves the device memory footprint.
-* Increase detail of debug printing controlled by LIBOMPTARGET_KERNEL_TRACE environment variable
-* Add support for -gpubnames in Flang Driver
-* Increase detail of debug printing controlled by LIBOMPTARGET_KERNEL_TRACE environment variable
-* Add support for -gpubnames in Flang Driver
-
-###  Fixes to Internal Clang Math Headers
-
-This release includes a set of changes applied to Clang internal headers to support OpenMP C, C++, FORTRAN, and HIP C. This establishes consistency between NVPTX and AMDGCN offloading, and OpenMP, HIP, and CUDA. OpenMP uses function variants and header overlays to define device versions of functions. This causes Clang LLVM IR codegen to mangle names of variants in both the definition and callsites of functions defined in the internal Clang headers. The changes apply to headers found in the installation subdirectory lib/clang/11.0.0/include.
-
-The changes also temporarily eliminate the use of the libm bitcode libraries for C and C++. Although math functions are now defined with internal clang headers, a bitcode library of the C functions defined in the headers is still built for the FORTRAN toolchain linking. This is because FORTRAN cannot use C math headers. This bitcode library is installed in lib/libdevice/libm-.bc. The source build of the bitcode library is implemented with the aomp-extras repository and the component-built script build_extras.sh. 
-
-### OpenMP Defect Fixes
-
-The following OpenMP defects are fixed in this release:
-
-* Openmpi configuration issue with real16. 
-* [flang] The AOMP 11.7-1 Fortran compiler claims to support the -isystem flag, but ignores it.
-* [flang] producing internal compiler error when the character is used with KIND.
-* [flang] openmp map clause on complex allocatable expressions !$omp target data map( chunk%tiles(1)%field%density0).
-* Add a fatal error if missing -Xopenmp-target or -march options when -fopenmp-targets is specified. However, this requirement is not 
-  applicable for offloading to the host when there is only a single target and that target is the host.
-* Openmp error message output for no_rocm_device_lib was asserting.
-* Linkage on constant per-kernel symbols from external to weaklinkageonly to prevent duplicate symbols when building kokkos.
-* Add environment variables ROCM_LLD_ARGS ROCM_LINK_ARGS ROCM_SELECT_ARGS to test driver options without compiler rebuild.  
-* Fix problems with device math functions being ambiguous, especially the pow function.ix aompcc to accept file type cxx. 
-* Fix a latent race between host runtime and devicertl.
-
-## MIOpen Tensile Integration
-
-MIOpenTensile provides host-callable interfaces to the Tensile library and supports the HIP programming model. You may use the Tensile feature in the HIP backend by setting the building environment variable value to ON.
-
-    MIOPEN_USE_MIOPENTENSILE=ON
-
-MIOpenTensile is an open-source collaboration tool where external entities can submit source pull requests (PRs) for updates. MIOpenTensile maintainers review and approve the PRs using standard open-source practices. 
-
-For more information about the sources and the build system, see
-
-https://github.com/ROCmSoftwarePlatform/MIOpenTensile
-
-
-# Known Issues 
-
-The following are the known issues in this release.
-
-## Upgrade to AMD ROCm v4.1 Not Supported
-
-An upgrade from previous releases to AMD ROCm v4.1 is not supported. A complete uninstallation of previous ROCm versions is required before installing a new version of ROCm.
-
-## Performance Impact for Kernel Launch Bound Attribute
-
-Kernels without the *__launch_bounds__* attribute assume the default maximum threads per block value. In the previous ROCm release, this value was 256. In the ROCm v4.1 release, it is changed to 1024. The objective of this change ensures the actual threads per block value used to launch a kernel, by default, are always within the launch bounds, thus, establishing the correctness of HIP programs. 
-
-**NOTE**: Using the above-mentioned approach may incur performance degradation in certain cases. Users must add a minimum launch bound to each kernel, which covers all possible threads per block values used to launch that kernel for correctness and performance. 
-
-The recommended workaround to recover the performance is to add *--gpu-max-threads-per-block=256* to the compilation options for HIP programs.
-
-## Issue with Passing a Subset of GPUs in a Multi-GPU System
-
-ROCm support for passing individual GPUs via the docker --device flag in a Docker run command has a known issue when passing a subset of GPUs in a multi-GPU system. The command runs without any warning or error notification. However, all GPU executable run outputs are randomly corrupted. 
-
-Using GPU targeting via the Docker command is not recommended for users of ROCm 4.1. There is no workaround for this issue currently. 
-
-## Performance Impact for LDS-Bound Kernels
-
-The compiler in ROCm v4.1 generates LDS load and stores instructions that incorrectly assume equal performance between aligned and misaligned accesses. While this does not impact code correctness, it may result in sub-optimal performance.
-
-This issue is under investigation, and there is no known workaround at this time.
-
-## Changed HIP Environment Variables in ROCm v4.1 Release
-
-In the ROCm v3.5 release, the Heterogeneous Compute Compiler (HCC) compiler was deprecated, and the HIP-Clang compiler was introduced for compiling Heterogeneous-Compute Interface for Portability (HIP) programs. Also, the HIP runtime API was implemented on top of the Radeon Open Compute Common Language runtime (ROCclr). ROCclr is an abstraction layer that provides the ability to interact with different runtime backends such as ROCr. 
-
-While the *HIP_PLATFORM=hcc* environment variable was functional in subsequent releases after ROCm v3.5, in the ROCm v4.1 release, changes to the following environment variables were implemented: 
-
-* *HIP_PLATFORM=hcc was changed to HIP_PLATFORM=amd*
-
-* *HIP_PLATFORM=nvcc was changed to HIP_PLATFORM=nvidia*
-
-Therefore, any applications continuing to use the HIP_PLATFORM=hcc environment variable will fail.
-
-**Workaround:**  Update the environment variables to reflect the changes mentioned above.
-
-
-# Deprecations
-
-This section describes deprecations and removals in AMD ROCm.
-
-## Compiler Generated Code Object Version 2 Deprecation 
-
-Compiler-generated code object version 2 is no longer supported and has been completely removed. Support for loading code object version 2 is also deprecated with no announced removal release.
-
-
-# Deploying ROCm
-
-AMD hosts both Debian and RPM repositories for the ROCm packages. 
-
-For more information on ROCM installation on all platforms, see
-
-https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html
-
-
-# Machine Learning and High Performance Computing Software Stack for AMD GPU
-
-For an updated version of the software stack for AMD GPU, see
-
-https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html#software-stack-for-amd-gpu
-
-
-
-# Hardware and Software Support
-ROCm is focused on using AMD GPUs to accelerate computational tasks such as machine learning, engineering workloads, and scientific computing.
-In order to focus our development efforts on these domains of interest, ROCm supports a targeted set of hardware configurations which are detailed further in this section.
-
-**Note:** The AMD ROCm™ open software platform is a compute stack for headless system deployments. GUI-based software applications are currently not supported.
-
-#### Supported GPUs
-Because the ROCm Platform has a focus on particular computational domains, we offer official support for a selection of AMD GPUs that are designed to offer good performance and price in these domains.
-
-**Note:** The integrated GPUs of Ryzen are not officially supported targets for ROCm.
-
-ROCm officially supports AMD GPUs that use following chips:
-
-* GFX9 GPUs
-
-  - "Vega 10" chips, such as on the AMD Radeon RX Vega 64 and Radeon Instinct MI25
-  
-  - "Vega 7nm" chips, such as on the Radeon Instinct MI50, Radeon Instinct MI60 or AMD Radeon VII, Radeon Pro VII
-
-* CDNA GPUs
-
-  - MI100 chips such as on the AMD Instinct™ MI100
-
-
-ROCm is a collection of software ranging from drivers and runtimes to libraries and developer tools.
-Some of this software may work with more GPUs than the "officially supported" list above, though AMD does not make any official claims of support for these devices on the ROCm software platform.
-
-The following list of GPUs are enabled in the ROCm software, though full support is not guaranteed:
-
-  * GFX8 GPUs
-    * "Polaris 11" chips, such as on the AMD Radeon RX 570 and Radeon Pro WX 4100
-    * "Polaris 12" chips, such as on the AMD Radeon RX 550 and Radeon RX 540
-  * GFX7 GPUs
-    * "Hawaii" chips, such as the AMD Radeon R9 390X and FirePro W9100
-
-As described in the next section, GFX8 GPUs require PCI Express 3.0 (PCIe 3.0) with support for PCIe atomics. This requires both CPU and motherboard support. GFX9 GPUs require PCIe 3.0 with support for PCIe atomics by default, but they can operate in most cases without this capability.
-
-The integrated GPUs in AMD APUs are not officially supported targets for ROCm.
-As described [below](#limited-support), "Carrizo", "Bristol Ridge", and "Raven Ridge" APUs are enabled in our upstream drivers and the ROCm OpenCL runtime.
-However, they are not enabled in the HIP runtime, and may not work due to motherboard or OEM hardware limitations.
-As such, they are not yet officially supported targets for ROCm.
-
-For a more detailed list of hardware support, please see [the following documentation](https://en.wikipedia.org/wiki/List_of_AMD_graphics_processing_units).
-
-#### Supported CPUs
-As described above, GFX8 GPUs require PCIe 3.0 with PCIe atomics in order to run ROCm.
-In particular, the CPU and every active PCIe point between the CPU and GPU require support for PCIe 3.0 and PCIe atomics.
-The CPU root must indicate PCIe AtomicOp Completion capabilities and any intermediate switch must indicate PCIe AtomicOp Routing capabilities.
-
-Current CPUs which support PCIe Gen3 + PCIe Atomics are:
-
-  * AMD Ryzen CPUs
-  * The CPUs in AMD Ryzen APUs
-  * AMD Ryzen Threadripper CPUs
-  * AMD EPYC CPUs
-  * Intel Xeon E7 v3 or newer CPUs
-  * Intel Xeon E5 v3 or newer CPUs
-  * Intel Xeon E3 v3 or newer CPUs
-  * Intel Core i7 v4, Core i5 v4, Core i3 v4 or newer CPUs (i.e. Haswell family or newer)
-  * Some Ivy Bridge-E systems
-
-Beginning with ROCm 1.8, GFX9 GPUs (such as Vega 10) no longer require PCIe atomics.
-We have similarly opened up more options for number of PCIe lanes.
-GFX9 GPUs can now be run on CPUs without PCIe atomics and on older PCIe generations, such as PCIe 2.0.
-This is not supported on GPUs below GFX9, e.g. GFX8 cards in the Fiji and Polaris families.
-
-If you are using any PCIe switches in your system, please note that PCIe Atomics are only supported on some switches, such as Broadcom PLX.
-When you install your GPUs, make sure you install them in a PCIe 3.1.0 x16, x8, x4, or x1 slot attached either directly to the CPU's Root I/O controller or via a PCIe switch directly attached to the CPU's Root I/O controller.
-
-In our experience, many issues stem from trying to use consumer motherboards which provide physical x16 connectors that are electrically connected as e.g. PCIe 2.0 x4, PCIe slots connected via the Southbridge PCIe I/O controller, or PCIe slots connected through a PCIe switch that does
-not support PCIe atomics.
-
-If you attempt to run ROCm on a system without proper PCIe atomic support, you may see an error in the kernel log (`dmesg`):
-```
-kfd: skipped device 1002:7300, PCI rejects atomics
+python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
 ```
 
-Experimental support for our Hawaii (GFX7) GPUs (Radeon R9 290, R9 390, FirePro W9100, S9150, S9170)
-does not require or take advantage of PCIe Atomics. However, we still recommend that you use a CPU
-from the list provided above for compatibility purposes.
-
-#### Not supported or limited support under ROCm
-
-##### Limited support
-
-* ROCm 4.x should support PCIe 2.0 enabled CPUs such as the AMD Opteron, Phenom, Phenom II, Athlon, Athlon X2, Athlon II and older Intel Xeon and Intel Core Architecture and Pentium CPUs. However, we have done very limited testing on these configurations, since our test farm has been catering to CPUs listed above. This is where we need community support. _If you find problems on such setups, please report these issues_.
-* Thunderbolt 1, 2, and 3 enabled breakout boxes should now be able to work with ROCm. Thunderbolt 1 and 2 are PCIe 2.0 based, and thus are only supported with GPUs that do not require PCIe 3.1.0 atomics (e.g. Vega 10). However, we have done no testing on this configuration and would need community support due to limited access to this type of equipment.
-* AMD "Carrizo" and "Bristol Ridge" APUs are enabled to run OpenCL, but do not yet support HIP or our libraries built on top of these compilers and runtimes.
-  * As of ROCm 2.1, "Carrizo" and "Bristol Ridge" require the use of upstream kernel drivers.
-  * In addition, various "Carrizo" and "Bristol Ridge" platforms may not work due to OEM and ODM choices when it comes to key configurations parameters such as inclusion of the required CRAT tables and IOMMU configuration parameters in the system BIOS.
-  * Before purchasing such a system for ROCm, please verify that the BIOS provides an option for enabling IOMMUv2 and that the system BIOS properly exposes the correct CRAT table. Inquire with your vendor about the latter.
-* AMD "Raven Ridge" APUs are enabled to run OpenCL, but do not yet support HIP or our libraries built on top of these compilers and runtimes.
-  * As of ROCm 2.1, "Raven Ridge" requires the use of upstream kernel drivers.
-  * In addition, various "Raven Ridge" platforms may not work due to OEM and ODM choices when it comes to key configurations parameters such as inclusion of the required CRAT tables and IOMMU configuration parameters in the system BIOS.
-  * Before purchasing such a system for ROCm, please verify that the BIOS provides an option for enabling IOMMUv2 and that the system BIOS properly exposes the correct CRAT table. Inquire with your vendor about the latter.
-
-##### Not supported
-
-* "Tonga", "Iceland", "Vega M", and "Vega 12" GPUs are not supported.
-* We do not support GFX8-class GPUs (Fiji, Polaris, etc.) on CPUs that do not have PCIe 3.0 with PCIe atomics.
-  * As such, we do not support AMD Carrizo and Kaveri APUs as hosts for such GPUs.
-  * Thunderbolt 1 and 2 enabled GPUs are not supported by GFX8 GPUs on ROCm. Thunderbolt 1 & 2 are based on PCIe 2.0.
-
-In the default ROCm configuration, GFX8 and GFX9 GPUs require PCI Express 3.0 with PCIe atomics. The ROCm platform leverages these advanced capabilities to allow features such as user-level submission of work from the host to the GPU. This includes PCIe atomic Fetch and Add, Compare and Swap, Unconditional Swap, and AtomicOp Completion.
-
-#### ROCm support in upstream Linux kernels
-
-As of ROCm 1.9.0, the ROCm user-level software is compatible with the AMD drivers in certain upstream Linux kernels.
-As such, users have the option of either using the ROCK kernel driver that are part of AMD's ROCm repositories or using the upstream driver and only installing ROCm user-level utilities from AMD's ROCm repositories.
-
-These releases of the upstream Linux kernel support the following GPUs in ROCm:
- * 4.17: Fiji, Polaris 10, Polaris 11
- * 4.18: Fiji, Polaris 10, Polaris 11, Vega10
- * 4.20: Fiji, Polaris 10, Polaris 11, Vega10, Vega 7nm
-
-The upstream driver may be useful for running ROCm software on systems that are not compatible with the kernel driver available in AMD's repositories.
-For users that have the option of using either AMD's or the upstreamed driver, there are various tradeoffs to take into consideration:
-
-|   | Using AMD's `rock-dkms` package | Using the upstream kernel driver |
-| ---- | ------------------------------------------------------------| ----- |
-| Pros | More GPU features, and they are enabled earlier | Includes the latest Linux kernel features |
-|      | Tested by AMD on supported distributions | May work on other distributions and with custom kernels |
-|      | Supported GPUs enabled regardless of kernel version | |
-|      | Includes the latest GPU firmware | |
-| Cons | May not work on all Linux distributions or versions | Features and hardware support varies depending on kernel version |
-|      | Not currently supported on kernels newer than 5.4 | Limits GPU's usage of system memory to 3/8 of system memory (before 5.6). For 5.6 and beyond, both DKMS and upstream kernels allow use of 15/16 of system memory. |
-|      |   | IPC and RDMA capabilities are not yet enabled |
-|      |   | Not tested by AMD to the same level as `rock-dkms` package |
-|      |   | Does not include most up-to-date firmware |
-
-
-# Disclaimer
-
-AMD®, the AMD Arrow logo, AMD Instinct™, Radeon™, ROCm® and combinations thereof are trademarks of Advanced Micro Devices, Inc.
-
-Linux® is the registered trademark of Linus Torvalds in the U.S. and other countries.
-
-PCIe® is a registered trademark of PCI-SIG Corporation. Other product names used in this publication are for identification purposes only and may be trademarks of their respective companies.  
-
-Google®  is a registered trademark of Google LLC.
-
-Ubuntu and the Ubuntu logo are registered trademarks of Canonical Ltd.
-
-Other product names used in this publication are for identification purposes only and may be trademarks of their respective companies.
+## Older ROCm™ Releases
 
+For release information for older ROCm™ releases, refer to
+[CHANGELOG](./CHANGELOG.md).

RELEASE.md

@@ -0,0 +1,31 @@
+# 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.0.1
+<!-- markdownlint-disable first-line-h1 -->
+<!-- markdownlint-disable no-duplicate-header -->
+### Deprecations and Warnings
+
+#### Refactor of HIPCC/HIPCONFIG
+
+In prior ROCm releases, by default, the hipcc/hipconfig Perl scripts were used to identify and set target compiler options, target platform, compiler, and runtime appropriately.
+
+In ROCm v5.0.1, hipcc.bin and hipconfig.bin have been added as the compiled binary implementations of the hipcc and hipconfig. These new binaries are currently a work-in-progress, considered, and marked as experimental. ROCm plans to fully transition to hipcc.bin and hipconfig.bin in the a future ROCm release. The existing hipcc and hipconfig Perl scripts are renamed to hipcc.pl and hipconfig.pl respectively. New top-level hipcc and hipconfig Perl scripts are created, which can switch between the Perl script or the compiled binary based on the environment variable HIPCC_USE_PERL_SCRIPT.
+
+In ROCm 5.0.1, by default, this environment variable is set to use hipcc and hipconfig through the Perl scripts.
+
+Subsequently, Perl scripts will no longer be available in ROCm in a future release.

default.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <manifest>
     <remote name="roc-github"
-fetch="http://github.com/RadeonOpenCompute/" />
+fetch="https://github.com/RadeonOpenCompute/" />
     <remote name="rocm-devtools"
 fetch="https://github.com/ROCm-Developer-Tools/" />
     <remote name="rocm-swplat"
@@ -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-4.1.0"
+    <default revision="refs/tags/rocm-5.5.1"
      remote="roc-github"
      sync-c="true"
      sync-j="4" />
@@ -20,8 +20,8 @@ fetch="https://github.com/KhronosGroup/" />
     <project name="ROCK-Kernel-Driver" />
     <project name="ROCT-Thunk-Interface" />
     <project name="ROCR-Runtime" />
-    <project name="ROC-smi" />
     <project name="rocm_smi_lib" />
+    <project name="rocm-core" />
     <project name="rocm-cmake" />
     <project name="rocminfo" />
     <project name="rocprofiler" remote="rocm-devtools" />
@@ -30,12 +30,14 @@ fetch="https://github.com/KhronosGroup/" />
     <project path="ROCm-OpenCL-Runtime/api/opencl/khronos/icd" name="OpenCL-ICD-Loader" remote="KhronosGroup" revision="6c03f8b58fafd9dd693eaac826749a5cfad515f8" />
     <project name="clang-ocl" />
 <!--HIP Projects-->
-    <project name="HIP" remote="rocm-devtools" revision="refs/tags/rocm-4.1.1" />
+    <project name="HIP" remote="rocm-devtools" />
+    <project name="hipamd" remote="rocm-devtools" />
     <project name="HIP-Examples" remote="rocm-devtools" />
     <project name="ROCclr" remote="rocm-devtools" />
     <project name="HIPIFY" remote="rocm-devtools" />
+    <project name="HIPCC" remote="rocm-devtools" />
 <!-- The following projects are all associated with the AMDGPU LLVM compiler -->
-    <project name="llvm-project" revision="refs/tags/rocm-4.1.1" />
+    <project name="llvm-project" />
     <project name="ROCm-Device-Libs" />
     <project name="atmi" />
     <project name="ROCm-CompilerSupport" />
@@ -47,24 +49,26 @@ fetch="https://github.com/KhronosGroup/" />
     <project name="ROCgdb" remote="rocm-devtools" />
     <project name="ROCdbgapi" remote="rocm-devtools" />
 <!-- ROCm Libraries -->
-    <project name="rdc" remote="roc-github" />
-    <project name="rocBLAS" remote="rocm-swplat" />
-    <project name="Tensile" remote="rocm-swplat" />
-    <project name="hipBLAS" remote="rocm-swplat" />
-    <project name="rocFFT" remote="rocm-swplat" />
-    <project name="hipFFT" remote="rocm-swplat" />
-    <project name="rocRAND" remote="rocm-swplat" />
-    <project name="rocSPARSE" remote="rocm-swplat" />
-    <project name="rocSOLVER" remote="rocm-swplat" />
-    <project name="hipSPARSE" remote="rocm-swplat" />
-    <project name="rocALUTION" remote="rocm-swplat" />
+    <project name="rdc" />
+    <project groups="mathlibs" name="rocBLAS" remote="rocm-swplat" />
+    <project groups="mathlibs" name="Tensile" remote="rocm-swplat" />
+    <project groups="mathlibs" name="hipBLAS" remote="rocm-swplat" />
+    <project groups="mathlibs" name="rocFFT" remote="rocm-swplat" />
+    <project groups="mathlibs" name="hipFFT" remote="rocm-swplat" />
+    <project groups="mathlibs" name="rocRAND" remote="rocm-swplat" />
+    <project groups="mathlibs" name="rocSPARSE" remote="rocm-swplat" />
+    <project groups="mathlibs" name="rocSOLVER" remote="rocm-swplat" />
+    <project groups="mathlibs" name="hipSOLVER" remote="rocm-swplat" />
+    <project groups="mathlibs" name="hipSPARSE" remote="rocm-swplat" />
+    <project groups="mathlibs" name="rocALUTION" remote="rocm-swplat" />
     <project name="MIOpenGEMM" remote="rocm-swplat" />
     <project name="MIOpen" remote="rocm-swplat" />
-    <project name="rccl" remote="rocm-swplat" />
+    <project groups="mathlibs" name="rccl" remote="rocm-swplat" />
     <project name="MIVisionX" remote="gpuopen-libs" />
-    <project name="rocThrust" remote="rocm-swplat" />
-    <project name="hipCUB" remote="rocm-swplat" />
-    <project name="rocPRIM" remote="rocm-swplat" />
+    <project groups="mathlibs" name="rocThrust" remote="rocm-swplat" />
+    <project groups="mathlibs" name="hipCUB" remote="rocm-swplat" />
+    <project groups="mathlibs" name="rocPRIM" remote="rocm-swplat" />
+    <project groups="mathlibs" name="rocWMMA" remote="rocm-swplat" />
     <project name="hipfort" remote="rocm-swplat" />
     <project name="AMDMIGraphX" remote="rocm-swplat" />
     <project name="ROCmValidationSuite" remote="rocm-devtools" />

docs/404.md

@@ -0,0 +1,6 @@
+# 404 Page Not Found
+
+Page could not be found.
+
+Return to [home](./index) or please use the links from the sidebar to find what
+you are looking for.

docs/about.md

@@ -0,0 +1,74 @@
+# About ROCm Documentation
+
+ROCm documentation is made available under open source [licenses](licensing.md).
+Documentation is built using open source toolchains. Contributions to our
+documentation is encouraged and welcome. As a contributor, please familiarize
+yourself with our documentation toolchain.
+
+## ReadTheDocs
+
+[ReadTheDocs](https://docs.readthedocs.io/en/stable/) is our front end for the
+our documentation. By front end, this is the tool that serves our HTML based
+documentation to our end users.
+
+## Doxygen
+
+[Doxygen](https://www.doxygen.nl/) is the most common inline code documentation
+standard. ROCm projects are use Doxygen for public API documentation (unless the
+upstream project is using a different tool).
+
+## Sphinx
+
+[Sphinx](https://www.sphinx-doc.org/en/master/) is a documentation generator
+originally used for python. It is now widely used in the Open Source community.
+Originally, sphinx supported RST based documentation. Markdown support is now
+available. ROCm documentation plans to default to markdown for new projects.
+Existing projects using RST are under no obligation to convert to markdown. New
+projects that believe markdown is not suitable should contact the documentation
+team prior to selecting RST.
+
+### MyST
+
+[Markedly Structured Text (MyST)](https://myst-tools.org/docs/spec) is an extended
+flavor of Markdown ([CommonMark](https://commonmark.org/)) influenced by reStructuredText (RST) and Sphinx.
+It is integrated via [`myst-parser`](https://myst-parser.readthedocs.io/en/latest/).
+A cheat sheet that showcases how to use the MyST syntax is available over at [the Jupyter
+reference](https://jupyterbook.org/en/stable/reference/cheatsheet.html).
+
+### Sphinx Theme
+
+ROCm is using the
+[Sphinx Book Theme](https://sphinx-book-theme.readthedocs.io/en/latest/). This
+theme is used by Jupyter books. ROCm documentation applies some customization
+include a header and footer on top of the Sphinx Book Theme. A future custom
+ROCm theme will be part of our documentation goals.
+
+### Sphinx Design
+
+Sphinx Design is an extension for sphinx based websites that add design
+functionality. Please see the documentation
+[here](https://sphinx-design.readthedocs.io/en/latest/index.html). ROCm
+documentation uses sphinx design for grids, cards, and synchronized tabs.
+Other features may be used in the future.
+
+### Sphinx External TOC
+
+ROCm uses the
+[sphinx-external-toc](https://sphinx-external-toc.readthedocs.io/en/latest/intro.html)
+for our navigation. This tool allows a YAML file based left navigation menu. This
+tool was selected due to its flexibility that allows scripts to operate on the
+YAML file. Please transition to this file for the project's navigation. You can
+see the `_toc.yml.in` file in this repository in the docs/sphinx folder for an
+example.
+
+### Breathe
+
+Sphinx uses [Breathe](https://www.breathe-doc.org/) to integrate Doxygen
+content.
+
+## `rocm-docs-core` pip package
+
+[rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) is an AMD
+maintained project that applies customization for our documentation. This
+project is the tool most ROCm repositories will use as part of the documentation
+build.

docs/conf.py

@@ -0,0 +1,76 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+import shutil
+
+from rocm_docs import ROCmDocs
+
+
+shutil.copy2('../CONTRIBUTING.md','./contributing.md')
+shutil.copy2('../RELEASE.md','./release.md')
+# Keep capitalization due to similar linking on GitHub's markdown preview.
+shutil.copy2('../CHANGELOG.md','./CHANGELOG.md')
+
+# configurations for PDF output by Read the Docs
+project = "ROCm Documentation"
+author = "Advanced Micro Devices, Inc."
+copyright = "Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved."
+version = "5.0.1"
+release = "5.0.1"
+
+setting_all_article_info = True
+all_article_info_os = ["linux"]
+all_article_info_author = ""
+
+# pages with specific settings
+article_pages = [
+    {"file":"deploy/linux/index", "os":["linux"]},
+    {"file":"deploy/linux/install_overview", "os":["linux"]},
+    {"file":"deploy/linux/prerequisites", "os":["linux"]},
+    {"file":"deploy/linux/quick_start", "os":["linux"]},
+    {"file":"deploy/linux/install", "os":["linux"]},
+    {"file":"deploy/linux/upgrade", "os":["linux"]},
+    {"file":"deploy/linux/uninstall", "os":["linux"]},
+    {"file":"deploy/linux/package_manager_integration", "os":["linux"]},
+    {"file":"deploy/docker", "os":["linux"]},
+    
+    {"file":"release/gpu_os_support", "os":["linux"]},
+    {"file":"release/docker_support_matrix", "os":["linux"]},
+    
+    {"file":"reference/gpu_libraries/communication", "os":["linux"]},
+    {"file":"reference/ai_tools", "os":["linux"]},
+    {"file":"reference/management_tools", "os":["linux"]},
+    {"file":"reference/validation_tools", "os":["linux"]},
+    {"file":"reference/framework_compatibility/framework_compatibility", "os":["linux"]},
+    {"file":"reference/computer_vision", "os":["linux"]},
+    
+    {"file":"how_to/deep_learning_rocm", "os":["linux"]},
+    {"file":"how_to/gpu_aware_mpi", "os":["linux"]},
+    {"file":"how_to/magma_install/magma_install", "os":["linux"]},
+    {"file":"how_to/pytorch_install/pytorch_install", "os":["linux"]},
+    {"file":"how_to/system_debugging", "os":["linux"]},
+    {"file":"how_to/tensorflow_install/tensorflow_install", "os":["linux"]},
+
+    {"file":"examples/machine_learning", "os":["linux"]},
+    {"file":"examples/inception_casestudy/inception_casestudy", "os":["linux"]},
+    
+    {"file":"understand/file_reorg", "os":["linux"]},
+
+    {"file":"understand/isv_deployment_win", "os":["windows"]},
+]
+
+external_toc_path = "./sphinx/_toc.yml"
+
+docs_core = ROCmDocs("ROCm 5.0.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
+}

docs/data/deploy/quick_start_windows/image planning

@@ -0,0 +1 @@
+