From 7b4b376e488c50c0a45c9a9abeac2a030d07e831 Mon Sep 17 00:00:00 2001 From: Tara Charter Date: Tue, 10 Sep 2024 12:12:52 -0500 Subject: [PATCH] ROCm and AMD ROCm used consistently --- .../api-guides/apis-howto/_index.rst | 4 ++-- docs/model-dev-guide/create-experiment.rst | 2 +- .../set-environment-images.rst | 4 ++-- .../deploy/agent-config-reference.rst | 2 +- docs/setup-cluster/_index.rst | 2 +- docs/setup-cluster/k8s/helm-commands.rst | 2 +- docs/setup-cluster/k8s/k8s-dev-guide.rst | 2 +- docs/setup-cluster/rocm-support.rst | 18 +++++++++--------- .../setup-cluster/slurm/slurm-known-issues.rst | 4 ++-- 9 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/model-dev-guide/api-guides/apis-howto/_index.rst b/docs/model-dev-guide/api-guides/apis-howto/_index.rst index cffd6b2f00b..bcb07fbd26f 100644 --- a/docs/model-dev-guide/api-guides/apis-howto/_index.rst +++ b/docs/model-dev-guide/api-guides/apis-howto/_index.rst @@ -56,8 +56,8 @@ Prefer to use an Example Model? If you'd like to build off of an existing model that already runs on Determined, visit our :ref:`example-solutions` to see if the model you'd like to train is already available. -ROCm Support -============ +AMD ROCm Support +================ For AMD ROCm support, visit :ref:`rocm-support` diff --git a/docs/model-dev-guide/create-experiment.rst b/docs/model-dev-guide/create-experiment.rst index dda26020077..7c301850576 100644 --- a/docs/model-dev-guide/create-experiment.rst +++ b/docs/model-dev-guide/create-experiment.rst @@ -26,7 +26,7 @@ Launcher options include: - A command with arguments, run in the container If you're using AMD ROCm GPUs, make sure to specify ``slot_type: rocm`` in your experiment -configuration. For more information on ROCm support, see :ref:`AMD ROCm Support `. +configuration. For more information on AMD ROCm support, see :ref:`AMD ROCm Support `. For distributed training, separate the launcher that starts distributed workers from your training script, which typically runs each worker. The distributed training launcher must: diff --git a/docs/model-dev-guide/prepare-container/set-environment-images.rst b/docs/model-dev-guide/prepare-container/set-environment-images.rst index 88042c43b3b..ba3afbba2c4 100644 --- a/docs/model-dev-guide/prepare-container/set-environment-images.rst +++ b/docs/model-dev-guide/prepare-container/set-environment-images.rst @@ -29,5 +29,5 @@ preparation needed. If you need to add additional customization to the training environment, review the :ref:`custom-env` page. -For details on using ROCm-enabled images, including our ROCm 6.1 images with DeepSpeed support for -MI300x users, see our :ref:`AMD ROCm Support documentation `. +For details on using AMD ROCm-enabled images, including our ROCm 6.1 images with DeepSpeed support +for MI300x users, see our :ref:`AMD ROCm Support documentation `. diff --git a/docs/reference/deploy/agent-config-reference.rst b/docs/reference/deploy/agent-config-reference.rst index e0e9e4a9084..359d7e1a797 100644 --- a/docs/reference/deploy/agent-config-reference.rst +++ b/docs/reference/deploy/agent-config-reference.rst @@ -81,7 +81,7 @@ option was called ``gpu``. ``cpu``: Map all the CPUs to a slot, even when GPUs are present. -``rocm``: The agent will map each detected ROCm AMD GPU to a slot. +``rocm``: The agent will map each detected AMD ROCm GPU to a slot. **************** ``http_proxy`` diff --git a/docs/setup-cluster/_index.rst b/docs/setup-cluster/_index.rst index 5f2404e6b7a..ea693b26fc1 100644 --- a/docs/setup-cluster/_index.rst +++ b/docs/setup-cluster/_index.rst @@ -97,4 +97,4 @@ Enable Determined to submit jobs to a Slurm cluster. Deploy on Kubernetes Deploy on Slurm/PBS Cluster Configuration - ROCm Support + AMD ROCm Support diff --git a/docs/setup-cluster/k8s/helm-commands.rst b/docs/setup-cluster/k8s/helm-commands.rst index 1497d6f616b..8380435e5fd 100644 --- a/docs/setup-cluster/k8s/helm-commands.rst +++ b/docs/setup-cluster/k8s/helm-commands.rst @@ -40,7 +40,7 @@ It is recommended to have just one instance of Determined per Kubernetes cluster **************************** For specific configuration details related to AMD ROCm GPUs, including how to set up resource pools -and configure experiments, see our :ref:`guide on Configuring Kubernetes for ROCm GPUs +and configure experiments, see our :ref:`guide on Configuring Kubernetes for AMD ROCm GPUs `. ************************************** diff --git a/docs/setup-cluster/k8s/k8s-dev-guide.rst b/docs/setup-cluster/k8s/k8s-dev-guide.rst index 64ea1432587..b4cc16dae4d 100644 --- a/docs/setup-cluster/k8s/k8s-dev-guide.rst +++ b/docs/setup-cluster/k8s/k8s-dev-guide.rst @@ -16,7 +16,7 @@ Kubernetes manually, or you can use a managed Kubernetes service such as :ref:`G .. note:: For information on using AMD ROCm GPUs with Determined on Kubernetes, please refer to our - :ref:`ROCm Support Guide `. + :ref:`AMD ROCm Support Guide `. ********************************** Set up a Development Environment diff --git a/docs/setup-cluster/rocm-support.rst b/docs/setup-cluster/rocm-support.rst index 8f3b5b0d033..13710f25e73 100644 --- a/docs/setup-cluster/rocm-support.rst +++ b/docs/setup-cluster/rocm-support.rst @@ -14,7 +14,7 @@ .. note:: - ROCm support in Determined is experimental. Features and configurations may change in future + AMD ROCm support in Determined is experimental. Features and configurations may change in future releases. We recommend testing thoroughly in a non-production environment before deploying to production. @@ -35,11 +35,11 @@ For more detailed information about configuration, visit the :ref:`helm-config-r .. _rocm-config-k8s: -************************************** - Configuring Kubernetes for ROCm GPUs -************************************** +****************************************** + Configuring Kubernetes for AMD ROCm GPUs +****************************************** -To use ROCm GPUs in your Kubernetes deployment: +To use AMD ROCm GPUs in your Kubernetes deployment: #. Ensure your Kubernetes cluster has nodes with ROCm-capable GPUs and the necessary drivers installed. @@ -59,11 +59,11 @@ To use ROCm GPUs in your Kubernetes deployment: #. When submitting experiments or launching tasks, specify ``slot_type: rocm`` in your experiment configuration. -********************************** - Using ROCm Images in Experiments -********************************** +************************************** + Using AMD ROCm Images in Experiments +************************************** -To use ROCm images in your experiments, specify the image in your experiment configuration: +To use AMD ROCm images in your experiments, specify the image in your experiment configuration: .. code:: yaml diff --git a/docs/setup-cluster/slurm/slurm-known-issues.rst b/docs/setup-cluster/slurm/slurm-known-issues.rst index d85127fc3c7..a1e0d2dd898 100644 --- a/docs/setup-cluster/slurm/slurm-known-issues.rst +++ b/docs/setup-cluster/slurm/slurm-known-issues.rst @@ -392,10 +392,10 @@ Some constraints are due to differences in behavior between Docker and Singulari `. *********************** - AMD/ROCm Known Issues + AMD ROCm Known Issues *********************** -For AMD/ROCm support and known issues, visit :ref:`AMD ROCm GPUs `. +For AMD ROCm support and known issues, visit :ref:`AMD ROCm GPUs `. *************************************** Determined AI Experiment Requirements