@@ -2,7 +2,7 @@ Getting Started with Distributed Data Parallel
2
2
=================================================
3
3
**Author **: `Shen Li <https://mrshenli.github.io/ >`_
4
4
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 >`__
6
6
7
7
.. note ::
8
8
|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:
12
12
- `PyTorch Distributed Overview <../beginner/dist_overview.html >`__
13
13
- `DistributedDataParallel API documents <https://pytorch.org/docs/master/generated/torch.nn.parallel.DistributedDataParallel.html >`__
14
14
- `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.
15
16
16
17
17
18
`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
21
24
`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!
28
35
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.
29
39
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.
36
43
37
44
38
45
.. note ::
@@ -43,25 +50,22 @@ combining DDP with model parallel.
43
50
Comparison between ``DataParallel `` and ``DistributedDataParallel ``
44
51
-------------------------------------------------------------------
45
52
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 :
48
55
49
56
- 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 .
55
62
- Recall from the
56
63
`prior tutorial <https://pytorch.org/tutorials/intermediate/model_parallel_tutorial.html >`__
57
64
that if your model is too large to fit on a single GPU, you must use **model parallel **
58
65
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
60
67
with model parallel, each DDP process would use model parallel, and all processes
61
68
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.
65
69
66
70
Basic Use Case
67
71
--------------
@@ -99,6 +103,9 @@ be found in
99
103
os.environ[' MASTER_ADDR' ] = ' localhost'
100
104
os.environ[' MASTER_PORT' ] = ' 12355'
101
105
106
+ # set the device id for this process
107
+ torch.cuda.set_device(rank)
108
+
102
109
# initialize the process group
103
110
dist.init_process_group(" gloo" , rank = rank, world_size = world_size)
104
111
@@ -141,6 +148,7 @@ different DDP processes starting from different initial model parameter values.
141
148
optimizer.step()
142
149
143
150
cleanup()
151
+ print (f " Finished running basic DDP example on rank { rank} . " )
144
152
145
153
146
154
def run_demo (demo_fn , world_size ):
@@ -149,6 +157,7 @@ different DDP processes starting from different initial model parameter values.
149
157
nprocs = world_size,
150
158
join = True )
151
159
160
+
152
161
As you can see, DDP wraps lower-level distributed communication details and
153
162
provides a clean API as if it were a local model. Gradient synchronization
154
163
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
179
188
during training and recover from checkpoints. See
180
189
`SAVING AND LOADING MODELS <https://pytorch.org/tutorials/beginner/saving_loading_models.html >`__
181
190
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
184
193
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
186
196
loading before the saving is finished. Additionally, when
187
197
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 ``
189
199
is missing, ``torch.load `` will first load the module to CPU and then copy each
190
200
parameter to where it was saved, which would result in all processes on the
191
201
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
218
228
219
229
loss_fn = nn.MSELoss()
220
230
optimizer = optim.SGD(ddp_model.parameters(), lr = 0.001 )
221
-
231
+
222
232
optimizer.zero_grad()
223
233
outputs = ddp_model(torch.randn(20 , 10 ))
224
234
labels = torch.randn(20 , 5 ).to(rank)
@@ -234,6 +244,7 @@ and elasticity support, please refer to `TorchElastic <https://pytorch.org/elast
234
244
os.remove(CHECKPOINT_PATH )
235
245
236
246
cleanup()
247
+ print (f " Finished running DDP checkpoint example on rank { rank} . " )
237
248
238
249
Combining DDP with Model Parallelism
239
250
------------------------------------
@@ -285,6 +296,7 @@ either the application or the model ``forward()`` method.
285
296
optimizer.step()
286
297
287
298
cleanup()
299
+ print (f " Finished running DDP with model parallel example on rank { rank} . " )
288
300
289
301
290
302
if __name__ == " __main__" :
@@ -325,13 +337,12 @@ Let's still use the Toymodel example and create a file named ``elastic_ddp.py``.
325
337
def demo_basic ():
326
338
dist.init_process_group(" nccl" )
327
339
rank = dist.get_rank()
340
+
328
341
print (f " Start running basic DDP example on rank { rank} . " )
329
-
330
342
# create model and move it to GPU with id rank
331
343
device_id = rank % torch.cuda.device_count()
332
344
model = ToyModel().to(device_id)
333
345
ddp_model = DDP(model, device_ids = [device_id])
334
-
335
346
loss_fn = nn.MSELoss()
336
347
optimizer = optim.SGD(ddp_model.parameters(), lr = 0.001 )
337
348
@@ -341,22 +352,23 @@ Let's still use the Toymodel example and create a file named ``elastic_ddp.py``.
341
352
loss_fn(outputs, labels).backward()
342
353
optimizer.step()
343
354
dist.destroy_process_group()
344
-
355
+ print (f " Finished running basic DDP example on rank { rank} . " )
356
+
345
357
if __name__ == " __main__" :
346
358
demo_basic()
347
359
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
349
361
on all nodes to initialize the DDP job created above:
350
362
351
363
.. code :: bash
352
364
353
365
torchrun --nnodes=2 --nproc_per_node=8 --rdzv_id=100 --rdzv_backend=c10d --rdzv_endpoint=$MASTER_ADDR :29400 elastic_ddp.py
354
366
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.
357
369
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
360
372
management tools like slurm to actually run this command on 2 nodes.
361
373
362
374
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:
368
380
369
381
370
382
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.
373
383
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