Skip to content

Commit a3811b6

Browse files
committed
Generate Python docs from pytorch/pytorch@28c4319
1 parent 3c7e609 commit a3811b6

File tree

1,985 files changed

+2376
-2185
lines changed

Some content is hidden

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

1,985 files changed

+2376
-2185
lines changed

docs/master/_images/RReLU.png

-207 Bytes
Loading

docs/master/_modules/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

docs/master/_modules/torch.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

docs/master/_modules/torch/__config__.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

docs/master/_modules/torch/_jit_internal.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

docs/master/_modules/torch/_lobpcg.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

docs/master/_modules/torch/_lowrank.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

docs/master/_modules/torch/_tensor.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

docs/master/_modules/torch/_tensor_str.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

docs/master/_modules/torch/_vmap_internals.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

docs/master/_modules/torch/ao/ns/_numeric_suite.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

docs/master/_modules/torch/ao/ns/_numeric_suite_fx.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

docs/master/_modules/torch/ao/ns/fx/utils.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

docs/master/_modules/torch/ao/quantization/fake_quantize.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

docs/master/_modules/torch/ao/quantization/fuse_modules.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

docs/master/_modules/torch/ao/quantization/observer.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

docs/master/_modules/torch/ao/quantization/qconfig.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

docs/master/_modules/torch/ao/quantization/quantize.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

docs/master/_modules/torch/ao/quantization/quantize_fx.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

docs/master/_modules/torch/ao/quantization/stubs.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

docs/master/_modules/torch/autograd.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

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

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
<div class="pytorch-left-menu-search">
220220

221221
<div class="version">
222-
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+gitb6b8803 ) &#x25BC</a>
222+
<a href='https://pytorch.org/docs/versions.html'>master (1.13.0a0+git28c4319 ) &#x25BC</a>
223223
</div>
224224

225225

@@ -429,10 +429,53 @@
429429
<h1>Source code for torch.backends.mkl</h1><div class="highlight"><pre>
430430
<span></span><span class="kn">import</span> <span class="nn">torch</span>
431431

432-
433432
<div class="viewcode-block" id="is_available"><a class="viewcode-back" href="../../../backends.html#torch.backends.mkl.is_available">[docs]</a><span class="k">def</span> <span class="nf">is_available</span><span class="p">():</span>
434433
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Returns whether PyTorch is built with MKL support.&quot;&quot;&quot;</span>
435434
<span class="k">return</span> <span class="n">torch</span><span class="o">.</span><span class="n">_C</span><span class="o">.</span><span class="n">has_mkl</span></div>
435+
436+
<span class="n">VERBOSE_OFF</span> <span class="o">=</span> <span class="mi">0</span>
437+
<span class="n">VERBOSE_ON</span> <span class="o">=</span> <span class="mi">1</span>
438+
<div class="viewcode-block" id="verbose"><a class="viewcode-back" href="../../../backends.html#torch.backends.mkl.verbose">[docs]</a><span class="k">class</span> <span class="nc">verbose</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
439+
<span class="sd">&quot;&quot;&quot;</span>
440+
<span class="sd"> On-demand oneMKL verbosing functionality</span>
441+
<span class="sd"> To make it easier to debug performance issues, oneMKL can dump verbose</span>
442+
<span class="sd"> messages containing execution information like duration while executing</span>
443+
<span class="sd"> the kernel. The verbosing functionality can be invoked via an environment</span>
444+
<span class="sd"> variable named `MKL_VERBOSE`. However, this methodology dumps messages in</span>
445+
<span class="sd"> all steps. Those are a large amount of verbose messages. Moreover, for</span>
446+
<span class="sd"> investigating the performance issues, generally taking verbose messages</span>
447+
<span class="sd"> for one single iteration is enough. This on-demand verbosing functionality</span>
448+
<span class="sd"> makes it possible to control scope for verbose message dumping. In the</span>
449+
<span class="sd"> following example, verbose messages will be dumped out for the second</span>
450+
<span class="sd"> inference only.</span>
451+
452+
<span class="sd"> .. highlight:: python</span>
453+
<span class="sd"> .. code-block:: python</span>
454+
455+
<span class="sd"> import torch</span>
456+
<span class="sd"> model(data)</span>
457+
<span class="sd"> with torch.backends.mkl.verbose(torch.backends.mkl.VERBOSE_ON):</span>
458+
<span class="sd"> model(data)</span>
459+
460+
<span class="sd"> Args:</span>
461+
<span class="sd"> level: Verbose level</span>
462+
<span class="sd"> - ``VERBOSE_OFF``: Disable verbosing</span>
463+
<span class="sd"> - ``VERBOSE_ON``: Enable verbosing</span>
464+
<span class="sd"> &quot;&quot;&quot;</span>
465+
466+
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">enable</span><span class="p">):</span>
467+
<span class="bp">self</span><span class="o">.</span><span class="n">enable</span> <span class="o">=</span> <span class="n">enable</span>
468+
469+
<span class="k">def</span> <span class="fm">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
470+
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">enable</span> <span class="o">==</span> <span class="n">VERBOSE_OFF</span><span class="p">:</span>
471+
<span class="k">return</span>
472+
<span class="n">st</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">_C</span><span class="o">.</span><span class="n">_verbose</span><span class="o">.</span><span class="n">mkl_set_verbose</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">enable</span><span class="p">)</span>
473+
<span class="k">assert</span> <span class="n">st</span><span class="p">,</span> <span class="s2">&quot;Failed to set MKL into verbose mode. Please consider to disable this verbose scope.&quot;</span>
474+
<span class="k">return</span> <span class="bp">self</span>
475+
476+
<span class="k">def</span> <span class="fm">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc_type</span><span class="p">,</span> <span class="n">exc_val</span><span class="p">,</span> <span class="n">exc_tb</span><span class="p">):</span>
477+
<span class="n">torch</span><span class="o">.</span><span class="n">_C</span><span class="o">.</span><span class="n">_verbose</span><span class="o">.</span><span class="n">mkl_set_verbose</span><span class="p">(</span><span class="n">VERBOSE_OFF</span><span class="p">)</span>
478+
<span class="k">return</span> <span class="kc">False</span></div>
436479
</pre></div>
437480

438481
</article>

0 commit comments

Comments
 (0)