Update doc from commit a6ab3fe

pytorch · Jul 16, 2024 · 56220b2 · 56220b2
1 parent cc84561
commit 56220b2
Show file tree

Hide file tree

Showing 22 changed files with 78 additions and 77 deletions.
diff --git a/master/_modules/index.html b/master/_modules/index.html
@@ -265,7 +265,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+gite523fdf )
+                  master (2.5.0+gita6ab3fe )
                 </div>
 
 
@@ -300,10 +300,10 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../debug.html">Troubleshooting</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../gpu.html">How to run with PyTorch/XLA:GPU</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../multi_process_distributed.html">How to do <code class="docutils literal notranslate"><span class="pre">DistributedDataParallel</span></code></a></li>
+<li class="toctree-l1"><a class="reference internal" href="../multi_process_distributed.html">How to do DistributedDataParallel(DDP)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../runtime.html">PJRT Runtime</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../spmd.html">PyTorch/XLA SPMD User Guide</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../spmd.html#fully-sharded-data-parallel-via-spmd">Fully Sharded Data Parallel via SPMD</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../spmd.html#fully-sharded-data-parallel-fsdp-via-spmd">Fully Sharded Data Parallel(FSDP) via SPMD</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../spmd.html#pytorch-xla-spmd-advanced-topics">PyTorch/XLA SPMD advanced topics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../spmd.html#distributed-checkpointing">Distributed Checkpointing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../torch_compile.html">TorchDynamo(torch.compile) integration in PyTorch XLA</a></li>

diff --git a/master/_modules/torch_xla/core/xla_model.html b/master/_modules/torch_xla/core/xla_model.html
@@ -265,7 +265,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+gite523fdf )
+                  master (2.5.0+gita6ab3fe )
                 </div>
 
 
@@ -300,10 +300,10 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../debug.html">Troubleshooting</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../gpu.html">How to run with PyTorch/XLA:GPU</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../multi_process_distributed.html">How to do <code class="docutils literal notranslate"><span class="pre">DistributedDataParallel</span></code></a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../multi_process_distributed.html">How to do DistributedDataParallel(DDP)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../runtime.html">PJRT Runtime</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../spmd.html">PyTorch/XLA SPMD User Guide</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../spmd.html#fully-sharded-data-parallel-via-spmd">Fully Sharded Data Parallel via SPMD</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../spmd.html#fully-sharded-data-parallel-fsdp-via-spmd">Fully Sharded Data Parallel(FSDP) via SPMD</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../spmd.html#pytorch-xla-spmd-advanced-topics">PyTorch/XLA SPMD advanced topics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../spmd.html#distributed-checkpointing">Distributed Checkpointing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../torch_compile.html">TorchDynamo(torch.compile) integration in PyTorch XLA</a></li>

diff --git a/master/_modules/torch_xla/debug/metrics.html b/master/_modules/torch_xla/debug/metrics.html
@@ -265,7 +265,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+gite523fdf )
+                  master (2.5.0+gita6ab3fe )
                 </div>
 
 
@@ -300,10 +300,10 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../debug.html">Troubleshooting</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../gpu.html">How to run with PyTorch/XLA:GPU</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../multi_process_distributed.html">How to do <code class="docutils literal notranslate"><span class="pre">DistributedDataParallel</span></code></a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../multi_process_distributed.html">How to do DistributedDataParallel(DDP)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../runtime.html">PJRT Runtime</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../spmd.html">PyTorch/XLA SPMD User Guide</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../spmd.html#fully-sharded-data-parallel-via-spmd">Fully Sharded Data Parallel via SPMD</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../spmd.html#fully-sharded-data-parallel-fsdp-via-spmd">Fully Sharded Data Parallel(FSDP) via SPMD</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../spmd.html#pytorch-xla-spmd-advanced-topics">PyTorch/XLA SPMD advanced topics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../spmd.html#distributed-checkpointing">Distributed Checkpointing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../torch_compile.html">TorchDynamo(torch.compile) integration in PyTorch XLA</a></li>

diff --git a/master/_modules/torch_xla/distributed/parallel_loader.html b/master/_modules/torch_xla/distributed/parallel_loader.html
@@ -265,7 +265,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+gite523fdf )
+                  master (2.5.0+gita6ab3fe )
                 </div>
 
 
@@ -300,10 +300,10 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../debug.html">Troubleshooting</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../gpu.html">How to run with PyTorch/XLA:GPU</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../multi_process_distributed.html">How to do <code class="docutils literal notranslate"><span class="pre">DistributedDataParallel</span></code></a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../multi_process_distributed.html">How to do DistributedDataParallel(DDP)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../runtime.html">PJRT Runtime</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../spmd.html">PyTorch/XLA SPMD User Guide</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../spmd.html#fully-sharded-data-parallel-via-spmd">Fully Sharded Data Parallel via SPMD</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../spmd.html#fully-sharded-data-parallel-fsdp-via-spmd">Fully Sharded Data Parallel(FSDP) via SPMD</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../spmd.html#pytorch-xla-spmd-advanced-topics">PyTorch/XLA SPMD advanced topics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../spmd.html#distributed-checkpointing">Distributed Checkpointing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../torch_compile.html">TorchDynamo(torch.compile) integration in PyTorch XLA</a></li>

diff --git a/master/_modules/torch_xla/distributed/spmd/xla_sharding.html b/master/_modules/torch_xla/distributed/spmd/xla_sharding.html
@@ -265,7 +265,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+gite523fdf )
+                  master (2.5.0+gita6ab3fe )
                 </div>
 
 
@@ -300,10 +300,10 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../../debug.html">Troubleshooting</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../gpu.html">How to run with PyTorch/XLA:GPU</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../../multi_process_distributed.html">How to do <code class="docutils literal notranslate"><span class="pre">DistributedDataParallel</span></code></a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../multi_process_distributed.html">How to do DistributedDataParallel(DDP)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../runtime.html">PJRT Runtime</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../spmd.html">PyTorch/XLA SPMD User Guide</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../../spmd.html#fully-sharded-data-parallel-via-spmd">Fully Sharded Data Parallel via SPMD</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../spmd.html#fully-sharded-data-parallel-fsdp-via-spmd">Fully Sharded Data Parallel(FSDP) via SPMD</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../spmd.html#pytorch-xla-spmd-advanced-topics">PyTorch/XLA SPMD advanced topics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../spmd.html#distributed-checkpointing">Distributed Checkpointing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../torch_compile.html">TorchDynamo(torch.compile) integration in PyTorch XLA</a></li>

diff --git a/master/_modules/torch_xla/distributed/xla_multiprocessing.html b/master/_modules/torch_xla/distributed/xla_multiprocessing.html
@@ -265,7 +265,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+gite523fdf )
+                  master (2.5.0+gita6ab3fe )
                 </div>
 
 
@@ -300,10 +300,10 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../debug.html">Troubleshooting</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../gpu.html">How to run with PyTorch/XLA:GPU</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../multi_process_distributed.html">How to do <code class="docutils literal notranslate"><span class="pre">DistributedDataParallel</span></code></a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../multi_process_distributed.html">How to do DistributedDataParallel(DDP)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../runtime.html">PJRT Runtime</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../spmd.html">PyTorch/XLA SPMD User Guide</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../spmd.html#fully-sharded-data-parallel-via-spmd">Fully Sharded Data Parallel via SPMD</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../spmd.html#fully-sharded-data-parallel-fsdp-via-spmd">Fully Sharded Data Parallel(FSDP) via SPMD</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../spmd.html#pytorch-xla-spmd-advanced-topics">PyTorch/XLA SPMD advanced topics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../spmd.html#distributed-checkpointing">Distributed Checkpointing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../torch_compile.html">TorchDynamo(torch.compile) integration in PyTorch XLA</a></li>

diff --git a/master/_modules/torch_xla/experimental/eager.html b/master/_modules/torch_xla/experimental/eager.html
@@ -265,7 +265,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+gite523fdf )
+                  master (2.5.0+gita6ab3fe )
                 </div>
 
 
@@ -300,10 +300,10 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../debug.html">Troubleshooting</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../gpu.html">How to run with PyTorch/XLA:GPU</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../multi_process_distributed.html">How to do <code class="docutils literal notranslate"><span class="pre">DistributedDataParallel</span></code></a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../multi_process_distributed.html">How to do DistributedDataParallel(DDP)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../runtime.html">PJRT Runtime</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../spmd.html">PyTorch/XLA SPMD User Guide</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../spmd.html#fully-sharded-data-parallel-via-spmd">Fully Sharded Data Parallel via SPMD</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../spmd.html#fully-sharded-data-parallel-fsdp-via-spmd">Fully Sharded Data Parallel(FSDP) via SPMD</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../spmd.html#pytorch-xla-spmd-advanced-topics">PyTorch/XLA SPMD advanced topics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../spmd.html#distributed-checkpointing">Distributed Checkpointing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../torch_compile.html">TorchDynamo(torch.compile) integration in PyTorch XLA</a></li>

diff --git a/master/_modules/torch_xla/runtime.html b/master/_modules/torch_xla/runtime.html
@@ -265,7 +265,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+gite523fdf )
+                  master (2.5.0+gita6ab3fe )
                 </div>
 
 
@@ -300,10 +300,10 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../debug.html">Troubleshooting</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../gpu.html">How to run with PyTorch/XLA:GPU</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../multi_process_distributed.html">How to do <code class="docutils literal notranslate"><span class="pre">DistributedDataParallel</span></code></a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../multi_process_distributed.html">How to do DistributedDataParallel(DDP)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../runtime.html">PJRT Runtime</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../spmd.html">PyTorch/XLA SPMD User Guide</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../spmd.html#fully-sharded-data-parallel-via-spmd">Fully Sharded Data Parallel via SPMD</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../spmd.html#fully-sharded-data-parallel-fsdp-via-spmd">Fully Sharded Data Parallel(FSDP) via SPMD</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../spmd.html#pytorch-xla-spmd-advanced-topics">PyTorch/XLA SPMD advanced topics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../spmd.html#distributed-checkpointing">Distributed Checkpointing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../torch_compile.html">TorchDynamo(torch.compile) integration in PyTorch XLA</a></li>

diff --git a/master/_modules/torch_xla/torch_xla.html b/master/_modules/torch_xla/torch_xla.html
@@ -265,7 +265,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+gite523fdf )
+                  master (2.5.0+gita6ab3fe )
                 </div>
 
 
@@ -300,10 +300,10 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../debug.html">Troubleshooting</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../gpu.html">How to run with PyTorch/XLA:GPU</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../multi_process_distributed.html">How to do <code class="docutils literal notranslate"><span class="pre">DistributedDataParallel</span></code></a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../multi_process_distributed.html">How to do DistributedDataParallel(DDP)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../runtime.html">PJRT Runtime</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../spmd.html">PyTorch/XLA SPMD User Guide</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../spmd.html#fully-sharded-data-parallel-via-spmd">Fully Sharded Data Parallel via SPMD</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../spmd.html#fully-sharded-data-parallel-fsdp-via-spmd">Fully Sharded Data Parallel(FSDP) via SPMD</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../spmd.html#pytorch-xla-spmd-advanced-topics">PyTorch/XLA SPMD advanced topics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../spmd.html#distributed-checkpointing">Distributed Checkpointing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../torch_compile.html">TorchDynamo(torch.compile) integration in PyTorch XLA</a></li>

diff --git a/master/debug.html b/master/debug.html
@@ -267,7 +267,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+gite523fdf )
+                  master (2.5.0+gita6ab3fe )
                 </div>
 
 
@@ -302,10 +302,10 @@
 <ul class="current">
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Troubleshooting</a></li>
 <li class="toctree-l1"><a class="reference internal" href="gpu.html">How to run with PyTorch/XLA:GPU</a></li>
-<li class="toctree-l1"><a class="reference internal" href="multi_process_distributed.html">How to do <code class="docutils literal notranslate"><span class="pre">DistributedDataParallel</span></code></a></li>
+<li class="toctree-l1"><a class="reference internal" href="multi_process_distributed.html">How to do DistributedDataParallel(DDP)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="runtime.html">PJRT Runtime</a></li>
 <li class="toctree-l1"><a class="reference internal" href="spmd.html">PyTorch/XLA SPMD User Guide</a></li>
-<li class="toctree-l1"><a class="reference internal" href="spmd.html#fully-sharded-data-parallel-via-spmd">Fully Sharded Data Parallel via SPMD</a></li>
+<li class="toctree-l1"><a class="reference internal" href="spmd.html#fully-sharded-data-parallel-fsdp-via-spmd">Fully Sharded Data Parallel(FSDP) via SPMD</a></li>
 <li class="toctree-l1"><a class="reference internal" href="spmd.html#pytorch-xla-spmd-advanced-topics">PyTorch/XLA SPMD advanced topics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="spmd.html#distributed-checkpointing">Distributed Checkpointing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="torch_compile.html">TorchDynamo(torch.compile) integration in PyTorch XLA</a></li>

diff --git a/master/genindex.html b/master/genindex.html
@@ -265,7 +265,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+gite523fdf )
+                  master (2.5.0+gita6ab3fe )
                 </div>
 
 
@@ -300,10 +300,10 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="debug.html">Troubleshooting</a></li>
 <li class="toctree-l1"><a class="reference internal" href="gpu.html">How to run with PyTorch/XLA:GPU</a></li>
-<li class="toctree-l1"><a class="reference internal" href="multi_process_distributed.html">How to do <code class="docutils literal notranslate"><span class="pre">DistributedDataParallel</span></code></a></li>
+<li class="toctree-l1"><a class="reference internal" href="multi_process_distributed.html">How to do DistributedDataParallel(DDP)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="runtime.html">PJRT Runtime</a></li>
 <li class="toctree-l1"><a class="reference internal" href="spmd.html">PyTorch/XLA SPMD User Guide</a></li>
-<li class="toctree-l1"><a class="reference internal" href="spmd.html#fully-sharded-data-parallel-via-spmd">Fully Sharded Data Parallel via SPMD</a></li>
+<li class="toctree-l1"><a class="reference internal" href="spmd.html#fully-sharded-data-parallel-fsdp-via-spmd">Fully Sharded Data Parallel(FSDP) via SPMD</a></li>
 <li class="toctree-l1"><a class="reference internal" href="spmd.html#pytorch-xla-spmd-advanced-topics">PyTorch/XLA SPMD advanced topics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="spmd.html#distributed-checkpointing">Distributed Checkpointing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="torch_compile.html">TorchDynamo(torch.compile) integration in PyTorch XLA</a></li>