Skip to content

Commit 246f4a0

Browse files
committed
Generate Python docs from pytorch/pytorch@acd0a1d
1 parent 3d39411 commit 246f4a0

File tree

831 files changed

+1228
-1221
lines changed

Some content is hidden

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

831 files changed

+1228
-1221
lines changed

docs/master/__config__.html

Lines changed: 1 addition & 1 deletion
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+5c9184d &#x25BC</a>
191+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
192192
</div>
193193

194194

docs/master/_modules/index.html

Lines changed: 1 addition & 1 deletion
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+5c9184d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch.html

Lines changed: 1 addition & 1 deletion
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+5c9184d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/__config__.html

Lines changed: 1 addition & 1 deletion
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+5c9184d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/_jit_internal.html

Lines changed: 1 addition & 1 deletion
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+5c9184d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/_lobpcg.html

Lines changed: 1 addition & 1 deletion
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+5c9184d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/_lowrank.html

Lines changed: 3 additions & 3 deletions
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+5c9184d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#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-
<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+
<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>
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>
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>
659659
</pre></div>
660660

661661
</article>

docs/master/_modules/torch/_tensor_str.html

Lines changed: 1 addition & 1 deletion
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+5c9184d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/_utils.html

Lines changed: 1 addition & 1 deletion
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+5c9184d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/_vmap_internals.html

Lines changed: 1 addition & 1 deletion
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+5c9184d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/autograd.html

Lines changed: 1 addition & 1 deletion
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+5c9184d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
191191
</div>
192192

193193

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

Lines changed: 1 addition & 1 deletion
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+5c9184d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
191191
</div>
192192

193193

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

Lines changed: 1 addition & 1 deletion
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+5c9184d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
191191
</div>
192192

193193

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

Lines changed: 1 addition & 1 deletion
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+5c9184d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
191191
</div>
192192

193193

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

Lines changed: 5 additions & 5 deletions
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+5c9184d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#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-
<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+
<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>
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>
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>
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>
@@ -546,7 +546,7 @@ <h1>Source code for torch.autograd.grad_mode</h1><div class="highlight"><pre>
546546
<span class="n">torch</span><span class="o">.</span><span class="n">_C</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>
547547

548548

549-
<div class="viewcode-block" id="set_grad_enabled"><a class="viewcode-back" href="../../../generated/torch.set_grad_enabled.html#torch.set_grad_enabled">[docs]</a><span class="k">class</span> <span class="nc">set_grad_enabled</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
549+
<span class="k">class</span> <span class="nc">set_grad_enabled</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
550550
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Context-manager that sets gradient calculation to on or off.</span>
551551

552552
<span class="sd"> ``set_grad_enabled`` will enable or disable grads based on its argument :attr:`mode`.</span>
@@ -588,7 +588,7 @@ <h1>Source code for torch.autograd.grad_mode</h1><div class="highlight"><pre>
588588
<span class="k">pass</span>
589589

590590
<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>
591-
<span class="n">torch</span><span class="o">.</span><span class="n">_C</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>
591+
<span class="n">torch</span><span class="o">.</span><span class="n">_C</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>
592592
</pre></div>
593593

594594
</article>

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

Lines changed: 1 addition & 1 deletion
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+5c9184d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
191191
</div>
192192

193193

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

Lines changed: 1 addition & 1 deletion
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+5c9184d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
191191
</div>
192192

193193

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

Lines changed: 1 addition & 1 deletion
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+5c9184d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
191191
</div>
192192

193193

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

Lines changed: 1 addition & 1 deletion
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+5c9184d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
191191
</div>
192192

193193

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

Lines changed: 1 addition & 1 deletion
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+5c9184d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
191191
</div>
192192

193193

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

Lines changed: 1 addition & 1 deletion
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+5c9184d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
191191
</div>
192192

193193

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

Lines changed: 1 addition & 1 deletion
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+5c9184d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/cuda.html

Lines changed: 1 addition & 1 deletion
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+5c9184d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
191191
</div>
192192

193193

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

Lines changed: 3 additions & 2 deletions
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+5c9184d &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.9.0a0+acd0a1d &#x25BC</a>
191191
</div>
192192

193193

@@ -390,6 +390,7 @@ <h1>Source code for torch.cuda.amp.autocast_mode</h1><div class="highlight"><pre
390390
<span class="k">except</span> <span class="ne">ModuleNotFoundError</span><span class="p">:</span>
391391
<span class="n">np</span> <span class="o">=</span> <span class="kc">None</span>
392392
<span class="kn">from</span> <span class="nn">torch._six</span> <span class="kn">import</span> <span class="n">string_classes</span>
393+
<span class="kn">from</span> <span class="nn">.common</span> <span class="kn">import</span> <span class="n">amp_definitely_not_available</span>
393394

394395

395396
<div class="viewcode-block" id="autocast"><a class="viewcode-back" href="../../../../amp.html#torch.cuda.amp.autocast">[docs]</a><span class="k">class</span> <span class="nc">autocast</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
@@ -497,7 +498,7 @@ <h1>Source code for torch.cuda.amp.autocast_mode</h1><div class="highlight"><pre
497498
<span class="sd"> enabled(bool, optional, default=True): Whether autocasting should be enabled in the region.</span>
498499
<span class="sd"> &quot;&quot;&quot;</span>
499500
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">enabled</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
500-
<span class="k">if</span> <span class="n">enabled</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">torch</span><span class="o">.</span><span class="n">cuda</span><span class="o">.</span><span class="n">is_available</span><span class="p">():</span>
501+
<span class="k">if</span> <span class="n">enabled</span> <span class="ow">and</span> <span class="n">amp_definitely_not_available</span><span class="p">():</span>
501502
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s2">&quot;torch.cuda.amp.autocast only affects CUDA ops, but CUDA is not available. Disabling.&quot;</span><span class="p">)</span>
502503
<span class="bp">self</span><span class="o">.</span><span class="n">_enabled</span> <span class="o">=</span> <span class="kc">False</span>
503504
<span class="k">else</span><span class="p">:</span>

0 commit comments

Comments
 (0)