Skip to content

Commit 840ee8c

Browse files
committed
auto-generating sphinx docs
1 parent 8b81e44 commit 840ee8c

File tree

756 files changed

+2562
-1285
lines changed

Some content is hidden

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

756 files changed

+2562
-1285
lines changed

docs/master/__config__.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@
159159

160160

161161
<div class="version">
162-
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+91256aa &#x25BC</a>
162+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+ec85071 &#x25BC</a>
163163
</div>
164164

165165

docs/master/_modules/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+91256aa &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+ec85071 &#x25BC</a>
162162
</div>
163163

164164

docs/master/_modules/torch.html

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+91256aa &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+ec85071 &#x25BC</a>
162162
</div>
163163

164164

@@ -614,7 +614,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
614614
<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>
615615

616616

617-
<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>
617+
<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>
618618
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Sets the default ``torch.Tensor`` type to floating point tensor type</span>
619619
<span class="sd"> ``t``. This type will also be used as default floating point type for</span>
620620
<span class="sd"> type inference in :func:`torch.tensor`.</span>
@@ -635,10 +635,10 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
635635
<span class="sd"> &quot;&quot;&quot;</span>
636636
<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>
637637
<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>
638-
<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>
638+
<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>
639639

640640

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

@@ -666,9 +666,9 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
666666
<span class="sd"> torch.complex128</span>
667667

668668
<span class="sd"> &quot;&quot;&quot;</span>
669-
<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>
669+
<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>
670670

671-
<span class="k">def</span> <span class="nf">set_deterministic</span><span class="p">(</span><span class="n">d</span><span class="p">):</span>
671+
<div class="viewcode-block" id="set_deterministic"><a class="viewcode-back" href="../generated/torch.set_deterministic.html#torch.set_deterministic">[docs]</a><span class="k">def</span> <span class="nf">set_deterministic</span><span class="p">(</span><span class="n">d</span><span class="p">):</span>
672672
<span class="sa">r</span><span class="sd">&quot;&quot;&quot; Sets whether PyTorch operations must use &quot;deterministic&quot;</span>
673673
<span class="sd"> algorithms. That is, algorithms which, given the same input, and when</span>
674674
<span class="sd"> run on the same software and hardware, always produce the same output.</span>
@@ -740,7 +740,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
740740
<span class="sd"> d (:class:`bool`): If True, force operations to be deterministic.</span>
741741
<span class="sd"> If False, allow non-deterministic operations.</span>
742742
<span class="sd"> &quot;&quot;&quot;</span>
743-
<span class="n">_C</span><span class="o">.</span><span class="n">_set_deterministic</span><span class="p">(</span><span class="n">d</span><span class="p">)</span>
743+
<span class="n">_C</span><span class="o">.</span><span class="n">_set_deterministic</span><span class="p">(</span><span class="n">d</span><span class="p">)</span></div>
744744

745745
<div class="viewcode-block" id="is_deterministic"><a class="viewcode-back" href="../generated/torch.is_deterministic.html#torch.is_deterministic">[docs]</a><span class="k">def</span> <span class="nf">is_deterministic</span><span class="p">():</span>
746746
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Returns True if the global deterministic flag is turned on. Refer to</span>
@@ -760,8 +760,8 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
760760
<span class="k">pass</span>
761761

762762

763-
<div class="viewcode-block" id="FloatStorage"><a class="viewcode-back" href="../storage.html#torch.FloatStorage">[docs]</a><span class="k">class</span> <span class="nc">FloatStorage</span><span class="p">(</span><span class="n">_C</span><span class="o">.</span><span class="n">FloatStorageBase</span><span class="p">,</span> <span class="n">_StorageBase</span><span class="p">):</span>
764-
<span class="k">pass</span></div>
763+
<span class="k">class</span> <span class="nc">FloatStorage</span><span class="p">(</span><span class="n">_C</span><span class="o">.</span><span class="n">FloatStorageBase</span><span class="p">,</span> <span class="n">_StorageBase</span><span class="p">):</span>
764+
<span class="k">pass</span>
765765

766766

767767
<span class="k">class</span> <span class="nc">HalfStorage</span><span class="p">(</span><span class="n">_C</span><span class="o">.</span><span class="n">HalfStorageBase</span><span class="p">,</span> <span class="n">_StorageBase</span><span class="p">):</span>
@@ -928,9 +928,9 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
928928
<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>
929929

930930

931-
<span class="k">def</span> <span class="nf">compiled_with_cxx11_abi</span><span class="p">():</span>
931+
<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>
932932
<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>
933-
<span class="k">return</span> <span class="n">_C</span><span class="o">.</span><span class="n">_GLIBCXX_USE_CXX11_ABI</span>
933+
<span class="k">return</span> <span class="n">_C</span><span class="o">.</span><span class="n">_GLIBCXX_USE_CXX11_ABI</span></div>
934934

935935

936936
<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
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+91256aa &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+ec85071 &#x25BC</a>
162162
</div>
163163

164164

docs/master/_modules/torch/_jit_internal.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+91256aa &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+ec85071 &#x25BC</a>
162162
</div>
163163

164164

docs/master/_modules/torch/_lobpcg.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+91256aa &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+ec85071 &#x25BC</a>
162162
</div>
163163

164164

docs/master/_modules/torch/_lowrank.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+91256aa &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+ec85071 &#x25BC</a>
162162
</div>
163163

164164

docs/master/_modules/torch/_tensor_str.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+91256aa &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+ec85071 &#x25BC</a>
162162
</div>
163163

164164

docs/master/_modules/torch/_utils.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+91256aa &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+ec85071 &#x25BC</a>
162162
</div>
163163

164164

docs/master/_modules/torch/_vmap_internals.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+91256aa &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+ec85071 &#x25BC</a>
162162
</div>
163163

164164

docs/master/_modules/torch/autograd.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+91256aa &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+ec85071 &#x25BC</a>
162162
</div>
163163

164164

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+91256aa &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+ec85071 &#x25BC</a>
162162
</div>
163163

164164

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+91256aa &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+ec85071 &#x25BC</a>
162162
</div>
163163

164164

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

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+91256aa &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+ec85071 &#x25BC</a>
162162
</div>
163163

164164

@@ -728,15 +728,15 @@ <h1>Source code for torch.autograd.functional</h1><div class="highlight"><pre>
728728
<span class="sd"> Defaults to ``False``.</span>
729729

730730
<span class="sd"> Returns:</span>
731-
<span class="sd"> Jacobian (Tensor or nested tuple of Tensors): if there are a single</span>
732-
<span class="sd"> input and output, this will be a single Tensor containing the</span>
733-
<span class="sd"> Jacobian for the linearized inputs and output. If one of the two is</span>
734-
<span class="sd"> a tuple, then the Jacobian will be a tuple of Tensors. If both of</span>
735-
<span class="sd"> them are tuples, then the Jacobian will be a tuple of tuple of</span>
736-
<span class="sd"> Tensors where ``Jacobian[i][j]`` will contain the Jacobian of the</span>
737-
<span class="sd"> ``i``\th output and ``j``\th input and will have as size the</span>
738-
<span class="sd"> concatenation of the sizes of the corresponding output and the</span>
739-
<span class="sd"> corresponding input.</span>
731+
<span class="sd"> Jacobian (Tensor or nested tuple of Tensors): if there is a single</span>
732+
<span class="sd"> input and output, this will be a single Tensor containing the</span>
733+
<span class="sd"> Jacobian for the linearized inputs and output. If one of the two is</span>
734+
<span class="sd"> a tuple, then the Jacobian will be a tuple of Tensors. If both of</span>
735+
<span class="sd"> them are tuples, then the Jacobian will be a tuple of tuple of</span>
736+
<span class="sd"> Tensors where ``Jacobian[i][j]`` will contain the Jacobian of the</span>
737+
<span class="sd"> ``i``\th output and ``j``\th input and will have as size the</span>
738+
<span class="sd"> concatenation of the sizes of the corresponding output and the</span>
739+
<span class="sd"> corresponding input.</span>
740740

741741
<span class="sd"> Example:</span>
742742

@@ -823,12 +823,12 @@ <h1>Source code for torch.autograd.functional</h1><div class="highlight"><pre>
823823
<span class="sd"> Defaults to ``False``.</span>
824824

825825
<span class="sd"> Returns:</span>
826-
<span class="sd"> Hessian (Tensor or a tuple of tuple of Tensors) if there are a single input,</span>
827-
<span class="sd"> this will be a single Tensor containing the Hessian for the input.</span>
828-
<span class="sd"> If it is a tuple, then the Hessian will be a tuple of tuples where</span>
829-
<span class="sd"> ``Hessian[i][j]`` will contain the Hessian of the ``i``\th input</span>
830-
<span class="sd"> and ``j``\th input with size the sum of the size of the ``i``\th input plus</span>
831-
<span class="sd"> the size of the ``j``\th input.</span>
826+
<span class="sd"> Hessian (Tensor or a tuple of tuple of Tensors): if there is a single input,</span>
827+
<span class="sd"> this will be a single Tensor containing the Hessian for the input.</span>
828+
<span class="sd"> If it is a tuple, then the Hessian will be a tuple of tuples where</span>
829+
<span class="sd"> ``Hessian[i][j]`` will contain the Hessian of the ``i``\th input</span>
830+
<span class="sd"> and ``j``\th input with size the sum of the size of the ``i``\th input plus</span>
831+
<span class="sd"> the size of the ``j``\th input.</span>
832832

833833
<span class="sd"> Example:</span>
834834

@@ -1007,7 +1007,9 @@ <h1>Source code for torch.autograd.functional</h1><div class="highlight"><pre>
10071007
<span class="sd"> hvp for said inputs, which is the expected mathematical value.</span>
10081008
<span class="sd"> Defaults to ``False``.</span>
10091009
<span class="sd"> Returns:</span>
1010-
<span class="sd"> func_output (tuple of Tensors or Tensor): output of ``func(inputs)``</span>
1010+
<span class="sd"> output (tuple): tuple with:</span>
1011+
<span class="sd"> func_output (tuple of Tensors or Tensor): output of ``func(inputs)``</span>
1012+
10111013
<span class="sd"> hvp (tuple of Tensors or Tensor): result of the dot product with</span>
10121014
<span class="sd"> the same shape as the inputs.</span>
10131015

0 commit comments

Comments
 (0)