Skip to content

Commit 0bb5c49

Browse files
committed
Generate Python docs from pytorch/pytorch@3a21f38
1 parent 61beb09 commit 0bb5c49

File tree

1,921 files changed

+28964
-2237
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,921 files changed

+28964
-2237
lines changed

docs/master/__config__.html

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,20 @@
4646
<meta name="robots" content="noindex">
4747

4848

49+
<!-- Google Analytics -->
50+
51+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-117752657-2"></script>
52+
<script>
53+
window.dataLayer = window.dataLayer || [];
54+
function gtag(){dataLayer.push(arguments);}
55+
gtag('js', new Date());
56+
57+
gtag('config', 'UA-117752657-2');
58+
</script>
59+
60+
<!-- End Google Analytics -->
61+
62+
4963

5064

5165
<script src="_static/js/modernizr.min.js"></script>
@@ -194,7 +208,7 @@
194208
<div class="pytorch-left-menu-search">
195209

196210
<div class="version">
197-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitf8f96d4 ) &#x25BC</a>
211+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git3a21f38 ) &#x25BC</a>
198212
</div>
199213

200214

docs/master/_images/RReLU.png

414 Bytes
Loading

docs/master/_modules/index.html

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,20 @@
4545
<meta name="robots" content="noindex">
4646

4747

48+
<!-- Google Analytics -->
49+
50+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-117752657-2"></script>
51+
<script>
52+
window.dataLayer = window.dataLayer || [];
53+
function gtag(){dataLayer.push(arguments);}
54+
gtag('js', new Date());
55+
56+
gtag('config', 'UA-117752657-2');
57+
</script>
58+
59+
<!-- End Google Analytics -->
60+
61+
4862

4963

5064
<script src="../_static/js/modernizr.min.js"></script>
@@ -193,7 +207,7 @@
193207
<div class="pytorch-left-menu-search">
194208

195209
<div class="version">
196-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitf8f96d4 ) &#x25BC</a>
210+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git3a21f38 ) &#x25BC</a>
197211
</div>
198212

199213

docs/master/_modules/torch.html

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,20 @@
4545
<meta name="robots" content="noindex">
4646

4747

48+
<!-- Google Analytics -->
49+
50+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-117752657-2"></script>
51+
<script>
52+
window.dataLayer = window.dataLayer || [];
53+
function gtag(){dataLayer.push(arguments);}
54+
gtag('js', new Date());
55+
56+
gtag('config', 'UA-117752657-2');
57+
</script>
58+
59+
<!-- End Google Analytics -->
60+
61+
4862

4963

5064
<script src="../_static/js/modernizr.min.js"></script>
@@ -193,7 +207,7 @@
193207
<div class="pytorch-left-menu-search">
194208

195209
<div class="version">
196-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitf8f96d4 ) &#x25BC</a>
210+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git3a21f38 ) &#x25BC</a>
197211
</div>
198212

199213

docs/master/_modules/torch/__config__.html

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,20 @@
4545
<meta name="robots" content="noindex">
4646

4747

48+
<!-- Google Analytics -->
49+
50+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-117752657-2"></script>
51+
<script>
52+
window.dataLayer = window.dataLayer || [];
53+
function gtag(){dataLayer.push(arguments);}
54+
gtag('js', new Date());
55+
56+
gtag('config', 'UA-117752657-2');
57+
</script>
58+
59+
<!-- End Google Analytics -->
60+
61+
4862

4963

5064
<script src="../../_static/js/modernizr.min.js"></script>
@@ -193,7 +207,7 @@
193207
<div class="pytorch-left-menu-search">
194208

195209
<div class="version">
196-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitf8f96d4 ) &#x25BC</a>
210+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git3a21f38 ) &#x25BC</a>
197211
</div>
198212

199213

docs/master/_modules/torch/_jit_internal.html

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,20 @@
4545
<meta name="robots" content="noindex">
4646

4747

48+
<!-- Google Analytics -->
49+
50+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-117752657-2"></script>
51+
<script>
52+
window.dataLayer = window.dataLayer || [];
53+
function gtag(){dataLayer.push(arguments);}
54+
gtag('js', new Date());
55+
56+
gtag('config', 'UA-117752657-2');
57+
</script>
58+
59+
<!-- End Google Analytics -->
60+
61+
4862

4963

5064
<script src="../../_static/js/modernizr.min.js"></script>
@@ -193,7 +207,7 @@
193207
<div class="pytorch-left-menu-search">
194208

195209
<div class="version">
196-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitf8f96d4 ) &#x25BC</a>
210+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git3a21f38 ) &#x25BC</a>
197211
</div>
198212

199213

docs/master/_modules/torch/_lobpcg.html

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,20 @@
4545
<meta name="robots" content="noindex">
4646

4747

48+
<!-- Google Analytics -->
49+
50+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-117752657-2"></script>
51+
<script>
52+
window.dataLayer = window.dataLayer || [];
53+
function gtag(){dataLayer.push(arguments);}
54+
gtag('js', new Date());
55+
56+
gtag('config', 'UA-117752657-2');
57+
</script>
58+
59+
<!-- End Google Analytics -->
60+
61+
4862

4963

5064
<script src="../../_static/js/modernizr.min.js"></script>
@@ -193,7 +207,7 @@
193207
<div class="pytorch-left-menu-search">
194208

195209
<div class="version">
196-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitf8f96d4 ) &#x25BC</a>
210+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git3a21f38 ) &#x25BC</a>
197211
</div>
198212

199213

docs/master/_modules/torch/_lowrank.html

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,20 @@
4545
<meta name="robots" content="noindex">
4646

4747

48+
<!-- Google Analytics -->
49+
50+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-117752657-2"></script>
51+
<script>
52+
window.dataLayer = window.dataLayer || [];
53+
function gtag(){dataLayer.push(arguments);}
54+
gtag('js', new Date());
55+
56+
gtag('config', 'UA-117752657-2');
57+
</script>
58+
59+
<!-- End Google Analytics -->
60+
61+
4862

4963

5064
<script src="../../_static/js/modernizr.min.js"></script>
@@ -193,7 +207,7 @@
193207
<div class="pytorch-left-menu-search">
194208

195209
<div class="version">
196-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitf8f96d4 ) &#x25BC</a>
210+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git3a21f38 ) &#x25BC</a>
197211
</div>
198212

199213

@@ -476,7 +490,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
476490
<span class="k">return</span> <span class="n">Q</span>
477491

478492

479-
<span class="k">def</span> <span class="nf">svd_lowrank</span><span class="p">(</span><span class="n">A</span><span class="p">:</span> <span class="n">Tensor</span><span class="p">,</span> <span class="n">q</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="mi">6</span><span class="p">,</span> <span class="n">niter</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="mi">2</span><span class="p">,</span>
493+
<div class="viewcode-block" id="svd_lowrank"><a class="viewcode-back" href="../../generated/torch.svd_lowrank.html#torch.svd_lowrank">[docs]</a><span class="k">def</span> <span class="nf">svd_lowrank</span><span class="p">(</span><span class="n">A</span><span class="p">:</span> <span class="n">Tensor</span><span class="p">,</span> <span class="n">q</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="mi">6</span><span class="p">,</span> <span class="n">niter</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="mi">2</span><span class="p">,</span>
480494
<span class="n">M</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Tensor</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">Tensor</span><span class="p">,</span> <span class="n">Tensor</span><span class="p">,</span> <span class="n">Tensor</span><span class="p">]:</span>
481495
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Return the singular value decomposition ``(U, S, V)`` of a matrix,</span>
482496
<span class="sd"> batches of matrices, or a sparse matrix :math:`A` such that</span>
@@ -521,7 +535,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
521535
<span class="n">tensor_ops</span> <span class="o">=</span> <span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">M</span><span class="p">)</span>
522536
<span class="k">if</span> <span class="p">(</span><span class="ow">not</span> <span class="nb">set</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">type</span><span class="p">,</span> <span class="n">tensor_ops</span><span class="p">))</span><span class="o">.</span><span class="n">issubset</span><span class="p">((</span><span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="kc">None</span><span class="p">)))</span> <span class="ow">and</span> <span class="n">has_torch_function</span><span class="p">(</span><span class="n">tensor_ops</span><span class="p">)):</span>
523537
<span class="k">return</span> <span class="n">handle_torch_function</span><span class="p">(</span><span class="n">svd_lowrank</span><span class="p">,</span> <span class="n">tensor_ops</span><span class="p">,</span> <span class="n">A</span><span class="p">,</span> <span class="n">q</span><span class="o">=</span><span class="n">q</span><span class="p">,</span> <span class="n">niter</span><span class="o">=</span><span class="n">niter</span><span class="p">,</span> <span class="n">M</span><span class="o">=</span><span class="n">M</span><span class="p">)</span>
524-
<span class="k">return</span> <span class="n">_svd_lowrank</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">q</span><span class="o">=</span><span class="n">q</span><span class="p">,</span> <span class="n">niter</span><span class="o">=</span><span class="n">niter</span><span class="p">,</span> <span class="n">M</span><span class="o">=</span><span class="n">M</span><span class="p">)</span>
538+
<span class="k">return</span> <span class="n">_svd_lowrank</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">q</span><span class="o">=</span><span class="n">q</span><span class="p">,</span> <span class="n">niter</span><span class="o">=</span><span class="n">niter</span><span class="p">,</span> <span class="n">M</span><span class="o">=</span><span class="n">M</span><span class="p">)</span></div>
525539

526540

527541
<span class="k">def</span> <span class="nf">_svd_lowrank</span><span class="p">(</span><span class="n">A</span><span class="p">:</span> <span class="n">Tensor</span><span class="p">,</span> <span class="n">q</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="mi">6</span><span class="p">,</span> <span class="n">niter</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="mi">2</span><span class="p">,</span>
@@ -571,7 +585,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
571585
<span class="k">return</span> <span class="n">U</span><span class="p">,</span> <span class="n">S</span><span class="p">,</span> <span class="n">V</span>
572586

573587

574-
<div class="viewcode-block" id="pca_lowrank"><a class="viewcode-back" href="../../generated/torch.pca_lowrank.html#torch.pca_lowrank">[docs]</a><span class="k">def</span> <span class="nf">pca_lowrank</span><span class="p">(</span><span class="n">A</span><span class="p">:</span> <span class="n">Tensor</span><span class="p">,</span> <span class="n">q</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><span class="p">,</span> <span class="n">center</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
588+
<span class="k">def</span> <span class="nf">pca_lowrank</span><span class="p">(</span><span class="n">A</span><span class="p">:</span> <span class="n">Tensor</span><span class="p">,</span> <span class="n">q</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><span class="p">,</span> <span class="n">center</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
575589
<span class="n">niter</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">2</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">Tensor</span><span class="p">,</span> <span class="n">Tensor</span><span class="p">,</span> <span class="n">Tensor</span><span class="p">]:</span>
576590
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Performs linear Principal Component Analysis (PCA) on a low-rank</span>
577591
<span class="sd"> matrix, batches of such matrices, or sparse matrix.</span>
@@ -672,7 +686,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
672686
<span class="k">return</span> <span class="n">_svd_lowrank</span><span class="p">(</span><span class="n">A</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">niter</span><span class="o">=</span><span class="n">niter</span><span class="p">,</span> <span class="n">M</span><span class="o">=</span><span class="n">M</span><span class="p">)</span>
673687
<span class="k">else</span><span class="p">:</span>
674688
<span class="n">C</span> <span class="o">=</span> <span class="n">A</span><span class="o">.</span><span class="n">mean</span><span class="p">(</span><span class="n">dim</span><span class="o">=</span><span class="p">(</span><span class="o">-</span><span class="mi">2</span><span class="p">,),</span> <span class="n">keepdim</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
675-
<span class="k">return</span> <span class="n">_svd_lowrank</span><span class="p">(</span><span class="n">A</span> <span class="o">-</span> <span class="n">C</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">niter</span><span class="o">=</span><span class="n">niter</span><span class="p">,</span> <span class="n">M</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></div>
689+
<span class="k">return</span> <span class="n">_svd_lowrank</span><span class="p">(</span><span class="n">A</span> <span class="o">-</span> <span class="n">C</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">niter</span><span class="o">=</span><span class="n">niter</span><span class="p">,</span> <span class="n">M</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
676690
</pre></div>
677691

678692
</article>

docs/master/_modules/torch/_tensor.html

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,20 @@
4545
<meta name="robots" content="noindex">
4646

4747

48+
<!-- Google Analytics -->
49+
50+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-117752657-2"></script>
51+
<script>
52+
window.dataLayer = window.dataLayer || [];
53+
function gtag(){dataLayer.push(arguments);}
54+
gtag('js', new Date());
55+
56+
gtag('config', 'UA-117752657-2');
57+
</script>
58+
59+
<!-- End Google Analytics -->
60+
61+
4862

4963

5064
<script src="../../_static/js/modernizr.min.js"></script>
@@ -193,7 +207,7 @@
193207
<div class="pytorch-left-menu-search">
194208

195209
<div class="version">
196-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+gitf8f96d4 ) &#x25BC</a>
210+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git3a21f38 ) &#x25BC</a>
197211
</div>
198212

199213

@@ -687,7 +701,7 @@ <h1>Source code for torch._tensor</h1><div class="highlight"><pre>
687701
<span class="c1"># All strings are unicode in Python 3.</span>
688702
<span class="k">return</span> <span class="n">torch</span><span class="o">.</span><span class="n">_tensor_str</span><span class="o">.</span><span class="n">_str</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
689703

690-
<div class="viewcode-block" id="Tensor.backward"><a class="viewcode-back" href="../../generated/torch.Tensor.backward.html#torch.Tensor.backward">[docs]</a> <span class="k">def</span> <span class="nf">backward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">gradient</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">retain_graph</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">create_graph</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">inputs</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
704+
<span class="k">def</span> <span class="nf">backward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">gradient</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">retain_graph</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">create_graph</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">inputs</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
691705
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Computes the gradient of current tensor w.r.t. graph leaves.</span>
692706

693707
<span class="sd"> The graph is differentiated using the chain rule. If the tensor is</span>
@@ -743,7 +757,7 @@ <h1>Source code for torch._tensor</h1><div class="highlight"><pre>
743757
<span class="n">retain_graph</span><span class="o">=</span><span class="n">retain_graph</span><span class="p">,</span>
744758
<span class="n">create_graph</span><span class="o">=</span><span class="n">create_graph</span><span class="p">,</span>
745759
<span class="n">inputs</span><span class="o">=</span><span class="n">inputs</span><span class="p">)</span>
746-
<span class="n">torch</span><span class="o">.</span><span class="n">autograd</span><span class="o">.</span><span class="n">backward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">gradient</span><span class="p">,</span> <span class="n">retain_graph</span><span class="p">,</span> <span class="n">create_graph</span><span class="p">,</span> <span class="n">inputs</span><span class="o">=</span><span class="n">inputs</span><span class="p">)</span></div>
760+
<span class="n">torch</span><span class="o">.</span><span class="n">autograd</span><span class="o">.</span><span class="n">backward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">gradient</span><span class="p">,</span> <span class="n">retain_graph</span><span class="p">,</span> <span class="n">create_graph</span><span class="p">,</span> <span class="n">inputs</span><span class="o">=</span><span class="n">inputs</span><span class="p">)</span>
747761

748762
<span class="k">def</span> <span class="nf">register_hook</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">hook</span><span class="p">):</span>
749763
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Registers a backward hook.</span>

0 commit comments

Comments
 (0)