Skip to content

Commit f9a913b

Browse files
committed
auto-generating sphinx docs
1 parent 0037e27 commit f9a913b

File tree

764 files changed

+2609
-1440
lines changed

Some content is hidden

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

764 files changed

+2609
-1440
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+96741a8 &#x25BC</a>
162+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+7a69d3f &#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+96741a8 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+7a69d3f &#x25BC</a>
162162
</div>
163163

164164

docs/master/_modules/torch.html

Lines changed: 13 additions & 12 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+96741a8 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+7a69d3f &#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-
<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>
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>
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></div>
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>
639639

640640

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>
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>
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></div>
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>
670670

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>
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>
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></div>
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>
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-
<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>
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>
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-
<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>
931+
<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></div>
933+
<span class="k">return</span> <span class="n">_C</span><span class="o">.</span><span class="n">_GLIBCXX_USE_CXX11_ABI</span>
934934

935935

936936
<span class="c1"># Import the ops &quot;namespace&quot;</span>
@@ -962,11 +962,12 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
962962
<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>
963963
<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>
964964

965-
<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>
966965

967966
<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>
968967
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;A wrapper around Python&#39;s assert which is symbolically traceable.</span>
969968
<span class="sd"> &quot;&quot;&quot;</span>
969+
<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>
970+
970971
<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>
971972
<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>
972973
<span class="k">assert</span> <span class="n">condition</span><span class="p">,</span> <span class="n">message</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+96741a8 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+7a69d3f &#x25BC</a>
162162
</div>
163163

164164

docs/master/_modules/torch/_jit_internal.html

Lines changed: 5 additions & 5 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+96741a8 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+7a69d3f &#x25BC</a>
162162
</div>
163163

164164

@@ -652,7 +652,7 @@ <h1>Source code for torch._jit_internal</h1><div class="highlight"><pre>
652652
<span class="s2">&quot;if this method is not scripted, copy the python method onto the scripted model&quot;</span>
653653

654654

655-
<div class="viewcode-block" id="export"><a class="viewcode-back" href="../../jit.html#torch.jit.export">[docs]</a><span class="k">def</span> <span class="nf">export</span><span class="p">(</span><span class="n">fn</span><span class="p">):</span>
655+
<span class="k">def</span> <span class="nf">export</span><span class="p">(</span><span class="n">fn</span><span class="p">):</span>
656656
<span class="sd">&quot;&quot;&quot;</span>
657657
<span class="sd"> This decorator indicates that a method on an ``nn.Module`` is used as an entry point into a</span>
658658
<span class="sd"> :class:`ScriptModule` and should be compiled.</span>
@@ -695,7 +695,7 @@ <h1>Source code for torch._jit_internal</h1><div class="highlight"><pre>
695695
<span class="sd"> m = torch.jit.script(MyModule())</span>
696696
<span class="sd"> &quot;&quot;&quot;</span>
697697
<span class="n">fn</span><span class="o">.</span><span class="n">_torchscript_modifier</span> <span class="o">=</span> <span class="n">FunctionModifiers</span><span class="o">.</span><span class="n">EXPORT</span>
698-
<span class="k">return</span> <span class="n">fn</span></div>
698+
<span class="k">return</span> <span class="n">fn</span>
699699

700700

701701
<div class="viewcode-block" id="unused"><a class="viewcode-back" href="../../generated/torch.jit.unused.html#torch.jit.unused">[docs]</a><span class="k">def</span> <span class="nf">unused</span><span class="p">(</span><span class="n">fn</span><span class="p">):</span>
@@ -1076,7 +1076,7 @@ <h1>Source code for torch._jit_internal</h1><div class="highlight"><pre>
10761076
<span class="nb">globals</span><span class="p">()[</span><span class="sa">f</span><span class="s2">&quot;BroadcastingList</span><span class="si">{</span><span class="n">i</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">BroadcastingList1</span>
10771077

10781078

1079-
<span class="k">def</span> <span class="nf">is_scripting</span><span class="p">():</span>
1079+
<div class="viewcode-block" id="is_scripting"><a class="viewcode-back" href="../../jit_language_reference.html#torch.jit.is_scripting">[docs]</a><span class="k">def</span> <span class="nf">is_scripting</span><span class="p">():</span>
10801080
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
10811081
<span class="sd"> Function that returns True when in compilation and False otherwise. This</span>
10821082
<span class="sd"> is useful especially with the @unused decorator to leave code in your</span>
@@ -1095,7 +1095,7 @@ <h1>Source code for torch._jit_internal</h1><div class="highlight"><pre>
10951095
<span class="sd"> else:</span>
10961096
<span class="sd"> return unsupported_linear_op(x)</span>
10971097
<span class="sd"> &quot;&quot;&quot;</span>
1098-
<span class="k">return</span> <span class="kc">False</span>
1098+
<span class="k">return</span> <span class="kc">False</span></div>
10991099

11001100

11011101
<span class="c1"># Retrieves a fully-qualified name (module hierarchy + classname) for a given obj.</span>

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+96741a8 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+7a69d3f &#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+96741a8 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+7a69d3f &#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+96741a8 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+7a69d3f &#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+96741a8 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+7a69d3f &#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+96741a8 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+7a69d3f &#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+96741a8 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+7a69d3f &#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+96741a8 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+7a69d3f &#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+96741a8 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+7a69d3f &#x25BC</a>
162162
</div>
163163

164164

docs/master/_modules/torch/autograd/functional.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+96741a8 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.8.0a0+7a69d3f &#x25BC</a>
162162
</div>
163163

164164

0 commit comments

Comments
 (0)