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+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 

docs/master/_modules/index.html

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 

docs/master/_modules/torch.html

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 
@@ -355,6 +355,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
 <span class="kn">import</span> <span class="nn">os</span>
 <span class="kn">import</span> <span class="nn">sys</span>
 <span class="kn">import</span> <span class="nn">platform</span>
+<span class="kn">import</span> <span class="nn">textwrap</span>
 <span class="kn">import</span> <span class="nn">ctypes</span>
 
 <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span> <span class="o">&lt;</span> <span class="p">(</span><span class="mi">3</span><span class="p">,):</span>
@@ -536,6 +537,31 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
 <span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
     <span class="kn">import</span> <span class="nn">torch._C</span> <span class="k">as</span> <span class="nn">_C</span>
 
+<span class="c1"># Check to see if we can load C extensions, and if not provide some guidance</span>
+<span class="c1"># on what the problem might be.</span>
+<span class="k">try</span><span class="p">:</span>
+    <span class="c1"># _initExtension is chosen (arbitrarily) as a sentinel.</span>
+    <span class="kn">from</span> <span class="nn">torch._C</span> <span class="kn">import</span> <span class="n">_initExtension</span>
+<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
+    <span class="kn">import</span> <span class="nn">torch._C</span> <span class="k">as</span> <span class="nn">_C_for_compiled_check</span>
+
+    <span class="c1"># The __file__ check only works for Python 3.7 and above.</span>
+    <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span> <span class="o">&gt;=</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">7</span><span class="p">)</span> <span class="ow">and</span> <span class="n">_C_for_compiled_check</span><span class="o">.</span><span class="vm">__file__</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+        <span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span><span class="n">textwrap</span><span class="o">.</span><span class="n">dedent</span><span class="p">(</span><span class="s1">&#39;&#39;&#39;</span>
+<span class="s1">            Failed to load PyTorch C extensions:</span>
+<span class="s1">                It appears that PyTorch has loaded the `torch/_C` folder</span>
+<span class="s1">                of the PyTorch repository rather than the C extensions which</span>
+<span class="s1">                are expected in the `torch._C` namespace. This can occur when</span>
+<span class="s1">                using the `install` workflow. e.g.</span>
+<span class="s1">                    $ python setup.py install &amp;&amp; python -c &quot;import torch&quot;</span>
+
+<span class="s1">                This error can generally be solved using the `develop` workflow</span>
+<span class="s1">                    $ python setup.py develop &amp;&amp; python -c &quot;import torch&quot;  # This should succeed</span>
+<span class="s1">                or by running Python from a different directory.</span>
+<span class="s1">            &#39;&#39;&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span> <span class="kn">from</span> <span class="bp">None</span>
+    <span class="k">raise</span>  <span class="c1"># If __file__ is not None the cause is unknown, so just re-raise.</span>
+
+
 <span class="n">__all__</span> <span class="o">+=</span> <span class="p">[</span><span class="n">name</span> <span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">_C</span><span class="p">)</span>
             <span class="k">if</span> <span class="n">name</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">&#39;_&#39;</span> <span class="ow">and</span>
             <span class="ow">not</span> <span class="n">name</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">&#39;Base&#39;</span><span class="p">)]</span>
@@ -732,8 +758,8 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
     <span class="k">pass</span>
 
 
-<span class="k">class</span> <span class="nc">FloatStorage</span><span class="p">(</span><span class="n">_C</span><span class="o">.</span><span class="n">FloatStorageBase</span><span class="p">,</span> <span class="n">_StorageBase</span><span class="p">):</span>
-    <span class="k">pass</span>
+<div class="viewcode-block" id="FloatStorage"><a class="viewcode-back" href="../storage.html#torch.FloatStorage">[docs]</a><span class="k">class</span> <span class="nc">FloatStorage</span><span class="p">(</span><span class="n">_C</span><span class="o">.</span><span class="n">FloatStorageBase</span><span class="p">,</span> <span class="n">_StorageBase</span><span class="p">):</span>
+    <span class="k">pass</span></div>
 
 
 <span class="k">class</span> <span class="nc">HalfStorage</span><span class="p">(</span><span class="n">_C</span><span class="o">.</span><span class="n">HalfStorageBase</span><span class="p">,</span> <span class="n">_StorageBase</span><span class="p">):</span>
@@ -820,9 +846,9 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
 <span class="c1"># is not a good way to fix this problem.  Perhaps, try to redesign VariableFunctions</span>
 <span class="c1"># so that this import is good enough</span>
 <span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
-    <span class="c1"># Some type signatures pulled in from _VariableFunctions here clash with </span>
+    <span class="c1"># Some type signatures pulled in from _VariableFunctions here clash with</span>
     <span class="c1"># signatures already imported. For now these clashes are ignored; see</span>
-    <span class="c1"># PR #43339 for details.  </span>
+    <span class="c1"># PR #43339 for details.</span>
     <span class="kn">from</span> <span class="nn">torch._C._VariableFunctions</span> <span class="kn">import</span> <span class="o">*</span>  <span class="c1"># type: ignore</span>
 
 <span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">_C</span><span class="o">.</span><span class="n">_VariableFunctions</span><span class="p">):</span>

docs/master/_modules/torch/__config__.html

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 

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+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 

docs/master/_modules/torch/_lobpcg.html

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 

docs/master/_modules/torch/_lowrank.html

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 

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+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 

docs/master/_modules/torch/_utils.html

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 

docs/master/_modules/torch/_vmap_internals.html

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 

docs/master/_modules/torch/autograd.html

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 

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

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 

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

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 

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

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 

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

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 
@@ -394,7 +394,7 @@ <h1>Source code for torch.autograd.grad_mode</h1><div class="highlight"><pre>
         <span class="k">raise</span> <span class="ne">NotImplementedError</span>
 
 
-<div class="viewcode-block" id="no_grad"><a class="viewcode-back" href="../../../autograd.html#torch.autograd.no_grad">[docs]</a><span class="k">class</span> <span class="nc">no_grad</span><span class="p">(</span><span class="n">_DecoratorContextManager</span><span class="p">):</span>
+<span class="k">class</span> <span class="nc">no_grad</span><span class="p">(</span><span class="n">_DecoratorContextManager</span><span class="p">):</span>
     <span class="sa">r</span><span class="sd">&quot;&quot;&quot;Context-manager that disabled gradient calculation.</span>
 
 <span class="sd">    Disabling gradient calculation is useful for inference, when you are sure</span>
@@ -434,10 +434,10 @@ <h1>Source code for torch.autograd.grad_mode</h1><div class="highlight"><pre>
         <span class="n">torch</span><span class="o">.</span><span class="n">set_grad_enabled</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
 
     <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">Any</span><span class="p">,</span> <span class="n">exc_value</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="n">traceback</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
-        <span class="n">torch</span><span class="o">.</span><span class="n">set_grad_enabled</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">prev</span><span class="p">)</span></div>
+        <span class="n">torch</span><span class="o">.</span><span class="n">set_grad_enabled</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">prev</span><span class="p">)</span>
 
 
-<div class="viewcode-block" id="enable_grad"><a class="viewcode-back" href="../../../autograd.html#torch.autograd.enable_grad">[docs]</a><span class="k">class</span> <span class="nc">enable_grad</span><span class="p">(</span><span class="n">_DecoratorContextManager</span><span class="p">):</span>
+<div class="viewcode-block" id="enable_grad"><a class="viewcode-back" href="../../../generated/torch.enable_grad.html#torch.enable_grad">[docs]</a><span class="k">class</span> <span class="nc">enable_grad</span><span class="p">(</span><span class="n">_DecoratorContextManager</span><span class="p">):</span>
     <span class="sa">r</span><span class="sd">&quot;&quot;&quot;Context-manager that enables gradient calculation.</span>
 
 <span class="sd">    Enables gradient calculation, if it has been disabled via :class:`~no_grad`</span>
@@ -476,7 +476,7 @@ <h1>Source code for torch.autograd.grad_mode</h1><div class="highlight"><pre>
         <span class="n">torch</span><span class="o">.</span><span class="n">_C</span><span class="o">.</span><span class="n">_set_grad_enabled</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">prev</span><span class="p">)</span></div>
 
 
-<div class="viewcode-block" id="set_grad_enabled"><a class="viewcode-back" href="../../../autograd.html#torch.autograd.set_grad_enabled">[docs]</a><span class="k">class</span> <span class="nc">set_grad_enabled</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+<span class="k">class</span> <span class="nc">set_grad_enabled</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
     <span class="sa">r</span><span class="sd">&quot;&quot;&quot;Context-manager that sets gradient calculation to on or off.</span>
 
 <span class="sd">    ``set_grad_enabled`` will enable or disable grads based on its argument :attr:`mode`.</span>
@@ -518,7 +518,7 @@ <h1>Source code for torch.autograd.grad_mode</h1><div class="highlight"><pre>
         <span class="k">pass</span>
 
     <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">Any</span><span class="p">,</span> <span class="n">exc_value</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="n">traceback</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
-        <span class="n">torch</span><span class="o">.</span><span class="n">_C</span><span class="o">.</span><span class="n">_set_grad_enabled</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">prev</span><span class="p">)</span></div>
+        <span class="n">torch</span><span class="o">.</span><span class="n">_C</span><span class="o">.</span><span class="n">_set_grad_enabled</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">prev</span><span class="p">)</span>
 </pre></div>
 
              </article>

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

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 

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

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 

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

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 

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

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 

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

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 

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

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 

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

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 

docs/master/_modules/torch/cuda.html

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 

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

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>
 
 

docs/master/_modules/torch/cuda/amp/grad_scaler.html

@@ -158,7 +158,7 @@
 
 
                 <div class="version">
-                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+c438a74 &#x25BC</a>
+                  <a href='http://pytorch.org/docs/versions.html'>1.7.0a0+e9e73ea &#x25BC</a>
                 </div>