Skip to content

Commit 64f54bd

Browse files
committed
[doc] minor fixups to DDP tutorial
Summary: Add "set_device" call to keep things consistent between all DDP tutorials. This was inspired by the following change in the PyTorch repo: pytorch/examples#1285 (review) Test Plan: Ran tutorial with the applied changes and we see: """ Running basic DDP example on rank 3. Running basic DDP example on rank 1. Running basic DDP example on rank 2. Running basic DDP example on rank 0. Finished running basic DDP example on rank 0. Finished running basic DDP example on rank 1. Finished running basic DDP example on rank 3. Finished running basic DDP example on rank 2. Running DDP checkpoint example on rank 2. Running DDP checkpoint example on rank 1. Running DDP checkpoint example on rank 0. Running DDP checkpoint example on rank 3. Finished DDP checkpoint example on rank 0. Finished DDP checkpoint example on rank 3. Finished DDP checkpoint example on rank 1. Finished DDP checkpoint example on rank 2. Running DDP with model parallel example on rank 0. Running DDP with model parallel example on rank 1. Finished running DDP with model parallel example on rank 0. Finished running DDP with model parallel example on rank 1. """
1 parent 904ca90 commit 64f54bd

File tree

1 file changed

+56
-44
lines changed

1 file changed

+56
-44
lines changed

intermediate_source/ddp_tutorial.rst

+56-44
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Getting Started with Distributed Data Parallel
22
=================================================
33
**Author**: `Shen Li <https://mrshenli.github.io/>`_
44

5-
**Edited by**: `Joe Zhu <https://github.com/gunandrose4u>`_
5+
**Edited by**: `Joe Zhu <https://github.com/gunandrose4u>`_, `Chirag Pandya <https://github.com/c-p-i-o>`__
66

77
.. note::
88
|edit| View and edit this tutorial in `github <https://github.com/pytorch/tutorials/blob/main/intermediate_source/ddp_tutorial.rst>`__.
@@ -12,27 +12,34 @@ Prerequisites:
1212
- `PyTorch Distributed Overview <../beginner/dist_overview.html>`__
1313
- `DistributedDataParallel API documents <https://pytorch.org/docs/master/generated/torch.nn.parallel.DistributedDataParallel.html>`__
1414
- `DistributedDataParallel notes <https://pytorch.org/docs/master/notes/ddp.html>`__
15+
- The code in this tutorial runs on an 8-GPU server, but it can be easily generalized to other environments.
1516

1617

1718
`DistributedDataParallel <https://pytorch.org/docs/stable/nn.html#module-torch.nn.parallel>`__
18-
(DDP) implements data parallelism at the module level which can run across
19-
multiple machines. Applications using DDP should spawn multiple processes and
20-
create a single DDP instance per process. DDP uses collective communications in the
19+
(DDP) is a powerful module in PyTorch that allows you to parallelize your model across
20+
multiple machines, making it perfect for large-scale deep learning applications.
21+
To use DDP, you'll need to spawn multiple processes and create a single instance of DDP per process.
22+
23+
But how does it work? DDP uses collective communications from the
2124
`torch.distributed <https://pytorch.org/tutorials/intermediate/dist_tuto.html>`__
22-
package to synchronize gradients and buffers. More specifically, DDP registers
23-
an autograd hook for each parameter given by ``model.parameters()`` and the
24-
hook will fire when the corresponding gradient is computed in the backward
25-
pass. Then DDP uses that signal to trigger gradient synchronization across
26-
processes. Please refer to
27-
`DDP design note <https://pytorch.org/docs/master/notes/ddp.html>`__ for more details.
25+
package to synchronize gradients and buffers across all processes. This means that each process will have
26+
its own copy of the model, but they'll all work together to train the model as if it were on a single machine.
27+
28+
To make this happen, DDP registers an autograd hook for each parameter in the model.
29+
When the backward pass is run, this hook fires and triggers gradient synchronization across all processes.
30+
This ensures that each process has the same gradients, which are then used to update the model.
31+
32+
For more information on how DDP works and how to use it effectively, be sure to check out the
33+
`DDP design note <https://pytorch.org/docs/master/notes/ddp.html>`__.
34+
With DDP, you can train your models faster and more efficiently than ever before!
2835

36+
The recommended way to use DDP is to spawn one process for each model replica. The model replica can span
37+
multiple devices. DDP processes can be placed on the same machine or across machines. Note that GPU devices
38+
cannot be shared across DDP processes.
2939

30-
The recommended way to use DDP is to spawn one process for each model replica,
31-
where a model replica can span multiple devices. DDP processes can be
32-
placed on the same machine or across machines, but GPU devices cannot be
33-
shared across processes. This tutorial starts from a basic DDP use case and
34-
then demonstrates more advanced use cases including checkpointing models and
35-
combining DDP with model parallel.
40+
41+
In this tutorial, we'll start with a basic DDP use case and then demonstrate more advanced use cases,
42+
including checkpointing models and combining DDP with model parallel.
3643

3744

3845
.. note::
@@ -43,25 +50,22 @@ combining DDP with model parallel.
4350
Comparison between ``DataParallel`` and ``DistributedDataParallel``
4451
-------------------------------------------------------------------
4552

46-
Before we dive in, let's clarify why, despite the added complexity, you would
47-
consider using ``DistributedDataParallel`` over ``DataParallel``:
53+
Before we dive in, let's clarify why you would consider using ``DistributedDataParallel``
54+
over ``DataParallel``, despite its added complexity:
4855

4956
- First, ``DataParallel`` is single-process, multi-thread, and only works on a
50-
single machine, while ``DistributedDataParallel`` is multi-process and works
51-
for both single- and multi- machine training. ``DataParallel`` is usually
52-
slower than ``DistributedDataParallel`` even on a single machine due to GIL
53-
contention across threads, per-iteration replicated model, and additional
54-
overhead introduced by scattering inputs and gathering outputs.
57+
single machine. In contrast, ``DistributedDataParallel`` is multi-process and supports
58+
both single- and multi- machine training.
59+
Due to GIL contention across threads, per-iteration replicated model, and additional overhead introduced by
60+
scattering inputs and gathering outputs, ``DataParallel`` is usually
61+
slower than ``DistributedDataParallel`` even on a single machine.
5562
- Recall from the
5663
`prior tutorial <https://pytorch.org/tutorials/intermediate/model_parallel_tutorial.html>`__
5764
that if your model is too large to fit on a single GPU, you must use **model parallel**
5865
to split it across multiple GPUs. ``DistributedDataParallel`` works with
59-
**model parallel**; ``DataParallel`` does not at this time. When DDP is combined
66+
**model parallel**, while ``DataParallel`` does not at this time. When DDP is combined
6067
with model parallel, each DDP process would use model parallel, and all processes
6168
collectively would use data parallel.
62-
- If your model needs to span multiple machines or if your use case does not fit
63-
into data parallelism paradigm, please see `the RPC API <https://pytorch.org/docs/stable/rpc.html>`__
64-
for more generic distributed training support.
6569

6670
Basic Use Case
6771
--------------
@@ -99,6 +103,9 @@ be found in
99103
os.environ['MASTER_ADDR'] = 'localhost'
100104
os.environ['MASTER_PORT'] = '12355'
101105
106+
# set the device id for this process
107+
torch.cuda.set_device(rank)
108+
102109
# initialize the process group
103110
dist.init_process_group("gloo", rank=rank, world_size=world_size)
104111
@@ -141,6 +148,7 @@ different DDP processes starting from different initial model parameter values.
141148
optimizer.step()
142149
143150
cleanup()
151+
print(f"Finished running basic DDP example on rank {rank}.")
144152
145153
146154
def run_demo(demo_fn, world_size):
@@ -149,6 +157,7 @@ different DDP processes starting from different initial model parameter values.
149157
nprocs=world_size,
150158
join=True)
151159
160+
152161
As you can see, DDP wraps lower-level distributed communication details and
153162
provides a clean API as if it were a local model. Gradient synchronization
154163
communications take place during the backward pass and overlap with the
@@ -179,13 +188,14 @@ It's common to use ``torch.save`` and ``torch.load`` to checkpoint modules
179188
during training and recover from checkpoints. See
180189
`SAVING AND LOADING MODELS <https://pytorch.org/tutorials/beginner/saving_loading_models.html>`__
181190
for more details. When using DDP, one optimization is to save the model in
182-
only one process and then load it to all processes, reducing write overhead.
183-
This is correct because all processes start from the same parameters and
191+
only one process and then load it on all processes, reducing write overhead.
192+
This works because all processes start from the same parameters and
184193
gradients are synchronized in backward passes, and hence optimizers should keep
185-
setting parameters to the same values. If you use this optimization, make sure no process starts
194+
setting parameters to the same values.
195+
If you use this optimization (i.e. save on one process but restore on all), make sure no process starts
186196
loading before the saving is finished. Additionally, when
187197
loading the module, you need to provide an appropriate ``map_location``
188-
argument to prevent a process from stepping into others' devices. If ``map_location``
198+
argument to prevent processes from stepping into others' devices. If ``map_location``
189199
is missing, ``torch.load`` will first load the module to CPU and then copy each
190200
parameter to where it was saved, which would result in all processes on the
191201
same machine using the same set of devices. For more advanced failure recovery
@@ -218,7 +228,7 @@ and elasticity support, please refer to `TorchElastic <https://pytorch.org/elast
218228
219229
loss_fn = nn.MSELoss()
220230
optimizer = optim.SGD(ddp_model.parameters(), lr=0.001)
221-
231+
222232
optimizer.zero_grad()
223233
outputs = ddp_model(torch.randn(20, 10))
224234
labels = torch.randn(20, 5).to(rank)
@@ -234,6 +244,7 @@ and elasticity support, please refer to `TorchElastic <https://pytorch.org/elast
234244
os.remove(CHECKPOINT_PATH)
235245
236246
cleanup()
247+
print(f"Finished running DDP checkpoint example on rank {rank}.")
237248
238249
Combining DDP with Model Parallelism
239250
------------------------------------
@@ -285,6 +296,7 @@ either the application or the model ``forward()`` method.
285296
optimizer.step()
286297
287298
cleanup()
299+
print(f"Finished running DDP with model parallel example on rank {rank}.")
288300
289301
290302
if __name__ == "__main__":
@@ -325,13 +337,12 @@ Let's still use the Toymodel example and create a file named ``elastic_ddp.py``.
325337
def demo_basic():
326338
dist.init_process_group("nccl")
327339
rank = dist.get_rank()
340+
328341
print(f"Start running basic DDP example on rank {rank}.")
329-
330342
# create model and move it to GPU with id rank
331343
device_id = rank % torch.cuda.device_count()
332344
model = ToyModel().to(device_id)
333345
ddp_model = DDP(model, device_ids=[device_id])
334-
335346
loss_fn = nn.MSELoss()
336347
optimizer = optim.SGD(ddp_model.parameters(), lr=0.001)
337348
@@ -341,22 +352,23 @@ Let's still use the Toymodel example and create a file named ``elastic_ddp.py``.
341352
loss_fn(outputs, labels).backward()
342353
optimizer.step()
343354
dist.destroy_process_group()
344-
355+
print(f"Finished running basic DDP example on rank {rank}.")
356+
345357
if __name__ == "__main__":
346358
demo_basic()
347359
348-
One can then run a `torch elastic/torchrun <https://pytorch.org/docs/stable/elastic/quickstart.html>`__ command
360+
One can then run a `torch elastic/torchrun <https://pytorch.org/docs/stable/elastic/quickstart.html>`__ command
349361
on all nodes to initialize the DDP job created above:
350362

351363
.. code:: bash
352364
353365
torchrun --nnodes=2 --nproc_per_node=8 --rdzv_id=100 --rdzv_backend=c10d --rdzv_endpoint=$MASTER_ADDR:29400 elastic_ddp.py
354366
355-
We are running the DDP script on two hosts, and each host we run with 8 processes, aka, we
356-
are running it on 16 GPUs. Note that ``$MASTER_ADDR`` must be the same across all nodes.
367+
In the example above, we are running the DDP script on two hosts and we run with 8 processes on each host. That is, we
368+
are running this job on 16 GPUs. Note that ``$MASTER_ADDR`` must be the same across all nodes.
357369

358-
Here torchrun will launch 8 process and invoke ``elastic_ddp.py``
359-
on each process on the node it is launched on, but user also needs to apply cluster
370+
Here ``torchrun`` will launch 8 processes and invoke ``elastic_ddp.py``
371+
on each process on the node it is launched on, but user also needs to apply cluster
360372
management tools like slurm to actually run this command on 2 nodes.
361373

362374
For example, on a SLURM enabled cluster, we can write a script to run the command above
@@ -368,8 +380,8 @@ and set ``MASTER_ADDR`` as:
368380
369381
370382
Then we can just run this script using the SLURM command: ``srun --nodes=2 ./torchrun_script.sh``.
371-
Of course, this is just an example; you can choose your own cluster scheduling tools
372-
to initiate the torchrun job.
373383

374-
For more information about Elastic run, one can check this
375-
`quick start document <https://pytorch.org/docs/stable/elastic/quickstart.html>`__ to learn more.
384+
This is just an example; you can choose your own cluster scheduling tools to initiate the ``torchrun`` job.
385+
386+
For more information about Elastic run, please see the
387+
`quick start document <https://pytorch.org/docs/stable/elastic/quickstart.html>`__.

0 commit comments

Comments
 (0)