Skip to content

Commit aff5eb0

Browse files
committed
Generate Python docs from pytorch/pytorch@bafa2c4
1 parent e9e79c4 commit aff5eb0

File tree

2,212 files changed

+33810
-5114
lines changed

Some content is hidden

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

2,212 files changed

+33810
-5114
lines changed

docs/main/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: bb3bb791658ccca09bc902e6b5fd4d2d
3+
config: b341d982278ca88e163440bcaa6aaa26
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/main/_dynamo.html

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1212

13-
<title>torch._dynamo &mdash; PyTorch 2.1 documentation</title>
13+
<title>torch._dynamo &mdash; PyTorch master documentation</title>
1414

1515

1616

@@ -44,6 +44,12 @@
4444
<link rel="next" title="torch.fft" href="fft.html" />
4545
<link rel="prev" title="Probability distributions - torch.distributions" href="distributions.html" />
4646

47+
<!--
48+
Search engines should not index the master version of documentation.
49+
Stable documentation are built without release == 'master'.
50+
-->
51+
<meta name="robots" content="noindex">
52+
4753

4854
<!-- Google Analytics -->
4955

@@ -231,7 +237,7 @@
231237
<div class="pytorch-left-menu-search">
232238

233239
<div class="version">
234-
<a href='https://pytorch.org/docs/versions.html'>2.1 &#x25BC</a>
240+
<a href='https://pytorch.org/docs/versions.html'>master (2.1.0a0+gitbafa2c4 ) &#x25BC</a>
235241
</div>
236242

237243

@@ -251,6 +257,13 @@
251257

252258

253259

260+
<div>
261+
<a style="color:#F05732" href="https://pytorch.org/docs/stable/_dynamo.html">
262+
You are viewing unstable developer preview docs.
263+
Click here to view docs for latest stable release.
264+
</a>
265+
</div>
266+
254267

255268

256269

@@ -589,7 +602,7 @@
589602

590603
<dl class="py function">
591604
<dt class="sig sig-object py" id="torch._dynamo.export">
592-
<span class="sig-prename descclassname"><span class="pre">torch._dynamo.</span></span><span class="sig-name descname"><span class="pre">export</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aten_graph</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decomposition_table</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tracing_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'symbolic'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">constraints</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">assume_static_by_default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/torch/_dynamo/eval_frame.html#export"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#torch._dynamo.export" title="Permalink to this definition"></a></dt>
605+
<span class="sig-prename descclassname"><span class="pre">torch._dynamo.</span></span><span class="sig-name descname"><span class="pre">export</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aten_graph</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pre_autograd</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decomposition_table</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tracing_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'symbolic'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">constraints</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">assume_static_by_default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/torch/_dynamo/eval_frame.html#export"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#torch._dynamo.export" title="Permalink to this definition"></a></dt>
593606
<dd><p>Export an input function f to a format that can be executed outside of PyTorch using the FX graph.</p>
594607
<dl class="field-list simple">
595608
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -598,7 +611,12 @@
598611
<li><p><strong>*args</strong> – Variable length argument list to be passed to the function f.</p></li>
599612
<li><p><strong>aten_graph</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><em>bool</em></a>) – If True, exports a graph with ATen operators.</p></li>
600613
<li><p><strong>False</strong> (<em>If</em>) – </p></li>
601-
<li><p><strong>False.</strong> (<em>exports a graph with Python operators. Default is</em>) – </p></li>
614+
<li><p><strong>False.</strong> (<em>Default is</em>) – </p></li>
615+
<li><p><strong>pre_autograd</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><em>bool</em></a>) – If True, exports a graph with ATen operators,</p></li>
616+
<li><p><strong>tranformations</strong> (<em>but before autograd has run. This can be useful if you want to apply further</em>) – </p></li>
617+
<li><p><strong>autograd.</strong> (<em>on a graph before running it through</em>) – </p></li>
618+
<li><p><strong>set.</strong> (<em>This flag is only valid if aten_graph=True is</em>) – </p></li>
619+
<li><p><strong>False.</strong></p></li>
602620
<li><p><strong>decomposition_table</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.11)"><em>dict</em></a>) – A dictionary that maps operators to their decomposition functions.</p></li>
603621
<li><p><strong>None.</strong> (<em>Required if aten_graph</em><em> or </em><em>tracing_mode is specified. Default is</em>) – </p></li>
604622
<li><p><strong>tracing_mode</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a>) – Specifies the tracing mode. Must be set to “real” if decomposition_table is not specified.</p></li>

docs/main/_images/RReLU.png

-10 Bytes
Loading

docs/main/_modules/index.html

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1212

13-
<title>Overview: module code &mdash; PyTorch 2.1 documentation</title>
13+
<title>Overview: module code &mdash; PyTorch master documentation</title>
1414

1515

1616

@@ -42,6 +42,12 @@
4242
<link rel="index" title="Index" href="../genindex.html" />
4343
<link rel="search" title="Search" href="../search.html" />
4444

45+
<!--
46+
Search engines should not index the master version of documentation.
47+
Stable documentation are built without release == 'master'.
48+
-->
49+
<meta name="robots" content="noindex">
50+
4551

4652
<!-- Google Analytics -->
4753

@@ -229,7 +235,7 @@
229235
<div class="pytorch-left-menu-search">
230236

231237
<div class="version">
232-
<a href='https://pytorch.org/docs/versions.html'>2.1 &#x25BC</a>
238+
<a href='https://pytorch.org/docs/versions.html'>master (2.1.0a0+gitbafa2c4 ) &#x25BC</a>
233239
</div>
234240

235241

@@ -249,6 +255,13 @@
249255

250256

251257

258+
<div>
259+
<a style="color:#F05732" href="https://pytorch.org/docs/stable/_modules/index.html">
260+
You are viewing unstable developer preview docs.
261+
Click here to view docs for latest stable release.
262+
</a>
263+
</div>
264+
252265

253266

254267

docs/main/_modules/torch.html

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1212

13-
<title>torch &mdash; PyTorch 2.1 documentation</title>
13+
<title>torch &mdash; PyTorch master documentation</title>
1414

1515

1616

@@ -42,6 +42,12 @@
4242
<link rel="index" title="Index" href="../genindex.html" />
4343
<link rel="search" title="Search" href="../search.html" />
4444

45+
<!--
46+
Search engines should not index the master version of documentation.
47+
Stable documentation are built without release == 'master'.
48+
-->
49+
<meta name="robots" content="noindex">
50+
4551

4652
<!-- Google Analytics -->
4753

@@ -229,7 +235,7 @@
229235
<div class="pytorch-left-menu-search">
230236

231237
<div class="version">
232-
<a href='https://pytorch.org/docs/versions.html'>2.1 &#x25BC</a>
238+
<a href='https://pytorch.org/docs/versions.html'>master (2.1.0a0+gitbafa2c4 ) &#x25BC</a>
233239
</div>
234240

235241

@@ -249,6 +255,13 @@
249255

250256

251257

258+
<div>
259+
<a style="color:#F05732" href="https://pytorch.org/docs/stable/_modules/torch.html">
260+
You are viewing unstable developer preview docs.
261+
Click here to view docs for latest stable release.
262+
</a>
263+
</div>
264+
252265

253266

254267

@@ -526,15 +539,15 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
526539

527540
<span class="n">dll_paths</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="nb">filter</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">,</span> <span class="p">[</span><span class="n">th_dll_path</span><span class="p">,</span> <span class="n">py_dll_path</span><span class="p">,</span> <span class="n">base_py_dll_path</span><span class="p">]))</span>
528541

529-
<span class="k">if</span> <span class="nb">all</span><span class="p">([</span><span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">p</span><span class="p">,</span> <span class="s1">&#39;nvToolsExt64_1.dll&#39;</span><span class="p">))</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">dll_paths</span><span class="p">]):</span>
542+
<span class="k">if</span> <span class="nb">all</span><span class="p">(</span><span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">p</span><span class="p">,</span> <span class="s1">&#39;nvToolsExt64_1.dll&#39;</span><span class="p">))</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">dll_paths</span><span class="p">):</span>
530543
<span class="n">nvtoolsext_dll_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
531544
<span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s1">&#39;NVTOOLSEXT_PATH&#39;</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">pfiles_path</span><span class="p">,</span> <span class="s1">&#39;NVIDIA Corporation&#39;</span><span class="p">,</span> <span class="s1">&#39;NvToolsExt&#39;</span><span class="p">)),</span> <span class="s1">&#39;bin&#39;</span><span class="p">,</span> <span class="s1">&#39;x64&#39;</span><span class="p">)</span>
532545
<span class="k">else</span><span class="p">:</span>
533546
<span class="n">nvtoolsext_dll_path</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
534547

535548
<span class="kn">from</span> <span class="nn">.version</span> <span class="kn">import</span> <span class="n">cuda</span> <span class="k">as</span> <span class="n">cuda_version</span>
536549
<span class="kn">import</span> <span class="nn">glob</span>
537-
<span class="k">if</span> <span class="n">cuda_version</span> <span class="ow">and</span> <span class="nb">all</span><span class="p">([</span><span class="ow">not</span> <span class="n">glob</span><span class="o">.</span><span class="n">glob</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">p</span><span class="p">,</span> <span class="s1">&#39;cudart64*.dll&#39;</span><span class="p">))</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">dll_paths</span><span class="p">]):</span>
550+
<span class="k">if</span> <span class="n">cuda_version</span> <span class="ow">and</span> <span class="nb">all</span><span class="p">(</span><span class="ow">not</span> <span class="n">glob</span><span class="o">.</span><span class="n">glob</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">p</span><span class="p">,</span> <span class="s1">&#39;cudart64*.dll&#39;</span><span class="p">))</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">dll_paths</span><span class="p">):</span>
538551
<span class="n">cuda_version_1</span> <span class="o">=</span> <span class="n">cuda_version</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">,</span> <span class="s1">&#39;_&#39;</span><span class="p">)</span>
539552
<span class="n">cuda_path_var</span> <span class="o">=</span> <span class="s1">&#39;CUDA_PATH_V&#39;</span> <span class="o">+</span> <span class="n">cuda_version_1</span>
540553
<span class="n">default_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">pfiles_path</span><span class="p">,</span> <span class="s1">&#39;NVIDIA GPU Computing Toolkit&#39;</span><span class="p">,</span> <span class="s1">&#39;CUDA&#39;</span><span class="p">,</span> <span class="s1">&#39;v&#39;</span> <span class="o">+</span> <span class="n">cuda_version</span><span class="p">)</span>

docs/main/_modules/torch/__config__.html

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1212

13-
<title>torch.__config__ &mdash; PyTorch 2.1 documentation</title>
13+
<title>torch.__config__ &mdash; PyTorch master documentation</title>
1414

1515

1616

@@ -42,6 +42,12 @@
4242
<link rel="index" title="Index" href="../../genindex.html" />
4343
<link rel="search" title="Search" href="../../search.html" />
4444

45+
<!--
46+
Search engines should not index the master version of documentation.
47+
Stable documentation are built without release == 'master'.
48+
-->
49+
<meta name="robots" content="noindex">
50+
4551

4652
<!-- Google Analytics -->
4753

@@ -229,7 +235,7 @@
229235
<div class="pytorch-left-menu-search">
230236

231237
<div class="version">
232-
<a href='https://pytorch.org/docs/versions.html'>2.1 &#x25BC</a>
238+
<a href='https://pytorch.org/docs/versions.html'>master (2.1.0a0+gitbafa2c4 ) &#x25BC</a>
233239
</div>
234240

235241

@@ -249,6 +255,13 @@
249255

250256

251257

258+
<div>
259+
<a style="color:#F05732" href="https://pytorch.org/docs/stable/_modules/torch/__config__.html">
260+
You are viewing unstable developer preview docs.
261+
Click here to view docs for latest stable release.
262+
</a>
263+
</div>
264+
252265

253266

254267

docs/main/_modules/torch/_dynamo.html

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1212

13-
<title>torch._dynamo &mdash; PyTorch 2.1 documentation</title>
13+
<title>torch._dynamo &mdash; PyTorch master documentation</title>
1414

1515

1616

@@ -42,6 +42,12 @@
4242
<link rel="index" title="Index" href="../../genindex.html" />
4343
<link rel="search" title="Search" href="../../search.html" />
4444

45+
<!--
46+
Search engines should not index the master version of documentation.
47+
Stable documentation are built without release == 'master'.
48+
-->
49+
<meta name="robots" content="noindex">
50+
4551

4652
<!-- Google Analytics -->
4753

@@ -229,7 +235,7 @@
229235
<div class="pytorch-left-menu-search">
230236

231237
<div class="version">
232-
<a href='https://pytorch.org/docs/versions.html'>2.1 &#x25BC</a>
238+
<a href='https://pytorch.org/docs/versions.html'>master (2.1.0a0+gitbafa2c4 ) &#x25BC</a>
233239
</div>
234240

235241

@@ -249,6 +255,13 @@
249255

250256

251257

258+
<div>
259+
<a style="color:#F05732" href="https://pytorch.org/docs/stable/_modules/torch/_dynamo.html">
260+
You are viewing unstable developer preview docs.
261+
Click here to view docs for latest stable release.
262+
</a>
263+
</div>
264+
252265

253266

254267

docs/main/_modules/torch/_dynamo/backends/registry.html

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1212

13-
<title>torch._dynamo.backends.registry &mdash; PyTorch 2.1 documentation</title>
13+
<title>torch._dynamo.backends.registry &mdash; PyTorch master documentation</title>
1414

1515

1616

@@ -42,6 +42,12 @@
4242
<link rel="index" title="Index" href="../../../../genindex.html" />
4343
<link rel="search" title="Search" href="../../../../search.html" />
4444

45+
<!--
46+
Search engines should not index the master version of documentation.
47+
Stable documentation are built without release == 'master'.
48+
-->
49+
<meta name="robots" content="noindex">
50+
4551

4652
<!-- Google Analytics -->
4753

@@ -229,7 +235,7 @@
229235
<div class="pytorch-left-menu-search">
230236

231237
<div class="version">
232-
<a href='https://pytorch.org/docs/versions.html'>2.1 &#x25BC</a>
238+
<a href='https://pytorch.org/docs/versions.html'>master (2.1.0a0+gitbafa2c4 ) &#x25BC</a>
233239
</div>
234240

235241

@@ -249,6 +255,13 @@
249255

250256

251257

258+
<div>
259+
<a style="color:#F05732" href="https://pytorch.org/docs/stable/_modules/torch/_dynamo/backends/registry.html">
260+
You are viewing unstable developer preview docs.
261+
Click here to view docs for latest stable release.
262+
</a>
263+
</div>
264+
252265

253266

254267

0 commit comments

Comments
 (0)