Skip to content

Commit d7d7ba2

Browse files
committed
Generate Python docs from pytorch/pytorch@7a93d8b
1 parent a4a0313 commit d7d7ba2

File tree

1,933 files changed

+7946
-2674
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,933 files changed

+7946
-2674
lines changed

docs/master/__config__.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@
208208
<div class="pytorch-left-menu-search">
209209

210210
<div class="version">
211-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git786f946 ) &#x25BC</a>
211+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git7a93d8b ) &#x25BC</a>
212212
</div>
213213

214214

@@ -290,6 +290,7 @@
290290
<li class="toctree-l1"><a class="reference internal" href="hub.html">torch.hub</a></li>
291291
<li class="toctree-l1"><a class="reference internal" href="jit.html">torch.jit</a></li>
292292
<li class="toctree-l1"><a class="reference internal" href="linalg.html">torch.linalg</a></li>
293+
<li class="toctree-l1"><a class="reference internal" href="monitor.html">torch.monitor</a></li>
293294
<li class="toctree-l1"><a class="reference internal" href="special.html">torch.special</a></li>
294295
<li class="toctree-l1"><a class="reference internal" href="torch.overrides.html">torch.overrides</a></li>
295296
<li class="toctree-l1"><a class="reference internal" href="package.html">torch.package</a></li>

docs/master/_images/RReLU.png

-19 Bytes
Loading

docs/master/_modules/index.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@
207207
<div class="pytorch-left-menu-search">
208208

209209
<div class="version">
210-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git786f946 ) &#x25BC</a>
210+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git7a93d8b ) &#x25BC</a>
211211
</div>
212212

213213

@@ -289,6 +289,7 @@
289289
<li class="toctree-l1"><a class="reference internal" href="../hub.html">torch.hub</a></li>
290290
<li class="toctree-l1"><a class="reference internal" href="../jit.html">torch.jit</a></li>
291291
<li class="toctree-l1"><a class="reference internal" href="../linalg.html">torch.linalg</a></li>
292+
<li class="toctree-l1"><a class="reference internal" href="../monitor.html">torch.monitor</a></li>
292293
<li class="toctree-l1"><a class="reference internal" href="../special.html">torch.special</a></li>
293294
<li class="toctree-l1"><a class="reference internal" href="../torch.overrides.html">torch.overrides</a></li>
294295
<li class="toctree-l1"><a class="reference internal" href="../package.html">torch.package</a></li>
@@ -410,6 +411,7 @@ <h1>All modules for which code is available</h1>
410411
<li><a href="torch/_C/_distributed_rpc.html">torch._C._distributed_rpc</a></li>
411412
<li><a href="torch/_C/_fft.html">torch._C._fft</a></li>
412413
<li><a href="torch/_C/_linalg.html">torch._C._linalg</a></li>
414+
<li><a href="torch/_C/_monitor.html">torch._C._monitor</a></li>
413415
<li><a href="torch/_C/_nn.html">torch._C._nn</a></li>
414416
<li><a href="torch/_C/_sparse.html">torch._C._sparse</a></li>
415417
<li><a href="torch/_C/_special.html">torch._C._special</a></li>

docs/master/_modules/torch.html

Lines changed: 50 additions & 49 deletions
Large diffs are not rendered by default.

docs/master/_modules/torch/__config__.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@
207207
<div class="pytorch-left-menu-search">
208208

209209
<div class="version">
210-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git786f946 ) &#x25BC</a>
210+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git7a93d8b ) &#x25BC</a>
211211
</div>
212212

213213

@@ -289,6 +289,7 @@
289289
<li class="toctree-l1"><a class="reference internal" href="../../hub.html">torch.hub</a></li>
290290
<li class="toctree-l1"><a class="reference internal" href="../../jit.html">torch.jit</a></li>
291291
<li class="toctree-l1"><a class="reference internal" href="../../linalg.html">torch.linalg</a></li>
292+
<li class="toctree-l1"><a class="reference internal" href="../../monitor.html">torch.monitor</a></li>
292293
<li class="toctree-l1"><a class="reference internal" href="../../special.html">torch.special</a></li>
293294
<li class="toctree-l1"><a class="reference internal" href="../../torch.overrides.html">torch.overrides</a></li>
294295
<li class="toctree-l1"><a class="reference internal" href="../../package.html">torch.package</a></li>

docs/master/_modules/torch/_jit_internal.html

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@
207207
<div class="pytorch-left-menu-search">
208208

209209
<div class="version">
210-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git786f946 ) &#x25BC</a>
210+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git7a93d8b ) &#x25BC</a>
211211
</div>
212212

213213

@@ -289,6 +289,7 @@
289289
<li class="toctree-l1"><a class="reference internal" href="../../hub.html">torch.hub</a></li>
290290
<li class="toctree-l1"><a class="reference internal" href="../../jit.html">torch.jit</a></li>
291291
<li class="toctree-l1"><a class="reference internal" href="../../linalg.html">torch.linalg</a></li>
292+
<li class="toctree-l1"><a class="reference internal" href="../../monitor.html">torch.monitor</a></li>
292293
<li class="toctree-l1"><a class="reference internal" href="../../special.html">torch.special</a></li>
293294
<li class="toctree-l1"><a class="reference internal" href="../../torch.overrides.html">torch.overrides</a></li>
294295
<li class="toctree-l1"><a class="reference internal" href="../../package.html">torch.package</a></li>
@@ -870,7 +871,7 @@ <h1>Source code for torch._jit_internal</h1><div class="highlight"><pre>
870871
<span class="s2">&quot;if this method is not scripted, copy the python method onto the scripted model&quot;</span>
871872

872873

873-
<span class="k">def</span> <span class="nf">export</span><span class="p">(</span><span class="n">fn</span><span class="p">):</span>
874+
<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>
874875
<span class="sd">&quot;&quot;&quot;</span>
875876
<span class="sd"> This decorator indicates that a method on an ``nn.Module`` is used as an entry point into a</span>
876877
<span class="sd"> :class:`ScriptModule` and should be compiled.</span>
@@ -913,7 +914,7 @@ <h1>Source code for torch._jit_internal</h1><div class="highlight"><pre>
913914
<span class="sd"> m = torch.jit.script(MyModule())</span>
914915
<span class="sd"> &quot;&quot;&quot;</span>
915916
<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>
916-
<span class="k">return</span> <span class="n">fn</span>
917+
<span class="k">return</span> <span class="n">fn</span></div>
917918

918919

919920
<span class="k">def</span> <span class="nf">unused</span><span class="p">(</span><span class="n">fn</span><span class="p">):</span>

docs/master/_modules/torch/_lobpcg.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@
207207
<div class="pytorch-left-menu-search">
208208

209209
<div class="version">
210-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git786f946 ) &#x25BC</a>
210+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git7a93d8b ) &#x25BC</a>
211211
</div>
212212

213213

@@ -289,6 +289,7 @@
289289
<li class="toctree-l1"><a class="reference internal" href="../../hub.html">torch.hub</a></li>
290290
<li class="toctree-l1"><a class="reference internal" href="../../jit.html">torch.jit</a></li>
291291
<li class="toctree-l1"><a class="reference internal" href="../../linalg.html">torch.linalg</a></li>
292+
<li class="toctree-l1"><a class="reference internal" href="../../monitor.html">torch.monitor</a></li>
292293
<li class="toctree-l1"><a class="reference internal" href="../../special.html">torch.special</a></li>
293294
<li class="toctree-l1"><a class="reference internal" href="../../torch.overrides.html">torch.overrides</a></li>
294295
<li class="toctree-l1"><a class="reference internal" href="../../package.html">torch.package</a></li>

docs/master/_modules/torch/_lowrank.html

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@
207207
<div class="pytorch-left-menu-search">
208208

209209
<div class="version">
210-
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git786f946 ) &#x25BC</a>
210+
<a href='https://pytorch.org/docs/versions.html'>master (1.11.0a0+git7a93d8b ) &#x25BC</a>
211211
</div>
212212

213213

@@ -289,6 +289,7 @@
289289
<li class="toctree-l1"><a class="reference internal" href="../../hub.html">torch.hub</a></li>
290290
<li class="toctree-l1"><a class="reference internal" href="../../jit.html">torch.jit</a></li>
291291
<li class="toctree-l1"><a class="reference internal" href="../../linalg.html">torch.linalg</a></li>
292+
<li class="toctree-l1"><a class="reference internal" href="../../monitor.html">torch.monitor</a></li>
292293
<li class="toctree-l1"><a class="reference internal" href="../../special.html">torch.special</a></li>
293294
<li class="toctree-l1"><a class="reference internal" href="../../torch.overrides.html">torch.overrides</a></li>
294295
<li class="toctree-l1"><a class="reference internal" href="../../package.html">torch.package</a></li>
@@ -490,7 +491,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
490491
<span class="k">return</span> <span class="n">Q</span>
491492

492493

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>
494+
<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>
494495
<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>
495496
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Return the singular value decomposition ``(U, S, V)`` of a matrix,</span>
496497
<span class="sd"> batches of matrices, or a sparse matrix :math:`A` such that</span>
@@ -535,7 +536,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
535536
<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>
536537
<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>
537538
<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>
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>
539+
<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>
539540

540541

541542
<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>
@@ -585,7 +586,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
585586
<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>
586587

587588

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>
589+
<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>
589590
<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>
590591
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Performs linear Principal Component Analysis (PCA) on a low-rank</span>
591592
<span class="sd"> matrix, batches of such matrices, or sparse matrix.</span>
@@ -686,7 +687,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
686687
<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>
687688
<span class="k">else</span><span class="p">:</span>
688689
<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>
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>
690+
<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>
690691
</pre></div>
691692

692693
</article>

0 commit comments

Comments
 (0)