Skip to content

Commit 1455997

Browse files
committed
Generate Python docs from pytorch/pytorch@a8da1dd
1 parent a801dca commit 1455997

File tree

824 files changed

+7891
-1303
lines changed

Some content is hidden

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

824 files changed

+7891
-1303
lines changed

docs/master/__config__.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@
188188

189189

190190
<div class="version">
191-
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+4b6fea9 &#x25BC</a>
191+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+a8da1dd &#x25BC</a>
192192
</div>
193193

194194

@@ -234,6 +234,7 @@
234234
<li class="toctree-l1"><a class="reference internal" href="notes/extending.html">Extending PyTorch</a></li>
235235
<li class="toctree-l1"><a class="reference internal" href="notes/faq.html">Frequently Asked Questions</a></li>
236236
<li class="toctree-l1"><a class="reference internal" href="notes/large_scale_deployments.html">Features for large-scale deployments</a></li>
237+
<li class="toctree-l1"><a class="reference internal" href="notes/modules.html">Modules</a></li>
237238
<li class="toctree-l1"><a class="reference internal" href="notes/multiprocessing.html">Multiprocessing best practices</a></li>
238239
<li class="toctree-l1"><a class="reference internal" href="notes/randomness.html">Reproducibility</a></li>
239240
<li class="toctree-l1"><a class="reference internal" href="notes/serialization.html">Serialization semantics</a></li>

docs/master/_modules/index.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+4b6fea9 &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+a8da1dd &#x25BC</a>
191191
</div>
192192

193193

@@ -233,6 +233,7 @@
233233
<li class="toctree-l1"><a class="reference internal" href="../notes/extending.html">Extending PyTorch</a></li>
234234
<li class="toctree-l1"><a class="reference internal" href="../notes/faq.html">Frequently Asked Questions</a></li>
235235
<li class="toctree-l1"><a class="reference internal" href="../notes/large_scale_deployments.html">Features for large-scale deployments</a></li>
236+
<li class="toctree-l1"><a class="reference internal" href="../notes/modules.html">Modules</a></li>
236237
<li class="toctree-l1"><a class="reference internal" href="../notes/multiprocessing.html">Multiprocessing best practices</a></li>
237238
<li class="toctree-l1"><a class="reference internal" href="../notes/randomness.html">Reproducibility</a></li>
238239
<li class="toctree-l1"><a class="reference internal" href="../notes/serialization.html">Serialization semantics</a></li>
@@ -559,7 +560,9 @@ <h1>All modules for which code is available</h1>
559560
<li><a href="torch/sparse.html">torch.sparse</a></li>
560561
<li><a href="torch/storage.html">torch.storage</a></li>
561562
<li><a href="torch/tensor.html">torch.tensor</a></li>
563+
<li><a href="torch/utils/benchmark/utils/common.html">torch.utils.benchmark.utils.common</a></li>
562564
<li><a href="torch/utils/benchmark/utils/timer.html">torch.utils.benchmark.utils.timer</a></li>
565+
<li><a href="torch/utils/benchmark/utils/valgrind_wrapper/timer_interface.html">torch.utils.benchmark.utils.valgrind_wrapper.timer_interface</a></li>
563566
<li><a href="torch/utils/checkpoint.html">torch.utils.checkpoint</a></li>
564567
<li><a href="torch/utils/cpp_extension.html">torch.utils.cpp_extension</a></li>
565568
<li><a href="torch/utils/data/_utils/worker.html">torch.utils.data._utils.worker</a></li>

docs/master/_modules/torch.html

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+4b6fea9 &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+a8da1dd &#x25BC</a>
191191
</div>
192192

193193

@@ -233,6 +233,7 @@
233233
<li class="toctree-l1"><a class="reference internal" href="../notes/extending.html">Extending PyTorch</a></li>
234234
<li class="toctree-l1"><a class="reference internal" href="../notes/faq.html">Frequently Asked Questions</a></li>
235235
<li class="toctree-l1"><a class="reference internal" href="../notes/large_scale_deployments.html">Features for large-scale deployments</a></li>
236+
<li class="toctree-l1"><a class="reference internal" href="../notes/modules.html">Modules</a></li>
236237
<li class="toctree-l1"><a class="reference internal" href="../notes/multiprocessing.html">Multiprocessing best practices</a></li>
237238
<li class="toctree-l1"><a class="reference internal" href="../notes/randomness.html">Reproducibility</a></li>
238239
<li class="toctree-l1"><a class="reference internal" href="../notes/serialization.html">Serialization semantics</a></li>
@@ -654,7 +655,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
654655
<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>
655656

656657

657-
<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>
658+
<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>
658659
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Sets the default ``torch.Tensor`` type to floating point tensor type</span>
659660
<span class="sd"> ``t``. This type will also be used as default floating point type for</span>
660661
<span class="sd"> type inference in :func:`torch.tensor`.</span>
@@ -675,10 +676,10 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
675676
<span class="sd"> &quot;&quot;&quot;</span>
676677
<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>
677678
<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>
678-
<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>
679+
<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>
679680

680681

681-
<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>
682+
<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>
682683
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Sets the default floating point dtype to :attr:`d`.</span>
683684
<span class="sd"> This dtype is:</span>
684685

@@ -706,7 +707,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
706707
<span class="sd"> torch.complex128</span>
707708

708709
<span class="sd"> &quot;&quot;&quot;</span>
709-
<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>
710+
<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>
710711

711712
<span class="k">def</span> <span class="nf">use_deterministic_algorithms</span><span class="p">(</span><span class="n">d</span><span class="p">):</span>
712713
<span class="sa">r</span><span class="sd">&quot;&quot;&quot; Sets whether PyTorch operations must use &quot;deterministic&quot;</span>
@@ -730,6 +731,10 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
730731
<span class="sd"> * :class:`torch.nn.ConvTranspose2d` when called on CUDA tensor</span>
731732
<span class="sd"> * :class:`torch.nn.ConvTranspose3d` when called on CUDA tensor</span>
732733
<span class="sd"> * :func:`torch.bmm` when called on sparse-dense CUDA tensors</span>
734+
<span class="sd"> * :func:`torch.__getitem__` backward when `self` is a CPU tensor and</span>
735+
<span class="sd"> ``indices`` is a list of tensors</span>
736+
<span class="sd"> * :func:`torch.index_put` with ``accumulate=True`` when called on a CPU</span>
737+
<span class="sd"> tensor</span>
733738

734739
<span class="sd"> The following normally-nondeterministic operations will throw a</span>
735740
<span class="sd"> :class:`RuntimeError` when `d=True`:</span>
@@ -957,14 +962,14 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
957962
<span class="c1">################################################################################</span>
958963

959964
<span class="c1"># needs to be before the submodule imports to avoid circular dependencies</span>
960-
<span class="k">def</span> <span class="nf">_assert</span><span class="p">(</span><span class="n">condition</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span>
965+
<div class="viewcode-block" id="_assert"><a class="viewcode-back" href="../generated/torch._assert.html#torch._assert">[docs]</a><span class="k">def</span> <span class="nf">_assert</span><span class="p">(</span><span class="n">condition</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span>
961966
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;A wrapper around Python&#39;s assert which is symbolically traceable.</span>
962967
<span class="sd"> &quot;&quot;&quot;</span>
963968
<span class="kn">from</span> <span class="nn">.overrides</span> <span class="kn">import</span> <span class="n">has_torch_function</span><span class="p">,</span> <span class="n">handle_torch_function</span>
964969

965970
<span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">condition</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span> <span class="ow">and</span> <span class="n">has_torch_function</span><span class="p">((</span><span class="n">condition</span><span class="p">,)):</span>
966971
<span class="k">return</span> <span class="n">handle_torch_function</span><span class="p">(</span><span class="n">_assert</span><span class="p">,</span> <span class="p">(</span><span class="n">condition</span><span class="p">,),</span> <span class="n">condition</span><span class="p">,</span> <span class="n">message</span><span class="p">)</span>
967-
<span class="k">assert</span> <span class="n">condition</span><span class="p">,</span> <span class="n">message</span>
972+
<span class="k">assert</span> <span class="n">condition</span><span class="p">,</span> <span class="n">message</span></div>
968973

969974
<span class="c1">################################################################################</span>
970975
<span class="c1"># Import most common subpackages</span>
@@ -1009,9 +1014,9 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
10091014
<span class="k">del</span> <span class="n">_torch_docs</span><span class="p">,</span> <span class="n">_tensor_docs</span><span class="p">,</span> <span class="n">_storage_docs</span>
10101015

10111016

1012-
<div class="viewcode-block" id="compiled_with_cxx11_abi"><a class="viewcode-back" href="../generated/torch.compiled_with_cxx11_abi.html#torch.compiled_with_cxx11_abi">[docs]</a><span class="k">def</span> <span class="nf">compiled_with_cxx11_abi</span><span class="p">():</span>
1017+
<span class="k">def</span> <span class="nf">compiled_with_cxx11_abi</span><span class="p">():</span>
10131018
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Returns whether PyTorch was built with _GLIBCXX_USE_CXX11_ABI=1&quot;&quot;&quot;</span>
1014-
<span class="k">return</span> <span class="n">_C</span><span class="o">.</span><span class="n">_GLIBCXX_USE_CXX11_ABI</span></div>
1019+
<span class="k">return</span> <span class="n">_C</span><span class="o">.</span><span class="n">_GLIBCXX_USE_CXX11_ABI</span>
10151020

10161021

10171022
<span class="c1"># Import the ops &quot;namespace&quot;</span>
@@ -1039,7 +1044,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
10391044

10401045
<span class="c1"># These were previously defined in native_functions.yaml and appeared on the</span>
10411046
<span class="c1"># `torch` namespace, but we moved them to c10 dispatch to facilitate custom</span>
1042-
<span class="c1"># class usage. We add these lines here to preserve backward compatbility.</span>
1047+
<span class="c1"># class usage. We add these lines here to preserve backward compatibility.</span>
10431048
<span class="n">quantized_lstm</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">ops</span><span class="o">.</span><span class="n">aten</span><span class="o">.</span><span class="n">quantized_lstm</span>
10441049
<span class="n">quantized_gru</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">ops</span><span class="o">.</span><span class="n">aten</span><span class="o">.</span><span class="n">quantized_gru</span>
10451050
</pre></div>

docs/master/_modules/torch/__config__.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+4b6fea9 &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+a8da1dd &#x25BC</a>
191191
</div>
192192

193193

@@ -233,6 +233,7 @@
233233
<li class="toctree-l1"><a class="reference internal" href="../../notes/extending.html">Extending PyTorch</a></li>
234234
<li class="toctree-l1"><a class="reference internal" href="../../notes/faq.html">Frequently Asked Questions</a></li>
235235
<li class="toctree-l1"><a class="reference internal" href="../../notes/large_scale_deployments.html">Features for large-scale deployments</a></li>
236+
<li class="toctree-l1"><a class="reference internal" href="../../notes/modules.html">Modules</a></li>
236237
<li class="toctree-l1"><a class="reference internal" href="../../notes/multiprocessing.html">Multiprocessing best practices</a></li>
237238
<li class="toctree-l1"><a class="reference internal" href="../../notes/randomness.html">Reproducibility</a></li>
238239
<li class="toctree-l1"><a class="reference internal" href="../../notes/serialization.html">Serialization semantics</a></li>

docs/master/_modules/torch/_jit_internal.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+4b6fea9 &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+a8da1dd &#x25BC</a>
191191
</div>
192192

193193

@@ -233,6 +233,7 @@
233233
<li class="toctree-l1"><a class="reference internal" href="../../notes/extending.html">Extending PyTorch</a></li>
234234
<li class="toctree-l1"><a class="reference internal" href="../../notes/faq.html">Frequently Asked Questions</a></li>
235235
<li class="toctree-l1"><a class="reference internal" href="../../notes/large_scale_deployments.html">Features for large-scale deployments</a></li>
236+
<li class="toctree-l1"><a class="reference internal" href="../../notes/modules.html">Modules</a></li>
236237
<li class="toctree-l1"><a class="reference internal" href="../../notes/multiprocessing.html">Multiprocessing best practices</a></li>
237238
<li class="toctree-l1"><a class="reference internal" href="../../notes/randomness.html">Reproducibility</a></li>
238239
<li class="toctree-l1"><a class="reference internal" href="../../notes/serialization.html">Serialization semantics</a></li>

docs/master/_modules/torch/_lobpcg.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+4b6fea9 &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+a8da1dd &#x25BC</a>
191191
</div>
192192

193193

@@ -233,6 +233,7 @@
233233
<li class="toctree-l1"><a class="reference internal" href="../../notes/extending.html">Extending PyTorch</a></li>
234234
<li class="toctree-l1"><a class="reference internal" href="../../notes/faq.html">Frequently Asked Questions</a></li>
235235
<li class="toctree-l1"><a class="reference internal" href="../../notes/large_scale_deployments.html">Features for large-scale deployments</a></li>
236+
<li class="toctree-l1"><a class="reference internal" href="../../notes/modules.html">Modules</a></li>
236237
<li class="toctree-l1"><a class="reference internal" href="../../notes/multiprocessing.html">Multiprocessing best practices</a></li>
237238
<li class="toctree-l1"><a class="reference internal" href="../../notes/randomness.html">Reproducibility</a></li>
238239
<li class="toctree-l1"><a class="reference internal" href="../../notes/serialization.html">Serialization semantics</a></li>

docs/master/_modules/torch/_lowrank.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+4b6fea9 &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+a8da1dd &#x25BC</a>
191191
</div>
192192

193193

@@ -233,6 +233,7 @@
233233
<li class="toctree-l1"><a class="reference internal" href="../../notes/extending.html">Extending PyTorch</a></li>
234234
<li class="toctree-l1"><a class="reference internal" href="../../notes/faq.html">Frequently Asked Questions</a></li>
235235
<li class="toctree-l1"><a class="reference internal" href="../../notes/large_scale_deployments.html">Features for large-scale deployments</a></li>
236+
<li class="toctree-l1"><a class="reference internal" href="../../notes/modules.html">Modules</a></li>
236237
<li class="toctree-l1"><a class="reference internal" href="../../notes/multiprocessing.html">Multiprocessing best practices</a></li>
237238
<li class="toctree-l1"><a class="reference internal" href="../../notes/randomness.html">Reproducibility</a></li>
238239
<li class="toctree-l1"><a class="reference internal" href="../../notes/serialization.html">Serialization semantics</a></li>

docs/master/_modules/torch/_tensor_str.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+4b6fea9 &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+a8da1dd &#x25BC</a>
191191
</div>
192192

193193

@@ -233,6 +233,7 @@
233233
<li class="toctree-l1"><a class="reference internal" href="../../notes/extending.html">Extending PyTorch</a></li>
234234
<li class="toctree-l1"><a class="reference internal" href="../../notes/faq.html">Frequently Asked Questions</a></li>
235235
<li class="toctree-l1"><a class="reference internal" href="../../notes/large_scale_deployments.html">Features for large-scale deployments</a></li>
236+
<li class="toctree-l1"><a class="reference internal" href="../../notes/modules.html">Modules</a></li>
236237
<li class="toctree-l1"><a class="reference internal" href="../../notes/multiprocessing.html">Multiprocessing best practices</a></li>
237238
<li class="toctree-l1"><a class="reference internal" href="../../notes/randomness.html">Reproducibility</a></li>
238239
<li class="toctree-l1"><a class="reference internal" href="../../notes/serialization.html">Serialization semantics</a></li>

docs/master/_modules/torch/_utils.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187

188188

189189
<div class="version">
190-
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+4b6fea9 &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+a8da1dd &#x25BC</a>
191191
</div>
192192

193193

@@ -233,6 +233,7 @@
233233
<li class="toctree-l1"><a class="reference internal" href="../../notes/extending.html">Extending PyTorch</a></li>
234234
<li class="toctree-l1"><a class="reference internal" href="../../notes/faq.html">Frequently Asked Questions</a></li>
235235
<li class="toctree-l1"><a class="reference internal" href="../../notes/large_scale_deployments.html">Features for large-scale deployments</a></li>
236+
<li class="toctree-l1"><a class="reference internal" href="../../notes/modules.html">Modules</a></li>
236237
<li class="toctree-l1"><a class="reference internal" href="../../notes/multiprocessing.html">Multiprocessing best practices</a></li>
237238
<li class="toctree-l1"><a class="reference internal" href="../../notes/randomness.html">Reproducibility</a></li>
238239
<li class="toctree-l1"><a class="reference internal" href="../../notes/serialization.html">Serialization semantics</a></li>

0 commit comments

Comments
 (0)