link cleanup (#26)

ROCm · Dec 18, 2023 · 5b363c2 · 5b363c2
1 parent 5f9f46f
commit 5b363c2
Show file tree

Hide file tree

Showing 15 changed files with 63 additions and 68 deletions.
diff --git a/docs/how-to/3rd-party/pytorch-install.rst b/docs/how-to/3rd-party/pytorch-install.rst
@@ -7,7 +7,9 @@ ROCm provides mixed-precision and large-scale training using our
 `MIOpen <https://github.com/ROCmSoftwarePlatform/MIOpen>`_ and
 `RCCL <https://github.com/ROCmSoftwarePlatform/rccl>`_ libraries.
 
-To install `PyTorch for ROCm <https://pytorch.org/blog/pytorch-for-amd-rocm-platform-now-available-as-python-package/>`_, you have the following options:
+To install
+`PyTorch for ROCm <https://pytorch.org/blog/pytorch-for-amd-rocm-platform-now-available-as-python-package/>`_,
+you have the following options:
 
 * :ref:`using-docker-with-pytorch-pre-installed`
   (recommended)
@@ -18,7 +20,7 @@ To install `PyTorch for ROCm <https://pytorch.org/blog/pytorch-for-amd-rocm-plat
 For hardware, software, and third-party framework compatibility between ROCm and PyTorch, refer to:
 
 * :ref:`system-requirements`
-* :doc:`../../reference/3rd-party-support-matrix`
+* :ref:`3rd-party-support-matrix`
 
 .. _using-docker-with-pytorch-pre-installed:
 
@@ -69,11 +71,11 @@ wheels command, you must select 'Linux', 'Python', 'pip', and 'ROCm' in the matr
           * - Base OS
             - Docker Image
           * - Ubuntu 20.04
-            - `rocm/dev-ubuntu-20.04 <https://hub.docker.com/r/rocm/dev-ubuntu-20.04>`
+            - `rocm/dev-ubuntu-20.04 <https://hub.docker.com/r/rocm/dev-ubuntu-20.04>`_
           * - Ubuntu 22.04
-            - `rocm/dev-ubuntu-20.04 <https://hub.docker.com/r/rocm/dev-ubuntu-22.04>`
+            - `rocm/dev-ubuntu-20.04 <https://hub.docker.com/r/rocm/dev-ubuntu-22.04>`_
           * - CentOS 7
-            - `rocm/dev-centos-7 <https://hub.docker.com/r/rocm/dev-centos-7>`
+            - `rocm/dev-centos-7 <https://hub.docker.com/r/rocm/dev-centos-7>`_
 
    b. Pull the selected image.
 
@@ -119,7 +121,7 @@ wheels command, you must select 'Linux', 'Python', 'pip', and 'ROCm' in the matr
        pip3 install wheel setuptools
 
 3. Install ``torch``, ``torchvision``, and ``torchaudio``, as specified in the
-   `installation matrix <https://pytorch.org/get-started/locally/>`.
+   `installation matrix <https://pytorch.org/get-started/locally/>`_.
 
    .. note::
 
@@ -135,8 +137,7 @@ wheels command, you must select 'Linux', 'Python', 'pip', and 'ROCm' in the matr
    PyTorch uses `MIOpen <https://github.com/ROCmSoftwarePlatform/MIOpen>`_ for machine learning
    primitives, which are compiled into kernels at runtime. Runtime compilation causes a small warm-up
    phase when starting PyTorch, and MIOpen kdb files contain precompiled kernels that can speed up
-   application warm-up phases. For more information, refer to the
-   {doc}`MIOpen installation page <miopen:install>`.
+   application warm-up phases.
 
    MIOpen kdb files can be used with ROCm PyTorch wheels. However, the kdb files need to be placed in
    a specific location with respect to the PyTorch installation path. A helper script simplifies this task by
@@ -232,7 +233,7 @@ scripts to determine the configuration of the build environment.
        ./.ci/pytorch/build.sh
 
    This converts PyTorch sources for
-   [HIP compatibility](https://www.amd.com/en/developer/rocm-hub/hip-sdk.html) and builds the
+   `HIP compatibility <https://www.amd.com/en/developer/rocm-hub/hip-sdk.html>`_ and builds the
    PyTorch framework.
 
    To check if your build is successful, run:
@@ -455,7 +456,8 @@ MNIST PyTorch example
 ImageNet PyTorch example
 ---------------------------------------------------------------------------------------------------------
 
-1. Clone the PyTorch examples repository (if you didn't already do this step in the preceding MNIST example).
+1. Clone the PyTorch examples repository (if you didn't already do this in the preceding MNIST
+   example).
 
    .. code-block:: bash
 

diff --git a/docs/how-to/3rd-party/tensorflow-install.rst b/docs/how-to/3rd-party/tensorflow-install.rst
@@ -168,8 +168,8 @@ To install TensorFlow using the wheels package, follow these steps:
 
    .. note::
 
-       For details on `tensorflow-rocm` wheels and ROCm version compatibility, see:
-       `https://github.com/ROCmSoftwarePlatform/tensorflow-upstream/blob/develop-upstream/rocm_docs/tensorflow-rocm-release.md <https://github.com/ROCmSoftwarePlatform/tensorflow-upstream/blob/develop-upstream/rocm_docs/tensorflow-rocm-release.md>`_
+       For details on `tensorflow-rocm` wheels and ROCm version compatibility, refer to our
+       `GitHub repo <https://github.com/ROCmSoftwarePlatform/tensorflow-upstream/blob/develop-upstream/rocm_docs/tensorflow-rocm-release.md>`_
 
 Test the TensorFlow installation
 =======================================

diff --git a/docs/how-to/amdgpu-install.rst b/docs/how-to/amdgpu-install.rst
@@ -6,7 +6,7 @@ Installation via AMDGPU installer
 and its components.
 
 .. warning::
-    ROCm currently doesn't support integrated graphics. Should your system have an
+    ROCm doesn't currently support integrated graphics. Should your system have an
     AMD IGP installed, disable it in the BIOS prior to using ROCm. If the driver can
     enumerate the IGP, the ROCm runtime may crash the system, even if told to omit
     it via :ref:`hip_visible_devices`.
@@ -117,12 +117,11 @@ output below.
     - ROCm math libraries
     - HIP development libraries
 
-
 Upgrading ROCm
 =================================================
 
 The upgrade procedure with the installer script is exactly the same as
-:ref:`installing for first time use. <amdgpu-install-installation>`
+:ref:`installing for first time use<amdgpu-install-installation>`.
 
 Installing ROCm packages
 =================================================
@@ -199,9 +198,7 @@ install except the latest one. The amdgpu-install script automatically adds the
 required repositories for the latest release.
 
 See the section "Register ROCm Packages" in :doc:`/how-to/native-install/index`
-for:
-
-- :ref:`Ubuntu <ubuntu-register-rocm>`
+for :ref:`Ubuntu<ubuntu-register-rocm>`.
 
 Additional options
 =================================================

diff --git a/docs/how-to/docker.rst b/docs/how-to/docker.rst
@@ -26,7 +26,7 @@ The ROCm runtimes make use of multiple device files:
   GPU. Where ``<node>`` is a number for each card in the system starting from 128.
 
 Exposing these devices to a container is done by using the
-[``--device``](https://docs.docker.com/engine/reference/commandline/run/#device)
+`--device <https://docs.docker.com/engine/reference/commandline/run/#device>`_
 option, i.e. to allow access to all GPUs expose ``/dev/kfd`` and all
 ``/dev/dri/renderD`` devices:
 

diff --git a/docs/how-to/native-install/index.rst b/docs/how-to/native-install/index.rst
@@ -7,23 +7,25 @@ Installation via native package manager
 
     .. grid-item-card:: Install
 
-        - :doc:`Ubuntu </how-to/native-install/ubuntu>`
-        - :doc:`Red Hat Enterprise Linux </how-to/native-install/rhel>`
-        - :doc:`SUSE Linux Enterprise </how-to/native-install/sle>`
+        - :doc:`Ubuntu</how-to/native-install/ubuntu>`
+        - :doc:`Red Hat Enterprise Linux</how-to/native-install/rhel>`
+        - :doc:`SUSE Linux Enterprise</how-to/native-install/sle>`
 
     .. grid-item-card:: Upgrade
 
         Instructions for upgrading an existing ROCm installation.
 
-        - :ref:`Ubuntu <ubuntu-upgrade>`
+        - :ref:`Ubuntu<ubuntu-upgrade>`
 
     .. grid-item-card:: Uninstall
 
         Steps for removing ROCm packages libraries and tools.
 
-        - :ref:`Ubuntu <ubuntu-uninstall>`
+        - :ref:`Ubuntu<ubuntu-uninstall>`
 
     .. grid-item-card:: Package manager integration
         :link: package-manager-integration
 
-See also: :doc:`/reference/system-requirements`
+        Required meta-packages for ROCm programming models.
+
+See also: :doc:`/reference/system-requirements`.
diff --git a/docs/how-to/native-install/package-manager-integration.rst b/docs/how-to/native-install/package-manager-integration.rst
@@ -60,12 +60,16 @@ All meta-packages are a combination of required packages and libraries.
     :width: 1500
     :alt: ROCm meta packages
 
+.. note::
+    The preceding figure is for informational purposes only. The individual packages in a meta-package
+    are subject to change. To avoid conflicts, install meta-packages, not individual packages.
+
 **Example:**
 
 - ``rocm-hip-runtime`` is used to deploy on supported machines to execute HIP
   applications.
 - ``rocm-hip-sdk`` contains runtime components to deploy and execute HIP
-  applications.  
+  applications.
 
 .. note::
     ``rocm-llvm`` is not a meta-package; it's a single package that installs the ROCm Clang compiler files.
@@ -265,7 +269,3 @@ The following table shows the meta-packages and their associated (meta-)packages
   |                            | ``openmp-extras-runtime``,      |
   |                            | ``rocm-core``                   |
   +----------------------------+---------------------------------+
-
-.. note::
-    The figure above is for informational purposes only, as the individual packages in a meta-package are subject to change.
-    Install meta-packages, and not individual packages, to avoid conflicts.
diff --git a/docs/how-to/native-install/post-install.rst b/docs/how-to/native-install/post-install.rst
@@ -2,7 +2,7 @@
 Post-installation instructions
 *************************************************************************
 
-1.  Configure system linker.
+1.  Configure the system linker.
 
     Instruct the system linker where to find shared objects (``.so``-files) for ROCm applications.
 

diff --git a/docs/how-to/native-install/rhel.rst b/docs/how-to/native-install/rhel.rst
@@ -81,7 +81,7 @@ Install ROCm packages
 
     sudo yum install rocm-hip-sdk
 
-Perform :doc:`post-install`.
+Complete the :doc:`post-install`.
 
 Upgrade
 =====================================================

diff --git a/docs/how-to/native-install/sle.rst b/docs/how-to/native-install/sle.rst
@@ -69,8 +69,7 @@ Install ROCm packages
 
     sudo zypper --gpg-auto-import-keys install rocm-hip-sdk
 
-Perform :doc:`post-install`.
-
+Complete the :doc:`post-install`.
 
 Upgrading
 ================================================

diff --git a/docs/how-to/native-install/ubuntu.rst b/docs/how-to/native-install/ubuntu.rst
@@ -50,7 +50,7 @@ Add the AMDGPU repository for the driver.
 
                 echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amdgpu/|rocm_version|/ubuntu {{ os_release }} main" \
                     | sudo tee /etc/apt/sources.list.d/amdgpu.list
-                sudo apt update 
+                sudo apt update
         {% endfor %}
 
 .. _ubuntu-register-rocm:
@@ -72,7 +72,6 @@ Add the ROCm repository.
 
                 echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/rocm/apt/|rocm_version| {{ os_release }} main" \
                     | sudo tee --append /etc/apt/sources.list.d/rocm.list
-                done
                 echo -e 'Package: *\nPin: release o=repo.radeon.com\nPin-Priority: 600' \
                     | sudo tee /etc/apt/preferences.d/rocm-pin-600
         {% endfor %}
@@ -97,7 +96,7 @@ Install ROCm packages
 
     sudo apt install rocm-hip-sdk
 
-Perform :doc:`post-install`.
+Complete the :doc:`post-install`.
 
 .. _ubuntu-upgrade:
 

diff --git a/docs/how-to/prerequisites.rst b/docs/how-to/prerequisites.rst
@@ -105,17 +105,13 @@ Kernel headers and development packages
 ================================================================
 
 The driver package uses
-:abbr:`DKMS (Dynamic Kernel Module Support)` [DKMS-wiki]_ to build
-the `amdgpu-dkms` module (driver) for the installed kernels. This requires the
-Linux kernel headers and modules to be installed for each. Usually these are
-automatically installed with the kernel, but if you have multiple kernel
-versions or you have downloaded the kernel images and not the kernel
+`DKMS (Dynamic Kernel Module Support) <https://en.wikipedia.org/wiki/Dynamic_Kernel_Module_Support>`_
+to build the `amdgpu-dkms` module (driver) for the installed kernels. This requires the Linux kernel
+headers and modules to be installed for each. Usually these are automatically installed with the kernel,
+but if you have multiple kernel versions or you have downloaded the kernel images and not the kernel
 meta-packages then they must be manually installed.
 
-.. [DKMS-wiki] https://en.wikipedia.org/wiki/Dynamic_Kernel_Module_Support
-
-To install for the currently active kernel run the command corresponding
-to your distribution.
+To install for the currently active kernel run the command corresponding to your distribution.
 
 .. tab-set::
 

diff --git a/docs/how-to/spack.rst b/docs/how-to/spack.rst
@@ -9,11 +9,10 @@ exotic architectures using libraries that do not have a standard ABI. Spack is n
 a new version does not break existing installations, so many configurations can coexist on the same
 system.
 
-Most importantly, Spack is *simple*. It offers a simple *spec* syntax, so users can concisely specify
+Most importantly, Spack is *simple*. It offers a simple ``spec`` syntax, so users can concisely specify
 versions and configuration options. Spack is also simple for package authors: package files are written
 in pure Python, and specs allow package authors to maintain a single file for many different builds of
-the same package. For more information on Spack, see the
-`Spack tutorial <https://spack-tutorial.readthedocs.io/en/latest/>`_.
+the same package.
 
 ROCM packages in Spack
 ===================================================
@@ -133,7 +132,7 @@ ROCM packages in Spack
 Building ROCm components using Spack
 ===================================================
 
-1. To use the spack package manager, clone the Spack project from GitHub.
+1. To use the Spack package manager, clone the Spack project from GitHub.
 
     .. code-block:: shell
 
@@ -283,8 +282,7 @@ Creating an environment
 
 You can create an environment with all the required components of your version.
 
-1. In the root folder, create a new folder when you can create a ``.yaml`` file. This file is used to
-create an environment.
+1. In the root folder, create a new folder when you can create a ``.yaml`` file. This file is used to create an environment.
 
     .. code-block:: shell
 
@@ -320,7 +318,7 @@ create an environment.
 
     .. code-block:: shell
 
-    spack env activate /localscratch/MyEnvironment
+        spack env activate /localscratch/MyEnvironment
 
 5. Verify that you want all the component versions.
 

diff --git a/docs/reference/3rd-party-support-matrix.rst b/docs/reference/3rd-party-support-matrix.rst
@@ -82,7 +82,7 @@ applications.
       - COMPATIBLE
       - COMPATIBLE
 
-The Unified Collective Communication (`UCC <https://github.com/openucx/ucc>`_) library also has
+The `Unified Collective Communication (UCC) <https://github.com/openucx/ucc>`_ library also has
 support for ROCm devices.
 
 .. list-table::
@@ -100,7 +100,8 @@ support for ROCm devices.
       - COMPATIBLE
       - COMPATIBLE
 
-## Algorithm libraries
+Algorithm libraries
+================================================
 
 ROCm releases provide algorithm libraries with interfaces compatible with
 contemporary CUDA / NVIDIA HPC SDK alternatives.
@@ -151,4 +152,5 @@ contemporary CUDA / NVIDIA HPC SDK alternatives.
       - 3.0.0
       - 22.9
 
-For the latest documentation of these libraries, refer to :doc:`API libraries <../../reference/library-index.md>`.
+For the latest documentation of these libraries, refer to the
+`ROCm API libraries <https://rocm.docs.amd.com/en/latest/reference/library-index.html>`_.
diff --git a/docs/reference/system-requirements.rst b/docs/reference/system-requirements.rst
@@ -7,9 +7,8 @@ System requirements
 Supported GPUs
 =============================================
 
-The table below shows supported GPUs for Instinct™, Radeon Pro™ and Radeon™ GPUs.
-Please click the tabs below to switch between GPU product lines.
-If a GPU is not listed on this table, the GPU is not officially supported by AMD.
+The following table shows the supported GPUs for Instinct™, Radeon Pro™ and Radeon™ GPUs. If a
+GPU is not listed on this table, It's not officially supported by AMD.
 
 .. tab-set::
 
@@ -21,7 +20,7 @@ If a GPU is not listed on this table, the GPU is not officially supported by AMD
 
             * - GPU
               - Architecture
-              - LLVM Target
+              - LLVM target
               - Support
 
             * - AMD Instinct™ MI300X
@@ -68,7 +67,7 @@ If a GPU is not listed on this table, the GPU is not officially supported by AMD
 
             * - GPU
               - Architecture
-              - LLVM Target
+              - LLVM target
               - Support
 
             * - AMD Radeon™ Pro W7900
@@ -96,7 +95,7 @@ If a GPU is not listed on this table, the GPU is not officially supported by AMD
 
             * - GPU
               - Architecture
-              - LLVM Target
+              - LLVM target
               - Support
 
             * - AMD Radeon™ RX 7900 XTX
@@ -110,13 +109,14 @@ If a GPU is not listed on this table, the GPU is not officially supported by AMD
 
 Support status:
 
-✅: **Supported** - AMD enables these GPUs in our software distributions for the corresponding ROCm product.
-⚠️: **Deprecated** - Support will be removed in a future release.
-❌: **Unsupported** - This configuration is not enabled in our software distributions.
+✅: **Supported** - AMD enables these GPUs in our software distributions for the corresponding
+ROCm product.\
+⚠️: **Deprecated** - Support will be removed in a future release.\
+❌: **Unsupported** - This configuration is not enabled in our software distributions.\
 
 .. [#]
     MI300A is currently not officially supported on RHEL 9.x.
-    This will be added on a later date.  
+    This will be added on a later date.
 
 Supported operating systems
 =============================================