From 06cb5f1c7d08664118a070e96bf6b8620df8a4bc Mon Sep 17 00:00:00 2001 From: Sam Wu Date: Fri, 1 Dec 2023 12:03:26 -0700 Subject: [PATCH 1/3] docs: Fix spellcheck violations --- docs/how-to/amdgpu-install.rst | 16 ++++++++-------- docs/how-to/docker.rst | 2 +- docs/how-to/spack.rst | 2 +- docs/reference/docker-image-support-matrix.rst | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/how-to/amdgpu-install.rst b/docs/how-to/amdgpu-install.rst index ff16a21b..51d756ea 100644 --- a/docs/how-to/amdgpu-install.rst +++ b/docs/how-to/amdgpu-install.rst @@ -134,27 +134,27 @@ amdgpu-install as follows: .. code-block:: bash - sudo amdgpu-install --usecase=rocm + sudo amdgpu-install --usecase=rocm - For multiple use cases separate them with commas: .. code-block:: bash - sudo amdgpu-install --usecase=hiplibsdk,rocm + sudo amdgpu-install --usecase=hiplibsdk,rocm - For graphical workloads using the open-source driver add ``graphics``. For example: .. code-block:: bash - sudo amdgpu-install --usecase=graphics,rocm + sudo amdgpu-install --usecase=graphics,rocm - For graphical workloads using the proprietary driver add ``workstation``. For example: .. code-block:: bash - sudo amdgpu-install --usecase=workstation,rocm + sudo amdgpu-install --usecase=workstation,rocm Uninstalling ROCm ================================================= @@ -166,20 +166,20 @@ can be used. .. code-block:: bash - sudo amdgpu-install --uninstall + sudo amdgpu-install --uninstall - Uninstalling a Specific ROCm Release .. code-block:: bash - sudo amdgpu-install --uninstall --rocmrelease= + sudo amdgpu-install --uninstall --rocmrelease= - Uninstalling all ROCm Releases .. code-block:: bash - sudo amdgpu-install --uninstall --rocmrelease=all + sudo amdgpu-install --uninstall --rocmrelease=all Multi-versioned ROCm Installation ================================================= @@ -225,5 +225,5 @@ containers or you may wish to keep a specific version when using multi-version installation, and not have the last installed version overwrite the kernel mode driver. -To skip the installation of the kernel-mode driver add the --no-dkms option when +To skip the installation of the kernel-mode driver add the :code:`--no-dkms` option when calling the installer script. diff --git a/docs/how-to/docker.rst b/docs/how-to/docker.rst index 11d28b3d..e3fd5891 100644 --- a/docs/how-to/docker.rst +++ b/docs/how-to/docker.rst @@ -23,7 +23,7 @@ The ROCm runtimes make use of multiple device files: - ``/dev/kfd``: the main compute interface shared by all GPUs - ``/dev/dri/renderD``: direct rendering interface (DRI) devices for each - GPU. Wher ```` is a number for each card in the system starting from 128. + GPU. Where ```` 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) diff --git a/docs/how-to/spack.rst b/docs/how-to/spack.rst index 4427e34a..001b0f82 100644 --- a/docs/how-to/spack.rst +++ b/docs/how-to/spack.rst @@ -343,7 +343,7 @@ create an environment. spack find -8. If any modification is made to the ``.yaml`` file, you must deactivate the existing environment and create a new one in order for the modications to be reflected. +8. If any modification is made to the ``.yaml`` file, you must deactivate the existing environment and create a new one in order for the modifications to be reflected. To deactivate, use: diff --git a/docs/reference/docker-image-support-matrix.rst b/docs/reference/docker-image-support-matrix.rst index e6d66317..da8ac3ad 100644 --- a/docs/reference/docker-image-support-matrix.rst +++ b/docs/reference/docker-image-support-matrix.rst @@ -5,7 +5,7 @@ Docker image support matrix ****************************************************************** AMD validates and publishes `PyTorch `_ and -`TensorFlow `_ containers on dockerhub. The following +`TensorFlow `_ containers on DockerHub. The following tags, and associated inventories, are validated with ROCm 5.7. .. tab-set:: From b8e905b93a39322b6d6051780d8e619aa3804e75 Mon Sep 17 00:00:00 2001 From: Sam Wu Date: Mon, 4 Dec 2023 16:20:23 -0700 Subject: [PATCH 2/3] docs(amdgpu-install.rst): Use code directive for keywords --- docs/how-to/amdgpu-install.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/how-to/amdgpu-install.rst b/docs/how-to/amdgpu-install.rst index 51d756ea..2ea37e44 100644 --- a/docs/how-to/amdgpu-install.rst +++ b/docs/how-to/amdgpu-install.rst @@ -130,7 +130,7 @@ Installing ROCm packages To install use cases specific to your requirements, use the installer amdgpu-install as follows: -- To install a single use case add it with the --usecase option: +- To install a single use case add it with the :code:`--usecase` option: .. code-block:: bash @@ -184,7 +184,7 @@ can be used. Multi-versioned ROCm Installation ================================================= -By default (without the --rocmrelease option) the installer script will install +By default (without the :code:`--rocmrelease` option) the installer script will install packages in the single-version layout. For the multi-version ROCm installation you must use the installer script from From d0e33e6000c6dd0f2a6aca71356c7e0ec0f0832b Mon Sep 17 00:00:00 2001 From: Sam Wu Date: Wed, 6 Dec 2023 16:32:26 -0700 Subject: [PATCH 3/3] Update docker-image-support-matrix.rst --- docs/reference/docker-image-support-matrix.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/docker-image-support-matrix.rst b/docs/reference/docker-image-support-matrix.rst index da8ac3ad..38f44029 100644 --- a/docs/reference/docker-image-support-matrix.rst +++ b/docs/reference/docker-image-support-matrix.rst @@ -5,7 +5,7 @@ Docker image support matrix ****************************************************************** AMD validates and publishes `PyTorch `_ and -`TensorFlow `_ containers on DockerHub. The following +`TensorFlow `_ containers on Docker Hub. The following tags, and associated inventories, are validated with ROCm 5.7. .. tab-set::