Skip to content

Commit 6b2471d

Browse files
committed
Generate Python docs from pytorch/pytorch@435d257
1 parent 6afdf16 commit 6b2471d

File tree

850 files changed

+1115
-996
lines changed

Some content is hidden

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

850 files changed

+1115
-996
lines changed

docs/master/__config__.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@
185185
<div class="pytorch-left-menu-search">
186186

187187
<div class="version">
188-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git33aed5f ) &#x25BC</a>
188+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git435d257 ) &#x25BC</a>
189189
</div>
190190

191191

docs/master/_modules/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@
184184
<div class="pytorch-left-menu-search">
185185

186186
<div class="version">
187-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git33aed5f ) &#x25BC</a>
187+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git435d257 ) &#x25BC</a>
188188
</div>
189189

190190

docs/master/_modules/torch.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@
184184
<div class="pytorch-left-menu-search">
185185

186186
<div class="version">
187-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git33aed5f ) &#x25BC</a>
187+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git435d257 ) &#x25BC</a>
188188
</div>
189189

190190

docs/master/_modules/torch/__config__.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@
184184
<div class="pytorch-left-menu-search">
185185

186186
<div class="version">
187-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git33aed5f ) &#x25BC</a>
187+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git435d257 ) &#x25BC</a>
188188
</div>
189189

190190

docs/master/_modules/torch/_jit_internal.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@
184184
<div class="pytorch-left-menu-search">
185185

186186
<div class="version">
187-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git33aed5f ) &#x25BC</a>
187+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git435d257 ) &#x25BC</a>
188188
</div>
189189

190190

docs/master/_modules/torch/_lobpcg.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@
184184
<div class="pytorch-left-menu-search">
185185

186186
<div class="version">
187-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git33aed5f ) &#x25BC</a>
187+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git435d257 ) &#x25BC</a>
188188
</div>
189189

190190

docs/master/_modules/torch/_lowrank.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@
184184
<div class="pytorch-left-menu-search">
185185

186186
<div class="version">
187-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git33aed5f ) &#x25BC</a>
187+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git435d257 ) &#x25BC</a>
188188
</div>
189189

190190

docs/master/_modules/torch/_tensor.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@
184184
<div class="pytorch-left-menu-search">
185185

186186
<div class="version">
187-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git33aed5f ) &#x25BC</a>
187+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git435d257 ) &#x25BC</a>
188188
</div>
189189

190190

docs/master/_modules/torch/_tensor_str.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@
184184
<div class="pytorch-left-menu-search">
185185

186186
<div class="version">
187-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git33aed5f ) &#x25BC</a>
187+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git435d257 ) &#x25BC</a>
188188
</div>
189189

190190

docs/master/_modules/torch/_utils.html

+22-6
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@
184184
<div class="pytorch-left-menu-search">
185185

186186
<div class="version">
187-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git33aed5f ) &#x25BC</a>
187+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git435d257 ) &#x25BC</a>
188188
</div>
189189

190190

@@ -377,7 +377,7 @@
377377

378378
<h1>Source code for torch._utils</h1><div class="highlight"><pre>
379379
<span></span><span class="kn">import</span> <span class="nn">torch</span>
380-
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">DefaultDict</span>
380+
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">DefaultDict</span><span class="p">,</span> <span class="n">Any</span>
381381
<span class="kn">import</span> <span class="nn">warnings</span>
382382
<span class="kn">from</span> <span class="nn">collections</span> <span class="kn">import</span> <span class="n">defaultdict</span>
383383
<span class="kn">import</span> <span class="nn">sys</span>
@@ -841,8 +841,17 @@ <h1>Source code for torch._utils</h1><div class="highlight"><pre>
841841
<span class="c1"># all device properties</span>
842842
<span class="k">return</span> <span class="p">[</span><span class="n">_get_device_attr</span><span class="p">(</span><span class="k">lambda</span> <span class="n">m</span><span class="p">:</span> <span class="n">m</span><span class="o">.</span><span class="n">get_device_properties</span><span class="p">(</span><span class="n">i</span><span class="p">))</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">device_ids</span><span class="p">]</span>
843843

844+
<span class="k">def</span> <span class="nf">get_current_device_index</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
845+
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Checks if there are CUDA devices available and</span>
846+
<span class="sd"> returns the device index of the current default CUDA device.</span>
847+
<span class="sd"> Returns -1 in case there are no CUDA devices available.</span>
848+
<span class="sd"> Arguments: ``None``</span>
849+
<span class="sd"> &quot;&quot;&quot;</span>
850+
<span class="k">if</span> <span class="n">torch</span><span class="o">.</span><span class="n">cuda</span><span class="o">.</span><span class="n">device_count</span><span class="p">()</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
851+
<span class="k">return</span> <span class="n">torch</span><span class="o">.</span><span class="n">cuda</span><span class="o">.</span><span class="n">current_device</span><span class="p">()</span>
852+
<span class="k">return</span> <span class="o">-</span><span class="mi">1</span>
844853

845-
<span class="k">def</span> <span class="nf">_get_device_index</span><span class="p">(</span><span class="n">device</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">allow_cpu</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
854+
<span class="k">def</span> <span class="nf">_get_device_index</span><span class="p">(</span><span class="n">device</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="n">optional</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> <span class="n">allow_cpu</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
846855
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Gets the device index from :attr:`device`, which can be a torch.device</span>
847856
<span class="sd"> object, a Python integer, or ``None``.</span>
848857

@@ -860,8 +869,7 @@ <h1>Source code for torch._utils</h1><div class="highlight"><pre>
860869
<span class="sd"> &quot;&quot;&quot;</span>
861870
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">device</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
862871
<span class="n">device</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">device</span><span class="p">(</span><span class="n">device</span><span class="p">)</span>
863-
<span class="n">device_idx</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span>
864-
<span class="n">device_idx</span> <span class="o">=</span> <span class="kc">None</span>
872+
<span class="n">device_idx</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>
865873
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">device</span><span class="p">,</span> <span class="n">torch</span><span class="o">.</span><span class="n">device</span><span class="p">):</span>
866874
<span class="k">if</span> <span class="ow">not</span> <span class="n">allow_cpu</span> <span class="ow">and</span> <span class="n">device</span><span class="o">.</span><span class="n">type</span> <span class="o">==</span> <span class="s1">&#39;cpu&#39;</span><span class="p">:</span>
867875
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Expected a non cpu device, but got: </span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">device</span><span class="p">))</span>
@@ -870,7 +878,15 @@ <h1>Source code for torch._utils</h1><div class="highlight"><pre>
870878
<span class="n">device_idx</span> <span class="o">=</span> <span class="n">device</span>
871879
<span class="k">if</span> <span class="n">device_idx</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
872880
<span class="k">if</span> <span class="n">optional</span><span class="p">:</span>
873-
<span class="n">device_idx</span> <span class="o">=</span> <span class="n">_get_current_device_index</span><span class="p">()</span>
881+
<span class="c1"># The eager API _get_current_device_index uses `lambda` functions which are</span>
882+
<span class="c1"># not supported in JIT and hence not scriptable. The JIT equivalent API to get</span>
883+
<span class="c1"># the current device index is `get_current_device_index()` which can</span>
884+
<span class="c1"># be scripted. We use is_scripting to check the mode we are in and call the</span>
885+
<span class="c1"># appropriate API.</span>
886+
<span class="k">if</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">is_scripting</span><span class="p">():</span>
887+
<span class="n">device_idx</span> <span class="o">=</span> <span class="n">get_current_device_index</span><span class="p">()</span>
888+
<span class="k">else</span><span class="p">:</span>
889+
<span class="n">device_idx</span> <span class="o">=</span> <span class="n">_get_current_device_index</span><span class="p">()</span>
874890
<span class="k">else</span><span class="p">:</span>
875891
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Expected a torch.device with a specified index &#39;</span>
876892
<span class="s1">&#39;or an integer, but got:</span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">device</span><span class="p">))</span>

docs/master/_modules/torch/_vmap_internals.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@
184184
<div class="pytorch-left-menu-search">
185185

186186
<div class="version">
187-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git33aed5f ) &#x25BC</a>
187+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git435d257 ) &#x25BC</a>
188188
</div>
189189

190190

docs/master/_modules/torch/autograd.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@
184184
<div class="pytorch-left-menu-search">
185185

186186
<div class="version">
187-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git33aed5f ) &#x25BC</a>
187+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git435d257 ) &#x25BC</a>
188188
</div>
189189

190190

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@
184184
<div class="pytorch-left-menu-search">
185185

186186
<div class="version">
187-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git33aed5f ) &#x25BC</a>
187+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git435d257 ) &#x25BC</a>
188188
</div>
189189

190190

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@
184184
<div class="pytorch-left-menu-search">
185185

186186
<div class="version">
187-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git33aed5f ) &#x25BC</a>
187+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git435d257 ) &#x25BC</a>
188188
</div>
189189

190190

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@
184184
<div class="pytorch-left-menu-search">
185185

186186
<div class="version">
187-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git33aed5f ) &#x25BC</a>
187+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git435d257 ) &#x25BC</a>
188188
</div>
189189

190190

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@
184184
<div class="pytorch-left-menu-search">
185185

186186
<div class="version">
187-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git33aed5f ) &#x25BC</a>
187+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git435d257 ) &#x25BC</a>
188188
</div>
189189

190190

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@
184184
<div class="pytorch-left-menu-search">
185185

186186
<div class="version">
187-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git33aed5f ) &#x25BC</a>
187+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git435d257 ) &#x25BC</a>
188188
</div>
189189

190190

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@
184184
<div class="pytorch-left-menu-search">
185185

186186
<div class="version">
187-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git33aed5f ) &#x25BC</a>
187+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git435d257 ) &#x25BC</a>
188188
</div>
189189

190190

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@
184184
<div class="pytorch-left-menu-search">
185185

186186
<div class="version">
187-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git33aed5f ) &#x25BC</a>
187+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git435d257 ) &#x25BC</a>
188188
</div>
189189

190190

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@
184184
<div class="pytorch-left-menu-search">
185185

186186
<div class="version">
187-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git33aed5f ) &#x25BC</a>
187+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git435d257 ) &#x25BC</a>
188188
</div>
189189

190190

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@
184184
<div class="pytorch-left-menu-search">
185185

186186
<div class="version">
187-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git33aed5f ) &#x25BC</a>
187+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git435d257 ) &#x25BC</a>
188188
</div>
189189

190190

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@
184184
<div class="pytorch-left-menu-search">
185185

186186
<div class="version">
187-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git33aed5f ) &#x25BC</a>
187+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git435d257 ) &#x25BC</a>
188188
</div>
189189

190190

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@
184184
<div class="pytorch-left-menu-search">
185185

186186
<div class="version">
187-
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git33aed5f ) &#x25BC</a>
187+
<a href='https://pytorch.org/docs/versions.html'>master (1.9.0a0+git435d257 ) &#x25BC</a>
188188
</div>
189189

190190

0 commit comments

Comments
 (0)