Skip to content

Commit d877241

Browse files
committed
Generate Python docs from pytorch/pytorch@256d46c
1 parent 4ae0b06 commit d877241

File tree

826 files changed

+3762
-1027
lines changed

Some content is hidden

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

826 files changed

+3762
-1027
lines changed

docs/master/__config__.html

Lines changed: 1 addition & 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+a8da1dd &#x25BC</a>
191+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
192192
</div>
193193

194194

docs/master/_modules/index.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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

@@ -521,6 +521,7 @@ <h1>All modules for which code is available</h1>
521521
<ul><li><a href="torch/nn/quantized/modules/activation.html">torch.nn.quantized.modules.activation</a></li>
522522
<li><a href="torch/nn/quantized/modules/batchnorm.html">torch.nn.quantized.modules.batchnorm</a></li>
523523
<li><a href="torch/nn/quantized/modules/conv.html">torch.nn.quantized.modules.conv</a></li>
524+
<li><a href="torch/nn/quantized/modules/embedding_ops.html">torch.nn.quantized.modules.embedding_ops</a></li>
524525
<li><a href="torch/nn/quantized/modules/functional_modules.html">torch.nn.quantized.modules.functional_modules</a></li>
525526
<li><a href="torch/nn/quantized/modules/linear.html">torch.nn.quantized.modules.linear</a></li>
526527
<li><a href="torch/nn/quantized/modules/normalization.html">torch.nn.quantized.modules.normalization</a></li>

docs/master/_modules/torch.html

Lines changed: 9 additions & 9 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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

@@ -655,7 +655,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
655655
<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>
656656

657657

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>
658+
<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>
659659
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Sets the default ``torch.Tensor`` type to floating point tensor type</span>
660660
<span class="sd"> ``t``. This type will also be used as default floating point type for</span>
661661
<span class="sd"> type inference in :func:`torch.tensor`.</span>
@@ -676,10 +676,10 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
676676
<span class="sd"> &quot;&quot;&quot;</span>
677677
<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>
678678
<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>
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>
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></div>
680680

681681

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

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

709709
<span class="sd"> &quot;&quot;&quot;</span>
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>
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></div>
711711

712712
<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>
713713
<span class="sa">r</span><span class="sd">&quot;&quot;&quot; Sets whether PyTorch operations must use &quot;deterministic&quot;</span>
@@ -962,14 +962,14 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
962962
<span class="c1">################################################################################</span>
963963

964964
<span class="c1"># needs to be before the submodule imports to avoid circular dependencies</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>
965+
<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>
966966
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;A wrapper around Python&#39;s assert which is symbolically traceable.</span>
967967
<span class="sd"> &quot;&quot;&quot;</span>
968968
<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>
969969

970970
<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>
971971
<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>
972-
<span class="k">assert</span> <span class="n">condition</span><span class="p">,</span> <span class="n">message</span></div>
972+
<span class="k">assert</span> <span class="n">condition</span><span class="p">,</span> <span class="n">message</span>
973973

974974
<span class="c1">################################################################################</span>
975975
<span class="c1"># Import most common subpackages</span>
@@ -1014,9 +1014,9 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
10141014
<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>
10151015

10161016

1017-
<span class="k">def</span> <span class="nf">compiled_with_cxx11_abi</span><span class="p">():</span>
1017+
<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>
10181018
<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>
1019-
<span class="k">return</span> <span class="n">_C</span><span class="o">.</span><span class="n">_GLIBCXX_USE_CXX11_ABI</span>
1019+
<span class="k">return</span> <span class="n">_C</span><span class="o">.</span><span class="n">_GLIBCXX_USE_CXX11_ABI</span></div>
10201020

10211021

10221022
<span class="c1"># Import the ops &quot;namespace&quot;</span>

docs/master/_modules/torch/__config__.html

Lines changed: 1 addition & 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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/_jit_internal.html

Lines changed: 1 addition & 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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/_lobpcg.html

Lines changed: 1 addition & 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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/_lowrank.html

Lines changed: 1 addition & 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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/_tensor_str.html

Lines changed: 1 addition & 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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/_utils.html

Lines changed: 1 addition & 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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/_vmap_internals.html

Lines changed: 1 addition & 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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/autograd.html

Lines changed: 1 addition & 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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/autograd/anomaly_mode.html

Lines changed: 1 addition & 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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/autograd/function.html

Lines changed: 1 addition & 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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/autograd/functional.html

Lines changed: 1 addition & 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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/autograd/grad_mode.html

Lines changed: 4 additions & 4 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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

@@ -463,7 +463,7 @@ <h1>Source code for torch.autograd.grad_mode</h1><div class="highlight"><pre>
463463
<span class="k">raise</span> <span class="ne">NotImplementedError</span>
464464

465465

466-
<div class="viewcode-block" id="no_grad"><a class="viewcode-back" href="../../../autograd.html#torch.autograd.no_grad">[docs]</a><span class="k">class</span> <span class="nc">no_grad</span><span class="p">(</span><span class="n">_DecoratorContextManager</span><span class="p">):</span>
466+
<div class="viewcode-block" id="no_grad"><a class="viewcode-back" href="../../../generated/torch.no_grad.html#torch.no_grad">[docs]</a><span class="k">class</span> <span class="nc">no_grad</span><span class="p">(</span><span class="n">_DecoratorContextManager</span><span class="p">):</span>
467467
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Context-manager that disabled gradient calculation.</span>
468468

469469
<span class="sd"> Disabling gradient calculation is useful for inference, when you are sure</span>
@@ -506,7 +506,7 @@ <h1>Source code for torch.autograd.grad_mode</h1><div class="highlight"><pre>
506506
<span class="n">torch</span><span class="o">.</span><span class="n">set_grad_enabled</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">prev</span><span class="p">)</span></div>
507507

508508

509-
<div class="viewcode-block" id="enable_grad"><a class="viewcode-back" href="../../../autograd.html#torch.autograd.enable_grad">[docs]</a><span class="k">class</span> <span class="nc">enable_grad</span><span class="p">(</span><span class="n">_DecoratorContextManager</span><span class="p">):</span>
509+
<div class="viewcode-block" id="enable_grad"><a class="viewcode-back" href="../../../generated/torch.enable_grad.html#torch.enable_grad">[docs]</a><span class="k">class</span> <span class="nc">enable_grad</span><span class="p">(</span><span class="n">_DecoratorContextManager</span><span class="p">):</span>
510510
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Context-manager that enables gradient calculation.</span>
511511

512512
<span class="sd"> Enables gradient calculation, if it has been disabled via :class:`~no_grad`</span>
@@ -545,7 +545,7 @@ <h1>Source code for torch.autograd.grad_mode</h1><div class="highlight"><pre>
545545
<span class="n">torch</span><span class="o">.</span><span class="n">_C</span><span class="o">.</span><span class="n">_set_grad_enabled</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">prev</span><span class="p">)</span></div>
546546

547547

548-
<div class="viewcode-block" id="set_grad_enabled"><a class="viewcode-back" href="../../../autograd.html#torch.autograd.set_grad_enabled">[docs]</a><span class="k">class</span> <span class="nc">set_grad_enabled</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
548+
<div class="viewcode-block" id="set_grad_enabled"><a class="viewcode-back" href="../../../generated/torch.set_grad_enabled.html#torch.set_grad_enabled">[docs]</a><span class="k">class</span> <span class="nc">set_grad_enabled</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
549549
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Context-manager that sets gradient calculation to on or off.</span>
550550

551551
<span class="sd"> ``set_grad_enabled`` will enable or disable grads based on its argument :attr:`mode`.</span>

docs/master/_modules/torch/autograd/gradcheck.html

Lines changed: 1 addition & 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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/autograd/profiler.html

Lines changed: 3 additions & 3 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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

@@ -747,8 +747,8 @@ <h1>Source code for torch.autograd.profiler</h1><div class="highlight"><pre>
747747

748748
<span class="sd"> with_flops (bool, optional): If with_flops is set, the profiler will estimate</span>
749749
<span class="sd"> the FLOPS (floating pointer operations per second) value using the operator&#39;s input shape</span>
750-
<span class="sd"> and total CPU time. This allows one to estimate the hardware performance. Currently,</span>
751-
<span class="sd"> this option only works for the matrix multiplication and convolution functions.</span>
750+
<span class="sd"> and total time. This allows one to estimate the hardware performance. Currently,</span>
751+
<span class="sd"> this option only works for the matrix multiplication and 2D convolution operators.</span>
752752

753753
<span class="sd"> profile_memory (bool, optional): track tensor memory allocation/deallocation.</span>
754754

docs/master/_modules/torch/backends/cuda.html

Lines changed: 1 addition & 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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/backends/cudnn.html

Lines changed: 1 addition & 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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/backends/mkl.html

Lines changed: 1 addition & 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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/backends/mkldnn.html

Lines changed: 1 addition & 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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/backends/openmp.html

Lines changed: 1 addition & 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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/cuda.html

Lines changed: 1 addition & 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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

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

Lines changed: 1 addition & 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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

docs/master/_modules/torch/cuda/amp/grad_scaler.html

Lines changed: 1 addition & 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+a8da1dd &#x25BC</a>
190+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+256d46c &#x25BC</a>
191191
</div>
192192

193193

0 commit comments

Comments
 (0)