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.pngZone.Identifier b/docs/data/how_to/magma_install/figures/image.006.pngZone.Identifier similarity index 100% rename from docs/sphinx/how_to/magma_install/figures/image.006.pngZone.Identifier rename to docs/data/how_to/magma_install/figures/image.006.pngZone.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. -| ![Setup](image/Setup-Icon.png) | +| ![Setup](../data/hip_sdk_install_win/image/Setup-Icon.png) | |:------------------------------:| | **Figure 1. Setup Icon** | -| ![Loading Window](image/Loading-Window.png) | +| ![Loading Window](../data/hip_sdk_install_win/image/Loading-Window.png) | |:-------------------------------------------:| | **Figure 2. AMD HIP SDK Loading Window** | -| ![Installer Window](image/Installer-Window.png) | +| ![Installer Window](../data/hip_sdk_install_win/image/Installer-Window.png) | |:-----------------------------------------------:| | **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. -| ![DeSelect All](image/DeSelectAll.png) | +| ![DeSelect All](../data/hip_sdk_install_win/image/DeSelectAll.png) | |:--------------------------------------:| | **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. -| ![HIP SDK Core](image/HIP-SDK-Core.png) | +| ![HIP SDK Core](../data/hip_sdk_install_win/image/HIP-SDK-Core.png) | |:---------------------------------------:| | **Figure 5. HIP SDK Core Option** | -| ![HIP Libraries](image/HIP-Libraries.png) | +| ![HIP Libraries](../data/hip_sdk_install_win/image/HIP-Libraries.png) | |:-----------------------------------------:| | **Figure 6. HIP Libraries Option** | -| ![HIP Runtime Compiler](image/HIP-Runtime-Compiler.png) | +| ![HIP Runtime Compiler](../data/hip_sdk_install_win/image/HIP-Runtime-Compiler.png) | |:-------------------------------------------------------:| | **Figure 7. HIP Runtime Compiler Option** | -| ![HIP Ray Tracing](image/HIP-Ray-Tracing.png) | +| ![HIP Ray Tracing](../data/hip_sdk_install_win/image/HIP-Ray-Tracing.png) | |:---------------------------------------------:| | **Figure 8. HIP Ray Tracing** | -| ![BitCode Profiler](image/BitCode-Profiler.png) | +| ![BitCode Profiler](../data/hip_sdk_install_win/image/BitCode-Profiler.png) | |:-----------------------------------------------:| | **Figure 9. BitCode Profiler** | @@ -148,7 +148,7 @@ previously installed drivers. Please wait for the installation to complete during as shown in Figure 11. -| ![Installing](image/Installation.png) | +| ![Installing](../data/hip_sdk_install_win/image/Installation.png) | |:-------------------------------------:| | **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. -| ![Installation Complete](image/Installation-Complete.png) | +| ![Installation Complete](../data/hip_sdk_install_win/image/Installation-Complete.png) | |:---------------------------------------------------------:| | **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. -| ![Uninstall](image/Uninstallation.png) | +| ![Uninstall](../data/hip_sdk_install_win/image/Uninstallation.png) | |:----------------------------------------:| | **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](figures/image.005.png)| +| ![Figure 5](../../data/how_to/magma_install/figures/image.005.png)| |:--:| | 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](figures/image.006.png)| +| ![Figure 6](../../data/how_to/magma_install/figures/image.006.png)| |:--:| | 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 -. - -### AMD ROCm™ V5.1.3 Release - -AMD ROCm v5.1.3 is now released. The release documentation is available at -. - -### AMD ROCm™ V5.1.1 Release - -AMD ROCm v5.1.1 is now released. The release documentation is available at -. - -### AMD ROCm™ V5.1 Release - -AMD ROCm v5.1 is now released. The release documentation is available at -. - -### AMD ROCm™ v5.0.2 Release Notes - -#### Fixed Defects in This Release - -The following defects are fixed in the ROCm v5.0.2 release. - -##### Issue with hostcall Facility in HIP Runtime - -In ROCm v5.0, when using the `assert()` call in a HIP kernel, the compiler may -sometimes fail to emit kernel metadata related to the hostcall facility, which -results in incomplete initialization of the hostcall facility in the HIP -runtime. This can cause the HIP kernel to crash when it attempts to execute the -`assert()` call. The root cause was an incorrect check in the compiler to -determine whether the hostcall facility is required by the kernel. This is fixed -in the ROCm v5.0.2 release. The resolution includes a compiler change, which -emits the required metadata by default, unless the compiler can prove that the -hostcall facility is not required by the kernel. This ensures that the -`assert()` call never fails. - -**Note**: This fix may lead to breakage in some OpenMP offload use cases, which -use print inside a target region and result in an abort in device code. -The issue will be fixed in a future release. - -##### Compatibility Matrix Updates to ROCm Deep Learning Guide - -The compatibility matrix in the AMD Deep Learning Guide is updated for ROCm -v5.0.2. - -For more information and documentation updates, refer to . - -### AMD ROCm™ v5.0.1 Release Notes - -#### 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. - -#### ROCM DOCUMENTATION UPDATES FOR ROCM 5.0.1 - -- ROCm Downloads Guide - -- ROCm Installation Guide - -- ROCm Release Notes - -For more information, see . - -### AMD ROCm™ v5.0 Release Notes - -## ROCm Installation Updates - -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 this release. - -## Notice for Open-source and Closed-source ROCm Repositories in Future Releases - -To make a distinction between open-source and closed-source components, all ROCm -repositories will consist of sub-folders in future releases. - -- All open-source components will be placed in the `base-url//main` - sub-folder -- All closed-source components will reside in the - `base-url//proprietary` sub-folder - -### List of Supported Operating Systems - -The AMD ROCm platform supports the following operating systems: - -| **OS-Version (64-bit)** | **Kernel Versions** | -|:-------------------------------:|:-----------------------------:| -| CentOS 8.3 | `4.18.0-193.el8` | -| CentOS 7.9 | `3.10.0-1127` | -| RHEL 8.5 | `4.18.0-348.7.1.el8_5.x86_64` | -| RHEL 8.4 | `4.18.0-305.el8.x86_64` | -| RHEL 7.9 | `3.10.0-1160.6.1.el7` | -| SLES 15 SP3 | `5.3.18-59.16-default` | -| Ubuntu 20.04.3 | `5.8.0 LTS / 5.11 HWE` | -| Ubuntu 18.04.5 [5.4 HWE kernel] | `5.4.0-71-generic` | - -#### Support for RHEL v8.5 - -This release extends support for RHEL v8.5. - -#### Supported GPUs - -##### Radeon Pro V620 and W6800 Workstation GPUs - -This release extends ROCm support for Radeon Pro V620 and W6800 Workstation -GPUs. - -- SRIOV virtualization support for Radeon Pro V620 -- KVM Hypervisor (1VF support only) on Ubuntu Host OS with Ubuntu, CentOs, and - RHEL Guest -- Support for ROCm-SMI in an SRIOV environment. For more details, refer to the - ROCm SMI API documentation. - -**Note:** Radeon Pro v620 is not supported on SLES. - -### ROCm Installation Updates for ROCm v5.0 - -This release has the following ROCm installation enhancements. - -#### Support for Kernel Mode Driver - -In this release, users can install the kernel-mode driver using the Installer -method. Some of the ROCm-specific use cases that the installer currently -supports are: - -- OpenCL (ROCr/KFD based) runtime -- HIP runtimes -- ROCm libraries and applications -- ROCm Compiler and device libraries -- ROCr runtime and thunk -- Kernel-mode driver - -#### Support for Multi-version ROCm Installation and Uninstallation - -Users now can install multiple ROCm releases simultaneously on a system using -the newly introduced installer script and package manager install mechanism. - -Users can also uninstall multi-version ROCm releases using the -`amdgpu-uninstall` script and package manager. - -#### Support for Updating Information on Local Repositories - -In this release, the `amdgpu-install` script automates the process of updating -local repository information before proceeding to ROCm installation. - -#### Support for Release Upgrades - -Users can now upgrade the existing ROCm installation to specific or latest ROCm -releases. - -For more details, refer to the AMD ROCm Installation Guide v5.0. - -## AMD ROCm V5.0 Documentation Updates - -### New AMD ROCm Information Portal – ROCm v4.5 and Above - -Beginning ROCm release v5.0, AMD ROCm documentation has a new portal at -. This portal consists of ROCm documentation v4.5 and -above. - -For documentation prior to ROCm v4.5, you may continue to access -. - -### Documentation Updates for ROCm 5.0 - -#### Deployment Tools - -##### ROCm Data Center Tool Documentation Updates - -- ROCm Data Center Tool User Guide -- ROCm Data Center Tool API Guide - -##### ROCm System Management Interface Updates - -- System Management Interface Guide -- System Management Interface API Guide - -##### ROCm Command Line Interface Updates - -- Command Line Interface Guide - -#### Machine Learning/AI Documentation Updates - -- Deep Learning Guide -- MIGraphX API Guide -- MIOpen API Guide -- MIVisionX API Guide - -#### ROCm Libraries Documentation Updates - -- hipSOLVER User Guide -- RCCL User Guide -- rocALUTION User Guide -- rocBLAS User Guide -- rocFFT User Guide -- rocRAND User Guide -- rocSOLVER User Guide -- rocSPARSE User Guide -- rocThrust User Guide - -#### Compilers and Tools - -##### ROCDebugger Documentation Updates - -- ROCDebugger User Guide -- ROCDebugger API Guide - -##### ROCTracer - -- ROCTracer User Guide -- ROCTracer API Guide - -##### Compilers - -- AMD Instinct High Performance Computing and Tuning Guide -- AMD Compiler Reference Guide - -##### HIPify Documentation - -- HIPify User Guide -- HIP Supported CUDA API Reference Guide - -##### ROCm Debug Agent - -- ROCm Debug Agent Guide -- System Level Debug Guide -- ROCm Validation Suite - -#### Programming Models Documentation - -##### HIP Documentation - -- HIP Programming Guide -- HIP API Guide -- HIP FAQ Guide - -##### OpenMP Documentation - -- OpenMP Support Guide - -#### ROCm Glossary - -- ROCm Glossary – Terms and Definitions - -### AMD ROCm Legacy Documentation Links – ROCm v4.3 and Prior - -- For AMD ROCm documentation, see - -- For installation instructions on supported platforms, see - - -- For AMD ROCm binary structure, see - - -- For AMD ROCm release history, see - - -## 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. - -Refer to the HIP API documentation for more details on managed memory APIs. - -For the application, see -[hipMallocManaged.cpp](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 compute units 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. | - -### ROCm Math and Communication Libraries - -| **Library** | **Changes** | -|:--------------:|:----------------------------------------------------------------------------------------| -| **rocBLAS** | **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 > 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`
| -| | | -| **hipBLAS** | **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 `HIP_PATH` when building from source.
  • Fixed windows packaging
  • Allowing negative increments in hipblas-bench
  • Removed boost dependency
| -| | | -| **rocFFT** | **Changed**
  • Enabled runtime compilation of single FFT kernels > length 1024.
  • Re-aligned split device library into 4 roughly equal libraries.
  • Implemented the FuseShim framework to replace the original OptimizePlan
  • Implemented the generic buffer-assignment framework. The buffer assignment is no longer performed by each node. A generic algorithm is designed to test and pick the best assignment path. With the help of FuseShim, more kernel-fusions are achieved.
  • Do not read the imaginary part of the DC and Nyquist modes for even-length complex-to-real transforms.
**Optimizations**
  • Optimized twiddle-conjugation; complex-to-complex inverse transforms have similar performance to foward transforms now.
  • Improved performance of single-kernel small 2D transforms.
| -| | | -| **hipFFT** | **Fixed**
  • Fixed incorrect reporting of rocFFT version.
**Changed**
  • Unconditionally enabled callback functionality. On the CUDA backend, callbacks only run correctly when hipFFT is built as a static library, and is linked against the static cuFFT library.
| -| | | -| **rocSPARSE** | **Added**
  • csrmv, coomv, ellmv, hybmv for (conjugate) transposed matricescsrmv for symmetric matrices
**Changed**
  • `spmm_ex` is now deprecated and will be removed in the next major release
**Improved**
  • Optimization for gtsv
| -| | | -| **hipSPARSE** | **Added**
  • Added (conjugate) transpose support for csrmv, hybmv and spmv routines
| -| | | -| **rocALUTION** | **Changed**
  • Removed deprecated GlobalPairwiseAMG class, please use PairwiseAMG instead.
**Improved**
  • Improved documentation
| -| | | -| **rocTHRUST** | **Updates**
  • 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)
| -| | | -| **rocSOLVER** | **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.
**Optimizations**
  • 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`
| -| | | -| **hipSOLVER** | **Added**
  • Added SYTRF functions: `hipsolverSsytrf_bufferSize`, `hipsolverDsytrf_bufferSize`, `hipsolverCsytrf_bufferSize`, `hipsolverZsytrf_bufferSize`, `hipsolverSsytrf`, `hipsolverDsytrf`, `hipsolverCsytrf`, `hipsolverZsytrf`
**Fixed**
  • Fixed use of incorrect `HIP_PATH` when building from source
| -| | | -| **RCCL** | **Added**
  • Compatibility with NCCL 2.10.3
**Known issues**
  • Managed memory is not currently supported for clique-based kernels
| -| | | -| **hipCUB** | **Fixed**
  • Added missing includes to `hipcub.hpp`
**Added**
  • Bfloat16 support to test cases (`device_reduce` & `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.
| -| | | -| **rocPRIM** | **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**
  • Scan size limit feature
  • Reduce size limit feature
  • 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 the issue was solved 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 `WindowsReduceEmptyInput` cause random failure with `bfloat16`
  • Managed memory is not currently supported for clique-based kernels
| - -### 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 . - -## Disclaimer - -The information presented in this document is for informational purposes only -and may contain technical inaccuracies, omissions, and typographical errors. -The information contained herein is subject to change and may be rendered -inaccurate for many reasons, including but not limited to product and roadmap -changes, component and motherboard versionchanges, new model and/or product -releases, product differences between differing manufacturers, software changes, -BIOS flashes, firmware upgrades, or the like. Any computer system has risks of -security vulnerabilities that cannot be completely prevented or mitigated. -AMD assumes no obligation to update or otherwise correct or revise this -information. However, AMD reserves the right to revise this information and to -make changes from time to time to the content hereof without obligation of AMD -to notify any person of such revisions or changes. THIS INFORMATION IS PROVIDED -"AS IS." AMD MAKES NO REPRESENTATIONS OR WARRANTIES WITH RESPECT TO THE CONTENTS -HEREOF AND ASSUMES NO RESPONSIBILITY FOR ANY INACCURACIES, ERRORS, OR OMISSIONS -THAT MAY APPEAR IN THIS INFORMATION. AMD SPECIFICALLY DISCLAIMS ANY IMPLIED -WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR ANY PARTICULAR -PURPOSE. IN NO EVENT WILL AMD BE LIABLE TO ANY PERSON FOR ANY RELIANCE, DIRECT, -INDIRECT, SPECIAL, OR OTHER CONSEQUENTIAL DAMAGES ARISING FROM THE USE OF ANY -INFORMATION CONTAINED HEREIN, EVEN IF AMD IS EXPRESSLY ADVISED OF THE -POSSIBILITY OF SUCH DAMAGES.AMD, the AMD Arrow logo, and combinations thereof -are trademarks of Advanced Micro Devices, Inc. Other product names used in this -publication are for identification purposes only and may be trademarks of their -respective companies. ©[2021]Advanced Micro Devices, Inc.All rights reserved. - -### Third-party Disclaimer - -Third-party content is licensed to you directly by the third party that owns the -content and is not licensed to you by AMD. ALL LINKED THIRD-PARTY CONTENT IS -PROVIDED “AS IS” WITHOUT A WARRANTY OF ANY KIND. USE OF SUCH THIRD-PARTY CONTENT -IS DONE AT YOUR SOLE DISCRETION AND UNDER NO CIRCUMSTANCES WILL AMD BE LIABLE TO -YOU FOR ANY THIRD-PARTY CONTENT. YOU ASSUME ALL RISK AND ARE SOLELY RESPONSIBLE -FOR ANY DAMAGES THAT MAY ARISE FROM YOUR USE OF THIRD-PARTY CONTENT. diff --git a/docs/sphinx/README.md b/docs/sphinx/README.md deleted file mode 100644 index 56e598114..000000000 --- a/docs/sphinx/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# How to build documentation via Sphinx - -```bash -pip3 install -r requirements.txt - -python -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html -``` - diff --git a/docs/sphinx/RELEASE.md b/docs/sphinx/RELEASE.md deleted file mode 100644 index 38bf0d779..000000000 --- a/docs/sphinx/RELEASE.md +++ /dev/null @@ -1 +0,0 @@ -# Release Notes diff --git a/docs/sphinx/_images/amd-header-logo.svg b/docs/sphinx/_images/amd-header-logo.svg deleted file mode 100644 index 233c26a20..000000000 --- a/docs/sphinx/_images/amd-header-logo.svg +++ /dev/null @@ -1 +0,0 @@ -AMD-logo-white-v2 \ No newline at end of file diff --git a/docs/sphinx/_images/rdc-watermark.svg b/docs/sphinx/_images/rdc-watermark.svg deleted file mode 100644 index 13e761d2e..000000000 --- a/docs/sphinx/_images/rdc-watermark.svg +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - - - \ No newline at end of file diff --git a/docs/sphinx/_images/rocm-on.png b/docs/sphinx/_images/rocm-on.png deleted file mode 100644 index b3bc5654f..000000000 Binary files a/docs/sphinx/_images/rocm-on.png and /dev/null differ diff --git a/docs/sphinx/_static/code_word_breaks.js b/docs/sphinx/_static/code_word_breaks.js deleted file mode 100644 index 79d5e9b46..000000000 --- a/docs/sphinx/_static/code_word_breaks.js +++ /dev/null @@ -1,22 +0,0 @@ -$(document).ready(() => { - const copy = async(event) => { - return await navigator.clipboard.writeText($(event.target).attr('copydata')); - } - - $('.table td code').each( function () { - var text = $(this).text() - $(this).addClass('hovertext') - $(this).attr('copydata', text) - $(this).attr('data-hover', "Click to copy.") - var new_text = text.replaceAll(/_([^\u200B])/g, '_\u200B$1').replaceAll(/([a-z])([A-Z])/g, '$1\u200B$2') - $(this).text(new_text) - $(this).click((event) => { - copy(event) - $(event.target).attr('data-hover', "Copied!") - $(event.target).on("mouseleave", () => { - $(event.target).attr('data-hover', "Click to copy.") - $(event.target).off("mouseleave") - }) - }) - }) -}) diff --git a/docs/sphinx/_static/custom.css b/docs/sphinx/_static/custom.css deleted file mode 100644 index 827ca482d..000000000 --- a/docs/sphinx/_static/custom.css +++ /dev/null @@ -1,72 +0,0 @@ -@import url("theme.css"); - -:root { - --pst-font-size-base: 11px; -} - -div#site-navigation { - height: fit-content; - min-height: calc(100vh - 190px); -} - -div.content-container { - overflow-y: clip; -} - -.hovertext { - position: relative; - /* border-bottom: 1px dotted black; */ -} - -.hovertext:before { - content: attr(data-hover); - visibility: hidden; - opacity: 0; - width: 140px; - background-color: black; - color: #fff; - text-align: center; - border-radius: 5px; - padding: 5px 0; - transition: opacity 0.5s ease-in-out; - - position: absolute; - z-index: 1; - left: 0; - top: 110%; -} - -.hovertext:hover:before { - opacity: 1; - visibility: visible; -} - -div#rdc-watermark-container { - pointer-events: none; - position: fixed; - height: 100vh; - width: 100vw; - top: 0; - left: 0; - z-index: 10000; -} - -img#rdc-watermark { - pointer-events: none; - position: absolute; - top: 50%; - left: 50%; - transform-origin: center; - transform: translate(-50%, -50%) rotate(-45deg); - opacity: 10%; - z-index: 10000; - max-width: 100%; - max-height: calc(100% - 200px); - object-fit: contain; - width: 45%; -} - -ul.bd-breadcrumbs { - margin-bottom: 0; - margin-top: 1px; -} diff --git a/docs/sphinx/_static/rocm_footer.css b/docs/sphinx/_static/rocm_footer.css deleted file mode 100644 index bab2b6788..000000000 --- a/docs/sphinx/_static/rocm_footer.css +++ /dev/null @@ -1,58 +0,0 @@ -.rocm-footer { - background-color: black; - color: white; - display: flex; - flex-wrap: wrap; - border-top: 1px solid hsla(216,3%,63%,.5); - align-items: center; - justify-content: center; - text-align: center; - width: 100%; - padding-top: 5px; - line-height: 20px; - height: 120px; -} - -.rocm-footer a, .rocm-footer p { - color: white; -} - -.rocm-footer>ul { - border-bottom: 1px solid hsla(216,3%,63%,.5); - justify-content: flex-end; - margin-top:15px; -} - -.rocm-footer ul { - display: flex; - flex-direction: row; - flex-wrap: wrap; - font-size: 12px; - padding: 0; - padding-bottom: 12px; - width:98vw; - list-style: none inside none; - margin: 0; -} - -.rocm-footer div { - width: 98vw; -} - -.rocm-footer div { - text-align: start; -} - -.rocm-footer a:hover { - color: #e9ecef; - text-decoration: none; -} - -.rocm-footer ul li { - margin-right: 5px; -} - -.rocm-footer ul li+li { - margin-left: 10px; - padding-left: 8px; -} diff --git a/docs/sphinx/_static/rocm_header.css b/docs/sphinx/_static/rocm_header.css deleted file mode 100644 index 06b142ddd..000000000 --- a/docs/sphinx/_static/rocm_header.css +++ /dev/null @@ -1,108 +0,0 @@ -.rocm-header { - background-color: black; - position: -webkit-sticky; /* Safari */ - position: sticky; - top: 0; - width: 100%; - min-height: 50px; - overflow: hidden; - font-family: 'Noto Sans', sans-serif; - font-size: 16px; - text-align: left; - height:70px; -} - -.rocm-header a { - color: white; - text-decoration: none; -} - -.rocm-header-link p { - margin-top: 1em; - margin-bottom: 1em; -} - -.rocm-header img#amd-logo{ - margin: 1.5em; - width: 8.25rem; -} - -.rocm-header img#rocm-logo{ - margin: 0; - max-height: 100%; -} - -.rocm-header-buttons { - display: inline-block; - height: fit-content; - max-width: 100%; - width: fit-content; - vertical-align: middle; -} - -.rocm-header-link:first-child { - margin-left: 4em; -} - -.rocm-header-link { - position: relative; - display: inline-block; - height: fit-content; - text-align: center; - vertical-align: middle; -} - -.rocm-header-link.rocm-header-last { - position: absolute; - right: 4em; - top: 50%; - transform: translate(0, -50%); - height: 100%; -} - -.rocm-header-link .rocm-link-box, .rocm-header-link p { - vertical-align: middle; - color: white; -} - -.rocm-header-link .rocm-link box { - font-size: x-large; -} - -.rocm-header-link p { - font-size: 16px; -} - -.rocm-header-link img, .rocm-header-link .rocm-link-box { - max-height: 50px; - margin-left: 2em; - margin-right: 2em; -} - -.rocm-header-link .glow-wrap{ - overflow: hidden; - position: absolute; - width: 100%; - height: 100%; - top: 0; -} - -.rocm-header-link .glow{ - display: block; - position:absolute; - width: 20%; - height: 100%; - background: rgba(255,255,255,.2); - top: 0; - left: 0; - transform-origin: right top; - transform: translate(-100%, 0) skew(-45deg); - filter: blur(2px); - transition: all .5s cubic-bezier(0.645, 0.045, 0.355, 1); -} - -.rocm-header-link:hover .glow{ - transform-origin: left bottom; - transform: translate(1000%, 0) skew(-45deg); - transition: all .5s cubic-bezier(0.645, 0.045, 0.355, 1); -} diff --git a/docs/sphinx/_templates/components/copyright.html b/docs/sphinx/_templates/components/copyright.html deleted file mode 100644 index e36eb8349..000000000 --- a/docs/sphinx/_templates/components/copyright.html +++ /dev/null @@ -1,11 +0,0 @@ -{% if show_copyright and copyright %} - -{% endif %} diff --git a/docs/sphinx/_templates/components/social-links.html b/docs/sphinx/_templates/components/social-links.html deleted file mode 100644 index 5dff4edc0..000000000 --- a/docs/sphinx/_templates/components/social-links.html +++ /dev/null @@ -1,43 +0,0 @@ - - -{%- macro icon_link_nav_item(url, icon, name, type, attributes='') -%} - {%- if url | length > 2 %} - - {%- endif -%} -{%- endmacro -%} - diff --git a/docs/sphinx/_templates/layout.html b/docs/sphinx/_templates/layout.html deleted file mode 100644 index 5966129de..000000000 --- a/docs/sphinx/_templates/layout.html +++ /dev/null @@ -1,5 +0,0 @@ -{% extends "!layout.html" %} - -{%- block footer %} - {%- include "sections/footer.html" %} -{%- endblock %} diff --git a/docs/sphinx/_templates/sections/footer-content.html b/docs/sphinx/_templates/sections/footer-content.html deleted file mode 100644 index ce0b4787d..000000000 --- a/docs/sphinx/_templates/sections/footer-content.html +++ /dev/null @@ -1,10 +0,0 @@ -

- {%- if last_updated %} - {% trans prefix=translate('Last updated on'), last_updated=last_updated|e %}{{ prefix }} {{ last_updated }}.{% endtrans %}
- {%- endif %} - {%- if theme_extra_footer %} -

- {%- endif %} -

diff --git a/docs/sphinx/_templates/sections/footer.html b/docs/sphinx/_templates/sections/footer.html deleted file mode 100644 index e032bd73c..000000000 --- a/docs/sphinx/_templates/sections/footer.html +++ /dev/null @@ -1,20 +0,0 @@ - - -
- DRAFT watermark -
diff --git a/docs/sphinx/_templates/sections/header.html b/docs/sphinx/_templates/sections/header.html deleted file mode 100644 index 9ed5f8e97..000000000 --- a/docs/sphinx/_templates/sections/header.html +++ /dev/null @@ -1,48 +0,0 @@ - diff --git a/docs/sphinx/_toc.yml b/docs/sphinx/_toc.yml deleted file mode 100644 index bfef630cb..000000000 --- a/docs/sphinx/_toc.yml +++ /dev/null @@ -1,165 +0,0 @@ -defaults: - numbered: False - maxdepth: 6 -root: index -subtrees: -- entries: - - file: release - subtrees: - - entries: - - file: release/gpu_os_support - - file: release/licensing - - url: https://github.com/RadeonOpenCompute/ROCm/labels/Verified%20Issue - title: Known Issues - - file: release/compatibility - subtrees: - - entries: - - file: reference/framework_compatiblity/framework_compatiblity - - file: reference/kernel_userspace_compatibility/kernel_userspace_comp - -- entries: - - file: deploy - subtrees: - - entries: - - file: quick_start - - file: hip_sdk_install_win/hip_sdk_install_win - - file: deploy/docker - - file: deploy/install - - file: deploy/multi - - file: deploy/spack - - file: deploy/build_source - - -- caption: APIs and Reference - entries: - - file: reference/hip - subtrees: - - entries: - - title: HIP Runtime API - url: https://advanced-micro-devices-hip-saad.readthedocs-hosted.com/en/wip-sphinx/ - - title: HIPify - Port Your Code - url: https://advanced-micro-devices-demo--737.com.readthedocs.build/projects/HIPIFY/en/737/ - - file: reference/gpu_libraries/math - title: Math Libraries - subtrees: - - entries: - - file: reference/gpu_libraries/blas - subtrees: - - entries: - - title: rocBLAS - url: https://rocmdocs.amd.com/projects/rocBLAS/en/master/ - - title: hipBLAS - url: https://rocmdocs.amd.com/projects/hipBLAS/en/master/ - - title: rocWMMA - url: https://rocmdocs.amd.com/projects/rocWMMA/en/master/ - - file: reference/gpu_libraries/fft - subtrees: - - entries: - - title: rocFFT - url: https://rocmdocs.amd.com/projects/rocFFT/en/master/ - - title: hipFFT - url: https://rocmdocs.amd.com/projects/hipFFT/en/master/ - - file: reference/gpu_libraries/rand - subtrees: - - entries: - - title: rocRAND - url: https://rocmdocs.amd.com/projects/rocRAND/en/master/ - - title: hipRAND - url: https://rocmdocs.amd.com/projects/hipRAND/en/master/ - - file: reference/gpu_libraries/solver - subtrees: - - entries: - - title: rocSOLVER - url: https://rocmdocs.amd.com/projects/rocSOLVER/en/master/ - - title: hipSOLVER - url: https://rocmdocs.amd.com/projects/hipSOLVER/en/master/ - - file: reference/gpu_libraries/sparse - subtrees: - - entries: - - title: rocSPARSE - url: https://rocmdocs.amd.com/projects/rocSPARSE/en/master/ - - title: hipSPARSE - url: https://rocmdocs.amd.com/projects/hipSPARSE/en/master/ - - file: reference/gpu_libraries/c++_primitives - title: C++ Primitives - subtrees: - - entries: - - url: https://rocmdocs.amd.com/projects/rocPRIM/en/master/ - title: rocPRIM - - entries: - - url: https://rocmdocs.amd.com/projects/hipCUB/en/master/ - title: hipCUB - - entries: - - url: https://rocmdocs.amd.com/projects/rocThrust/en/master/ - title: rocThrust - - file: reference/gpu_libraries/communication - title: Communication Libraries - subtrees: - - entries: - - url: https://rocmdocs.amd.com/projects/RCCL/en/master/ - title: RCCL - - url: https://rocmsoftwareplatform.github.io/MIOpen/doc/html/releasenotes.html - title: MIOpen - Machine Intelligence - - url: https://rocmsoftwareplatform.github.io/AMDMIGraphX/doc/html/ - title: MIGraphX- Graph Optimization - - file: reference/computer_vision - subtrees: - - entries: - - url: https://rocmdocs.amd.com/projects/MIVisionX/en/master/ - title: MIVisionX - - entries: - - url: https://rocmdocs.amd.com/projects/rocAL/en/master/ - title: rocAL - - file: reference/openmp/openmp - title: OpenMP - - file: reference/compilers - title: Compilers and Tools - subtrees: - - entries: - - file: reference/rocmcc/rocmcc - title: ROCmCC - - url: http://profiler - title: ROCGDB - - url: http://profiler - title: rocprof - - url: http://profiler - title: roctracer - - url: http://profiler - title: ROCdbgapi - - file: reference/management_tools - title: Management Tools - subtrees: - - entries: - - url: http://smi - title: rocmsmi - - file: reference/gpu_arch -- caption: Understand ROCm - entries: - - title: Compiler Disambiguation - file: understand/compiler_disabiguation - - file: isv_deployment_win - - file: understand/deep_learning/deep_learning - - file: understand/cmake_packages - -- caption: How to Guides - entries: - - file: how_to/docker_gpu_isolation - - file: how_to/magma_install/magma_install - - file: how_to/pytorch_install/pytorch_install - - file: how_to/tensorflow_install/tensorflow_install - - file: how_to/system_debugging - -- caption: Examples - entries: - - title: rocm-examples - url: https://github.com/ - - file: examples/ai_ml_inferencing - title: AI/ML/Inferencing - subtrees: - - entries: - - file: examples/inception_casestudy/inception_casestudy - - file: examples/inception_casestudy_migraphx/inception_casestudy_migraphx - -- caption: About - entries: - - file: about diff --git a/docs/sphinx/format_toc.py b/docs/sphinx/format_toc.py deleted file mode 100644 index d102472ac..000000000 --- a/docs/sphinx/format_toc.py +++ /dev/null @@ -1,42 +0,0 @@ -import os -from typing import Union -from git import Repo, Remote, RemoteReference -from pathlib import Path - -def format_toc(repo_path: Union[str, os.PathLike, None] = None): - pwd = Path(__file__).resolve().parent - if repo_path is None: - repo_path = pwd.parent - at_start = True - repo = Repo(repo_path, search_parent_directories=True) - assert not repo.bare - try: - branch = repo.active_branch.name - except TypeError as exc: # HEAD is detached commit - checked_heads = [] - for head in repo.heads: - checked_heads.append(head.name) - if head.commit == repo.head.commit: - branch = head.name - break - else: # loop fell through - for remote in repo.remotes: - remote: Remote - for ref in remote.refs: - ref: RemoteReference - if ref.commit == repo.head.commit: - branch = ref.name.split('/')[-1] - break - else: # loop fell through - raise TypeError("A branch name could not be determined.\n(Checked heads: %s)" % ' '.join(checked_heads)) from exc - with open(pwd / '_toc.yml.in', 'r', encoding='utf-8') as input: - with open(pwd / '_toc.yml', 'w', encoding='utf-8') as output: - for line in input.readlines(): - if line[0] == '#' and at_start: - continue - at_start = False - output.write(line.format(branch=branch)) - - -if __name__ == '__main__': - format_toc() diff --git a/docs/sphinx/reference/compilers.md b/docs/sphinx/reference/compilers.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/sphinx/understand/deep_learning/Deep Learning Image 1.png b/docs/sphinx/understand/deep_learning/Deep Learning Image 1.png deleted file mode 100644 index 4b5691f69..000000000 Binary files a/docs/sphinx/understand/deep_learning/Deep Learning Image 1.png and /dev/null differ diff --git a/docs/sphinx/understand/deep_learning/Install PyTorch using wheels Package.png b/docs/sphinx/understand/deep_learning/Install PyTorch using wheels Package.png deleted file mode 100644 index 15f821f28..000000000 Binary files a/docs/sphinx/understand/deep_learning/Install PyTorch using wheels Package.png and /dev/null differ diff --git a/docs/sphinx/understand/deep_learning/Machine Learning.png b/docs/sphinx/understand/deep_learning/Machine Learning.png deleted file mode 100644 index 06c2d0782..000000000 Binary files a/docs/sphinx/understand/deep_learning/Machine Learning.png and /dev/null differ diff --git a/docs/sphinx/understand/deep_learning/Matrix-1.png b/docs/sphinx/understand/deep_learning/Matrix-1.png deleted file mode 100644 index 4c8fdac1c..000000000 Binary files a/docs/sphinx/understand/deep_learning/Matrix-1.png and /dev/null differ diff --git a/docs/sphinx/understand/deep_learning/Matrix-2.png b/docs/sphinx/understand/deep_learning/Matrix-2.png deleted file mode 100644 index 1fa27ea08..000000000 Binary files a/docs/sphinx/understand/deep_learning/Matrix-2.png and /dev/null differ diff --git a/docs/sphinx/understand/deep_learning/Matrix-3.png b/docs/sphinx/understand/deep_learning/Matrix-3.png deleted file mode 100644 index f73a19ce2..000000000 Binary files a/docs/sphinx/understand/deep_learning/Matrix-3.png and /dev/null differ diff --git a/docs/sphinx/understand/deep_learning/Model In.png b/docs/sphinx/understand/deep_learning/Model In.png deleted file mode 100644 index 42518565c..000000000 Binary files a/docs/sphinx/understand/deep_learning/Model In.png and /dev/null differ diff --git a/docs/sphinx/understand/deep_learning/Pytorch 11.png b/docs/sphinx/understand/deep_learning/Pytorch 11.png deleted file mode 100644 index 14db5bdf0..000000000 Binary files a/docs/sphinx/understand/deep_learning/Pytorch 11.png and /dev/null differ diff --git a/docs/sphinx/understand/deep_learning/Text Classification 1.png b/docs/sphinx/understand/deep_learning/Text Classification 1.png deleted file mode 100644 index 046316b3d..000000000 Binary files a/docs/sphinx/understand/deep_learning/Text Classification 1.png and /dev/null differ diff --git a/docs/sphinx/understand/deep_learning/Text Classification 2.png b/docs/sphinx/understand/deep_learning/Text Classification 2.png deleted file mode 100644 index b5edb41ce..000000000 Binary files a/docs/sphinx/understand/deep_learning/Text Classification 2.png and /dev/null differ diff --git a/docs/sphinx/understand/deep_learning/Text Classification 3.png b/docs/sphinx/understand/deep_learning/Text Classification 3.png deleted file mode 100644 index 6c2e2eafd..000000000 Binary files a/docs/sphinx/understand/deep_learning/Text Classification 3.png and /dev/null differ diff --git a/docs/sphinx/understand/deep_learning/Text Classification 4.png b/docs/sphinx/understand/deep_learning/Text Classification 4.png deleted file mode 100644 index 14d8d4260..000000000 Binary files a/docs/sphinx/understand/deep_learning/Text Classification 4.png and /dev/null differ diff --git a/docs/sphinx/understand/deep_learning/Text Classification 5.png b/docs/sphinx/understand/deep_learning/Text Classification 5.png deleted file mode 100644 index 31626e9ef..000000000 Binary files a/docs/sphinx/understand/deep_learning/Text Classification 5.png and /dev/null differ diff --git a/docs/sphinx/understand/deep_learning/Text Classification 6.png b/docs/sphinx/understand/deep_learning/Text Classification 6.png deleted file mode 100644 index 84d532ca6..000000000 Binary files a/docs/sphinx/understand/deep_learning/Text Classification 6.png and /dev/null differ diff --git a/docs/sphinx/understand/deep_learning/Text Classification 7.png b/docs/sphinx/understand/deep_learning/Text Classification 7.png deleted file mode 100644 index 3b215e00e..000000000 Binary files a/docs/sphinx/understand/deep_learning/Text Classification 7.png and /dev/null differ diff --git a/docs/sphinx/understand/deep_learning/amd_logo.png b/docs/sphinx/understand/deep_learning/amd_logo.png deleted file mode 100644 index c305726e2..000000000 Binary files a/docs/sphinx/understand/deep_learning/amd_logo.png and /dev/null differ diff --git a/docs/sphinx/understand/deep_learning/inception v3.png b/docs/sphinx/understand/deep_learning/inception v3.png deleted file mode 100644 index f47628f58..000000000 Binary files a/docs/sphinx/understand/deep_learning/inception v3.png and /dev/null differ diff --git a/docs/sphinx/understand/deep_learning/mnist 1.png b/docs/sphinx/understand/deep_learning/mnist 1.png deleted file mode 100644 index e3e1e1c40..000000000 Binary files a/docs/sphinx/understand/deep_learning/mnist 1.png and /dev/null differ diff --git a/docs/sphinx/understand/deep_learning/mnist 2.png b/docs/sphinx/understand/deep_learning/mnist 2.png deleted file mode 100644 index 5bf1932c4..000000000 Binary files a/docs/sphinx/understand/deep_learning/mnist 2.png and /dev/null differ diff --git a/docs/sphinx/understand/deep_learning/mnist 3.png b/docs/sphinx/understand/deep_learning/mnist 3.png deleted file mode 100644 index e93863f13..000000000 Binary files a/docs/sphinx/understand/deep_learning/mnist 3.png and /dev/null differ diff --git a/docs/sphinx/understand/deep_learning/mnist 4.png b/docs/sphinx/understand/deep_learning/mnist 4.png deleted file mode 100644 index 3d35f354b..000000000 Binary files a/docs/sphinx/understand/deep_learning/mnist 4.png and /dev/null differ diff --git a/docs/sphinx/understand/deep_learning/mnist 5.png b/docs/sphinx/understand/deep_learning/mnist 5.png deleted file mode 100644 index ac92f29bb..000000000 Binary files a/docs/sphinx/understand/deep_learning/mnist 5.png and /dev/null differ diff --git a/docs/sphinx/understand/cmake_packages.rst b/docs/understand/cmake_packages.rst similarity index 100% rename from docs/sphinx/understand/cmake_packages.rst rename to docs/understand/cmake_packages.rst diff --git a/docs/sphinx/understand/compiler_disambiguation.md b/docs/understand/compiler_disambiguation.md similarity index 100% rename from docs/sphinx/understand/compiler_disambiguation.md rename to docs/understand/compiler_disambiguation.md diff --git a/docs/sphinx/understand/deep_learning/deep_learning.md b/docs/understand/deep_learning/deep_learning.md similarity index 100% rename from docs/sphinx/understand/deep_learning/deep_learning.md rename to docs/understand/deep_learning/deep_learning.md