Generate Python docs from pytorch/pytorch@9dbfca7

Author: pytorchbot

docs/master/_dynamo.html

@@ -237,7 +237,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>master (2.0.0a0+gitbb347dc ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>master (2.0.0a0+git9dbfca7 ) &#x25BC</a>
     </div>
 
 
@@ -514,12 +514,45 @@
 single <cite>torch.add()</cite> op.</p>
 </dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="torch._dynamo.forbid_in_graph">
+<span class="sig-prename descclassname"><span class="pre">torch._dynamo.</span></span><span class="sig-name descname"><span class="pre">forbid_in_graph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fn</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/torch/_dynamo.html#forbid_in_graph"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#torch._dynamo.forbid_in_graph" title="Permalink to this definition">¶</a></dt>
+<dd><p>Customize which functions TorchDynamo will assert are not present while tracing.</p>
+<p>If you want a graph break on this function instead, use disallow_in_graph.
+TODO(voz): We now have allow_in_graph, disallow_in_graph, forbid_in_graph - some more robust
+documentation would not be amiss.</p>
+</dd></dl>
+
 <dl class="py function">
 <dt class="sig sig-object py" id="torch._dynamo.graph_break">
 <span class="sig-prename descclassname"><span class="pre">torch._dynamo.</span></span><span class="sig-name descname"><span class="pre">graph_break</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/torch/_dynamo.html#graph_break"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#torch._dynamo.graph_break" title="Permalink to this definition">¶</a></dt>
 <dd><p>Force a graph break</p>
 </dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="torch._dynamo.mark_dynamic">
+<span class="sig-prename descclassname"><span class="pre">torch._dynamo.</span></span><span class="sig-name descname"><span class="pre">mark_dynamic</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">index</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/torch/_dynamo.html#mark_dynamic"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#torch._dynamo.mark_dynamic" title="Permalink to this definition">¶</a></dt>
+<dd><p>Mark a tensor as having a dynamic dim.</p>
+<p>[Note - on the state of mark_dynamic]</p>
+<p>The behavior of having a dynamic dimension on a tensor is governed by a few factors:</p>
+<ol class="arabic simple">
+<li><dl class="simple">
+<dt>torch._dynamo.config dynamic_shapes True or False.</dt><dd><p>a) dynamic_shapes=True - dynamic_shapes must be True for mark_dynamic to work.
+a) dynamic_shapes=False - This config will raise an exception when used in conjunction with
+mark_dyamic. We will eventually support this.</p>
+</dd>
+</dl>
+</li>
+</ol>
+<p>2) If the dimension is fully constrained - as in, it does not allow more than a single value
+in both eager (torch.compile, torch._dynamo.optimize) mode and export mode (torch._dynamo.export),
+we will raise an error</p>
+<p>3) If the dimension is partially constrained - allowing at least 2 values but not the full unbounded
+range of shapes, in eager we will pass it through, but export will raise an error.</p>
+<p>4) Attempts to trace this function will explicitly raise. As such, all calls to mark_dynamic must be made
+before torch.compile.</p>
+</dd></dl>
+
 <dl class="py function">
 <dt class="sig sig-object py" id="torch._dynamo.optimize">
 <span class="sig-prename descclassname"><span class="pre">torch._dynamo.</span></span><span class="sig-name descname"><span class="pre">optimize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'inductor'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nopython</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guard_export_fn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guard_fail_fn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disable</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dynamic</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/torch/_dynamo/eval_frame.html#optimize"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#torch._dynamo.optimize" title="Permalink to this definition">¶</a></dt>

docs/master/_images/RReLU.png

@@ -235,7 +235,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>master (2.0.0a0+gitbb347dc ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>master (2.0.0a0+git9dbfca7 ) &#x25BC</a>
     </div>
 
 

docs/master/_modules/index.html

@@ -235,7 +235,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>master (2.0.0a0+gitbb347dc ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>master (2.0.0a0+git9dbfca7 ) &#x25BC</a>
     </div>
 
 

docs/master/_modules/torch.html

@@ -235,7 +235,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>master (2.0.0a0+gitbb347dc ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>master (2.0.0a0+git9dbfca7 ) &#x25BC</a>
     </div>
 
 

docs/master/_modules/torch/__config__.html

@@ -235,7 +235,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>master (2.0.0a0+gitbb347dc ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>master (2.0.0a0+git9dbfca7 ) &#x25BC</a>
     </div>
 
 
@@ -488,7 +488,9 @@ <h1>Source code for torch._dynamo</h1><div class="highlight"><pre>
     <span class="s2">&quot;allow_in_graph&quot;</span><span class="p">,</span>
     <span class="s2">&quot;assume_constant_result&quot;</span><span class="p">,</span>
     <span class="s2">&quot;disallow_in_graph&quot;</span><span class="p">,</span>
+    <span class="s2">&quot;forbid_in_graph&quot;</span><span class="p">,</span>
     <span class="s2">&quot;graph_break&quot;</span><span class="p">,</span>
+    <span class="s2">&quot;mark_dynamic&quot;</span><span class="p">,</span>
     <span class="s2">&quot;optimize&quot;</span><span class="p">,</span>
     <span class="s2">&quot;optimize_assert&quot;</span><span class="p">,</span>
     <span class="s2">&quot;export&quot;</span><span class="p">,</span>
@@ -580,6 +582,58 @@ <h1>Source code for torch._dynamo</h1><div class="highlight"><pre>
 <span class="k">def</span> <span class="nf">graph_break</span><span class="p">():</span>
     <span class="sd">&quot;&quot;&quot;Force a graph break&quot;&quot;&quot;</span>
     <span class="k">pass</span></div>
+
+
+<div class="viewcode-block" id="forbid_in_graph"><a class="viewcode-back" href="../../_dynamo.html#torch._dynamo.forbid_in_graph">[docs]</a><span class="k">def</span> <span class="nf">forbid_in_graph</span><span class="p">(</span><span class="n">fn</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Customize which functions TorchDynamo will assert are not present while tracing.</span>
+
+<span class="sd">    If you want a graph break on this function instead, use disallow_in_graph.</span>
+<span class="sd">    TODO(voz): We now have allow_in_graph, disallow_in_graph, forbid_in_graph - some more robust</span>
+<span class="sd">    documentation would not be amiss.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">fn</span><span class="p">,</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)):</span>
+        <span class="k">return</span> <span class="p">[</span><span class="n">forbid_in_graph</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">fn</span><span class="p">]</span>
+    <span class="k">assert</span> <span class="n">callable</span><span class="p">(</span><span class="n">fn</span><span class="p">),</span> <span class="s2">&quot;forbid_in_graph applies only to callables&quot;</span>
+    <span class="n">fn</span><span class="o">.</span><span class="n">_dynamo_forbidden</span> <span class="o">=</span> <span class="kc">True</span>
+    <span class="k">return</span> <span class="n">fn</span></div>
+
+
+<div class="viewcode-block" id="mark_dynamic"><a class="viewcode-back" href="../../_dynamo.html#torch._dynamo.mark_dynamic">[docs]</a><span class="nd">@forbid_in_graph</span>
+<span class="k">def</span> <span class="nf">mark_dynamic</span><span class="p">(</span><span class="n">t</span><span class="p">,</span> <span class="n">index</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Mark a tensor as having a dynamic dim.</span>
+
+<span class="sd">    [Note - on the state of mark_dynamic]</span>
+
+<span class="sd">    The behavior of having a dynamic dimension on a tensor is governed by a few factors:</span>
+
+<span class="sd">    1) torch._dynamo.config dynamic_shapes True or False.</span>
+<span class="sd">        a) dynamic_shapes=True - dynamic_shapes must be True for mark_dynamic to work.</span>
+<span class="sd">        a) dynamic_shapes=False - This config will raise an exception when used in conjunction with</span>
+<span class="sd">        mark_dyamic. We will eventually support this.</span>
+
+<span class="sd">    2) If the dimension is fully constrained - as in, it does not allow more than a single value</span>
+<span class="sd">    in both eager (torch.compile, torch._dynamo.optimize) mode and export mode (torch._dynamo.export),</span>
+<span class="sd">    we will raise an error</span>
+
+<span class="sd">    3) If the dimension is partially constrained - allowing at least 2 values but not the full unbounded</span>
+<span class="sd">    range of shapes, in eager we will pass it through, but export will raise an error.</span>
+
+<span class="sd">    4) Attempts to trace this function will explicitly raise. As such, all calls to mark_dynamic must be made</span>
+<span class="sd">    before torch.compile.</span>
+
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">index</span><span class="p">,</span> <span class="nb">int</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">t</span><span class="p">,</span> <span class="s2">&quot;_dynamo_dynamic_indices&quot;</span><span class="p">):</span>
+            <span class="n">t</span><span class="o">.</span><span class="n">_dynamo_dynamic_indices</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
+        <span class="c1"># TODO(voz): Should we bounds check?</span>
+        <span class="n">t</span><span class="o">.</span><span class="n">_dynamo_dynamic_indices</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">index</span><span class="p">)</span>
+        <span class="k">return</span>
+
+    <span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">index</span><span class="p">,</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">))</span>
+    <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">index</span><span class="p">:</span>
+        <span class="n">mark_dynamic</span><span class="p">(</span><span class="n">t</span><span class="p">,</span> <span class="n">i</span><span class="p">)</span></div>
 </pre></div>
 
              </article>

docs/master/_modules/torch/_dynamo.html

@@ -235,7 +235,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>master (2.0.0a0+gitbb347dc ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>master (2.0.0a0+git9dbfca7 ) &#x25BC</a>
     </div>
 
 

docs/master/_modules/torch/_dynamo/backends/registry.html

@@ -235,7 +235,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>master (2.0.0a0+gitbb347dc ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>master (2.0.0a0+git9dbfca7 ) &#x25BC</a>
     </div>
 
 
@@ -840,6 +840,13 @@ <h1>Source code for torch._dynamo.eval_frame</h1><div class="highlight"><pre>
         <span class="k">return</span> <span class="n">fn</span>
 
 
+<span class="k">def</span> <span class="nf">check_if_dynamo_supported</span><span class="p">():</span>
+    <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">platform</span> <span class="o">==</span> <span class="s2">&quot;win32&quot;</span><span class="p">:</span>
+        <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">&quot;Windows not yet supported for torch.compile&quot;</span><span class="p">)</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">11</span><span class="p">):</span>
+        <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">&quot;Python 3.11+ not yet supported for torch.compile&quot;</span><span class="p">)</span>
+
+
 <div class="viewcode-block" id="optimize"><a class="viewcode-back" href="../../../_dynamo.html#torch._dynamo.optimize">[docs]</a><span class="k">def</span> <span class="nf">optimize</span><span class="p">(</span>
     <span class="n">backend</span><span class="o">=</span><span class="s2">&quot;inductor&quot;</span><span class="p">,</span>
     <span class="o">*</span><span class="p">,</span>
@@ -873,6 +880,7 @@ <h1>Source code for torch._dynamo.eval_frame</h1><div class="highlight"><pre>
 <span class="sd">        def toy_example(a, b):</span>
 <span class="sd">            ...</span>
 <span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">check_if_dynamo_supported</span><span class="p">()</span>
     <span class="c1"># Note: The hooks object could be global instead of passed around, *however* that would make</span>
     <span class="c1"># for a confusing API usage and plumbing story wherein we nest multiple .optimize calls.</span>
     <span class="c1"># There is some prior art around this, w/r/t nesting backend calls are enforced to be the same</span>
@@ -882,10 +890,6 @@ <h1>Source code for torch._dynamo.eval_frame</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">_log_api_usage_once</span><span class="p">(</span><span class="s2">&quot;torch._dynamo.optimize&quot;</span><span class="p">)</span>
     <span class="k">if</span> <span class="n">disable</span> <span class="ow">or</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;TORCHDYNAMO_DISABLE&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="s2">&quot;1&quot;</span><span class="p">:</span>
         <span class="k">return</span> <span class="n">_NullDecorator</span><span class="p">()</span>
-    <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">platform</span> <span class="o">==</span> <span class="s2">&quot;win32&quot;</span><span class="p">:</span>
-        <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">&quot;Windows not yet supported for torch.compile&quot;</span><span class="p">)</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">11</span><span class="p">):</span>
-        <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">&quot;Python 3.11+ not yet supported for torch.compile&quot;</span><span class="p">)</span>
 
     <span class="n">backend</span> <span class="o">=</span> <span class="n">get_compiler_fn</span><span class="p">(</span><span class="n">backend</span><span class="p">)</span>
 
@@ -987,6 +991,7 @@ <h1>Source code for torch._dynamo.eval_frame</h1><div class="highlight"><pre>
 <span class="k">def</span> <span class="nf">export</span><span class="p">(</span>
     <span class="n">f</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="n">aten_graph</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">decomposition_table</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">tracing_mode</span><span class="o">=</span><span class="s2">&quot;real&quot;</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span>
 <span class="p">):</span>
+    <span class="n">check_if_dynamo_supported</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">_log_api_usage_once</span><span class="p">(</span><span class="s2">&quot;torch._dynamo.export&quot;</span><span class="p">)</span>
     <span class="k">if</span> <span class="n">decomposition_table</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">tracing_mode</span> <span class="o">!=</span> <span class="s2">&quot;real&quot;</span><span class="p">:</span>
         <span class="k">assert</span> <span class="p">(</span>

docs/master/_modules/torch/_dynamo/eval_frame.html

@@ -235,7 +235,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>master (2.0.0a0+gitbb347dc ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>master (2.0.0a0+git9dbfca7 ) &#x25BC</a>
     </div>
 
 

docs/master/_modules/torch/_jit_internal.html

@@ -235,7 +235,7 @@
           <div class="pytorch-left-menu-search">
 
     <div class="version">
-      <a href='https://pytorch.org/docs/versions.html'>master (2.0.0a0+gitbb347dc ) &#x25BC</a>
+      <a href='https://pytorch.org/docs/versions.html'>master (2.0.0a0+git9dbfca7 ) &#x25BC</a>
     </div>