auto-generating sphinx docs

Author: pytorchbot

docs/master/__config__.html

@@ -159,7 +159,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c0218bb &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+fc26830 &#x25BC</a>
                 </div>
 
 
@@ -226,6 +226,7 @@
 <li class="toctree-l1"><a class="reference internal" href="autograd.html">torch.autograd</a></li>
 <li class="toctree-l1"><a class="reference internal" href="cuda.html">torch.cuda</a></li>
 <li class="toctree-l1"><a class="reference internal" href="amp.html">torch.cuda.amp</a></li>
+<li class="toctree-l1"><a class="reference internal" href="backends.html">torch.backends</a></li>
 <li class="toctree-l1"><a class="reference internal" href="distributed.html">torch.distributed</a></li>
 <li class="toctree-l1"><a class="reference internal" href="distributions.html">torch.distributions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="fft.html">torch.fft</a></li>

docs/master/_modules/index.html

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c0218bb &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+fc26830 &#x25BC</a>
                 </div>
 
 
@@ -225,6 +225,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../autograd.html">torch.autograd</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../cuda.html">torch.cuda</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../amp.html">torch.cuda.amp</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../backends.html">torch.backends</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../distributed.html">torch.distributed</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../distributions.html">torch.distributions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../fft.html">torch.fft</a></li>
@@ -356,7 +357,12 @@ <h1>All modules for which code is available</h1>
 <li><a href="torch/autograd/grad_mode.html">torch.autograd.grad_mode</a></li>
 <li><a href="torch/autograd/gradcheck.html">torch.autograd.gradcheck</a></li>
 <li><a href="torch/autograd/profiler.html">torch.autograd.profiler</a></li>
-</ul><li><a href="torch/cuda.html">torch.cuda</a></li>
+</ul><li><a href="torch/backends/cuda.html">torch.backends.cuda</a></li>
+<li><a href="torch/backends/cudnn.html">torch.backends.cudnn</a></li>
+<li><a href="torch/backends/mkl.html">torch.backends.mkl</a></li>
+<li><a href="torch/backends/mkldnn.html">torch.backends.mkldnn</a></li>
+<li><a href="torch/backends/openmp.html">torch.backends.openmp</a></li>
+<li><a href="torch/cuda.html">torch.cuda</a></li>
 <ul><li><a href="torch/cuda/amp/autocast_mode.html">torch.cuda.amp.autocast_mode</a></li>
 <li><a href="torch/cuda/amp/grad_scaler.html">torch.cuda.amp.grad_scaler</a></li>
 <li><a href="torch/cuda/memory.html">torch.cuda.memory</a></li>

docs/master/_modules/torch.html

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c0218bb &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+fc26830 &#x25BC</a>
                 </div>
 
 
@@ -225,6 +225,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../autograd.html">torch.autograd</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../cuda.html">torch.cuda</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../amp.html">torch.cuda.amp</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../backends.html">torch.backends</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../distributed.html">torch.distributed</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../distributions.html">torch.distributions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../fft.html">torch.fft</a></li>

docs/master/_modules/torch/__config__.html

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c0218bb &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+fc26830 &#x25BC</a>
                 </div>
 
 
@@ -225,6 +225,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../autograd.html">torch.autograd</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../cuda.html">torch.cuda</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../amp.html">torch.cuda.amp</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../backends.html">torch.backends</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../distributed.html">torch.distributed</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../distributions.html">torch.distributions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../fft.html">torch.fft</a></li>

docs/master/_modules/torch/_jit_internal.html

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c0218bb &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+fc26830 &#x25BC</a>
                 </div>
 
 
@@ -225,6 +225,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../autograd.html">torch.autograd</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../cuda.html">torch.cuda</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../amp.html">torch.cuda.amp</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../backends.html">torch.backends</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../distributed.html">torch.distributed</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../distributions.html">torch.distributions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../fft.html">torch.fft</a></li>
@@ -971,6 +972,13 @@ <h1>Source code for torch._jit_internal</h1><div class="highlight"><pre>
 
 
 <span class="k">def</span> <span class="nf">is_tuple</span><span class="p">(</span><span class="n">ann</span><span class="p">):</span>
+    <span class="k">if</span> <span class="n">ann</span> <span class="ow">is</span> <span class="n">Tuple</span><span class="p">:</span>
+        <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span>
+            <span class="s2">&quot;Attempted to use Tuple without a &quot;</span>
+            <span class="s2">&quot;contained type. Please add a contained type, e.g. &quot;</span>
+            <span class="s2">&quot;Tuple[int]&quot;</span>
+        <span class="p">)</span>
+
     <span class="c1"># For some reason Python 3.7 violates the Type[A, B].__origin__ == Type rule</span>
     <span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">ann</span><span class="p">,</span> <span class="s1">&#39;__module__&#39;</span><span class="p">):</span>
         <span class="k">return</span> <span class="kc">False</span>
@@ -979,20 +987,41 @@ <h1>Source code for torch._jit_internal</h1><div class="highlight"><pre>
             <span class="nb">getattr</span><span class="p">(</span><span class="n">ann</span><span class="p">,</span> <span class="s1">&#39;__origin__&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">is</span> <span class="nb">tuple</span><span class="p">)</span>
 
 <span class="k">def</span> <span class="nf">is_list</span><span class="p">(</span><span class="n">ann</span><span class="p">):</span>
+    <span class="k">if</span> <span class="n">ann</span> <span class="ow">is</span> <span class="n">List</span><span class="p">:</span>
+        <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span>
+            <span class="s2">&quot;Attempted to use List without a &quot;</span>
+            <span class="s2">&quot;contained type. Please add a contained type, e.g. &quot;</span>
+            <span class="s2">&quot;List[int]&quot;</span>
+        <span class="p">)</span>
+
     <span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">ann</span><span class="p">,</span> <span class="s1">&#39;__module__&#39;</span><span class="p">):</span>
         <span class="k">return</span> <span class="kc">False</span>
     <span class="k">return</span> <span class="n">ann</span><span class="o">.</span><span class="vm">__module__</span> <span class="o">==</span> <span class="s1">&#39;typing&#39;</span> <span class="ow">and</span> \
         <span class="p">(</span><span class="nb">getattr</span><span class="p">(</span><span class="n">ann</span><span class="p">,</span> <span class="s1">&#39;__origin__&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">is</span> <span class="n">List</span> <span class="ow">or</span>
             <span class="nb">getattr</span><span class="p">(</span><span class="n">ann</span><span class="p">,</span> <span class="s1">&#39;__origin__&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">is</span> <span class="nb">list</span><span class="p">)</span>
 
 <span class="k">def</span> <span class="nf">is_dict</span><span class="p">(</span><span class="n">ann</span><span class="p">):</span>
+    <span class="k">if</span> <span class="n">ann</span> <span class="ow">is</span> <span class="n">Dict</span><span class="p">:</span>
+        <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span>
+            <span class="s2">&quot;Attempted to use Dict without &quot;</span>
+            <span class="s2">&quot;contained types. Please add contained type, e.g. &quot;</span>
+            <span class="s2">&quot;Dict[int, int]&quot;</span>
+        <span class="p">)</span>
+
     <span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">ann</span><span class="p">,</span> <span class="s1">&#39;__module__&#39;</span><span class="p">):</span>
         <span class="k">return</span> <span class="kc">False</span>
     <span class="k">return</span> <span class="n">ann</span><span class="o">.</span><span class="vm">__module__</span> <span class="o">==</span> <span class="s1">&#39;typing&#39;</span> <span class="ow">and</span> \
         <span class="p">(</span><span class="nb">getattr</span><span class="p">(</span><span class="n">ann</span><span class="p">,</span> <span class="s1">&#39;__origin__&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">is</span> <span class="n">Dict</span> <span class="ow">or</span>
             <span class="nb">getattr</span><span class="p">(</span><span class="n">ann</span><span class="p">,</span> <span class="s1">&#39;__origin__&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">is</span> <span class="nb">dict</span><span class="p">)</span>
 
 <span class="k">def</span> <span class="nf">is_optional</span><span class="p">(</span><span class="n">ann</span><span class="p">):</span>
+    <span class="k">if</span> <span class="n">ann</span> <span class="ow">is</span> <span class="n">Optional</span><span class="p">:</span>
+        <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span>
+            <span class="s2">&quot;Attempted to use Optional without a &quot;</span>
+            <span class="s2">&quot;contained type. Please add a contained type, e.g. &quot;</span>
+            <span class="s2">&quot;Optional[int]&quot;</span>
+        <span class="p">)</span>
+
     <span class="c1"># Optional[T] is just shorthand for Union[T, None], so check for both</span>
     <span class="k">def</span> <span class="nf">safe_is_subclass</span><span class="p">(</span><span class="n">the_type</span><span class="p">,</span> <span class="n">super_type</span><span class="p">):</span>
         <span class="c1"># Don&#39;t throw if `the_type` isn&#39;t a class type (e.g. if it is</span>

docs/master/_modules/torch/_lobpcg.html

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c0218bb &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+fc26830 &#x25BC</a>
                 </div>
 
 
@@ -225,6 +225,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../autograd.html">torch.autograd</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../cuda.html">torch.cuda</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../amp.html">torch.cuda.amp</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../backends.html">torch.backends</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../distributed.html">torch.distributed</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../distributions.html">torch.distributions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../fft.html">torch.fft</a></li>

docs/master/_modules/torch/_lowrank.html

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c0218bb &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+fc26830 &#x25BC</a>
                 </div>
 
 
@@ -225,6 +225,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../autograd.html">torch.autograd</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../cuda.html">torch.cuda</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../amp.html">torch.cuda.amp</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../backends.html">torch.backends</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../distributed.html">torch.distributed</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../distributions.html">torch.distributions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../fft.html">torch.fft</a></li>
@@ -426,7 +427,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
     <span class="k">return</span> <span class="n">Q</span>
 
 
-<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">q</span><span class="o">=</span><span class="mi">6</span><span class="p">,</span> <span class="n">niter</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">M</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+<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">q</span><span class="o">=</span><span class="mi">6</span><span class="p">,</span> <span class="n">niter</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">M</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
     <span class="c1"># type: (Tensor, Optional[int], Optional[int], Optional[Tensor]) -&gt; Tuple[Tensor, Tensor, Tensor]</span>
     <span class="sa">r</span><span class="sd">&quot;&quot;&quot;Return the singular value decomposition ``(U, S, V)`` of a matrix,</span>
 <span class="sd">    batches of matrices, or a sparse matrix :math:`A` such that</span>
@@ -471,7 +472,7 @@ <h1>Source code for torch._lowrank</h1><div class="highlight"><pre>
         <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>
         <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>
             <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>
-    <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>
+    <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>
 
 
 <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">q</span><span class="o">=</span><span class="mi">6</span><span class="p">,</span> <span class="n">niter</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">M</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>

docs/master/_modules/torch/_tensor_str.html

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c0218bb &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+fc26830 &#x25BC</a>
                 </div>
 
 
@@ -225,6 +225,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../autograd.html">torch.autograd</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../cuda.html">torch.cuda</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../amp.html">torch.cuda.amp</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../backends.html">torch.backends</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../distributed.html">torch.distributed</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../distributions.html">torch.distributions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../fft.html">torch.fft</a></li>