Generate Python docs from pytorch/pytorch@980fb94

Author: pytorchbot

docs/main/_images/RReLU.png

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>
 
 

docs/main/_modules/index.html

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>
 
 
@@ -2063,7 +2063,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">compiler_fn</span><span class="p">(</span><span class="n">model_</span><span class="p">,</span> <span class="n">inputs_</span><span class="p">,</span> <span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span><span class="p">)</span>
 
 
-<div class="viewcode-block" id="compile"><a class="viewcode-back" href="../compile/generated/torch.compile.html#torch.compile">[docs]</a><span class="k">def</span> <span class="nf">compile</span><span class="p">(</span><span class="n">model</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Callable</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span>
+<div class="viewcode-block" id="compile"><a class="viewcode-back" href="../generated/torch.compile.html#torch.compile">[docs]</a><span class="k">def</span> <span class="nf">compile</span><span class="p">(</span><span class="n">model</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Callable</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span>
             <span class="n">fullgraph</span><span class="p">:</span> <span class="n">builtins</span><span class="o">.</span><span class="n">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
             <span class="n">dynamic</span><span class="p">:</span> <span class="n">builtins</span><span class="o">.</span><span class="n">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
             <span class="n">backend</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Callable</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;inductor&quot;</span><span class="p">,</span>
@@ -2097,7 +2097,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
 <span class="sd">        - &quot;inductor&quot; is the default backend, which is a good balance between performance and overhead</span>
 <span class="sd">        - Non experimental in-tree backends can be seen with `torch._dynamo.list_backends()`</span>
 <span class="sd">        - Experimental or debug in-tree backends can be seen with `torch._dynamo.list_backends(None)`</span>
-<span class="sd">        - To register an out-of-tree custom backend: https://pytorch.org/docs/master/dynamo/custom-backends.html</span>
+<span class="sd">        - To register an out-of-tree custom backend: https://pytorch.org/docs/main/compile/custom-backends.html</span>
 <span class="sd">       mode (str): Can be either &quot;default&quot;, &quot;reduce-overhead&quot; or &quot;max-autotune&quot;</span>
 <span class="sd">        - &quot;default&quot; is the default mode, which is a good balance between performance and overhead</span>
 
@@ -2194,10 +2194,6 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
 <span class="kn">from</span> <span class="nn">torch.func</span> <span class="kn">import</span> <span class="n">vmap</span>
 
 
-<span class="c1"># ONNX must be imported after _dynamo, _ops, _subclasses, fx, func and jit</span>
-<span class="kn">from</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="n">onnx</span> <span class="k">as</span> <span class="n">onnx</span>  <span class="c1"># ONNX depends on a bunch of Dynamo stuff</span>
-
-
 <span class="c1"># The function _sparse_coo_tensor_unsafe is removed from PyTorch</span>
 <span class="c1"># Python API (v. 1.13), here we temporarily provide its replacement</span>
 <span class="c1"># with a deprecation warning.</span>
@@ -2240,6 +2236,8 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
 <span class="n">_lazy_modules</span> <span class="o">=</span> <span class="p">{</span>
     <span class="s2">&quot;_dynamo&quot;</span><span class="p">,</span>
     <span class="s2">&quot;_inductor&quot;</span><span class="p">,</span>
+    <span class="c1"># ONNX must be imported after _dynamo, _ops, _subclasses, fx, func and jit</span>
+    <span class="s2">&quot;onnx&quot;</span><span class="p">,</span>
 <span class="p">}</span>
 
 <span class="k">def</span> <span class="fm">__getattr__</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>

docs/main/_modules/torch.html

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>
 
 

docs/main/_modules/torch/__config__.html

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>
 
 

docs/main/_modules/torch/_jit_internal.html

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>
 
 

docs/main/_modules/torch/_lobpcg.html

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>
 
 
@@ -490,7 +490,6 @@ <h1>Source code for torch._logging._internal</h1><div class="highlight"><pre>
 <span class="n">log</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
 
 <span class="n">DEFAULT_LOG_LEVEL</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">WARN</span>
-<span class="n">DEFAULT_FORMAT</span> <span class="o">=</span> <span class="s2">&quot;[</span><span class="si">%(asctime)s</span><span class="s2">] </span><span class="si">%(name)s</span><span class="s2">: [</span><span class="si">%(levelname)s</span><span class="s2">] </span><span class="si">%(message)s</span><span class="s2">&quot;</span>
 <span class="n">LOG_ENV_VAR</span> <span class="o">=</span> <span class="s2">&quot;TORCH_LOGS&quot;</span>
 
 
@@ -784,6 +783,11 @@ <h1>Source code for torch._logging._internal</h1><div class="highlight"><pre>
                 <span class="n">val</span> <span class="o">=</span> <span class="n">default_level</span>
 
             <span class="k">if</span> <span class="n">log_registry</span><span class="o">.</span><span class="n">is_artifact</span><span class="p">(</span><span class="n">alias</span><span class="p">):</span>
+                <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="nb">bool</span><span class="p">):</span>
+                    <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
+                        <span class="sa">f</span><span class="s2">&quot;Expected bool to enable artifact </span><span class="si">{</span><span class="n">alias</span><span class="si">}</span><span class="s2">, received </span><span class="si">{</span><span class="n">val</span><span class="si">}</span><span class="s2">&quot;</span>
+                    <span class="p">)</span>
+
                 <span class="k">if</span> <span class="n">val</span><span class="p">:</span>
                     <span class="n">log_state</span><span class="o">.</span><span class="n">enable_artifact</span><span class="p">(</span><span class="n">alias</span><span class="p">)</span>
             <span class="k">elif</span> <span class="n">log_registry</span><span class="o">.</span><span class="n">is_log</span><span class="p">(</span><span class="n">alias</span><span class="p">)</span> <span class="ow">or</span> <span class="n">alias</span> <span class="ow">in</span> <span class="n">log_registry</span><span class="o">.</span><span class="n">child_log_qnames</span><span class="p">:</span>
@@ -1010,10 +1014,21 @@ <h1>Source code for torch._logging._internal</h1><div class="highlight"><pre>
             <span class="p">)</span>
             <span class="k">if</span> <span class="n">artifact_formatter</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
                 <span class="k">return</span> <span class="n">artifact_formatter</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">record</span><span class="p">)</span>
-        <span class="k">return</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">record</span><span class="p">)</span>
+
+        <span class="n">record</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="n">record</span><span class="o">.</span><span class="n">getMessage</span><span class="p">()</span>
+        <span class="n">record</span><span class="o">.</span><span class="n">asctime</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">formatTime</span><span class="p">(</span><span class="n">record</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">datefmt</span><span class="p">)</span>
+
+        <span class="n">lines</span> <span class="o">=</span> <span class="n">record</span><span class="o">.</span><span class="n">message</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">)</span>
+        <span class="n">record</span><span class="o">.</span><span class="n">rankprefix</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
+        <span class="k">if</span> <span class="n">dist</span><span class="o">.</span><span class="n">is_available</span><span class="p">()</span> <span class="ow">and</span> <span class="n">dist</span><span class="o">.</span><span class="n">is_initialized</span><span class="p">():</span>
+            <span class="n">record</span><span class="o">.</span><span class="n">rankprefix</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;[rank</span><span class="si">{</span><span class="n">dist</span><span class="o">.</span><span class="n">get_rank</span><span class="p">()</span><span class="si">}</span><span class="s2">]:&quot;</span>
+        <span class="n">prefix</span> <span class="o">=</span> <span class="p">(</span>
+            <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">record</span><span class="o">.</span><span class="n">rankprefix</span><span class="si">}</span><span class="s2">[</span><span class="si">{</span><span class="n">record</span><span class="o">.</span><span class="n">asctime</span><span class="si">}</span><span class="s2">] </span><span class="si">{</span><span class="n">record</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2">: [</span><span class="si">{</span><span class="n">record</span><span class="o">.</span><span class="n">levelname</span><span class="si">}</span><span class="s2">]&quot;</span>
+        <span class="p">)</span>
+        <span class="k">return</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">prefix</span><span class="si">}</span><span class="s2"> </span><span class="si">{</span><span class="n">l</span><span class="si">}</span><span class="s2">&quot;</span> <span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">lines</span><span class="p">)</span>
 
 
-<span class="n">DEFAULT_FORMATTER</span> <span class="o">=</span> <span class="n">TorchLogsFormatter</span><span class="p">(</span><span class="n">DEFAULT_FORMAT</span><span class="p">)</span>
+<span class="n">DEFAULT_FORMATTER</span> <span class="o">=</span> <span class="n">TorchLogsFormatter</span><span class="p">()</span>
 
 
 <span class="k">def</span> <span class="nf">_setup_handlers</span><span class="p">(</span><span class="n">create_handler_fn</span><span class="p">,</span> <span class="n">log</span><span class="p">):</span>
@@ -1108,6 +1123,9 @@ <h1>Source code for torch._logging._internal</h1><div class="highlight"><pre>
 <span class="sd">    another type of cache that includes the caller frame information in the hashing function.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">logger_obj</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
+
+
+<span class="kn">import</span> <span class="nn">torch.distributed</span> <span class="k">as</span> <span class="nn">dist</span>
 </pre></div>
 
              </article>

docs/main/_modules/torch/_logging/_internal.html

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>
 
 

docs/main/_modules/torch/_lowrank.html

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>
 
 

docs/main/_modules/torch/_tensor.html

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>
 
 

docs/main/_modules/torch/_tensor_str.html

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>
 
 

docs/main/_modules/torch/_utils.html

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>
 
 

docs/main/_modules/torch/amp/autocast_mode.html

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>
 
 

docs/main/_modules/torch/ao/nn/intrinsic/modules/fused.html

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>
 
 

docs/main/_modules/torch/ao/nn/intrinsic/qat/modules/conv_fused.html

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>
 
 

docs/main/_modules/torch/ao/nn/intrinsic/qat/modules/linear_relu.html

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>
 
 

docs/main/_modules/torch/ao/nn/intrinsic/quantized/dynamic/modules/linear_relu.html

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>
 
 

docs/main/_modules/torch/ao/nn/intrinsic/quantized/modules/bn_relu.html

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>
 
 

docs/main/_modules/torch/ao/nn/intrinsic/quantized/modules/conv_relu.html

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>
 
 

docs/main/_modules/torch/ao/nn/intrinsic/quantized/modules/linear_relu.html

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>
 
 

docs/main/_modules/torch/ao/nn/qat/dynamic/modules/linear.html

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>
 
 

docs/main/_modules/torch/ao/nn/qat/modules/conv.html

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>
 
 

docs/main/_modules/torch/ao/nn/qat/modules/linear.html

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>
 
 

docs/main/_modules/torch/ao/nn/quantizable/modules/activation.html

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>
 
 

docs/main/_modules/torch/ao/nn/quantizable/modules/rnn.html

@@ -230,7 +230,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+gite940d5d ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>main (2.1.0a0+git980fb94 ) &#x25BC</a>
     </div>