Update doc from commit 4e94ff6

master/_modules/index.html

@@ -265,7 +265,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+git52ea89f )
+                  master (2.5.0+git4e94ff6 )
                 </div>
 
 

master/_modules/torch_xla/core/xla_model.html

@@ -265,7 +265,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+git52ea89f )
+                  master (2.5.0+git4e94ff6 )
                 </div>
 
 

master/_modules/torch_xla/debug/metrics.html

@@ -265,7 +265,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+git52ea89f )
+                  master (2.5.0+git4e94ff6 )
                 </div>
 
 

master/_modules/torch_xla/distributed/parallel_loader.html

@@ -265,7 +265,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+git52ea89f )
+                  master (2.5.0+git4e94ff6 )
                 </div>
 
 

master/_modules/torch_xla/distributed/spmd/xla_sharding.html

@@ -265,7 +265,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+git52ea89f )
+                  master (2.5.0+git4e94ff6 )
                 </div>
 
 

master/_modules/torch_xla/distributed/xla_multiprocessing.html

@@ -265,7 +265,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+git52ea89f )
+                  master (2.5.0+git4e94ff6 )
                 </div>
 
 

master/_modules/torch_xla/experimental/eager.html

@@ -265,7 +265,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+git52ea89f )
+                  master (2.5.0+git4e94ff6 )
                 </div>
 
 

master/_modules/torch_xla/runtime.html

@@ -265,7 +265,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+git52ea89f )
+                  master (2.5.0+git4e94ff6 )
                 </div>
 
 

master/_modules/torch_xla/torch_xla.html

@@ -265,7 +265,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+git52ea89f )
+                  master (2.5.0+git4e94ff6 )
                 </div>
 
 
@@ -442,9 +442,20 @@ <h1>Source code for torch_xla.torch_xla</h1><div class="highlight"><pre>
   <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="n">real_devices</span><span class="p">())</span></div>
 
 
-<div class="viewcode-block" id="sync"><a class="viewcode-back" href="../../index.html#torch_xla.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">():</span>
-<span class="w">  </span><span class="sd">&quot;&quot;&quot;Launches all pending graph operations.&quot;&quot;&quot;</span>
-  <span class="n">xm</span><span class="o">.</span><span class="n">mark_step</span><span class="p">()</span></div>
+<div class="viewcode-block" id="sync"><a class="viewcode-back" href="../../index.html#torch_xla.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span><span class="n">wait</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">):</span>
+<span class="w">  </span><span class="sd">&quot;&quot;&quot;Launches all pending graph operations.</span>
+<span class="sd">  </span>
+<span class="sd">  Args:</span>
+<span class="sd">    wait (bool): whether to block the current process until the execution finished.</span>
+
+<span class="sd">  &quot;&quot;&quot;</span>
+  <span class="n">torch_xla</span><span class="o">.</span><span class="n">_XLAC</span><span class="o">.</span><span class="n">_xla_step_marker</span><span class="p">(</span>
+      <span class="n">torch_xla</span><span class="o">.</span><span class="n">_XLAC</span><span class="o">.</span><span class="n">_xla_get_default_device</span><span class="p">(),</span>
+      <span class="p">[],</span>
+      <span class="n">wait</span><span class="o">=</span><span class="n">wait</span><span class="p">,</span>
+  <span class="p">)</span>
+  <span class="n">devctx</span> <span class="o">=</span> <span class="n">xm</span><span class="o">.</span><span class="n">_run_step_closures</span><span class="p">()</span>
+  <span class="n">torch_xla</span><span class="o">.</span><span class="n">_XLAC</span><span class="o">.</span><span class="n">_set_all_reduce_token</span><span class="p">(</span><span class="n">devctx</span><span class="o">.</span><span class="n">device</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span></div>
 
 
 <span class="k">def</span> <span class="nf">step</span><span class="p">():</span>
@@ -489,13 +500,15 @@ <h1>Source code for torch_xla.torch_xla</h1><div class="highlight"><pre>
 <span class="sd">        res = foo2(x)</span>
 <span class="sd">  &quot;&quot;&quot;</span>
 
+  <span class="k">def</span> <span class="nf">_clear_pending_ops_before_compile</span><span class="p">():</span>
+    <span class="n">sync</span><span class="p">()</span>
+
   <span class="nd">@contextlib</span><span class="o">.</span><span class="n">contextmanager</span>
-  <span class="k">def</span> <span class="nf">_step</span><span class="p">():</span>
+  <span class="k">def</span> <span class="nf">_compile</span><span class="p">():</span>
     <span class="n">saved_eager_mode_status</span> <span class="o">=</span> <span class="n">torch_xla</span><span class="o">.</span><span class="n">_XLAC</span><span class="o">.</span><span class="n">_get_use_eager_mode</span><span class="p">()</span>
     <span class="n">saved_allow_execution</span> <span class="o">=</span> <span class="n">torch_xla</span><span class="o">.</span><span class="n">_XLAC</span><span class="o">.</span><span class="n">_get_allow_execution</span><span class="p">()</span>
     <span class="n">torch_xla</span><span class="o">.</span><span class="n">_XLAC</span><span class="o">.</span><span class="n">_set_use_eager_mode</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
-    <span class="c1"># Clear pending operations</span>
-    <span class="n">sync</span><span class="p">()</span>
+    <span class="n">_clear_pending_ops_before_compile</span><span class="p">()</span>
 
     <span class="c1"># if full_graph sets to true execution can not happen before the sync below</span>
     <span class="n">torch_xla</span><span class="o">.</span><span class="n">_XLAC</span><span class="o">.</span><span class="n">_set_allow_execution</span><span class="p">(</span><span class="ow">not</span> <span class="n">full_graph</span><span class="p">)</span>
@@ -504,10 +517,12 @@ <h1>Source code for torch_xla.torch_xla</h1><div class="highlight"><pre>
       <span class="k">yield</span>
     <span class="k">finally</span><span class="p">:</span>
       <span class="n">torch_xla</span><span class="o">.</span><span class="n">_XLAC</span><span class="o">.</span><span class="n">_set_allow_execution</span><span class="p">(</span><span class="n">saved_allow_execution</span><span class="p">)</span>
+      <span class="c1"># Collect the traced graph after running the target function and</span>
+      <span class="c1"># execute the graph.</span>
       <span class="n">sync</span><span class="p">()</span>
       <span class="n">torch_xla</span><span class="o">.</span><span class="n">_XLAC</span><span class="o">.</span><span class="n">_set_use_eager_mode</span><span class="p">(</span><span class="n">saved_eager_mode_status</span><span class="p">)</span>
 
-  <span class="k">return</span> <span class="n">_step</span><span class="p">()</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">f</span> <span class="k">else</span> <span class="n">_step</span><span class="p">()(</span><span class="n">f</span><span class="p">)</span></div>
+  <span class="k">return</span> <span class="n">_compile</span><span class="p">()</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">f</span> <span class="k">else</span> <span class="n">_compile</span><span class="p">()(</span><span class="n">f</span><span class="p">)</span></div>
 
 
 <div class="viewcode-block" id="manual_seed"><a class="viewcode-back" href="../../index.html#torch_xla.manual_seed">[docs]</a><span class="k">def</span> <span class="nf">manual_seed</span><span class="p">(</span><span class="n">seed</span><span class="p">,</span> <span class="n">device</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>

master/debug.html

@@ -267,7 +267,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+git52ea89f )
+                  master (2.5.0+git4e94ff6 )
                 </div>
 
 

master/eager_mode.html

@@ -267,7 +267,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+git52ea89f )
+                  master (2.5.0+git4e94ff6 )
                 </div>
 
 

master/genindex.html

@@ -265,7 +265,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+git52ea89f )
+                  master (2.5.0+git4e94ff6 )
                 </div>
 
 

master/gpu.html

@@ -267,7 +267,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+git52ea89f )
+                  master (2.5.0+git4e94ff6 )
                 </div>
 
 

master/index.html

@@ -266,7 +266,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+git52ea89f )
+                  master (2.5.0+git4e94ff6 )
                 </div>
 
 
@@ -750,8 +750,13 @@ <h1>PyTorch/XLA API<a class="headerlink" href="#pytorch-xla-api" title="Permalin
 
 <dl class="py function">
 <dt class="sig sig-object py" id="torch_xla.sync">
-<span class="sig-prename descclassname"><span class="pre">torch_xla.</span></span><span class="sig-name descname"><span class="pre">sync</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/torch_xla/torch_xla.html#sync"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#torch_xla.sync" title="Permalink to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">torch_xla.</span></span><span class="sig-name descname"><span class="pre">sync</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">wait</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/torch_xla/torch_xla.html#sync"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#torch_xla.sync" title="Permalink to this definition">¶</a></dt>
 <dd><p>Launches all pending graph operations.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><p><strong>wait</strong> (<em>bool</em>) – whether to block the current process until the execution finished.</p>
+</dd>
+</dl>
 </dd></dl>
 
 <dl class="py function">

master/multi_process_distributed.html

@@ -267,7 +267,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+git52ea89f )
+                  master (2.5.0+git4e94ff6 )
                 </div>
 
 

master/notes/source_of_recompilation.html

@@ -265,7 +265,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+git52ea89f )
+                  master (2.5.0+git4e94ff6 )
                 </div>
 
 

master/py-modindex.html

@@ -268,7 +268,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+git52ea89f )
+                  master (2.5.0+git4e94ff6 )
                 </div>
 
 

master/runtime.html

@@ -267,7 +267,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+git52ea89f )
+                  master (2.5.0+git4e94ff6 )
                 </div>
 
 

master/search.html

@@ -265,7 +265,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+git52ea89f )
+                  master (2.5.0+git4e94ff6 )
                 </div>
 
 

master/spmd.html

@@ -267,7 +267,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+git52ea89f )
+                  master (2.5.0+git4e94ff6 )
                 </div>
 
 

master/torch_compile.html

@@ -266,7 +266,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+git52ea89f )
+                  master (2.5.0+git4e94ff6 )
                 </div>