Skip to content

documentation: fix SMP code example, added note for CUDA 11 to SDP #2037

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 14, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions doc/api/training/smd_data_parallel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,15 @@ with multiple GPUs. As the cluster size increases, so does the significant drop
in performance. This drop in performance is primarily caused the communications
overhead between nodes in a cluster.

.. important::
SDP only supports training jobs using CUDA 11. When you define a PyTorch or TensorFlow
``Estimator`` with ``dataparallel`` parameter ``enabled`` set to ``True``,
it uses CUDA 11. When you extend or customize your own training image
you must use a CUDA 11 base image. See
`SageMaker Python SDK's SDP APIs
<https://docs.aws.amazon.com/sagemaker/latest/dg/data-parallel-use-api.html#data-parallel-use-python-skd-api>`__
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: It seems there are two underscores here.

for more information.

.. rubric:: Customize your training script

To customize your own training script, you will need the following:
Expand Down
2 changes: 1 addition & 1 deletion doc/api/training/smd_model_parallel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Use the following sections to learn more about the model parallelism and the SMP

.. important::
SMP only supports training jobs using CUDA 11. When you define a PyTorch or TensorFlow
``Estimator`` with ``smdistributed`` ``enabled``,
``Estimator`` with ``modelparallel`` parameter ``enabled`` set to ``True``,
it uses CUDA 11. When you extend or customize your own training image
you must use a CUDA 11 base image. See
`Extend or Adapt A Docker Container that Contains SMP
Expand Down
2 changes: 1 addition & 1 deletion doc/api/training/smd_model_parallel_general.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The following is an example of how you can launch a new PyTorch training job wit
py_version='py3',
instance_count=1,
distribution={
"smdistributed": smp_options,
"smdistributed": {"modelparallel": smp_options},
"mpi": mpi_options
},
base_job_name="SMD-MP-demo",
Expand Down