Skip to content

Commit da524c3

Browse files
committed
Generate Python docs from pytorch/pytorch@08889b2
1 parent e75b16a commit da524c3

File tree

1,939 files changed

+3421
-2628
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,939 files changed

+3421
-2628
lines changed

docs/master/__config__.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@
208208
<div class="pytorch-left-menu-search">
209209

210210
<div class="version">
211-
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git52c516e ) &#x25BC</a>
211+
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git08889b2 ) &#x25BC</a>
212212
</div>
213213

214214

docs/master/_images/RReLU.png

223 Bytes
Loading

docs/master/_modules/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@
207207
<div class="pytorch-left-menu-search">
208208

209209
<div class="version">
210-
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git52c516e ) &#x25BC</a>
210+
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git08889b2 ) &#x25BC</a>
211211
</div>
212212

213213

docs/master/_modules/torch.html

Lines changed: 22 additions & 22 deletions
Large diffs are not rendered by default.

docs/master/_modules/torch/__config__.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@
207207
<div class="pytorch-left-menu-search">
208208

209209
<div class="version">
210-
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git52c516e ) &#x25BC</a>
210+
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git08889b2 ) &#x25BC</a>
211211
</div>
212212

213213

docs/master/_modules/torch/_jit_internal.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@
207207
<div class="pytorch-left-menu-search">
208208

209209
<div class="version">
210-
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git52c516e ) &#x25BC</a>
210+
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git08889b2 ) &#x25BC</a>
211211
</div>
212212

213213

docs/master/_modules/torch/_lobpcg.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@
207207
<div class="pytorch-left-menu-search">
208208

209209
<div class="version">
210-
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git52c516e ) &#x25BC</a>
210+
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git08889b2 ) &#x25BC</a>
211211
</div>
212212

213213

docs/master/_modules/torch/_lowrank.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@
207207
<div class="pytorch-left-menu-search">
208208

209209
<div class="version">
210-
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git52c516e ) &#x25BC</a>
210+
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git08889b2 ) &#x25BC</a>
211211
</div>
212212

213213

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

494494

495-
<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>
495+
<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>
496496
<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>
497497
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Return the singular value decomposition ``(U, S, V)`` of a matrix,</span>
498498
<span class="sd"> batches of matrices, or a sparse matrix :math:`A` such that</span>
@@ -537,7 +537,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
537537
<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>
538538
<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>
539539
<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>
540-
<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>
540+
<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>
541541

542542

543543
<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>
@@ -587,7 +587,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
587587
<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>
588588

589589

590-
<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>
590+
<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>
591591
<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>
592592
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Performs linear Principal Component Analysis (PCA) on a low-rank</span>
593593
<span class="sd"> matrix, batches of such matrices, or sparse matrix.</span>
@@ -688,7 +688,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
688688
<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>
689689
<span class="k">else</span><span class="p">:</span>
690690
<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>
691-
<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>
691+
<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>
692692
</pre></div>
693693

694694
</article>

docs/master/_modules/torch/_tensor.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@
207207
<div class="pytorch-left-menu-search">
208208

209209
<div class="version">
210-
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git52c516e ) &#x25BC</a>
210+
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git08889b2 ) &#x25BC</a>
211211
</div>
212212

213213

@@ -519,9 +519,9 @@ <h1>Source code for torch._tensor</h1><div class="highlight"><pre>
519519
<span class="k">else</span><span class="p">:</span>
520520
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Unsupported qscheme </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">qscheme</span><span class="p">()</span><span class="si">}</span><span class="s2"> in deepcopy&quot;</span><span class="p">)</span>
521521
<span class="c1"># TODO: Once we decide to break serialization FC, no longer</span>
522-
<span class="c1"># need to wrap with TypedStorage</span>
522+
<span class="c1"># need to wrap with _TypedStorage</span>
523523
<span class="n">new_tensor</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">_utils</span><span class="o">.</span><span class="n">_rebuild_qtensor</span><span class="p">(</span>
524-
<span class="n">torch</span><span class="o">.</span><span class="n">storage</span><span class="o">.</span><span class="n">TypedStorage</span><span class="p">(</span>
524+
<span class="n">torch</span><span class="o">.</span><span class="n">storage</span><span class="o">.</span><span class="n">_TypedStorage</span><span class="p">(</span>
525525
<span class="n">wrap_storage</span><span class="o">=</span><span class="n">new_storage</span><span class="o">.</span><span class="n">_untyped</span><span class="p">(),</span>
526526
<span class="n">dtype</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">dtype</span><span class="p">),</span>
527527
<span class="bp">self</span><span class="o">.</span><span class="n">storage_offset</span><span class="p">(),</span>
@@ -642,9 +642,9 @@ <h1>Source code for torch._tensor</h1><div class="highlight"><pre>
642642
<span class="k">else</span><span class="p">:</span>
643643
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Serialization is not supported for tensors of type </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">qscheme</span><span class="p">()</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
644644
<span class="c1"># TODO: Once we decide to break serialization FC, no longer</span>
645-
<span class="c1"># need to wrap with TypedStorage</span>
645+
<span class="c1"># need to wrap with _TypedStorage</span>
646646
<span class="n">args_qtensor</span> <span class="o">=</span> <span class="p">(</span>
647-
<span class="n">torch</span><span class="o">.</span><span class="n">storage</span><span class="o">.</span><span class="n">TypedStorage</span><span class="p">(</span>
647+
<span class="n">torch</span><span class="o">.</span><span class="n">storage</span><span class="o">.</span><span class="n">_TypedStorage</span><span class="p">(</span>
648648
<span class="n">wrap_storage</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">storage</span><span class="p">()</span><span class="o">.</span><span class="n">_untyped</span><span class="p">(),</span>
649649
<span class="n">dtype</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">dtype</span><span class="p">),</span>
650650
<span class="bp">self</span><span class="o">.</span><span class="n">storage_offset</span><span class="p">(),</span>
@@ -677,9 +677,9 @@ <h1>Source code for torch._tensor</h1><div class="highlight"><pre>
677677
<span class="k">return</span> <span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">_utils</span><span class="o">.</span><span class="n">_rebuild_sparse_csr_tensor</span><span class="p">,</span> <span class="n">args_sparse_csr</span><span class="p">)</span>
678678
<span class="k">else</span><span class="p">:</span>
679679
<span class="c1"># TODO: Once we decide to break serialization FC, no longer</span>
680-
<span class="c1"># need to wrap with TypedStorage</span>
680+
<span class="c1"># need to wrap with _TypedStorage</span>
681681
<span class="n">args</span> <span class="o">=</span> <span class="p">(</span>
682-
<span class="n">torch</span><span class="o">.</span><span class="n">storage</span><span class="o">.</span><span class="n">TypedStorage</span><span class="p">(</span>
682+
<span class="n">torch</span><span class="o">.</span><span class="n">storage</span><span class="o">.</span><span class="n">_TypedStorage</span><span class="p">(</span>
683683
<span class="n">wrap_storage</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">storage</span><span class="p">()</span><span class="o">.</span><span class="n">_untyped</span><span class="p">(),</span>
684684
<span class="n">dtype</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">dtype</span><span class="p">),</span>
685685
<span class="bp">self</span><span class="o">.</span><span class="n">storage_offset</span><span class="p">(),</span>
@@ -1240,9 +1240,9 @@ <h1>Source code for torch._tensor</h1><div class="highlight"><pre>
12401240
<span class="sd"> Returns the type of the underlying storage.</span>
12411241

12421242
<span class="sd"> &quot;&quot;&quot;</span>
1243-
<span class="c1"># NB: this returns old fashioned TypedStorage, e.g., FloatStorage, as it</span>
1243+
<span class="c1"># NB: this returns old fashioned _TypedStorage, e.g., FloatStorage, as it</span>
12441244
<span class="c1"># would be pretty pointless otherwise (it would always return</span>
1245-
<span class="c1"># UntypedStorage)</span>
1245+
<span class="c1"># _UntypedStorage)</span>
12461246
<span class="k">return</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">storage</span><span class="p">())</span>
12471247

12481248
<span class="k">def</span> <span class="nf">refine_names</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">names</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
@@ -207,7 +207,7 @@
207207
<div class="pytorch-left-menu-search">
208208

209209
<div class="version">
210-
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git52c516e ) &#x25BC</a>
210+
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git08889b2 ) &#x25BC</a>
211211
</div>
212212

213213

docs/master/_modules/torch/_vmap_internals.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@
207207
<div class="pytorch-left-menu-search">
208208

209209
<div class="version">
210-
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git52c516e ) &#x25BC</a>
210+
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git08889b2 ) &#x25BC</a>
211211
</div>
212212

213213

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@
207207
<div class="pytorch-left-menu-search">
208208

209209
<div class="version">
210-
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git52c516e ) &#x25BC</a>
210+
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git08889b2 ) &#x25BC</a>
211211
</div>
212212

213213

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@
207207
<div class="pytorch-left-menu-search">
208208

209209
<div class="version">
210-
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git52c516e ) &#x25BC</a>
210+
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git08889b2 ) &#x25BC</a>
211211
</div>
212212

213213

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@
207207
<div class="pytorch-left-menu-search">
208208

209209
<div class="version">
210-
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git52c516e ) &#x25BC</a>
210+
<a href='https://pytorch.org/docs/versions.html'>master (1.12.0a0+git08889b2 ) &#x25BC</a>
211211
</div>
212212

213213

0 commit comments

Comments
 (0)