Update links (#2992)

* Update links * table cleanup * cross-refs * wordlist update * add temp hard links * verbiage * docs(index.md): Disable MD051 for Sphinx Markdown anchor point In general this rule should be followed to avoid broken links * revert gpu-arch table, remove dropdowns, quick start hyphen removedon index.md * revise opening text as per PR comment --------- Co-authored-by: Lisa <lisa.delaney@amd.com> Co-authored-by: Sam Wu <sam.wu2@amd.com> Co-authored-by: Young Hui <young.hui@amd.com>
2026-04-05 03:01:17 -04:00 · 2024-04-12 12:36:23 -07:00
parent 5ea5d1d3f1
commit a29b54a453
7 changed files with 61 additions and 59 deletions
--- a/docs/about/compatibility/precision-support.rst
+++ b/docs/about/compatibility/precision-support.rst
@@ -1,17 +1,18 @@
 .. meta::
  :description: Supported data types in ROCm
-  :keywords: int8, float8, float8 (E4M3), float8 (E5M2), bfloat8, float16, half, bfloat16, tensorfloat32, float, float32, float64, double, AMD, ROCm, AMDGPU
-
-.. _rocm-supported-data-types:
+  :keywords: int8, float8, float8 (E4M3), float8 (E5M2), bfloat8, float16, half, bfloat16, tensorfloat32, float,
+   float32, float64, double, AMD, ROCm, AMDGPU

 *************************************************************
-ROCm data type specifications
+Precision support
 *************************************************************

+Use the following sections to identify data types and HIP types ROCm™ supports.
+
 Integral types
 ==========================================

-The signed and unsigned integral types that are supported by ROCm™ are listed in the following table,
+The signed and unsigned integral types that are supported by ROCm are listed in the following table,
 together with their corresponding HIP type and a short description.


@@ -403,37 +404,37 @@ description, refer to the corresponding library data type support page.
        - int32
        - int64
      *
-        - hipSPARSELt (:doc:`details<hipsparselt:reference/data-type-support>`)
+        - hipSPARSELt (:doc:`details <hipsparselt:reference/data-type-support>`)
        - ✅/✅
        - ❌/❌
        - ❌/❌
        - ❌/❌
      *
-        - rocRAND (:doc:`details<rocrand:data-type-support>`)
+        - rocRAND (`details <https://rocm.docs.amd.com/projects/rocRAND/en/develop/data-type-support.html>`_)
        - -/✅
        - -/✅
        - -/✅
        - -/✅
      *
-        - hipRAND (:doc:`details<hiprand:data-type-support>`)
+        - hipRAND (`details <https://rocm.docs.amd.com/projects/hipRAND/en/develop/data-type-support.html>`_)
        - -/✅
        - -/✅
        - -/✅
        - -/✅
      *
-        - rocPRIM (:doc:`details<rocprim:data-type-support>`)
+        - rocPRIM (`details <https://rocmdocs.amd.com/projects/rocPRIM/en/develop/reference/data-type-support.html>`_)
        - ✅/✅
        - ✅/✅
        - ✅/✅
        - ✅/✅
      *
-        - hipCUB (:doc:`details<hipcub:data-type-support>`)
+        - hipCUB (`details <https://rocm.docs.amd.com/projects/hipCUB/en/develop/data-type-support.html>`_)
        - ✅/✅
        - ✅/✅
        - ✅/✅
        - ✅/✅
      *
-        - rocThrust (:doc:`details<rocthrust:data-type-support>`)
+        - rocThrust (`details <https://rocm.docs.amd.com/projects/rocThrust/en/develop/data-type-support.html>`_)
        - ✅/✅
        - ✅/✅
        - ✅/✅
@@ -455,7 +456,7 @@ description, refer to the corresponding library data type support page.
        - float32
        - float64
      *
-        - hipSPARSELt (:doc:`details<hipsparselt:reference/data-type-support>`)
+        - hipSPARSELt (:doc:`details <hipsparselt:reference/data-type-support>`)
        - ❌/❌
        - ❌/❌
        - ✅/✅
@@ -464,7 +465,7 @@ description, refer to the corresponding library data type support page.
        - ❌/❌
        - ❌/❌
      *
-        - rocRAND (:doc:`details<rocrand:data-type-support>`)
+        - rocRAND (`details <https://rocm.docs.amd.com/projects/rocRAND/en/develop/data-type-support.html>`_)
        - -/❌
        - -/❌
        - -/✅
@@ -473,7 +474,7 @@ description, refer to the corresponding library data type support page.
        - -/✅
        - -/✅
      *
-        - hipRAND (:doc:`details<hiprand:data-type-support>`)
+        - hipRAND (`details <https://rocm.docs.amd.com/projects/hipRAND/en/develop/data-type-support.html>`_)
        - -/❌
        - -/❌
        - -/✅
@@ -482,7 +483,7 @@ description, refer to the corresponding library data type support page.
        - -/✅
        - -/✅
      *
-        - rocPRIM (:doc:`details<rocprim:data-type-support>`)
+        - rocPRIM (`details <https://rocmdocs.amd.com/projects/rocPRIM/en/develop/reference/data-type-support.html>`_)
        - ❌/❌
        - ❌/❌
        - ✅/✅
@@ -491,7 +492,7 @@ description, refer to the corresponding library data type support page.
        - ✅/✅
        - ✅/✅
      *
-        - hipCUB (:doc:`details<hipcub:data-type-support>`)
+        - hipCUB (`details <https://rocm.docs.amd.com/projects/hipCUB/en/develop/data-type-support.html>`_)
        - ❌/❌
        - ❌/❌
        - ✅/✅
@@ -500,7 +501,7 @@ description, refer to the corresponding library data type support page.
        - ✅/✅
        - ✅/✅
      *
-        - rocThrust (:doc:`details<rocthrust:data-type-support>`)
+        - rocThrust (`details <https://rocm.docs.amd.com/projects/rocThrust/en/develop/data-type-support.html>`_)
        - ❌/❌
        - ❌/❌
        - ⚠️/⚠️
@@ -531,7 +532,7 @@ description, refer to the corresponding library data type support page.
        - int32
        - int64
      *
-        - hipSPARSELt (:doc:`details<hipsparselt:reference/data-type-support>`)
+        - hipSPARSELt (:doc:`details <hipsparselt:reference/data-type-support>`)
        - ❌
        - ❌
        - ✅
@@ -554,7 +555,7 @@ description, refer to the corresponding library data type support page.
        - float32
        - float64
      *
-        - hipSPARSELt (:doc:`details<hipsparselt:reference/data-type-support>`)
+        - hipSPARSELt (:doc:`details <hipsparselt:reference/data-type-support>`)
        - ❌
        - ❌
        - ❌
--- a/docs/index.md
+++ b/docs/index.md
@@ -31,7 +31,7 @@ Our documentation is organized into the following categories:
 :padding: 2

 * Linux
-  * {doc}`Quick-start (Linux)<rocm-install-on-linux:tutorial/quick-start>`
+  * {doc}`Quick start guide<rocm-install-on-linux:tutorial/quick-start>`
  * {doc}`Linux install guide<rocm-install-on-linux:how-to/native-install/index>`
  * {doc}`Package manager integration<rocm-install-on-linux:how-to/native-install/package-manager-integration>`
 * Windows
@@ -56,10 +56,11 @@ Our documentation is organized into the following categories:
 * {doc}`User/kernel space<rocm-install-on-linux:reference/user-kernel-space-compat-matrix>`
 * {doc}`Docker<rocm-install-on-linux:reference/docker-image-support-matrix>`
 * [OpenMP](./about/compatibility/openmp.md)
-* [Precision support](./about/compatibility/data-type-support.rst)
+* [Precision support](./about/compatibility/precision-support.rst)
 * {doc}`ROCm on Radeon GPUs<radeon:index>`
 :::

+<!-- markdownlint-disable MD051 -->
 :::{grid-item-card}
 :class-card: sd-text-black
 :img-top: ./data/banner-reference.jpg
@@ -67,20 +68,19 @@ Our documentation is organized into the following categories:
 :padding: 2

 * [API libraries](./reference/api-libraries.md)
-  * Artificial intelligence
-  * C++ primitives
-  * Communication
-  * Fast Fourier transforms
-  * HIP
-  * Linear algebra
-  * Random number generators
+  * [Artificial intelligence](#artificial-intelligence-apis)
+  * [C++ primitives](#cpp-primitives)
+  * [Communication](#communication-libraries)
+  * [Math](#math-apis)
+  * [Random number generators](#random-number-apis)
+  * [HIP runtime](#hip-runtime)
 * [Tools](./reference/rocm-tools.md)
-  * Development
-  * Performance analysis
-  * System
-* [GPU architectures](./reference/gpu-arch.rst)
-  * [GPU architecture hardware specification overview](./reference/gpu-arch/gpu-arch-spec-overview.rst)
+  * [Development](#development-tools)
+  * [Performance analysis](#performance-analysis)
+  * [System](#system-tools)
+* [Hardware specifications](./reference/gpu-arch-specs.rst)
 :::
+<!-- markdownlint-enable MD051 -->

 :::{grid-item-card}
 :class-card: sd-text-black
--- a/docs/reference/api-libraries.md
+++ b/docs/reference/api-libraries.md
@@ -11,6 +11,8 @@
 ::::{grid} 1 2 2 2
 :class-container: rocm-doc-grid

+(artificial-intelligence-apis)=
+
 :::{grid-item-card}
 :class-card: sd-text-black
 :img-top: ../data/reference/banner-ai.jpg
@@ -24,6 +26,8 @@
 * [ROCm Performance Primitives (RPP)](https://rocm.docs.amd.com/projects/rpp/en/latest/)
 :::

+(cpp-primitives)=
+
 :::{grid-item-card}
 :class-card: sd-text-black
 :img-top: ../data/reference/banner-cpp-primitives.jpg
@@ -36,6 +40,8 @@
 * {doc}`rocThrust <rocthrust:index>`
 :::

+(communication-libraries)=
+
 :::{grid-item-card}
 :class-card: sd-text-black
 :img-top: ../data/reference/banner-communication.jpg
@@ -45,6 +51,8 @@
 * {doc}`RCCL <rccl:index>`
 :::

+(hip-runtime)=
+
 :::{grid-item-card}
 :class-card: sd-text-black
 :img-top: ../data/reference/banner-hip.jpg
@@ -55,6 +63,8 @@
 * {doc}`HIPIFY <hipify:index>`
 :::

+(math-apis)=
+
 :::{grid-item-card}
 :class-card: sd-text-black
 :img-top: ../data/reference/banner-math.jpg
@@ -74,6 +84,8 @@
 * [Tensile](https://github.com/ROCm/Tensile)
 :::

+(random-number-apis)=
+
 :::{grid-item-card}
 :class-card: sd-text-black
 :img-top: ../data/reference/banner-random-number.jpg
--- a/docs/reference/gpu-arch/gpu-arch-spec-overview.rst
+++ b/docs/reference/gpu-arch/gpu-arch-spec-overview.rst
@@ -2,14 +2,14 @@
   :description: AMD Instinct™ GPU architecture information
   :keywords: Instinct, CDNA, GPU, architecture, VRAM, Compute Units, Cache, Registers, LDS, Register File

-GPU architecture hardware specifications
+AMD hardware specifications
 ########################################

-The following table provides an overview over the hardware specifications for the AMD Instinct accelerators, AMD Radeon and AMD Radeon Pro GPUs.
+The following tables provide an overview of the hardware specifications for AMD Instinct™ accelerators, AMD Radeon™ and AMD Radeon™ Pro GPUs.

 .. tab-set::

-  .. tab-item:: AMD Instinct GPUs
+  .. tab-item:: AMD Instinct Accelerators

    .. list-table::
        :header-rows: 1
@@ -657,4 +657,4 @@ The following table provides an overview over the hardware specifications for th
          - 256 KiB
          - 12.5 KiB

-For a detailed explanation of the terms refer to the :ref:`specific documents and guides <gpu-arch-documentation>` or the :ref:`HIP programming guide <HIP:understand/programming_model>`.
+For a detailed explanation of the terms refer to the :ref:`specific documents and guides <gpu-arch-documentation>` or the :ref:`HIP programming guide <HIP:user_guide/hip_rtc>`.
--- a/docs/reference/gpu-arch.rst
+++ b/docs/reference/gpu-arch.rst
@@ -1,13 +0,0 @@
-.. meta::
-    :description: GPU Architecture reference
-    :keywords: AMD, GPU, architecture, hardware, CDNA, Instinct, reference
-
-.. _gpu-arch-reference:
-
-GPU architecture reference
-##########################
-
-General overview
-""""""""""""""""
-
-* :doc:`GPU architecture hardware specifications overview<gpu-arch/gpu-arch-spec-overview>`
--- a/docs/reference/rocm-tools.md
+++ b/docs/reference/rocm-tools.md
@@ -11,6 +11,8 @@
 ::::{grid} 1 2 2 2
 :class-container: rocm-doc-grid

+(development-tools)=
+
 :::{grid-item-card}
 :class-card: sd-text-black
 :img-top: ../data/reference/banner-development.jpg
@@ -23,6 +25,8 @@
 * {doc}`ROCm debugger (ROCgdb) <rocgdb:index>`
 :::

+(performance-tools)=
+
 :::{grid-item-card}
 :class-card: sd-text-black
 :img-top: ../data/reference/banner-performance.jpg
@@ -34,6 +38,8 @@
 * {doc}`ROCTracer <roctracer:index>`
 :::

+(system-tools)=
+
 :::{grid-item-card}
 :class-card: sd-text-black
 :img-top: ../data/reference/banner-system.jpg
--- a/docs/sphinx/_toc.yml.in
+++ b/docs/sphinx/_toc.yml.in
@@ -29,7 +29,7 @@ subtrees:
    title: Linux
  - url: https://rocm.docs.amd.com/projects/install-on-windows/en/${branch}/reference/system-requirements.html
    title: Windows
-  - file: about/compatibility/data-type-support.rst
+  - file: about/compatibility/precision-support.rst
    title: Precision support
  - url: https://rocm.docs.amd.com/projects/install-on-linux/en/${branch}/reference/3rd-party-support-matrix.html
    title: Third-party
@@ -40,14 +40,10 @@ subtrees:
      title: API libraries
    - file: reference/rocm-tools.md
      title: Tools
-    - file: reference/gpu-arch.rst
-      title: GPU architectures
-      subtrees:
-      - entries:
-        - file: reference/gpu-arch/gpu-arch-spec-overview.rst
-          title: Hardware specifications overview
+    - file: reference/gpu-arch-specs.rst
+      title: Hardware specifications

- caption: How-to
+- caption: How to
  entries:
  - file: how-to/deep-learning-rocm.md
    title: Deep learning
@@ -71,7 +67,7 @@ subtrees:
 - caption: Conceptual
  entries:
  - file: conceptual/gpu-arch.md
-    title: GPU architectures
+    title: GPU architecture overview
    subtrees:
    - entries:
      - file: conceptual/gpu-arch/mi300.md