Skip to content

Commit b968d08

Browse files
committed
Generate Python docs from pytorch/pytorch@08bda18
1 parent cd6c4f7 commit b968d08

File tree

829 files changed

+1238
-1208
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

829 files changed

+1238
-1208
lines changed

docs/master/__config__.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@
188188

189189

190190
<div class="version">
191-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
191+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
192192
</div>
193193

194194

docs/master/_modules/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

@@ -804,11 +804,11 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
804804

805805
<span class="n">use_deterministic_algorithms</span><span class="p">(</span><span class="n">d</span><span class="p">)</span>
806806

807-
<span class="k">def</span> <span class="nf">are_deterministic_algorithms_enabled</span><span class="p">():</span>
807+
<div class="viewcode-block" id="are_deterministic_algorithms_enabled"><a class="viewcode-back" href="../generated/torch.are_deterministic_algorithms_enabled.html#torch.are_deterministic_algorithms_enabled">[docs]</a><span class="k">def</span> <span class="nf">are_deterministic_algorithms_enabled</span><span class="p">():</span>
808808
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Returns True if the global deterministic flag is turned on. Refer to</span>
809809
<span class="sd"> :func:`torch.use_deterministic_algorithms` documentation for more details.</span>
810810
<span class="sd"> &quot;&quot;&quot;</span>
811-
<span class="k">return</span> <span class="n">_C</span><span class="o">.</span><span class="n">_get_deterministic_algorithms</span><span class="p">()</span>
811+
<span class="k">return</span> <span class="n">_C</span><span class="o">.</span><span class="n">_get_deterministic_algorithms</span><span class="p">()</span></div>
812812

813813
<span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">():</span>
814814
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;This function is deprecated and will be removed in a future release.</span>
@@ -1034,9 +1034,9 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
10341034
<span class="k">del</span> <span class="n">_torch_docs</span><span class="p">,</span> <span class="n">_tensor_docs</span><span class="p">,</span> <span class="n">_storage_docs</span>
10351035

10361036

1037-
<div class="viewcode-block" id="compiled_with_cxx11_abi"><a class="viewcode-back" href="../generated/torch.compiled_with_cxx11_abi.html#torch.compiled_with_cxx11_abi">[docs]</a><span class="k">def</span> <span class="nf">compiled_with_cxx11_abi</span><span class="p">():</span>
1037+
<span class="k">def</span> <span class="nf">compiled_with_cxx11_abi</span><span class="p">():</span>
10381038
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Returns whether PyTorch was built with _GLIBCXX_USE_CXX11_ABI=1&quot;&quot;&quot;</span>
1039-
<span class="k">return</span> <span class="n">_C</span><span class="o">.</span><span class="n">_GLIBCXX_USE_CXX11_ABI</span></div>
1039+
<span class="k">return</span> <span class="n">_C</span><span class="o">.</span><span class="n">_GLIBCXX_USE_CXX11_ABI</span>
10401040

10411041

10421042
<span class="c1"># Import the ops &quot;namespace&quot;</span>

docs/master/_modules/torch/__config__.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/_jit_internal.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/_lobpcg.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/_lowrank.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

@@ -554,7 +554,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
554554
<span class="k">return</span> <span class="n">U</span><span class="p">,</span> <span class="n">S</span><span class="p">,</span> <span class="n">V</span>
555555

556556

557-
<div class="viewcode-block" id="pca_lowrank"><a class="viewcode-back" href="../../generated/torch.pca_lowrank.html#torch.pca_lowrank">[docs]</a><span class="k">def</span> <span class="nf">pca_lowrank</span><span class="p">(</span><span class="n">A</span><span class="p">:</span> <span class="n">Tensor</span><span class="p">,</span> <span class="n">q</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">center</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
557+
<span class="k">def</span> <span class="nf">pca_lowrank</span><span class="p">(</span><span class="n">A</span><span class="p">:</span> <span class="n">Tensor</span><span class="p">,</span> <span class="n">q</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">center</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
558558
<span class="n">niter</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">2</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">Tensor</span><span class="p">,</span> <span class="n">Tensor</span><span class="p">,</span> <span class="n">Tensor</span><span class="p">]:</span>
559559
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Performs linear Principal Component Analysis (PCA) on a low-rank</span>
560560
<span class="sd"> matrix, batches of such matrices, or sparse matrix.</span>
@@ -655,7 +655,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
655655
<span class="k">return</span> <span class="n">_svd_lowrank</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">niter</span><span class="o">=</span><span class="n">niter</span><span class="p">,</span> <span class="n">M</span><span class="o">=</span><span class="n">M</span><span class="p">)</span>
656656
<span class="k">else</span><span class="p">:</span>
657657
<span class="n">C</span> <span class="o">=</span> <span class="n">A</span><span class="o">.</span><span class="n">mean</span><span class="p">(</span><span class="n">dim</span><span class="o">=</span><span class="p">(</span><span class="o">-</span><span class="mi">2</span><span class="p">,),</span> <span class="n">keepdim</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
658-
<span class="k">return</span> <span class="n">_svd_lowrank</span><span class="p">(</span><span class="n">A</span> <span class="o">-</span> <span class="n">C</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">niter</span><span class="o">=</span><span class="n">niter</span><span class="p">,</span> <span class="n">M</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></div>
658+
<span class="k">return</span> <span class="n">_svd_lowrank</span><span class="p">(</span><span class="n">A</span> <span class="o">-</span> <span class="n">C</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">niter</span><span class="o">=</span><span class="n">niter</span><span class="p">,</span> <span class="n">M</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
659659
</pre></div>
660660

661661
</article>

docs/master/_modules/torch/_tensor_str.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/_utils.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/_vmap_internals.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/autograd.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/autograd/anomaly_mode.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/autograd/function.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/autograd/functional.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/autograd/grad_mode.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

@@ -464,7 +464,7 @@ <h1>Source code for torch.autograd.grad_mode</h1><div class="highlight"><pre>
464464
<span class="k">raise</span> <span class="ne">NotImplementedError</span>
465465

466466

467-
<div class="viewcode-block" id="no_grad"><a class="viewcode-back" href="../../../generated/torch.no_grad.html#torch.no_grad">[docs]</a><span class="k">class</span> <span class="nc">no_grad</span><span class="p">(</span><span class="n">_DecoratorContextManager</span><span class="p">):</span>
467+
<span class="k">class</span> <span class="nc">no_grad</span><span class="p">(</span><span class="n">_DecoratorContextManager</span><span class="p">):</span>
468468
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Context-manager that disabled gradient calculation.</span>
469469

470470
<span class="sd"> Disabling gradient calculation is useful for inference, when you are sure</span>
@@ -504,7 +504,7 @@ <h1>Source code for torch.autograd.grad_mode</h1><div class="highlight"><pre>
504504
<span class="n">torch</span><span class="o">.</span><span class="n">set_grad_enabled</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
505505

506506
<span class="k">def</span> <span class="fm">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc_type</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="n">exc_value</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="n">traceback</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
507-
<span class="n">torch</span><span class="o">.</span><span class="n">set_grad_enabled</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">prev</span><span class="p">)</span></div>
507+
<span class="n">torch</span><span class="o">.</span><span class="n">set_grad_enabled</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">prev</span><span class="p">)</span>
508508

509509

510510
<div class="viewcode-block" id="enable_grad"><a class="viewcode-back" href="../../../generated/torch.enable_grad.html#torch.enable_grad">[docs]</a><span class="k">class</span> <span class="nc">enable_grad</span><span class="p">(</span><span class="n">_DecoratorContextManager</span><span class="p">):</span>

docs/master/_modules/torch/autograd/gradcheck.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/autograd/profiler.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/backends/cuda.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/backends/cudnn.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/backends/mkl.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/backends/mkldnn.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/backends/openmp.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/cuda.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/cuda/amp/autocast_mode.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/cuda/amp/grad_scaler.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/cuda/memory.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/cuda/nvtx.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/cuda/random.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/cuda/streams.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/distributed.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/distributed/algorithms/ddp_comm_hooks/default_hooks.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/distributed/algorithms/ddp_comm_hooks/powerSGD_hook.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/distributed/autograd.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+08bda18 &#x25BC</a>
191191
</div>
192192

193193

0 commit comments

Comments
 (0)