Generate Python docs from pytorch/pytorch@8072ebc

pytorch · Sep 15, 2024 · f83eeff · f83eeff
1 parent 3f2c6bd
commit f83eeff
Show file tree

Hide file tree

Showing 41 changed files with 60 additions and 40 deletions.
diff --git a/nightly/_modules/index.html b/nightly/_modules/index.html
@@ -265,7 +265,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/_modules/torch/_functorch/aot_autograd.html b/nightly/_modules/torch/_functorch/aot_autograd.html
@@ -265,7 +265,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/_modules/torch/_functorch/compilers.html b/nightly/_modules/torch/_functorch/compilers.html
@@ -265,7 +265,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/_modules/torch/_functorch/deprecated.html b/nightly/_modules/torch/_functorch/deprecated.html
@@ -265,7 +265,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/_modules/torch/_functorch/partitioners.html b/nightly/_modules/torch/_functorch/partitioners.html
@@ -265,7 +265,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 
@@ -1170,6 +1170,26 @@ <h1>Source code for torch._functorch.partitioners</h1><div class="highlight"><pr
                     <span class="ow">and</span> <span class="n">user</span><span class="o">.</span><span class="n">meta</span><span class="p">[</span><span class="s2">&quot;ac_graph_id&quot;</span><span class="p">]</span> <span class="o">&gt;</span> <span class="n">node</span><span class="o">.</span><span class="n">meta</span><span class="p">[</span><span class="s2">&quot;ac_graph_id&quot;</span><span class="p">]</span>
                 <span class="p">):</span>
                     <span class="n">node</span><span class="o">.</span><span class="n">meta</span><span class="p">[</span><span class="s2">&quot;recompute&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">CheckpointPolicy</span><span class="o">.</span><span class="n">MUST_SAVE</span>
+            <span class="k">if</span> <span class="n">node</span><span class="o">.</span><span class="n">meta</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;has_backward_hook&quot;</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">any</span><span class="p">(</span>
+                <span class="n">must_recompute</span><span class="p">(</span><span class="n">user</span><span class="p">)</span> <span class="k">for</span> <span class="n">user</span> <span class="ow">in</span> <span class="n">node</span><span class="o">.</span><span class="n">users</span>
+            <span class="p">):</span>
+                <span class="c1"># If node is AC region output and has a backward hook on it, we intentionally choose to save it.</span>
+                <span class="c1"># This is to work around circular dependencies in Traceable FSDP2+AC.</span>
+                <span class="c1"># Example:</span>
+                <span class="c1"># ```</span>
+                <span class="c1"># out = fully_shard(utils.checkpoint(module))(x)</span>
+                <span class="c1"># norm_out = layer_norm(out)</span>
+                <span class="c1"># ```</span>
+                <span class="c1"># Here there is a circular dependency:</span>
+                <span class="c1"># 1. In backward, grad_input of layer_norm aka. `out_grad` is actually dependent on `out`.</span>
+                <span class="c1"># 2. `out` depends on `out`&#39;s backward hook created by FSDP2 (which does all-gather for `module` weights)</span>
+                <span class="c1">#    in order to be recomputed.</span>
+                <span class="c1"># 3. `out`&#39;s backward hook, as is the case for all eager backward hooks, depends on `out_grad`</span>
+                <span class="c1">#    -&gt; circular dependency with (1)!</span>
+                <span class="c1">#</span>
+                <span class="c1"># Solution: check whether `out` has a backward hook, and if so, intentionally save `out`</span>
+                <span class="c1"># in forward graph outputs. With this, we can break the above circular dependency.</span>
+                <span class="n">node</span><span class="o">.</span><span class="n">meta</span><span class="p">[</span><span class="s2">&quot;recompute&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">CheckpointPolicy</span><span class="o">.</span><span class="n">MUST_SAVE</span>
     <span class="k">return</span> <span class="n">joint_module</span>
 
 

diff --git a/nightly/aot_autograd.html b/nightly/aot_autograd.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/batch_norm.html b/nightly/batch_norm.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/experimental.html b/nightly/experimental.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/functorch.html b/nightly/functorch.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/generated/functorch.combine_state_for_ensemble.html b/nightly/generated/functorch.combine_state_for_ensemble.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/generated/functorch.compile.aot_function.html b/nightly/generated/functorch.compile.aot_function.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/generated/functorch.compile.aot_module.html b/nightly/generated/functorch.compile.aot_module.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/generated/functorch.compile.default_partition.html b/nightly/generated/functorch.compile.default_partition.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/generated/functorch.compile.memory_efficient_fusion.html b/nightly/generated/functorch.compile.memory_efficient_fusion.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/generated/functorch.compile.min_cut_rematerialization_partition.html b/nightly/generated/functorch.compile.min_cut_rematerialization_partition.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/generated/functorch.compile.nop.html b/nightly/generated/functorch.compile.nop.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/generated/functorch.compile.ts_compile.html b/nightly/generated/functorch.compile.ts_compile.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/generated/functorch.functionalize.html b/nightly/generated/functorch.functionalize.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/generated/functorch.grad.html b/nightly/generated/functorch.grad.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/generated/functorch.grad_and_value.html b/nightly/generated/functorch.grad_and_value.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/generated/functorch.hessian.html b/nightly/generated/functorch.hessian.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/generated/functorch.jacfwd.html b/nightly/generated/functorch.jacfwd.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/generated/functorch.jacrev.html b/nightly/generated/functorch.jacrev.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/generated/functorch.jvp.html b/nightly/generated/functorch.jvp.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/generated/functorch.make_functional.html b/nightly/generated/functorch.make_functional.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/generated/functorch.make_functional_with_buffers.html b/nightly/generated/functorch.make_functional_with_buffers.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/generated/functorch.vjp.html b/nightly/generated/functorch.vjp.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/generated/functorch.vmap.html b/nightly/generated/functorch.vmap.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/genindex.html b/nightly/genindex.html
@@ -265,7 +265,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/index.html b/nightly/index.html
@@ -266,7 +266,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/install.html b/nightly/install.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/notebooks/aot_autograd_optimizations.html b/nightly/notebooks/aot_autograd_optimizations.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/notebooks/ensembling.html b/nightly/notebooks/ensembling.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/notebooks/jacobians_hessians.html b/nightly/notebooks/jacobians_hessians.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/notebooks/minifier.html b/nightly/notebooks/minifier.html
@@ -266,7 +266,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/notebooks/neural_tangent_kernels.html b/nightly/notebooks/neural_tangent_kernels.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/notebooks/per_sample_grads.html b/nightly/notebooks/per_sample_grads.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/notebooks/whirlwind_tour.html b/nightly/notebooks/whirlwind_tour.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/objects.inv b/nightly/objects.inv
diff --git a/nightly/search.html b/nightly/search.html
@@ -265,7 +265,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>
 
 

diff --git a/nightly/ux_limitations.html b/nightly/ux_limitations.html
@@ -267,7 +267,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+gita00faf4) &#x25BC</a>
+      <a href='https://pytorch.org/functorch/versions.html'>nightly (2.6.0a0+git8072ebc) &#x25BC</a>
     </div>