diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
index ec9950588..99ce4d5fe 100644
--- a/.github/CODEOWNERS
+++ b/.github/CODEOWNERS
@@ -1 +1 @@
-* @saadrahim @Rmalavally @amd-aakash @zhang2amd @jlgreathouse
+* @saadrahim @Rmalavally @amd-aakash @zhang2amd @jlgreathouse @samjwu
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index a58c4bee8..d751197bf 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -4,11 +4,11 @@
version: 2
sphinx:
- configuration: docs/sphinx/conf.py
+ configuration: docs/conf.py
formats: all
python:
version: "3.8"
install:
- - requirements: docs/sphinx/requirements.txt
+ - requirements: docs/.sphinx/requirements.txt
diff --git a/README.md b/README.md
index d74bb4075..804e16c65 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,16 @@ repositories and the associated commit used to build the current ROCm release.
The default.xml file uses the repo Manifest format.
+## How to build documentation via Sphinx
+
+```bash
+cd docs
+
+pip3 install -r .sphinx/requirements.txt
+
+python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
+```
+
## ROCm v5.4.3 Release Notes
ROCm v5.4.3 is now released. For ROCm v5.4.3 documentation, refer to
diff --git a/docs/sphinx/_toc.yml.in b/docs/.sphinx/_toc.yml.in
similarity index 100%
rename from docs/sphinx/_toc.yml.in
rename to docs/.sphinx/_toc.yml.in
diff --git a/docs/sphinx/requirements.in b/docs/.sphinx/requirements.in
similarity index 100%
rename from docs/sphinx/requirements.in
rename to docs/.sphinx/requirements.in
diff --git a/docs/sphinx/requirements.txt b/docs/.sphinx/requirements.txt
similarity index 100%
rename from docs/sphinx/requirements.txt
rename to docs/.sphinx/requirements.txt
diff --git a/docs/sphinx/about.md b/docs/about.md
similarity index 100%
rename from docs/sphinx/about.md
rename to docs/about.md
diff --git a/docs/sphinx/all_deploy_options.md b/docs/all_deploy_options.md
similarity index 100%
rename from docs/sphinx/all_deploy_options.md
rename to docs/all_deploy_options.md
diff --git a/docs/sphinx/conf.py b/docs/conf.py
similarity index 84%
rename from docs/sphinx/conf.py
rename to docs/conf.py
index 70d69b051..5be7ed5ee 100644
--- a/docs/sphinx/conf.py
+++ b/docs/conf.py
@@ -5,8 +5,8 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html
import shutil
-shutil.copy2('../../CHANGELOG.md','./')
-shutil.copy2('../../RELEASE.md','./')
+shutil.copy2('../CHANGELOG.md','./')
+shutil.copy2('../RELEASE.md','./')
from rocm_docs import ROCmDocs
diff --git a/docs/sphinx/hip_sdk_install_win/image/AMD-Display-Driver.png b/docs/data/hip_sdk_install_win/image/AMD-Display-Driver.png
similarity index 100%
rename from docs/sphinx/hip_sdk_install_win/image/AMD-Display-Driver.png
rename to docs/data/hip_sdk_install_win/image/AMD-Display-Driver.png
diff --git a/docs/sphinx/hip_sdk_install_win/image/AMD-Logo.png b/docs/data/hip_sdk_install_win/image/AMD-Logo.png
similarity index 100%
rename from docs/sphinx/hip_sdk_install_win/image/AMD-Logo.png
rename to docs/data/hip_sdk_install_win/image/AMD-Logo.png
diff --git a/docs/sphinx/hip_sdk_install_win/image/BitCode-Profiler.png b/docs/data/hip_sdk_install_win/image/BitCode-Profiler.png
similarity index 100%
rename from docs/sphinx/hip_sdk_install_win/image/BitCode-Profiler.png
rename to docs/data/hip_sdk_install_win/image/BitCode-Profiler.png
diff --git a/docs/sphinx/hip_sdk_install_win/image/DeSelectAll.png b/docs/data/hip_sdk_install_win/image/DeSelectAll.png
similarity index 100%
rename from docs/sphinx/hip_sdk_install_win/image/DeSelectAll.png
rename to docs/data/hip_sdk_install_win/image/DeSelectAll.png
diff --git a/docs/sphinx/hip_sdk_install_win/image/HIP-Libraries.png b/docs/data/hip_sdk_install_win/image/HIP-Libraries.png
similarity index 100%
rename from docs/sphinx/hip_sdk_install_win/image/HIP-Libraries.png
rename to docs/data/hip_sdk_install_win/image/HIP-Libraries.png
diff --git a/docs/sphinx/hip_sdk_install_win/image/HIP-Ray-Tracing.png b/docs/data/hip_sdk_install_win/image/HIP-Ray-Tracing.png
similarity index 100%
rename from docs/sphinx/hip_sdk_install_win/image/HIP-Ray-Tracing.png
rename to docs/data/hip_sdk_install_win/image/HIP-Ray-Tracing.png
diff --git a/docs/sphinx/hip_sdk_install_win/image/HIP-Runtime-Compiler.png b/docs/data/hip_sdk_install_win/image/HIP-Runtime-Compiler.png
similarity index 100%
rename from docs/sphinx/hip_sdk_install_win/image/HIP-Runtime-Compiler.png
rename to docs/data/hip_sdk_install_win/image/HIP-Runtime-Compiler.png
diff --git a/docs/sphinx/hip_sdk_install_win/image/HIP-SDK-Core.png b/docs/data/hip_sdk_install_win/image/HIP-SDK-Core.png
similarity index 100%
rename from docs/sphinx/hip_sdk_install_win/image/HIP-SDK-Core.png
rename to docs/data/hip_sdk_install_win/image/HIP-SDK-Core.png
diff --git a/docs/sphinx/hip_sdk_install_win/image/Installation-Complete.png b/docs/data/hip_sdk_install_win/image/Installation-Complete.png
similarity index 100%
rename from docs/sphinx/hip_sdk_install_win/image/Installation-Complete.png
rename to docs/data/hip_sdk_install_win/image/Installation-Complete.png
diff --git a/docs/sphinx/hip_sdk_install_win/image/Installation.png b/docs/data/hip_sdk_install_win/image/Installation.png
similarity index 100%
rename from docs/sphinx/hip_sdk_install_win/image/Installation.png
rename to docs/data/hip_sdk_install_win/image/Installation.png
diff --git a/docs/sphinx/hip_sdk_install_win/image/Installer-Window.png b/docs/data/hip_sdk_install_win/image/Installer-Window.png
similarity index 100%
rename from docs/sphinx/hip_sdk_install_win/image/Installer-Window.png
rename to docs/data/hip_sdk_install_win/image/Installer-Window.png
diff --git a/docs/sphinx/hip_sdk_install_win/image/Loading-Window.png b/docs/data/hip_sdk_install_win/image/Loading-Window.png
similarity index 100%
rename from docs/sphinx/hip_sdk_install_win/image/Loading-Window.png
rename to docs/data/hip_sdk_install_win/image/Loading-Window.png
diff --git a/docs/sphinx/hip_sdk_install_win/image/LoadingWindow.png b/docs/data/hip_sdk_install_win/image/LoadingWindow.png
similarity index 100%
rename from docs/sphinx/hip_sdk_install_win/image/LoadingWindow.png
rename to docs/data/hip_sdk_install_win/image/LoadingWindow.png
diff --git a/docs/sphinx/hip_sdk_install_win/image/Setup-Icon.png b/docs/data/hip_sdk_install_win/image/Setup-Icon.png
similarity index 100%
rename from docs/sphinx/hip_sdk_install_win/image/Setup-Icon.png
rename to docs/data/hip_sdk_install_win/image/Setup-Icon.png
diff --git a/docs/sphinx/hip_sdk_install_win/image/Uninstallation.png b/docs/data/hip_sdk_install_win/image/Uninstallation.png
similarity index 100%
rename from docs/sphinx/hip_sdk_install_win/image/Uninstallation.png
rename to docs/data/hip_sdk_install_win/image/Uninstallation.png
diff --git a/docs/sphinx/hip_sdk_install_win/image/Windows-Security.png b/docs/data/hip_sdk_install_win/image/Windows-Security.png
similarity index 100%
rename from docs/sphinx/hip_sdk_install_win/image/Windows-Security.png
rename to docs/data/hip_sdk_install_win/image/Windows-Security.png
diff --git a/docs/sphinx/hip_sdk_install_win/image/image planning b/docs/data/hip_sdk_install_win/image/image planning
similarity index 100%
rename from docs/sphinx/hip_sdk_install_win/image/image planning
rename to docs/data/hip_sdk_install_win/image/image planning
diff --git a/docs/sphinx/how_to/magma_install/figures/image.005.png b/docs/data/how_to/magma_install/figures/image.005.png
similarity index 100%
rename from docs/sphinx/how_to/magma_install/figures/image.005.png
rename to docs/data/how_to/magma_install/figures/image.005.png
diff --git a/docs/sphinx/how_to/magma_install/figures/image.006.png b/docs/data/how_to/magma_install/figures/image.006.png
similarity index 100%
rename from docs/sphinx/how_to/magma_install/figures/image.006.png
rename to docs/data/how_to/magma_install/figures/image.006.png
diff --git a/docs/sphinx/how_to/magma_install/figures/image.006.pngZone.Identifier b/docs/data/how_to/magma_install/figures/image.006.pngZone.Identifier
similarity index 100%
rename from docs/sphinx/how_to/magma_install/figures/image.006.pngZone.Identifier
rename to docs/data/how_to/magma_install/figures/image.006.pngZone.Identifier
diff --git a/docs/sphinx/deploy.md b/docs/deploy.md
similarity index 100%
rename from docs/sphinx/deploy.md
rename to docs/deploy.md
diff --git a/docs/sphinx/deploy/build_source.md b/docs/deploy/build_source.md
similarity index 100%
rename from docs/sphinx/deploy/build_source.md
rename to docs/deploy/build_source.md
diff --git a/docs/sphinx/deploy/docker.md b/docs/deploy/docker.md
similarity index 100%
rename from docs/sphinx/deploy/docker.md
rename to docs/deploy/docker.md
diff --git a/docs/sphinx/deploy/install.md b/docs/deploy/install.md
similarity index 100%
rename from docs/sphinx/deploy/install.md
rename to docs/deploy/install.md
diff --git a/docs/sphinx/deploy/multi.md b/docs/deploy/multi.md
similarity index 100%
rename from docs/sphinx/deploy/multi.md
rename to docs/deploy/multi.md
diff --git a/docs/sphinx/deploy/spack.md b/docs/deploy/spack.md
similarity index 100%
rename from docs/sphinx/deploy/spack.md
rename to docs/deploy/spack.md
diff --git a/docs/sphinx/examples/ai_ml_inferencing.md b/docs/examples/ai_ml_inferencing.md
similarity index 100%
rename from docs/sphinx/examples/ai_ml_inferencing.md
rename to docs/examples/ai_ml_inferencing.md
diff --git a/docs/sphinx/examples/inception_casestudy/inception_casestudy.md b/docs/examples/inception_casestudy/inception_casestudy.md
similarity index 100%
rename from docs/sphinx/examples/inception_casestudy/inception_casestudy.md
rename to docs/examples/inception_casestudy/inception_casestudy.md
diff --git a/docs/sphinx/gpu_libraries.md b/docs/gpu_libraries.md
similarity index 100%
rename from docs/sphinx/gpu_libraries.md
rename to docs/gpu_libraries.md
diff --git a/docs/sphinx/hip_sdk_install_win/hip_sdk_install_win.md b/docs/hip_sdk_install_win/hip_sdk_install_win.md
similarity index 89%
rename from docs/sphinx/hip_sdk_install_win/hip_sdk_install_win.md
rename to docs/hip_sdk_install_win/hip_sdk_install_win.md
index a6beb9995..5c677b234 100644
--- a/docs/sphinx/hip_sdk_install_win/hip_sdk_install_win.md
+++ b/docs/hip_sdk_install_win/hip_sdk_install_win.md
@@ -35,15 +35,15 @@ The installer will begin to load and detect your system's configuration and
compatibility, as shown in Figure 2. A completely loaded AMD HIP SDK Installer
window will appear, as shown in Figure 3.
-|  |
+|  |
|:------------------------------:|
| **Figure 1. Setup Icon** |
-|  |
+|  |
|:-------------------------------------------:|
| **Figure 2. AMD HIP SDK Loading Window** |
-|  |
+|  |
|:-----------------------------------------------:|
| **Figure 3. AMD HIP SDK Installer Window** |
@@ -76,7 +76,7 @@ in the upper right corner of the installer window, as seen in Figure 3. Figure 4
demonstrates the installer window once the installation components are all
deselected.
-|  |
+|  |
|:--------------------------------------:|
| **Figure 4. Deselect All Selection** |
@@ -95,23 +95,23 @@ Figures 4 through 8 demonstrate the options available to you when you click
**Note** You can manually select installation locations for the HIP SDK Core, as
shown in Figure 5.
-|  |
+|  |
|:---------------------------------------:|
| **Figure 5. HIP SDK Core Option** |
-|  |
+|  |
|:-----------------------------------------:|
| **Figure 6. HIP Libraries Option** |
-|  |
+|  |
|:-------------------------------------------------------:|
| **Figure 7. HIP Runtime Compiler Option** |
-|  |
+|  |
|:---------------------------------------------:|
| **Figure 8. HIP Ray Tracing** |
-|  |
+|  |
|:-----------------------------------------------:|
| **Figure 9. BitCode Profiler** |
@@ -148,7 +148,7 @@ previously installed drivers.
Please wait for the installation to complete during as shown in Figure 11.
-|  |
+|  |
|:-------------------------------------:|
| **Figure 11. Active Installation** |
@@ -157,7 +157,7 @@ Please wait for the installation to complete during as shown in Figure 11.
Once the installation is complete, the installer window may prompt you for a
system restart. Click **Restart** at the lower right corner, shown in Figure 12.
-|  |
+|  |
|:---------------------------------------------------------:|
| **Figure 12. Installation Complete** |
@@ -174,6 +174,6 @@ uninstallation of the HIP SDK Core and drivers repeat the steps in the sections
**Note** Selecting **Install** once ROCm has already installed results in its
uninstallation.
-|  |
+|  |
|:----------------------------------------:|
| **Figure 13. HIP SDK Uninstalling** |
diff --git a/docs/sphinx/how_to/deep_learning_rocm.md b/docs/how_to/deep_learning_rocm.md
similarity index 100%
rename from docs/sphinx/how_to/deep_learning_rocm.md
rename to docs/how_to/deep_learning_rocm.md
diff --git a/docs/sphinx/how_to/docker_gpu_isolation.md b/docs/how_to/docker_gpu_isolation.md
similarity index 100%
rename from docs/sphinx/how_to/docker_gpu_isolation.md
rename to docs/how_to/docker_gpu_isolation.md
diff --git a/docs/sphinx/how_to/magma_install/magma_install.md b/docs/how_to/magma_install/magma_install.md
similarity index 96%
rename from docs/sphinx/how_to/magma_install/magma_install.md
rename to docs/how_to/magma_install/magma_install.md
index 29c0dc1a4..7c7589ed0 100644
--- a/docs/sphinx/how_to/magma_install/magma_install.md
+++ b/docs/how_to/magma_install/magma_install.md
@@ -9,7 +9,7 @@ each framework. Refer to the ROCm Compatible Frameworks Release Notes for each
framework's most current release notes at
[/bundle/ROCm-Compatible-Frameworks-Release-Notes/page/Framework_Release_Notes.html](/bundle/ROCm-Compatible-Frameworks-Release-Notes/page/Framework_Release_Notes.html).
-| |
+| |
|:--:|
| Figure 5. ROCm Compatible Frameworks Flowchart|
@@ -47,7 +47,7 @@ This will automatically download the image if it does not exist on the host. You
PyTorch supports the ROCm platform by providing tested wheels packages. To access this feature, refer to [https://pytorch.org/get-started/locally/](https://pytorch.org/get-started/locally/) and choose the "ROCm" compute platform. Figure 6 is a matrix from pytroch.org that illustrates the installation compatibility between ROCm and the PyTorch build.
-| |
+| |
|:--:|
| Figure 6. Installation Matrix from Pytorch.org|
diff --git a/docs/sphinx/how_to/pytorch_install/pytorch_install.md b/docs/how_to/pytorch_install/pytorch_install.md
similarity index 100%
rename from docs/sphinx/how_to/pytorch_install/pytorch_install.md
rename to docs/how_to/pytorch_install/pytorch_install.md
diff --git a/docs/sphinx/how_to/system_debugging.md b/docs/how_to/system_debugging.md
similarity index 100%
rename from docs/sphinx/how_to/system_debugging.md
rename to docs/how_to/system_debugging.md
diff --git a/docs/sphinx/how_to/tensorflow_install/tensorflow_install.md b/docs/how_to/tensorflow_install/tensorflow_install.md
similarity index 100%
rename from docs/sphinx/how_to/tensorflow_install/tensorflow_install.md
rename to docs/how_to/tensorflow_install/tensorflow_install.md
diff --git a/docs/sphinx/inception_casestudy_migraphx/inception_casestudy_migraphx.md b/docs/inception_casestudy_migraphx/inception_casestudy_migraphx.md
similarity index 100%
rename from docs/sphinx/inception_casestudy_migraphx/inception_casestudy_migraphx.md
rename to docs/inception_casestudy_migraphx/inception_casestudy_migraphx.md
diff --git a/docs/sphinx/index.md b/docs/index.md
similarity index 100%
rename from docs/sphinx/index.md
rename to docs/index.md
diff --git a/docs/sphinx/isv_deployment_win.md b/docs/isv_deployment_win.md
similarity index 100%
rename from docs/sphinx/isv_deployment_win.md
rename to docs/isv_deployment_win.md
diff --git a/docs/sphinx/kernel_userspace.md b/docs/kernel_userspace.md
similarity index 100%
rename from docs/sphinx/kernel_userspace.md
rename to docs/kernel_userspace.md
diff --git a/docs/sphinx/packaging_guidelines.md b/docs/packaging_guidelines.md
similarity index 100%
rename from docs/sphinx/packaging_guidelines.md
rename to docs/packaging_guidelines.md
diff --git a/docs/sphinx/quick_start.md b/docs/quick_start.md
similarity index 100%
rename from docs/sphinx/quick_start.md
rename to docs/quick_start.md
diff --git a/docs/reference/compilers.md b/docs/reference/compilers.md
new file mode 100644
index 000000000..254ef1456
--- /dev/null
+++ b/docs/reference/compilers.md
@@ -0,0 +1 @@
+# Compilers
diff --git a/docs/sphinx/reference/computer_vision.md b/docs/reference/computer_vision.md
similarity index 100%
rename from docs/sphinx/reference/computer_vision.md
rename to docs/reference/computer_vision.md
diff --git a/docs/sphinx/reference/dev_tools.md b/docs/reference/dev_tools.md
similarity index 100%
rename from docs/sphinx/reference/dev_tools.md
rename to docs/reference/dev_tools.md
diff --git a/docs/sphinx/reference/docker.md b/docs/reference/docker.md
similarity index 100%
rename from docs/sphinx/reference/docker.md
rename to docs/reference/docker.md
diff --git a/docs/sphinx/reference/framework_compatiblity/framework_compatiblity.md b/docs/reference/framework_compatiblity/framework_compatiblity.md
similarity index 100%
rename from docs/sphinx/reference/framework_compatiblity/framework_compatiblity.md
rename to docs/reference/framework_compatiblity/framework_compatiblity.md
diff --git a/docs/sphinx/reference/gpu_arch.md b/docs/reference/gpu_arch.md
similarity index 100%
rename from docs/sphinx/reference/gpu_arch.md
rename to docs/reference/gpu_arch.md
diff --git a/docs/sphinx/reference/gpu_libraries/blas.md b/docs/reference/gpu_libraries/blas.md
similarity index 100%
rename from docs/sphinx/reference/gpu_libraries/blas.md
rename to docs/reference/gpu_libraries/blas.md
diff --git a/docs/sphinx/reference/gpu_libraries/c++_primitives.md b/docs/reference/gpu_libraries/c++_primitives.md
similarity index 100%
rename from docs/sphinx/reference/gpu_libraries/c++_primitives.md
rename to docs/reference/gpu_libraries/c++_primitives.md
diff --git a/docs/sphinx/reference/gpu_libraries/communication.md b/docs/reference/gpu_libraries/communication.md
similarity index 100%
rename from docs/sphinx/reference/gpu_libraries/communication.md
rename to docs/reference/gpu_libraries/communication.md
diff --git a/docs/sphinx/reference/gpu_libraries/fft.md b/docs/reference/gpu_libraries/fft.md
similarity index 100%
rename from docs/sphinx/reference/gpu_libraries/fft.md
rename to docs/reference/gpu_libraries/fft.md
diff --git a/docs/sphinx/reference/gpu_libraries/math.md b/docs/reference/gpu_libraries/math.md
similarity index 100%
rename from docs/sphinx/reference/gpu_libraries/math.md
rename to docs/reference/gpu_libraries/math.md
diff --git a/docs/sphinx/reference/gpu_libraries/rand.md b/docs/reference/gpu_libraries/rand.md
similarity index 100%
rename from docs/sphinx/reference/gpu_libraries/rand.md
rename to docs/reference/gpu_libraries/rand.md
diff --git a/docs/sphinx/reference/gpu_libraries/solver.md b/docs/reference/gpu_libraries/solver.md
similarity index 100%
rename from docs/sphinx/reference/gpu_libraries/solver.md
rename to docs/reference/gpu_libraries/solver.md
diff --git a/docs/sphinx/reference/gpu_libraries/sparse.md b/docs/reference/gpu_libraries/sparse.md
similarity index 100%
rename from docs/sphinx/reference/gpu_libraries/sparse.md
rename to docs/reference/gpu_libraries/sparse.md
diff --git a/docs/sphinx/reference/hip.md b/docs/reference/hip.md
similarity index 100%
rename from docs/sphinx/reference/hip.md
rename to docs/reference/hip.md
diff --git a/docs/sphinx/reference/kernel_userspace_compatibility/kernel_userspace_comp.md b/docs/reference/kernel_userspace_compatibility/kernel_userspace_comp.md
similarity index 100%
rename from docs/sphinx/reference/kernel_userspace_compatibility/kernel_userspace_comp.md
rename to docs/reference/kernel_userspace_compatibility/kernel_userspace_comp.md
diff --git a/docs/sphinx/reference/management_tools.md b/docs/reference/management_tools.md
similarity index 100%
rename from docs/sphinx/reference/management_tools.md
rename to docs/reference/management_tools.md
diff --git a/docs/sphinx/reference/openmp/openmp.md b/docs/reference/openmp/openmp.md
similarity index 100%
rename from docs/sphinx/reference/openmp/openmp.md
rename to docs/reference/openmp/openmp.md
diff --git a/docs/sphinx/reference/rocmcc/rocmcc.md b/docs/reference/rocmcc/rocmcc.md
similarity index 100%
rename from docs/sphinx/reference/rocmcc/rocmcc.md
rename to docs/reference/rocmcc/rocmcc.md
diff --git a/docs/sphinx/release.md b/docs/release.md
similarity index 100%
rename from docs/sphinx/release.md
rename to docs/release.md
diff --git a/docs/sphinx/release/compatibility.md b/docs/release/compatibility.md
similarity index 100%
rename from docs/sphinx/release/compatibility.md
rename to docs/release/compatibility.md
diff --git a/docs/sphinx/release/gpu_os_support.md b/docs/release/gpu_os_support.md
similarity index 97%
rename from docs/sphinx/release/gpu_os_support.md
rename to docs/release/gpu_os_support.md
index 2de33e500..c16409279 100644
--- a/docs/sphinx/release/gpu_os_support.md
+++ b/docs/release/gpu_os_support.md
@@ -1,4 +1,4 @@
- GPU and OS Support
+# GPU and OS Support
## OS Support
@@ -79,7 +79,7 @@ ROCm software support varies by GPU type and Operating System. ROCm ecosystem pr
- HIP enables the use of the HIP Runtime only.
-### GPU Support Levels
+### Support Status
GPU support levels in ROCm:
diff --git a/docs/sphinx/release/licensing.md b/docs/release/licensing.md
similarity index 100%
rename from docs/sphinx/release/licensing.md
rename to docs/release/licensing.md
diff --git a/docs/sphinx/rocm_stack.md b/docs/rocm_stack.md
similarity index 100%
rename from docs/sphinx/rocm_stack.md
rename to docs/rocm_stack.md
diff --git a/docs/sphinx/CHANGELOG.md b/docs/sphinx/CHANGELOG.md
deleted file mode 100644
index 1ad27c9e5..000000000
--- a/docs/sphinx/CHANGELOG.md
+++ /dev/null
@@ -1,882 +0,0 @@
-# Changelog
-
---------------------------------------------------------------------------------
-
-## AMD ROCm™ Releases
-
-### AMD ROCm™ V5.2 Release
-
-AMD ROCm v5.2 is now released. The release documentation is available at
-
- {%- if last_updated %}
- {% trans prefix=translate('Last updated on'), last_updated=last_updated|e %}{{ prefix }} {{ last_updated }}.{% endtrans %}
**Optimizations**
**Changed**
**Fixed**
|
-| | |
-| **hipBLAS** | **Added**
**Fixed**
|
-| | |
-| **rocFFT** | **Changed**
**Optimizations**
|
-| | |
-| **hipFFT** | **Fixed**
**Changed**
|
-| | |
-| **rocSPARSE** | **Added**
**Changed**
**Improved**
|
-| | |
-| **hipSPARSE** | **Added**
|
-| | |
-| **rocALUTION** | **Changed**
**Improved**
|
-| | |
-| **rocTHRUST** | **Updates**
**Changed**
|
-| | |
-| **rocSOLVER** | **Added**
**Optimizations**
**Changed**
**Fixed**
|
-| | |
-| **hipSOLVER** | **Added**
**Fixed**
|
-| | |
-| **RCCL** | **Added**
**Known issues**
|
-| | |
-| **hipCUB** | **Fixed**
**Added**
**Changed**
|
-| | |
-| **rocPRIM** | **Fixed**
**Added**
**Changed**
**Known issues**
|
-
-### System Management Interface
-
-#### Clock Throttling for GPU Events
-
-This feature lists GPU events as they occur in real-time and can be used with
-`kfdtest` to produce `vm_fault` events for testing.
-
-The command can be called with either `-e` or `--showevents` like this:
-
-```bash
--e [EVENT [EVENT ...]], --showevents [EVENT [EVENT ...]] Show event list
-```
-
-Where `EVENT` is any list combination of `VM_FAULT`, `THERMAL_THROTTLE`, or
-`GPU_RESET` and is **NOT** case sensitive.
-
-**Note:** If no event arguments are passed, all events will be watched by
-default.
-
-##### CLI Commands
-
-```bash
-$ rocm-smi --showevents vm_fault thermal_throttle gpu_reset
-
-======================= ROCm System Management Interface =======================
-================================= Show Events ==================================
-press 'q' or 'ctrl + c' to quit
-DEVICE TIME TYPE DESCRIPTION
-
-============================= End of ROCm SMI Log ==============================
-```
-
-(Run `kfdtest` in another window to test for `vm_fault` events.)
-
-**Note:** Unlike other rocm-smi CLI commands, this command does not quit unless
-specified by the user. Users may press either `q` or `ctrl + c` to quit.
-
-#### Display XGMI Bandwidth Between Nodes
-
-The `rsmi_minmax_bandwidth_get` API reads the HW Topology file and displays
-bandwidth (min-max) between any two NUMA nodes in a matrix format.
-
-The Command Line Interface (CLI) command can be called as follows:
-
-```bash
-$ rocm-smi --shownodesbw
-
-======================= ROCm System Management Interface =======================
-================================== Bandwidth ===================================
-GPU0 GPU1 GPU2 GPU3 GPU4 GPU5 GPU6 GPU7
-GPU0 N/A 50000-200000 50000-50000 0-0 0-0 0-0 50000-100000 0-0
-GPU1 50000-200000 N/A 0-0 50000-50000 0-0 50000-50000 0-0 0-0
-GPU2 50000-50000 0-0 N/A 50000-200000 50000-100000 0-0 0-0 0-0
-GPU3 0-0 50000-50000 50000-200000 N/A 0-0 0-0 0-0 50000-50000
-GPU4 0-0 0-0 50000-100000 0-0 N/A 50000-200000 50000-50000 0-0
-GPU5 0-0 50000-50000 0-0 0-0 50000-200000 N/A 0-0 50000-50000
-GPU6 50000-100000 0-0 0-0 0-0 50000-50000 0-0 N/A 50000-200000
-GPU7 0-0 0-0 0-0 50000-50000 0-0 50000-50000 50000-200000 N/A
-Format: min-max; Units: mps
-============================= End of ROCm SMI Log ==============================
-```
-
-The sample output above shows the maximum theoretical xgmi bandwidth between 2
-numa nodes,
-
-**Note:** "0-0" min-max bandwidth indicates devices are not connected directly.
-
-#### P2P Connection Status
-
-The `rsmi_is_p2p_accessible` API returns `True` if P2P can be implemented
-between two nodes, and returns `False` if P2P cannot be implemented between the
-two nodes.
-
-The Command Line Interface command can be called as follows:
-
-```bash
-rocm-smi --showtopoaccess
-```
-
-Sample Output:
-
-```bash
-$ rocm-smi --showtopoaccess
-======================= ROCm System Management Interface =======================
-===================== Link accessibility between two GPUs ======================
-GPU0 GPU1
-GPU0 True True
-GPU1 True True
-============================= End of ROCm SMI Log ==============================
-```
-
-## Breaking Changes
-
-### Runtime Breaking Change
-
-Re-ordering of the enumerated type in `hip_runtime_api.h` to better match CUDA.
-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.
-
-```c
-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;
-```
-
-## Known Issues in This Release
-
-### 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`
-
-1. Users can find the values of the collected counters in the output file
- generated in step 2.
-
-### No Support for SMI and ROCDebugger on SRIOV
-
-System Management Interface (SMI) and ROCDebugger are not supported in the SRIOV
-environment on any GPU, including the
-**Radeon Pro V620 and W6800 Workstation GPUs**. For more information, refer to
-the Systems Management Interface documentation.
-
-## Deprecations and Warnings in This Release
-
-### 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
-
-```c
-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
-
-```c
-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.
-
-#### HIPCC/HIPCONFIG Refactoring
-
-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, `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, 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.
-
-### 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.
-
-## Archived Documentation
-
-Older rocm documentation is archived at
- {% else %}
- {% trans copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %}
-
- {% endif %}
-
- {%- elif type == "url" -%}
-
- {%- else %}
- Incorrectly configured icon link. Type must be `fontawesome`, `url` or `local`.
- {%- endif -%}
-
-
- {%- endif %}
- {%- if theme_extra_footer %}
-