Skip to content

Commit

Permalink
Merge pull request #12 from ROCm/spelling-fixes
Browse files Browse the repository at this point in the history
docs: Fix spellcheck violations
  • Loading branch information
samjwu authored Dec 6, 2023
2 parents f146424 + d0e33e6 commit fa2069a
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 13 deletions.
20 changes: 10 additions & 10 deletions docs/how-to/amdgpu-install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -130,31 +130,31 @@ 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
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
=================================================
Expand All @@ -166,25 +166,25 @@ 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=<release-number>
sudo amdgpu-install --uninstall --rocmrelease=<release-number>
- Uninstalling all ROCm Releases

.. code-block:: bash
sudo amdgpu-install --uninstall --rocmrelease=all
sudo amdgpu-install --uninstall --rocmrelease=all
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
Expand Down Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/how-to/docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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<node>``: direct rendering interface (DRI) devices for each
GPU. Wher ``<node>`` is a number for each card in the system starting from 128.
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)
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/spack.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/docker-image-support-matrix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Docker image support matrix
******************************************************************

AMD validates and publishes `PyTorch <https://hub.docker.com/r/rocm/pytorch>`_ and
`TensorFlow <https://hub.docker.com/r/rocm/tensorflow>`_ containers on dockerhub. The following
`TensorFlow <https://hub.docker.com/r/rocm/tensorflow>`_ containers on Docker Hub. The following
tags, and associated inventories, are validated with ROCm 5.7.

.. tab-set::
Expand Down

0 comments on commit fa2069a

Please sign in to comment.