What-is and TOC clean-up (#2539)

2026-02-04 03:15:28 -05:00 · 2023-10-16 15:25:00 -06:00
parent c6e2856822
commit fd927e514d
4 changed files with 80 additions and 93 deletions
--- a/docs/about/licensing.md
+++ b/docs/about/licensing.md
@@ -9,7 +9,7 @@ The table is ordered to follow the ROCm manifest file.

 <!-- spellcheck-disable -->
 | Component | License |
-|:------------------------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------------------------------------------------:|
+|:---------------------|:-------------------------|
 | [AMDMIGraphX](https://github.com/ROCmSoftwarePlatform/AMDMIGraphX/) | [MIT](https://github.com/ROCmSoftwarePlatform/AMDMIGraphX/blob/develop/LICENSE) |
 | [HIPCC](https://github.com/ROCm-Developer-Tools/HIPCC/blob/develop/LICENSE.txt) | [MIT](https://github.com/ROCm-Developer-Tools/HIPCC/blob/develop/LICENSE.txt) |
 | [HIPIFY](https://github.com/ROCm-Developer-Tools/HIPIFY/) | [MIT](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/amd-staging/LICENSE.txt) |
--- a/docs/reference/library-index.md
+++ b/docs/reference/library-index.md
@@ -1,4 +1,4 @@
-# ROCm API libraries
+# ROCm API libraries & tools

 ::::{grid} 1 2 2 2
 :class-container: rocm-doc-grid
@@ -38,6 +38,20 @@

 :::

+:::{grid-item-card}
+:padding: 2
+**Development tools**
+
+^^^
+
+* {doc}`hipCC <hipcc:index>`
+* {doc}`ROCdbgapi <rocdbgapi:index>`
+* [ROCmCC](./rocmcc.md)
+* {doc}`ROCm debugger (ROCgdb) <rocgdb:index>`
+* {doc}`ROCTracer <roctracer:index>`
+
+:::
+
 :::{grid-item-card}
 :padding: 2
 **Fast Fourier transforms (FFTs)**
@@ -94,8 +108,8 @@

 ^^^

-* [Performance tracing](https://github.com/ROCm-Developer-Tools/roctracer)
 * {doc}`ROCProfiler <rocprofiler:rocprof>`
+* {doc}`ROCTracer <roctracer:index>`

 :::

@@ -112,17 +126,13 @@

 :::{grid-item-card}
 :padding: 2
-**Tools**
+**System tools**

 ^^^

-* {doc}`AMD debugger (ROCdbgapi) <rocdbgapi:index>`
-* [ROCmCC](./rocmcc.md)
 * {doc}`ROCm Data Center Tool <rdc:index>`
-* {doc}`ROCm debugger (ROCgdb) <rocgdb:index>`
 * {doc}`ROCm SMI LIB <rocm_smi_lib:index>`
 * {doc}`ROCm Validation Suite <rocmvalidationsuite:index>`
-* {doc}`ROCTracer <roctracer:index>`
 * {doc}`TransferBench <transferbench:index>`

 :::
--- a/docs/sphinx/_toc.yml.in
+++ b/docs/sphinx/_toc.yml.in
@@ -35,7 +35,7 @@ subtrees:
    title: Tensorflow for ROCm
  - file: install/magma-install.md
    title: MAGMA for ROCm
-  - file: how-to/spack-intro.md
+  - file: install/spack-intro.md
    title: ROCm & Spack

 - caption: Compatibility & support
@@ -88,95 +88,74 @@ subtrees:
 - caption: Reference
  entries:
    - file: reference/library-index.md
-      title: Library APIs
+      title: API libraries & tools
      subtrees:
-      - caption: Artificial intelligence
-        entries:
-        - url: https://rocm.docs.amd.com/projects/composable_kernel/en/latest/index.html
+      - entries:
+        - url: ${project:composable_kernel}
          title: Composable kernel
-        - url: https://rocm.docs.amd.com/projects/MIOpen/en/latest/index.html
-          title: MIOpen
-        - url: https://rocm.docs.amd.com/projects/AMDMIGraphX/en/latest/index.html
-          title: MIGraphX
-      - caption: C++ primitives
-        entries:
-        - url: https://rocm.docs.amd.com/projects/hipCUB/en/latest/index.html
-          title: hipCUB
-        - url: https://rocm.docs.amd.com/projects/hipTensor/en/latest/index.html
-          title: hipTensor
-        - url: https://rocm.docs.amd.com/projects/rocPRIM/en/latest/index.html
-          title: rocPRIM
-        - url: https://rocm.docs.amd.com/projects/rocThrust/en/latest/index.html
-          title: rocThrust
-      - caption: Communication
-        entries:
-        - url: https://rocm.docs.amd.com/projects/rccl/en/latest/index.html
-          title: RCCL
-      - caption: Fast Fourier transforms (FFTs)
-        entries:
-        - url: https://rocm.docs.amd.com/projects/hipFFT/en/latest/index.html
-          title: hipFFT
-        - url: https://rocm.docs.amd.com/projects/rocFFT/en/latest/index.html
-          title: rocFFT
-      - caption: HIP
-        entries:
-        - url: https://rocm.docs.amd.com/projects/HIP/en/develop/.doxygen/docBin/html/index.html
-          title: HIP runtime
-        - url: https://rocm.docs.amd.com/projects/HIPIFY/en/latest/index.html
-          title: HIPIFY
-      - caption: Linear algebra
-        entries:
-        - url: https://rocm.docs.amd.com/projects/hipBLAS/en/latest/index.html
+        - url: ${project:hipblas}
          title: hipBLAS
-        - url: https://rocm.docs.amd.com/projects/hipBLASLt/en/latest/index.html
+        - url: ${project:hipblaslt}
          title: hipBLASLt
-        - url: https://rocm.docs.amd.com/projects/hipSOLVER/en/latest/index.html
-          title: hipSOLVER
-        - url: https://rocm.docs.amd.com/projects/hipSPARSE/en/latest/index.html
-          title: hipSPARSE
-        - url: https://rocm.docs.amd.com/projects/hipSPARSELt/en/latest/index.html
-          title: hipSPARSELt
-        - url: https://rocm.docs.amd.com/projects/rocALUTION/en/latest/index.html
-          title: rocALUTION
-        - url: https://rocm.docs.amd.com/projects/rocBLAS/en/latest/index.html
-          title: rocBLAS
-        - url: https://rocm.docs.amd.com/projects/rocSOLVER/en/latest/index.html
-          title: rocSOLVER
-        - url: https://rocm.docs.amd.com/projects/rocSPARSE/en/latest/index.html
-          title: rocSPARSE
-      - caption: Matrix multiply
-        entries:
-        - url: https://rocm.docs.amd.com/projects/rocWMMA/en/latest/index.html
-          title: rocWMMA
-      - caption: Performance analysis
-        entries:
-        - url: https://rocm.docs.amd.com/projects/rocprofiler/en/latest/rocprof.html
-          title: ROCProfiler
-        - url: https://github.com/ROCm-Developer-Tools/roctracer
-          title: Performance tracing
-      - caption: Random number generators
-        entries:
-        - url: https://rocm.docs.amd.com/projects/hipRAND/en/latest/index.html
+        - url: ${project:hipcc}
+          title: hipCC
+        - url: ${project:hipcub}
+          title: hipCUB
+        - url: ${project:hipfft}
+          title: hipFFT
+        - url: ${project:hipify}
+          title: HIPIFY
+        - url: ${project:hiprand}
          title: hipRAND
-        - url: https://rocm.docs.amd.com/projects/rocRAND/en/latest/index.html
-          title: rocRAND
-      - caption: Tools
-        entries:
-        - url: https://rocm.docs.amd.com/projects/ROCdbgapi/en/latest/index.html
-          title: AMD debugger API
+        - url: ${project:hip}
+          title: HIP runtime
+        - url: ${project:hipsolver}
+          title: hipSOLVER
+        - url: ${project:hipsparse}
+          title: hipSPARSE
+        - url: ${project:hipsparselt}
+          title: hipSPARSELt
+        - url: ${project:hiptensor}
+          title: hipTensor
+        - url: ${project:miopen}
+          title: MIOpen
+        - url: ${project:amdmigraphx}
+          title: MIGraphX
+        - url: ${project:rccl}
+          title: RCCL
+        - url: ${project:rocalution}
+          title: rocALUTION
+        - url: ${project:rocblas}
+          title: rocBLAS
+        - url: ${project:rocdbgapi}
+          title: ROCdbgapi
+        - url: ${project:rocfft}
+          title: rocFFT
        - file: reference/rocmcc.md
          title: ROCmCC
-        - url: https://rocm.docs.amd.com/projects/rdc/en/latest/
+        - url: ${project:rdc}
          title: ROCm Data Center Tool
-        - url: https://rocm.docs.amd.com/projects/ROCgdb/en/latest/index.html
-          title: ROCm debugger AP
-        - url: https://rocm.docs.amd.com/projects/rocm_smi_lib/en/latest/
+        - url: ${project:rocm_smi_lib}
          title: ROCm SMI LIB
-        - url: https://rocm.docs.amd.com/projects/ROCmValidationSuite/en/latest/
+        - url: ${project:rocmvalidationsuite}
          title: ROCm validation suite
-        - url: https://rocm.docs.amd.com/projects/roctracer/en/latest/index.html
-          title: ROCTracer
-        - url: https://rocm.docs.amd.com/projects/TransferBench/en/latest/
+        - url: ${project:rocprim}
+          title: rocPRIM
+        - url: ${project:rocprofiler}
+          title: ROCProfiler
+        - url: ${project:rocrand}
+          title: rocRAND
+        - url: ${project:rocsolver}
+          title: rocSOLVER
+        - url: ${project:rocsparse}
+          title: rocSPARSE
+        - url: ${project:rocthrust}
+          title: rocThrust
+        - url: ${project:roctracer}
+          title: rocTracer
+        - url: ${project:rocwmma}
+          title: rocWMMA
+        - url: ${project:transferbench}
          title: TransferBench

 - caption: Conceptual
--- a/docs/what-is-rocm.md
+++ b/docs/what-is-rocm.md
@@ -23,10 +23,9 @@ source software compilers, debuggers, and libraries. ROCm is fully integrated in

 ROCm consists of the following drivers, development tools, and APIs.

-| ROCm product | Description |
+| Project | Description |
 | :---------------- | :------------ |
 | [AMD Compute Language Runtimes (CLR)](https://github.com/ROCm-Developer-Tools/clr) | Contains source code for AMD's compute languages runtimes: {doc}`HIP <hip:index>` and OpenCL |
-| [AMDMIGraphX](https://github.com/ROCmSoftwarePlatform/AMDMIGraphX/) | A graph inference engine that accelerates machine learning model inference |
 | [AOMP](https://github.com/ROCm-Developer-Tools/aomp/) | A scripted build of [LLVM](https://github.com/RadeonOpenCompute/llvm-project) and supporting software |
 | [Asynchronous Task and Memory Interface (ATMI)](https://github.com/RadeonOpenCompute/atmi/) | A runtime framework for efficient task management in heterogeneous CPU-GPU systems |
 | [Composable Kernel](https://rocm.docs.amd.com/projects/composable_kernel/en/latest/) | A library that aims to provide a programming model for writing performance critical kernels for machine learning workloads across multiple architectures |
@@ -43,7 +42,7 @@ ROCm consists of the following drivers, development tools, and APIs.
 | [hipify-perl](https://rocm.docs.amd.com/projects/HIPIFY/en/latest/hipify-perl.html) | An autogenerated, perl-based script that translates CUDA source code into portable HIP C++ |
 | [hipSOLVER](https://rocm.docs.amd.com/projects/hipSOLVER/en/latest/) | An LAPACK-marshalling library that supports [rocSOLVER](https://rocm.docs.amd.com/projects/rocSOLVER/en/latest/) and cuSOLVER backends |
 | [hipSPARSE](https://rocm.docs.amd.com/projects/hipSPARSE/en/latest/)  | A SPARSE-marshalling library that supports [rocSPARSE](https://rocm.docs.amd.com/projects/rocSPARSE/en/latest/) and cuSPARSE backends |
-| [hipTensor](https://github.com/ROCmSoftwarePlatform/hipTensor) | AMD's C++ library for accelerating tensor primitives based on the composable kernel library |
+| [hipTensor](https://rocm.docs.amd.com/projects/hipTensor/en/latest/index.html) | AMD's C++ library for accelerating tensor primitives based on the composable kernel library |
 | [LLVM](https://github.com/RadeonOpenCompute/llvm-project) | A toolkit for the construction of highly optimized compilers, optimizers, and run-time environments |
 | [MIGraphX](https://rocm.docs.amd.com/projects/AMDMIGraphX/en/latest/) | A graph inference engine that accelerates machine learning model inference |
 | [MIOpen](https://rocm.docs.amd.com/projects/MIOpen/en/latest/) | An open source deep-learning library |
@@ -58,13 +57,12 @@ ROCm consists of the following drivers, development tools, and APIs.
 | [rocBLAS](https://rocm.docs.amd.com/projects/rocBLAS/en/latest/)| A BLAS implementation (in the HIP programming language) on the ROCm runtime and toolchains |
 | [rocFFT](https://rocm.docs.amd.com/projects/rocFFT/en/latest/) | A software library for computing fast Fourier transforms (FFTs) written in HIP |
 | [ROCK-Kernel-Driver](https://github.com/RadeonOpenCompute/ROCK-Kernel-Driver/) | An AMDGPU Driver with KFD that is used by ROCm |
-| [ROCm Augmentation Library (rocAL)](https://rocm.docs.amd.com/projects/rocAL/en/latest/doxygen/html/index.html) | An augmentation library designed to decode and process images and videos |
 | [ROCmCC](https://rocm.docs.amd.com/en/latest/reference/rocmcc/rocmcc.html) | A Clang/LLVM-based compiler |
 | [ROCm cmake](https://github.com/RadeonOpenCompute/rocm-cmake) | A collection of CMake modules for common build and development tasks |
 | [ROCm Data Center Tool](https://rocm.docs.amd.com/projects/rdc/en/latest/) | Simplifies administration and addresses key infrastructure challenges in AMD GPUs in cluster and data-center environments |
 | [ROCm Debug Agent Library (ROCdebug-agent)](https://github.com/ROCm-Developer-Tools/rocr_debug_agent/) | A library that can print the state of all AMD GPU wavefronts that caused a queue error by sending a SIGQUIT signal to the process while the program is running |
 | [ROCm Debugger (ROCgdb)](https://rocm.docs.amd.com/projects/ROCgdb/en/latest/) | A source-level debugger for Linux, based on the GNU Debugger (GDB) |
-| [ROCm Debugger API (ROCdbgapi)](https://rocm.docs.amd.com/projects/ROCdbgapi/en/latest/) | The ROCm debugger library |
+| [ROCdbgapi](https://rocm.docs.amd.com/projects/ROCdbgapi/en/latest/) | The ROCm debugger API library |
 | [rocminfo](https://github.com/RadeonOpenCompute/rocminfo/) | Reports system information |
 | [ROCm SMI](https://github.com/RadeonOpenCompute/rocm_smi_lib/) | A C library for Linux that provides a user space interface for applications to monitor and control GPU applications |
 | [ROCm Validation Suite](https://rocm.docs.amd.com/projects/ROCmValidationSuite/en/latest/) | A tool for detecting and troubleshooting common problems affecting AMD GPUs running in a high-performance computing environment |