Skip to content

Commit eb49d41

Browse files
committed
Generate Python docs from pytorch/pytorch@b6672b1
1 parent 1eaa33a commit eb49d41

File tree

1,971 files changed

+2313
-2375
lines changed

Some content is hidden

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

1,971 files changed

+2313
-2375
lines changed

docs/master/_images/RReLU.png

434 Bytes
Loading

docs/master/_modules/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@
217217
<div class="pytorch-left-menu-search">
218218

219219
<div class="version">
220-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git089203f ) &#x25BC</a>
220+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6672b1 ) &#x25BC</a>
221221
</div>
222222

223223

docs/master/_modules/torch.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@
217217
<div class="pytorch-left-menu-search">
218218

219219
<div class="version">
220-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git089203f ) &#x25BC</a>
220+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6672b1 ) &#x25BC</a>
221221
</div>
222222

223223

docs/master/_modules/torch/__config__.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@
217217
<div class="pytorch-left-menu-search">
218218

219219
<div class="version">
220-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git089203f ) &#x25BC</a>
220+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6672b1 ) &#x25BC</a>
221221
</div>
222222

223223

docs/master/_modules/torch/_jit_internal.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@
217217
<div class="pytorch-left-menu-search">
218218

219219
<div class="version">
220-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git089203f ) &#x25BC</a>
220+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6672b1 ) &#x25BC</a>
221221
</div>
222222

223223

docs/master/_modules/torch/_lobpcg.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@
217217
<div class="pytorch-left-menu-search">
218218

219219
<div class="version">
220-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git089203f ) &#x25BC</a>
220+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6672b1 ) &#x25BC</a>
221221
</div>
222222

223223

docs/master/_modules/torch/_lowrank.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@
217217
<div class="pytorch-left-menu-search">
218218

219219
<div class="version">
220-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git089203f ) &#x25BC</a>
220+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6672b1 ) &#x25BC</a>
221221
</div>
222222

223223

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

508508

509-
<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">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="mi">6</span><span class="p">,</span> <span class="n">niter</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="mi">2</span><span class="p">,</span>
509+
<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">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="mi">6</span><span class="p">,</span> <span class="n">niter</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="mi">2</span><span class="p">,</span>
510510
<span class="n">M</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Tensor</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</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>
511511
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Return the singular value decomposition ``(U, S, V)`` of a matrix,</span>
512512
<span class="sd"> batches of matrices, or a sparse matrix :math:`A` such that</span>
@@ -551,7 +551,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
551551
<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>
552552
<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>
553553
<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>
554-
<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>
554+
<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>
555555

556556

557557
<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">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="mi">6</span><span class="p">,</span> <span class="n">niter</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="mi">2</span><span class="p">,</span>
@@ -601,7 +601,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
601601
<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>
602602

603603

604-
<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>
604+
<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>
605605
<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>
606606
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Performs linear Principal Component Analysis (PCA) on a low-rank</span>
607607
<span class="sd"> matrix, batches of such matrices, or sparse matrix.</span>
@@ -702,7 +702,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
702702
<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>
703703
<span class="k">else</span><span class="p">:</span>
704704
<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>
705-
<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>
705+
<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>
706706
</pre></div>
707707

708708
</article>

docs/master/_modules/torch/_tensor.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@
217217
<div class="pytorch-left-menu-search">
218218

219219
<div class="version">
220-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git089203f ) &#x25BC</a>
220+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6672b1 ) &#x25BC</a>
221221
</div>
222222

223223

@@ -958,7 +958,7 @@ <h1>Source code for torch._tensor</h1><div class="highlight"><pre>
958958
<span class="kn">from</span> <span class="nn">._linalg_utils</span> <span class="kn">import</span> <span class="n">solve</span>
959959
<span class="k">return</span> <span class="n">solve</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">)</span>
960960

961-
<div class="viewcode-block" id="Tensor.lu"><a class="viewcode-back" href="../../generated/torch.Tensor.lu.html#torch.Tensor.lu">[docs]</a> <span class="k">def</span> <span class="nf">lu</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pivot</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">get_infos</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
961+
<span class="k">def</span> <span class="nf">lu</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pivot</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">get_infos</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
962962
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;See :func:`torch.lu`&quot;&quot;&quot;</span>
963963
<span class="c1"># If get_infos is True, then we don&#39;t need to check for errors and vice versa</span>
964964
<span class="k">if</span> <span class="n">has_torch_function_unary</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
@@ -968,7 +968,7 @@ <h1>Source code for torch._tensor</h1><div class="highlight"><pre>
968968
<span class="k">if</span> <span class="n">get_infos</span><span class="p">:</span>
969969
<span class="k">return</span> <span class="n">LU</span><span class="p">,</span> <span class="n">pivots</span><span class="p">,</span> <span class="n">infos</span>
970970
<span class="k">else</span><span class="p">:</span>
971-
<span class="k">return</span> <span class="n">LU</span><span class="p">,</span> <span class="n">pivots</span></div>
971+
<span class="k">return</span> <span class="n">LU</span><span class="p">,</span> <span class="n">pivots</span>
972972

973973
<span class="k">def</span> <span class="nf">stft</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n_fft</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">hop_length</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>
974974
<span class="n">win_length</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">window</span><span class="p">:</span> <span class="s1">&#39;Optional[Tensor]&#39;</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>

docs/master/_modules/torch/_tensor_str.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@
217217
<div class="pytorch-left-menu-search">
218218

219219
<div class="version">
220-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git089203f ) &#x25BC</a>
220+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6672b1 ) &#x25BC</a>
221221
</div>
222222

223223

docs/master/_modules/torch/_vmap_internals.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@
217217
<div class="pytorch-left-menu-search">
218218

219219
<div class="version">
220-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git089203f ) &#x25BC</a>
220+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6672b1 ) &#x25BC</a>
221221
</div>
222222

223223

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@
217217
<div class="pytorch-left-menu-search">
218218

219219
<div class="version">
220-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git089203f ) &#x25BC</a>
220+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6672b1 ) &#x25BC</a>
221221
</div>
222222

223223

docs/master/_modules/torch/ao/ns/_numeric_suite.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@
217217
<div class="pytorch-left-menu-search">
218218

219219
<div class="version">
220-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git089203f ) &#x25BC</a>
220+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6672b1 ) &#x25BC</a>
221221
</div>
222222

223223

docs/master/_modules/torch/ao/ns/_numeric_suite_fx.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@
217217
<div class="pytorch-left-menu-search">
218218

219219
<div class="version">
220-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git089203f ) &#x25BC</a>
220+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6672b1 ) &#x25BC</a>
221221
</div>
222222

223223

docs/master/_modules/torch/ao/ns/fx/utils.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@
217217
<div class="pytorch-left-menu-search">
218218

219219
<div class="version">
220-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git089203f ) &#x25BC</a>
220+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6672b1 ) &#x25BC</a>
221221
</div>
222222

223223

docs/master/_modules/torch/ao/quantization/fake_quantize.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@
217217
<div class="pytorch-left-menu-search">
218218

219219
<div class="version">
220-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git089203f ) &#x25BC</a>
220+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6672b1 ) &#x25BC</a>
221221
</div>
222222

223223

docs/master/_modules/torch/ao/quantization/fuse_modules.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@
217217
<div class="pytorch-left-menu-search">
218218

219219
<div class="version">
220-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git089203f ) &#x25BC</a>
220+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6672b1 ) &#x25BC</a>
221221
</div>
222222

223223

docs/master/_modules/torch/ao/quantization/observer.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@
217217
<div class="pytorch-left-menu-search">
218218

219219
<div class="version">
220-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git089203f ) &#x25BC</a>
220+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6672b1 ) &#x25BC</a>
221221
</div>
222222

223223

docs/master/_modules/torch/ao/quantization/qconfig.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@
217217
<div class="pytorch-left-menu-search">
218218

219219
<div class="version">
220-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git089203f ) &#x25BC</a>
220+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6672b1 ) &#x25BC</a>
221221
</div>
222222

223223

docs/master/_modules/torch/ao/quantization/quantize.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@
217217
<div class="pytorch-left-menu-search">
218218

219219
<div class="version">
220-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git089203f ) &#x25BC</a>
220+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6672b1 ) &#x25BC</a>
221221
</div>
222222

223223

0 commit comments

Comments
 (0)