From 934cc718b13ab73972f822e0134deda3acd2a4a0 Mon Sep 17 00:00:00 2001 From: Saad Rahim <44449863+saadrahim@users.noreply.github.com> Date: Fri, 24 Mar 2023 08:08:30 -0600 Subject: [PATCH] Pulling libraries out in the navigation tree (#1989) * Pulling libraries out * add libraries listed in left sidebar to index page * Adding all * Updating nav tree * fix link to rocm-examples in toc * update TOC --------- Co-authored-by: Sam Wu --- .gitignore | 3 + docs/.gitignore | 5 -- docs/.sphinx/.gitignore | 1 - docs/.sphinx/_toc.yml.in | 151 ++++++++++++++++++++----------------- docs/index.md | 6 ++ docs/reference/ai_tools.md | 1 + docs/reference/all.md | 69 +++++++++++++++++ 7 files changed, 160 insertions(+), 76 deletions(-) delete mode 100644 docs/.gitignore delete mode 100644 docs/.sphinx/.gitignore create mode 100644 docs/reference/ai_tools.md create mode 100644 docs/reference/all.md diff --git a/.gitignore b/.gitignore index 72057994a..9b13b5f33 100644 --- a/.gitignore +++ b/.gitignore @@ -9,3 +9,6 @@ _static/ _templates/ _toc.yml docBin/ + +# avoid duplicating contributing.md due to conf.py +docs/contributing.md diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index 3d870b99d..000000000 --- a/docs/.gitignore +++ /dev/null @@ -1,5 +0,0 @@ -/_images -/_static -/_templates -/CHANGELOG.md -/RELEASE.md \ No newline at end of file diff --git a/docs/.sphinx/.gitignore b/docs/.sphinx/.gitignore deleted file mode 100644 index 243eac16c..000000000 --- a/docs/.sphinx/.gitignore +++ /dev/null @@ -1 +0,0 @@ -/_toc.yml \ No newline at end of file diff --git a/docs/.sphinx/_toc.yml.in b/docs/.sphinx/_toc.yml.in index d536f9f32..34120e753 100644 --- a/docs/.sphinx/_toc.yml.in +++ b/docs/.sphinx/_toc.yml.in @@ -31,6 +31,7 @@ subtrees: - caption: APIs and Reference entries: + - file: reference/all - file: reference/hip subtrees: - entries: @@ -38,73 +39,83 @@ subtrees: 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/linear_algebra - subtrees: - - entries: - - title: rocBLAS - url: https://rocmdocs.amd.com/projects/rocBLAS/en/{branch}/ - - title: hipBLAS - url: https://rocmdocs.amd.com/projects/hipBLAS/en/{branch}/ - - title: rocWMMA - url: https://rocmdocs.amd.com/projects/rocWMMA/en/{branch}/ - - title: rocSPARSE - url: https://rocmdocs.amd.com/projects/rocSPARSE/en/{branch}/ - - title: hipSPARSE - url: https://rocmdocs.amd.com/projects/hipSPARSE/en/{branch}/ - - title: rocALUTION - url: https://rocmdocs.amd.com/projects/rocALUTION/en/{branch}/ - - title: rocSOLVER - url: https://rocmdocs.amd.com/projects/rocSOLVER/en/{branch}/ - - title: hipSOLVER - url: https://rocmdocs.amd.com/projects/hipSOLVER/en/{branch}/ - - file: reference/gpu_libraries/fft - subtrees: - - entries: - - title: rocFFT - url: https://rocmdocs.amd.com/projects/rocFFT/en/{branch}/ - - title: hipFFT - url: https://rocmdocs.amd.com/projects/hipFFT/en/{branch}/ - - file: reference/gpu_libraries/rand - subtrees: - - entries: - - title: rocRAND - url: https://rocmdocs.amd.com/projects/rocRAND/en/{branch}/ - - title: hipRAND - url: https://rocmdocs.amd.com/projects/hipRAND/en/{branch}/ - - file: reference/gpu_libraries/c++_primitives - title: C++ Primitives - subtrees: - - entries: - - url: https://rocmdocs.amd.com/projects/rocPRIM/en/{branch}/ - title: rocPRIM - - entries: - - url: https://rocmdocs.amd.com/projects/hipCUB/en/{branch}/ - title: hipCUB - - entries: - - url: https://rocmdocs.amd.com/projects/rocThrust/en/{branch}/ - title: rocThrust - - file: reference/gpu_libraries/communication - title: Communication Libraries - subtrees: - - entries: - - url: https://rocmdocs.amd.com/projects/rccl/en/{branch}/ - 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/{branch}/ - title: MIVisionX - - entries: - - url: https://rocmdocs.amd.com/projects/rocAL/en/{branch}/ - title: rocAL + - file: reference/gpu_libraries/math + title: Math Libraries + subtrees: + - entries: + - file: reference/gpu_libraries/linear_algebra + subtrees: + - entries: + - title: rocBLAS + url: https://rocmdocs.amd.com/projects/rocBLAS/en/{branch}/ + - title: hipBLAS + url: https://rocmdocs.amd.com/projects/hipBLAS/en/{branch}/ + - title: hipBLASLt + url: https://rocmdocs.amd.com/projects/hipBLASLt/en/{branch}/ + - title: rocWMMA + url: https://rocmdocs.amd.com/projects/rocWMMA/en/{branch}/ + - title: rocSPARSE + url: https://rocmdocs.amd.com/projects/rocSPARSE/en/{branch}/ + - title: hipSPARSE + url: https://rocmdocs.amd.com/projects/hipSPARSE/en/{branch}/ + - title: hipSPARSELt + url: https://rocmdocs.amd.com/projects/hipSPARSELt/en/{branch}/ + - title: rocALUTION + url: https://rocmdocs.amd.com/projects/rocALUTION/en/{branch}/ + - title: rocSOLVER + url: https://rocmdocs.amd.com/projects/rocSOLVER/en/{branch}/ + - title: hipSOLVER + url: https://rocmdocs.amd.com/projects/hipSOLVER/en/{branch}/ + - file: reference/gpu_libraries/fft + subtrees: + - entries: + - title: rocFFT + url: https://rocmdocs.amd.com/projects/rocFFT/en/{branch}/ + - title: hipFFT + url: https://rocmdocs.amd.com/projects/hipFFT/en/{branch}/ + - file: reference/gpu_libraries/rand + subtrees: + - entries: + - title: rocRAND + url: https://rocmdocs.amd.com/projects/rocRAND/en/{branch}/ + - title: hipRAND + url: https://rocmdocs.amd.com/projects/hipRAND/en/{branch}/ + - file: reference/gpu_libraries/c++_primitives + title: C++ Primitives + subtrees: + - entries: + - title: rocPRIM + url: https://rocmdocs.amd.com/projects/rocPRIM/en/{branch}/ + - entries: + - title: hipCUB + url: https://rocmdocs.amd.com/projects/hipCUB/en/{branch}/ + - entries: + - title: rocThrust + url: https://rocmdocs.amd.com/projects/rocThrust/en/{branch}/ + - file: reference/gpu_libraries/communication + title: Communication Libraries + subtrees: + - entries: + - title: RCCL + url: https://rocmdocs.amd.com/projects/rccl/en/{branch}/ + - file: reference/ai_tools + title: AI Tools + subtrees: + - entries: + - title: MIOpen - Machine Intelligence + url: https://rocmsoftwareplatform.github.io/MIOpen/doc/html/releasenotes.html + - title: Composable Kernel + url: https://rocmdocs.amd.com/projects/composable_kernel/en/{branch}/ + - title: MIGraphX - Graph Optimization + url: https://rocmsoftwareplatform.github.io/AMDMIGraphX/doc/html/ + - file: reference/computer_vision + subtrees: + - entries: + - url: https://rocmdocs.amd.com/projects/MIVisionX/en/{branch}/ + title: MIVisionX + - entries: + - url: https://rocmdocs.amd.com/projects/rocAL/en/{branch}/ + title: rocAL - file: reference/openmp/openmp title: OpenMP - file: reference/compilers @@ -141,7 +152,7 @@ subtrees: - caption: Understand ROCm entries: - title: Compiler Disambiguation - file: understand/compiler_disabiguation + file: understand/compiler_disambiguation - file: isv_deployment_win - file: understand/deep_learning/deep_learning - file: understand/cmake_packages @@ -159,8 +170,8 @@ subtrees: - caption: Examples entries: - - title: rocm-examples - url: https://github.com/ + - title: ROCm Examples + url: https://github.com/amd/rocm-examples - file: examples/ai_ml_inferencing title: AI/ML/Inferencing subtrees: diff --git a/docs/index.md b/docs/index.md index 5b42aaabd..314bffffd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -42,6 +42,12 @@ Welcome to AMD ROCm's documentation! ^^^ - [HIP](reference/hip) +- [Math Libraries](reference/gpu_libraries/math) +- [C++ Primitives](reference/gpu_libraries/c++_primitives) +- [Communication Libraries](reference/gpu_libraries/communication) +- [MIOpen - Machine Intelligence](https://rocmsoftwareplatform.github.io/MIOpen/doc/html/releasenotes.html) +- [MIGraphX - Graph Optimization](https://rocmsoftwareplatform.github.io/AMDMIGraphX/doc/html/) +- [Computer Vision](reference/computer_vision) - [OpenMP](reference/openmp/openmp) - [Compilers and Tools](reference/compilers) - [Management Tools](reference/management_tools) diff --git a/docs/reference/ai_tools.md b/docs/reference/ai_tools.md new file mode 100644 index 000000000..e84cfb8c1 --- /dev/null +++ b/docs/reference/ai_tools.md @@ -0,0 +1 @@ +# AI Tools diff --git a/docs/reference/all.md b/docs/reference/all.md new file mode 100644 index 000000000..8110b8d5a --- /dev/null +++ b/docs/reference/all.md @@ -0,0 +1,69 @@ +# All Reference Material + +## ROCm Software Groups +:::::{grid} 1 1 2 2 +:gutter: 1 + +:::{grid-item-card} HIP Runtime +The HIP Runtime is used to enable GPU acceleration for all HIP language based products. + +- [HIP Runtime API Manual](https://rocmdocs.amd.com/projects/hipBLAS/en/rtd/) +- [Examples](https://github.com/amd/rocm-examples/tree/develop/HIP-Basic) + +::: + +:::{grid-item-card} [Math Libraries](./gpu_libraries/math) +HIP Math Libraries support the following domains: + +- [Matrix Multiplication](./gpu_libraries/blas) +- [Fast Fourier Transforms](./gpu_libraries/fft) +- [Random Numbers](./gpu_libraries/rand) +- [Linear Solvers](./gpu_libraries/solver) +- [Sparse Matrix Solvers](./gpu_libraries/sparse) + +::: + +:::{grid-item-card} [C++ Primitives](./gpu_libraries/c++_primitives) +ROCm template libraries for C++ primitives and algorithms are as follows: + +- [rocPRIM](https://rocprim.readthedocs.io/en/latest/) +- [rocThrust](https://rocthrust.readthedocs.io/en/latest/) +- [hipCUB](https://hipcub.readthedocs.io/en/latest/) + +::: + +:::{grid-item-card} [Communication Libraries](gpu_libraries/communication) +Inter and intra node communication is supported by the following projects: + +- [RCCL](https://rocmdocs.amd.com/projects/rccl/en/latest/) + + +::: + +:::{grid-item-card} MIOpen +AMD's library for high performance machine learning primitives. + +- [API Reference Manual](https://rocmdocs.amd.com/projects/MIOpen/en/develop/) +- [Changelog](https://github.com/ROCmSoftwarePlatform/MIOpen/blob/develop/CHANGELOG.md) + + +::: + +:::{grid-item-card} MIGraphX +AMD's graph optimization engine. + +- [API Reference Manual](https://rocmdocs.amd.com/projects/AMDMIGraphX/en/develop/) +- [Changelog](https://github.com/ROCmSoftwarePlatform/MIGraphX/blob/develop/CHANGELOG.md) + +::: + +:::{grid-item-card} [Computer Vision](./computer_vision) +Computer vision related projects. + +- [MIVisionX](https://rocmdocs.amd.com/projects/MIVisionX/en/develop) +- [rocAL](https://rocmdocs.amd.com/projects/rocAL/en/develop) + +::: + + +::::: \ No newline at end of file