Skip to content

Commit 83af444

Browse files
committed
auto-generating sphinx docs
1 parent 084ca1e commit 83af444

File tree

727 files changed

+2490
-1022
lines changed

Some content is hidden

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

727 files changed

+2490
-1022
lines changed

docs/master/__config__.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@
159159

160160

161161
<div class="version">
162-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+3431a89 &#x25BC</a>
162+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+8a83851 &#x25BC</a>
163163
</div>
164164

165165

docs/master/_modules/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+3431a89 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+8a83851 &#x25BC</a>
162162
</div>
163163

164164

docs/master/_modules/torch.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+3431a89 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+8a83851 &#x25BC</a>
162162
</div>
163163

164164

@@ -564,7 +564,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
564564
<span class="k">return</span> <span class="n">module</span> <span class="o">+</span> <span class="n">class_name</span>
565565

566566

567-
<span class="k">def</span> <span class="nf">is_tensor</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
567+
<div class="viewcode-block" id="is_tensor"><a class="viewcode-back" href="../generated/torch.is_tensor.html#torch.is_tensor">[docs]</a><span class="k">def</span> <span class="nf">is_tensor</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
568568
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Returns True if `obj` is a PyTorch tensor.</span>
569569

570570
<span class="sd"> Note that this function is simply doing ``isinstance(obj, Tensor)``.</span>
@@ -575,16 +575,16 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
575575
<span class="sd"> Args:</span>
576576
<span class="sd"> obj (Object): Object to test</span>
577577
<span class="sd"> &quot;&quot;&quot;</span>
578-
<span class="k">return</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">)</span>
578+
<span class="k">return</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">)</span></div>
579579

580580

581-
<span class="k">def</span> <span class="nf">is_storage</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
581+
<div class="viewcode-block" id="is_storage"><a class="viewcode-back" href="../generated/torch.is_storage.html#torch.is_storage">[docs]</a><span class="k">def</span> <span class="nf">is_storage</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
582582
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Returns True if `obj` is a PyTorch storage object.</span>
583583

584584
<span class="sd"> Args:</span>
585585
<span class="sd"> obj (Object): Object to test</span>
586586
<span class="sd"> &quot;&quot;&quot;</span>
587-
<span class="k">return</span> <span class="nb">type</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span> <span class="ow">in</span> <span class="n">_storage_classes</span>
587+
<span class="k">return</span> <span class="nb">type</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span> <span class="ow">in</span> <span class="n">_storage_classes</span></div>
588588

589589

590590
<span class="k">def</span> <span class="nf">set_default_tensor_type</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
@@ -674,8 +674,8 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
674674
<span class="k">pass</span>
675675

676676

677-
<div class="viewcode-block" id="FloatStorage"><a class="viewcode-back" href="../storage.html#torch.FloatStorage">[docs]</a><span class="k">class</span> <span class="nc">FloatStorage</span><span class="p">(</span><span class="n">_C</span><span class="o">.</span><span class="n">FloatStorageBase</span><span class="p">,</span> <span class="n">_StorageBase</span><span class="p">):</span>
678-
<span class="k">pass</span></div>
677+
<span class="k">class</span> <span class="nc">FloatStorage</span><span class="p">(</span><span class="n">_C</span><span class="o">.</span><span class="n">FloatStorageBase</span><span class="p">,</span> <span class="n">_StorageBase</span><span class="p">):</span>
678+
<span class="k">pass</span>
679679

680680

681681
<span class="k">class</span> <span class="nc">HalfStorage</span><span class="p">(</span><span class="n">_C</span><span class="o">.</span><span class="n">HalfStorageBase</span><span class="p">,</span> <span class="n">_StorageBase</span><span class="p">):</span>

docs/master/_modules/torch/__config__.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+3431a89 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+8a83851 &#x25BC</a>
162162
</div>
163163

164164

docs/master/_modules/torch/_jit_internal.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+3431a89 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+8a83851 &#x25BC</a>
162162
</div>
163163

164164

docs/master/_modules/torch/_lobpcg.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+3431a89 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+8a83851 &#x25BC</a>
162162
</div>
163163

164164

docs/master/_modules/torch/_lowrank.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+3431a89 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+8a83851 &#x25BC</a>
162162
</div>
163163

164164

@@ -426,7 +426,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
426426
<span class="k">return</span> <span class="n">Q</span>
427427

428428

429-
<span class="k">def</span> <span class="nf">svd_lowrank</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">q</span><span class="o">=</span><span class="mi">6</span><span class="p">,</span> <span class="n">niter</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">M</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
429+
<div class="viewcode-block" id="svd_lowrank"><a class="viewcode-back" href="../../generated/torch.svd_lowrank.html#torch.svd_lowrank">[docs]</a><span class="k">def</span> <span class="nf">svd_lowrank</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">q</span><span class="o">=</span><span class="mi">6</span><span class="p">,</span> <span class="n">niter</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">M</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
430430
<span class="c1"># type: (Tensor, Optional[int], Optional[int], Optional[Tensor]) -&gt; Tuple[Tensor, Tensor, Tensor]</span>
431431
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Return the singular value decomposition ``(U, S, V)`` of a matrix,</span>
432432
<span class="sd"> batches of matrices, or a sparse matrix :math:`A` such that</span>
@@ -471,7 +471,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
471471
<span class="n">tensor_ops</span> <span class="o">=</span> <span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">M</span><span class="p">)</span>
472472
<span class="k">if</span> <span class="p">(</span><span class="ow">not</span> <span class="nb">set</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">type</span><span class="p">,</span> <span class="n">tensor_ops</span><span class="p">))</span><span class="o">.</span><span class="n">issubset</span><span class="p">((</span><span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="kc">None</span><span class="p">)))</span> <span class="ow">and</span> <span class="n">has_torch_function</span><span class="p">(</span><span class="n">tensor_ops</span><span class="p">)):</span>
473473
<span class="k">return</span> <span class="n">handle_torch_function</span><span class="p">(</span><span class="n">svd_lowrank</span><span class="p">,</span> <span class="n">tensor_ops</span><span class="p">,</span> <span class="n">A</span><span class="p">,</span> <span class="n">q</span><span class="o">=</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>
474-
<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="o">=</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>
474+
<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="o">=</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></div>
475475

476476

477477
<span class="k">def</span> <span class="nf">_svd_lowrank</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">q</span><span class="o">=</span><span class="mi">6</span><span class="p">,</span> <span class="n">niter</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">M</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>

docs/master/_modules/torch/_tensor_str.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+3431a89 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+8a83851 &#x25BC</a>
162162
</div>
163163

164164

docs/master/_modules/torch/_utils.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+3431a89 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+8a83851 &#x25BC</a>
162162
</div>
163163

164164

docs/master/_modules/torch/autograd.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+3431a89 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+8a83851 &#x25BC</a>
162162
</div>
163163

164164

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+3431a89 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+8a83851 &#x25BC</a>
162162
</div>
163163

164164

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+3431a89 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+8a83851 &#x25BC</a>
162162
</div>
163163

164164

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+3431a89 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+8a83851 &#x25BC</a>
162162
</div>
163163

164164

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+3431a89 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+8a83851 &#x25BC</a>
162162
</div>
163163

164164

@@ -377,7 +377,7 @@ <h1>Source code for torch.autograd.grad_mode</h1><div class="highlight"><pre>
377377
<span class="k">return</span> <span class="n">generator_context</span>
378378

379379

380-
<span class="k">class</span> <span class="nc">no_grad</span><span class="p">(</span><span class="n">_DecoratorContextManager</span><span class="p">):</span>
380+
<div class="viewcode-block" id="no_grad"><a class="viewcode-back" href="../../../autograd.html#torch.autograd.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>
381381
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Context-manager that disabled gradient calculation.</span>
382382

383383
<span class="sd"> Disabling gradient calculation is useful for inference, when you are sure</span>
@@ -417,10 +417,10 @@ <h1>Source code for torch.autograd.grad_mode</h1><div class="highlight"><pre>
417417
<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>
418418

419419
<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>
420-
<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>
420+
<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>
421421

422422

423-
<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>
423+
<div class="viewcode-block" id="enable_grad"><a class="viewcode-back" href="../../../autograd.html#torch.autograd.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>
424424
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Context-manager that enables gradient calculation.</span>
425425

426426
<span class="sd"> Enables gradient calculation, if it has been disabled via :class:`~no_grad`</span>
@@ -459,7 +459,7 @@ <h1>Source code for torch.autograd.grad_mode</h1><div class="highlight"><pre>
459459
<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>
460460

461461

462-
<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>
462+
<div class="viewcode-block" id="set_grad_enabled"><a class="viewcode-back" href="../../../autograd.html#torch.autograd.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>
463463
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Context-manager that sets gradient calculation to on or off.</span>
464464

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

503503
<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="o">*</span><span class="n">args</span><span class="p">):</span>
504-
<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>
504+
<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>
505505
</pre></div>
506506

507507
</article>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+3431a89 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+8a83851 &#x25BC</a>
162162
</div>
163163

164164

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+3431a89 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+8a83851 &#x25BC</a>
162162
</div>
163163

164164

docs/master/_modules/torch/cuda.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+3431a89 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+8a83851 &#x25BC</a>
162162
</div>
163163

164164

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+3431a89 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+8a83851 &#x25BC</a>
162162
</div>
163163

164164

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+3431a89 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+8a83851 &#x25BC</a>
162162
</div>
163163

164164

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+3431a89 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+8a83851 &#x25BC</a>
162162
</div>
163163

164164

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+3431a89 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+8a83851 &#x25BC</a>
162162
</div>
163163

164164

0 commit comments

Comments
 (0)