Minor update to the docs (#7691)

pytorch · Jul 16, 2024 · a6ab3fe · a6ab3fe
1 parent e523fdf
commit a6ab3fe
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/docs/ddp.md b/docs/ddp.md
@@ -1,8 +1,8 @@
-# How to do `DistributedDataParallel`
+# How to do DistributedDataParallel(DDP)
 
 This document shows how to use torch.nn.parallel.DistributedDataParallel in xla,
 and further describes its difference against the native xla data parallel
-approach.
+approach. You can  find a minimum runnable example [here](https://github.com/pytorch/xla/blob/master/examples/data_parallel/train_resnet_ddp.py).
 
 
 ## Background / Motivation

diff --git a/docs/fsdp.md b/docs/fsdp.md
@@ -61,7 +61,7 @@ The implementation of this class is largely inspired by and mostly follows the s
 ---
 
 ### Example training scripts on MNIST and ImageNet
-
+* Minimum example : [`examples/fsdp/train_resnet_fsdp_auto_wrap.py`](https://github.com/pytorch/xla/blob/master/examples/fsdp/train_resnet_fsdp_auto_wrap.py)
 * MNIST: [`test/test_train_mp_mnist_fsdp_with_ckpt.py`](https://github.com/pytorch/xla/blob/master/test/test_train_mp_mnist_fsdp_with_ckpt.py) (it also tests checkpoint consolidation)
 * ImageNet: [`test/test_train_mp_imagenet_fsdp.py`](https://github.com/pytorch/xla/blob/master/test/test_train_mp_imagenet_fsdp.py)
 

diff --git a/docs/fsdpv2.md b/docs/fsdpv2.md
@@ -1,10 +1,10 @@
-# Fully Sharded Data Parallel via SPMD
+# Fully Sharded Data Parallel(FSDP) via SPMD
 
 Fully Sharded Data Parallel via SPMD or FSDPv2 is an utility that re-expresses the famous FSDP algorithm in SPMD. [This](https://github.com/pytorch/xla/blob/master/torch_xla/experimental/spmd_fully_sharded_data_parallel.py) is
 an experimental feature that aiming to offer a familiar interface for users to enjoy all the benefits that SPMD brings into
 the table. The design doc is [here](https://github.com/pytorch/xla/issues/6379).
 
-Please review the [SPMD user guide](./spmd.md) before proceeding.
+Please review the [SPMD user guide](./spmd_basic.md) before proceeding. You can also find a minimum runnable example [here](https://github.com/pytorch/xla/blob/master/examples/fsdp/train_decoder_only_fsdp_v2.py).
 
 Example usage:
 ```python3