Skip to content

Commit 66aab7c

Browse files
pytorchbotpytorchbot
committed
Generate Python docs from pytorch/pytorch@a465a93 
1 parent c02d9d2 commit 66aab7c

File tree

1,610 files changed

+2029
-1991
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,610 files changed

+2029
-1991
lines changed

‎docs/master/__config__.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@
189189
<div class="pytorch-left-menu-search">
190190

191191
<div class="version">
192-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git2bd4ead ) &#x25BC</a>
192+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+gita465a93 ) &#x25BC</a>
193193
</div>
194194

195195

‎docs/master/_modules/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@
188188
<div class="pytorch-left-menu-search">
189189

190190
<div class="version">
191-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git2bd4ead ) &#x25BC</a>
191+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+gita465a93 ) &#x25BC</a>
192192
</div>
193193

194194

‎docs/master/_modules/torch.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@
188188
<div class="pytorch-left-menu-search">
189189

190190
<div class="version">
191-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git2bd4ead ) &#x25BC</a>
191+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+gita465a93 ) &#x25BC</a>
192192
</div>
193193

194194

‎docs/master/_modules/torch/__config__.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@
188188
<div class="pytorch-left-menu-search">
189189

190190
<div class="version">
191-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git2bd4ead ) &#x25BC</a>
191+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+gita465a93 ) &#x25BC</a>
192192
</div>
193193

194194

‎docs/master/_modules/torch/_jit_internal.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@
188188
<div class="pytorch-left-menu-search">
189189

190190
<div class="version">
191-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git2bd4ead ) &#x25BC</a>
191+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+gita465a93 ) &#x25BC</a>
192192
</div>
193193

194194

@@ -875,7 +875,7 @@ <h1>Source code for torch._jit_internal</h1><div class="highlight"><pre>
875875
<span class="k">return</span> <span class="n">fn</span></div>
876876

877877

878-
<div class="viewcode-block" id="unused"><a class="viewcode-back" href="../../generated/torch.jit.unused.html#torch.jit.unused">[docs]</a><span class="k">def</span> <span class="nf">unused</span><span class="p">(</span><span class="n">fn</span><span class="p">):</span>
878+
<span class="k">def</span> <span class="nf">unused</span><span class="p">(</span><span class="n">fn</span><span class="p">):</span>
879879
<span class="sd">&quot;&quot;&quot;</span>
880880
<span class="sd"> This decorator indicates to the compiler that a function or method should</span>
881881
<span class="sd"> be ignored and replaced with the raising of an exception. This allows you</span>
@@ -922,9 +922,9 @@ <h1>Source code for torch._jit_internal</h1><div class="highlight"><pre>
922922
<span class="k">return</span> <span class="n">prop</span>
923923

924924
<span class="n">fn</span><span class="o">.</span><span class="n">_torchscript_modifier</span> <span class="o">=</span> <span class="n">FunctionModifiers</span><span class="o">.</span><span class="n">UNUSED</span>
925-
<span class="k">return</span> <span class="n">fn</span></div>
925+
<span class="k">return</span> <span class="n">fn</span>
926926

927-
<div class="viewcode-block" id="ignore"><a class="viewcode-back" href="../../generated/torch.jit.ignore.html#torch.jit.ignore">[docs]</a><span class="k">def</span> <span class="nf">ignore</span><span class="p">(</span><span class="n">drop</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
927+
<span class="k">def</span> <span class="nf">ignore</span><span class="p">(</span><span class="n">drop</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
928928
<span class="sd">&quot;&quot;&quot;</span>
929929
<span class="sd"> This decorator indicates to the compiler that a function or method should</span>
930930
<span class="sd"> be ignored and left as a Python function. This allows you to leave code in</span>
@@ -1015,7 +1015,7 @@ <h1>Source code for torch._jit_internal</h1><div class="highlight"><pre>
10151015
<span class="k">else</span><span class="p">:</span>
10161016
<span class="n">fn</span><span class="o">.</span><span class="n">_torchscript_modifier</span> <span class="o">=</span> <span class="n">FunctionModifiers</span><span class="o">.</span><span class="n">IGNORE</span>
10171017
<span class="k">return</span> <span class="n">fn</span>
1018-
<span class="k">return</span> <span class="n">decorator</span></div>
1018+
<span class="k">return</span> <span class="n">decorator</span>
10191019

10201020

10211021
<span class="k">def</span> <span class="nf">_copy_to_script_wrapper</span><span class="p">(</span><span class="n">fn</span><span class="p">):</span>

‎docs/master/_modules/torch/_lobpcg.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@
188188
<div class="pytorch-left-menu-search">
189189

190190
<div class="version">
191-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git2bd4ead ) &#x25BC</a>
191+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+gita465a93 ) &#x25BC</a>
192192
</div>
193193

194194

‎docs/master/_modules/torch/_lowrank.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@
188188
<div class="pytorch-left-menu-search">
189189

190190
<div class="version">
191-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git2bd4ead ) &#x25BC</a>
191+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+gita465a93 ) &#x25BC</a>
192192
</div>
193193

194194

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

466466

467-
<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>
467+
<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>
468468
<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>
469469
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Return the singular value decomposition ``(U, S, V)`` of a matrix,</span>
470470
<span class="sd"> batches of matrices, or a sparse matrix :math:`A` such that</span>
@@ -509,7 +509,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
509509
<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>
510510
<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>
511511
<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>
512-
<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>
512+
<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>
513513

514514

515515
<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>
@@ -557,7 +557,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
557557
<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>
558558

559559

560-
<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>
560+
<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>
561561
<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>
562562
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Performs linear Principal Component Analysis (PCA) on a low-rank</span>
563563
<span class="sd"> matrix, batches of such matrices, or sparse matrix.</span>
@@ -658,7 +658,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
658658
<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>
659659
<span class="k">else</span><span class="p">:</span>
660660
<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>
661-
<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>
661+
<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>
662662
</pre></div>
663663

664664
</article>

0 commit comments

Comments
 (0)