Skip to content

Commit 559479c

Browse files
committed
Generate Python docs from pytorch/pytorch@afbb6e8
1 parent a979beb commit 559479c

File tree

1,915 files changed

+2241
-2182
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,915 files changed

+2241
-2182
lines changed

docs/master/__config__.html

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

196196
<div class="version">
197-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git4b0e1e1 ) &#x25BC</a>
197+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitafbb6e8 ) &#x25BC</a>
198198
</div>
199199

200200

docs/master/_images/RReLU.png

213 Bytes
Loading

docs/master/_modules/index.html

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

195195
<div class="version">
196-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git4b0e1e1 ) &#x25BC</a>
196+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitafbb6e8 ) &#x25BC</a>
197197
</div>
198198

199199

docs/master/_modules/torch.html

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@
193193
<div class="pytorch-left-menu-search">
194194

195195
<div class="version">
196-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git4b0e1e1 ) &#x25BC</a>
196+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitafbb6e8 ) &#x25BC</a>
197197
</div>
198198

199199

@@ -690,7 +690,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
690690
<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>
691691

692692

693-
<div class="viewcode-block" id="set_default_tensor_type"><a class="viewcode-back" href="../generated/torch.set_default_tensor_type.html#torch.set_default_tensor_type">[docs]</a><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>
693+
<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>
694694
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Sets the default ``torch.Tensor`` type to floating point tensor type</span>
695695
<span class="sd"> ``t``. This type will also be used as default floating point type for</span>
696696
<span class="sd"> type inference in :func:`torch.tensor`.</span>
@@ -711,10 +711,10 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
711711
<span class="sd"> &quot;&quot;&quot;</span>
712712
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">t</span><span class="p">,</span> <span class="n">_string_classes</span><span class="p">):</span>
713713
<span class="n">t</span> <span class="o">=</span> <span class="n">_import_dotted_name</span><span class="p">(</span><span class="n">t</span><span class="p">)</span>
714-
<span class="n">_C</span><span class="o">.</span><span class="n">_set_default_tensor_type</span><span class="p">(</span><span class="n">t</span><span class="p">)</span></div>
714+
<span class="n">_C</span><span class="o">.</span><span class="n">_set_default_tensor_type</span><span class="p">(</span><span class="n">t</span><span class="p">)</span>
715715

716716

717-
<div class="viewcode-block" id="set_default_dtype"><a class="viewcode-back" href="../generated/torch.set_default_dtype.html#torch.set_default_dtype">[docs]</a><span class="k">def</span> <span class="nf">set_default_dtype</span><span class="p">(</span><span class="n">d</span><span class="p">):</span>
717+
<span class="k">def</span> <span class="nf">set_default_dtype</span><span class="p">(</span><span class="n">d</span><span class="p">):</span>
718718
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
719719

720720
<span class="sd"> Sets the default floating point dtype to :attr:`d`. Supports torch.float32</span>
@@ -757,9 +757,9 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
757757
<span class="sd"> torch.complex128</span>
758758

759759
<span class="sd"> &quot;&quot;&quot;</span>
760-
<span class="n">_C</span><span class="o">.</span><span class="n">_set_default_dtype</span><span class="p">(</span><span class="n">d</span><span class="p">)</span></div>
760+
<span class="n">_C</span><span class="o">.</span><span class="n">_set_default_dtype</span><span class="p">(</span><span class="n">d</span><span class="p">)</span>
761761

762-
<div class="viewcode-block" id="use_deterministic_algorithms"><a class="viewcode-back" href="../generated/torch.use_deterministic_algorithms.html#torch.use_deterministic_algorithms">[docs]</a><span class="k">def</span> <span class="nf">use_deterministic_algorithms</span><span class="p">(</span><span class="n">mode</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">warn_only</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
762+
<span class="k">def</span> <span class="nf">use_deterministic_algorithms</span><span class="p">(</span><span class="n">mode</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">warn_only</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
763763
<span class="sa">r</span><span class="sd">&quot;&quot;&quot; Sets whether PyTorch operations must use &quot;deterministic&quot;</span>
764764
<span class="sd"> algorithms. That is, algorithms which, given the same input, and when</span>
765765
<span class="sd"> run on the same software and hardware, always produce the same output.</span>
@@ -882,7 +882,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
882882
<span class="sd"> ...</span>
883883
<span class="sd"> RuntimeError: index_add_cuda_ does not have a deterministic implementation...</span>
884884
<span class="sd"> &quot;&quot;&quot;</span>
885-
<span class="n">_C</span><span class="o">.</span><span class="n">_set_deterministic_algorithms</span><span class="p">(</span><span class="n">mode</span><span class="p">,</span> <span class="n">warn_only</span><span class="o">=</span><span class="n">warn_only</span><span class="p">)</span></div>
885+
<span class="n">_C</span><span class="o">.</span><span class="n">_set_deterministic_algorithms</span><span class="p">(</span><span class="n">mode</span><span class="p">,</span> <span class="n">warn_only</span><span class="o">=</span><span class="n">warn_only</span><span class="p">)</span>
886886

887887
<div class="viewcode-block" id="are_deterministic_algorithms_enabled"><a class="viewcode-back" href="../generated/torch.are_deterministic_algorithms_enabled.html#torch.are_deterministic_algorithms_enabled">[docs]</a><span class="k">def</span> <span class="nf">are_deterministic_algorithms_enabled</span><span class="p">():</span>
888888
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Returns True if the global deterministic flag is turned on. Refer to</span>
@@ -897,7 +897,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
897897
<span class="sd"> &quot;&quot;&quot;</span>
898898
<span class="k">return</span> <span class="n">_C</span><span class="o">.</span><span class="n">_get_deterministic_algorithms_warn_only</span><span class="p">()</span></div>
899899

900-
<div class="viewcode-block" id="set_deterministic_debug_mode"><a class="viewcode-back" href="../generated/torch.set_deterministic_debug_mode.html#torch.set_deterministic_debug_mode">[docs]</a><span class="k">def</span> <span class="nf">set_deterministic_debug_mode</span><span class="p">(</span><span class="n">debug_mode</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">builtins</span><span class="o">.</span><span class="n">int</span><span class="p">,</span> <span class="nb">str</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
900+
<span class="k">def</span> <span class="nf">set_deterministic_debug_mode</span><span class="p">(</span><span class="n">debug_mode</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">builtins</span><span class="o">.</span><span class="n">int</span><span class="p">,</span> <span class="nb">str</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
901901
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Sets the debug mode for deterministic operations.</span>
902902

903903
<span class="sd"> .. note:: This is an alternative interface for</span>
@@ -937,7 +937,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
937937
<span class="k">else</span><span class="p">:</span>
938938
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span>
939939
<span class="s1">&#39;invalid value of debug_mode, expected 0, 1, or 2, &#39;</span>
940-
<span class="sa">f</span><span class="s1">&#39;but got </span><span class="si">{</span><span class="n">debug_mode</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">)</span></div>
940+
<span class="sa">f</span><span class="s1">&#39;but got </span><span class="si">{</span><span class="n">debug_mode</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">)</span>
941941

942942
<span class="k">def</span> <span class="nf">get_deterministic_debug_mode</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">builtins</span><span class="o">.</span><span class="n">int</span><span class="p">:</span>
943943
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Returns the current value of the debug mode for deterministic</span>
@@ -953,7 +953,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
953953
<span class="k">else</span><span class="p">:</span>
954954
<span class="k">return</span> <span class="mi">0</span>
955955

956-
<div class="viewcode-block" id="set_warn_always"><a class="viewcode-back" href="../generated/torch.set_warn_always.html#torch.set_warn_always">[docs]</a><span class="k">def</span> <span class="nf">set_warn_always</span><span class="p">(</span><span class="n">b</span><span class="p">):</span>
956+
<span class="k">def</span> <span class="nf">set_warn_always</span><span class="p">(</span><span class="n">b</span><span class="p">):</span>
957957
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;When this flag is False (default) then some PyTorch warnings may only</span>
958958
<span class="sd"> appear once per process. This helps avoid excessive warning information.</span>
959959
<span class="sd"> Setting it to True causes these warnings to always appear, which may be</span>
@@ -963,7 +963,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
963963
<span class="sd"> b (:class:`bool`): If True, force warnings to always be emitted</span>
964964
<span class="sd"> If False, set to the default behaviour</span>
965965
<span class="sd"> &quot;&quot;&quot;</span>
966-
<span class="n">_C</span><span class="o">.</span><span class="n">_set_warnAlways</span><span class="p">(</span><span class="n">b</span><span class="p">)</span></div>
966+
<span class="n">_C</span><span class="o">.</span><span class="n">_set_warnAlways</span><span class="p">(</span><span class="n">b</span><span class="p">)</span>
967967

968968
<div class="viewcode-block" id="is_warn_always_enabled"><a class="viewcode-back" href="../generated/torch.is_warn_always_enabled.html#torch.is_warn_always_enabled">[docs]</a><span class="k">def</span> <span class="nf">is_warn_always_enabled</span><span class="p">():</span>
969969
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Returns True if the global warn_always flag is turned on. Refer to</span>

docs/master/_modules/torch/__config__.html

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

195195
<div class="version">
196-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git4b0e1e1 ) &#x25BC</a>
196+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitafbb6e8 ) &#x25BC</a>
197197
</div>
198198

199199

docs/master/_modules/torch/_jit_internal.html

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

195195
<div class="version">
196-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git4b0e1e1 ) &#x25BC</a>
196+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitafbb6e8 ) &#x25BC</a>
197197
</div>
198198

199199

docs/master/_modules/torch/_lobpcg.html

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

195195
<div class="version">
196-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git4b0e1e1 ) &#x25BC</a>
196+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitafbb6e8 ) &#x25BC</a>
197197
</div>
198198

199199

docs/master/_modules/torch/_lowrank.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@
193193
<div class="pytorch-left-menu-search">
194194

195195
<div class="version">
196-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git4b0e1e1 ) &#x25BC</a>
196+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitafbb6e8 ) &#x25BC</a>
197197
</div>
198198

199199

@@ -570,7 +570,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
570570
<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>
571571

572572

573-
<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>
573+
<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>
574574
<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>
575575
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Performs linear Principal Component Analysis (PCA) on a low-rank</span>
576576
<span class="sd"> matrix, batches of such matrices, or sparse matrix.</span>
@@ -671,7 +671,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
671671
<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>
672672
<span class="k">else</span><span class="p">:</span>
673673
<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>
674-
<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>
674+
<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>
675675
</pre></div>
676676

677677
</article>

docs/master/_modules/torch/_tensor.html

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

195195
<div class="version">
196-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git4b0e1e1 ) &#x25BC</a>
196+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitafbb6e8 ) &#x25BC</a>
197197
</div>
198198

199199

docs/master/_modules/torch/_tensor_str.html

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

195195
<div class="version">
196-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git4b0e1e1 ) &#x25BC</a>
196+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitafbb6e8 ) &#x25BC</a>
197197
</div>
198198

199199

docs/master/_modules/torch/_vmap_internals.html

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

195195
<div class="version">
196-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git4b0e1e1 ) &#x25BC</a>
196+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitafbb6e8 ) &#x25BC</a>
197197
</div>
198198

199199

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

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

195195
<div class="version">
196-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git4b0e1e1 ) &#x25BC</a>
196+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitafbb6e8 ) &#x25BC</a>
197197
</div>
198198

199199

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

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

195195
<div class="version">
196-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git4b0e1e1 ) &#x25BC</a>
196+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitafbb6e8 ) &#x25BC</a>
197197
</div>
198198

199199

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

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

195195
<div class="version">
196-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git4b0e1e1 ) &#x25BC</a>
196+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitafbb6e8 ) &#x25BC</a>
197197
</div>
198198

199199

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

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

195195
<div class="version">
196-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git4b0e1e1 ) &#x25BC</a>
196+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitafbb6e8 ) &#x25BC</a>
197197
</div>
198198

199199

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

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

195195
<div class="version">
196-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git4b0e1e1 ) &#x25BC</a>
196+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitafbb6e8 ) &#x25BC</a>
197197
</div>
198198

199199

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

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

195195
<div class="version">
196-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git4b0e1e1 ) &#x25BC</a>
196+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitafbb6e8 ) &#x25BC</a>
197197
</div>
198198

199199

0 commit comments

Comments
 (0)