Update doc from commit 5b8e8e0

master/_modules/index.html

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

master/_modules/torch_xla/core/xla_model.html

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

master/_modules/torch_xla/debug/metrics.html

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

master/_modules/torch_xla/distributed/parallel_loader.html

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

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

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

master/_modules/torch_xla/distributed/xla_multiprocessing.html

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

master/_modules/torch_xla/experimental/eager.html

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

master/_modules/torch_xla/runtime.html

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

master/_modules/torch_xla/torch_xla.html

@@ -265,7 +265,7 @@
 
 
                 <div class="version">
-                  master (2.5.0+git75b10b7 )
+                  master (2.5.0+git5b8e8e0 )
                 </div>
 
 
@@ -383,11 +383,16 @@
 
   <h1>Source code for torch_xla.torch_xla</h1><div class="highlight"><pre>
 <span></span><span class="kn">import</span> <span class="nn">contextlib</span>
-<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span>
+<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Tuple</span>
 
 <span class="kn">import</span> <span class="nn">torch</span>
+<span class="kn">import</span> <span class="nn">torch.distributed</span> <span class="k">as</span> <span class="nn">dist</span>
 <span class="kn">import</span> <span class="nn">torch_xla</span>
 <span class="kn">import</span> <span class="nn">torch_xla.core.xla_model</span> <span class="k">as</span> <span class="nn">xm</span>
+<span class="kn">import</span> <span class="nn">torch_xla.core.xla_env_vars</span> <span class="k">as</span> <span class="nn">xenv</span>
+<span class="kn">import</span> <span class="nn">torch_xla.distributed.xla_multiprocessing</span> <span class="k">as</span> <span class="nn">xmp</span>
+<span class="kn">import</span> <span class="nn">torch_xla.runtime</span> <span class="k">as</span> <span class="nn">xr</span>
+<span class="kn">import</span> <span class="nn">torch_xla.utils.utils</span> <span class="k">as</span> <span class="nn">xu</span>
 
 
 <div class="viewcode-block" id="device"><a class="viewcode-back" href="../../index.html#torch_xla.device">[docs]</a><span class="k">def</span> <span class="nf">device</span><span class="p">(</span><span class="n">index</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">torch</span><span class="o">.</span><span class="n">device</span><span class="p">:</span>
@@ -464,6 +469,30 @@ <h1>Source code for torch_xla.torch_xla</h1><div class="highlight"><pre>
 <span class="sd">      If missing the default device seed will be set.</span>
 <span class="sd">  &quot;&quot;&quot;</span>
   <span class="n">xm</span><span class="o">.</span><span class="n">set_rng_state</span><span class="p">(</span><span class="n">seed</span><span class="p">,</span> <span class="n">device</span><span class="p">)</span></div>
+
+
+<span class="k">def</span> <span class="nf">launch</span><span class="p">(</span>
+    <span class="n">fn</span><span class="p">:</span> <span class="n">Callable</span><span class="p">,</span>
+    <span class="n">args</span><span class="p">:</span> <span class="n">Tuple</span> <span class="o">=</span> <span class="p">(),</span>
+    <span class="n">start_method</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;spawn&#39;</span><span class="p">,</span>
+    <span class="n">debug_single_process</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="p">):</span>
+<span class="w">  </span><span class="sd">&quot;&quot;&quot; Entry to launch multiprocess.</span>
+
+<span class="sd">  Raises:</span>
+<span class="sd">    NotImplementedError: SPMD is not supported yet.</span>
+<span class="sd">  &quot;&quot;&quot;</span>
+  <span class="k">if</span> <span class="n">xr</span><span class="o">.</span><span class="n">is_spmd</span><span class="p">():</span>
+    <span class="c1"># TODO(piz): SPMD is specified differently from mp. Skip for now.</span>
+    <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span>
+        <span class="s1">&#39;launch function does not support SPMD at this time&#39;</span><span class="p">)</span>
+
+  <span class="n">nprocs</span> <span class="o">=</span> <span class="mi">1</span> <span class="k">if</span> <span class="n">debug_single_process</span> <span class="k">else</span> <span class="kc">None</span>
+
+  <span class="k">if</span> <span class="n">dist</span><span class="o">.</span><span class="n">is_torchelastic_launched</span><span class="p">():</span>
+    <span class="n">fn</span><span class="p">(</span><span class="n">xu</span><span class="o">.</span><span class="n">getenv_as</span><span class="p">(</span><span class="n">xenv</span><span class="o">.</span><span class="n">LOCAL_RANK</span><span class="p">,</span> <span class="nb">int</span><span class="p">),</span> <span class="o">*</span><span class="n">args</span><span class="p">)</span>
+  <span class="k">else</span><span class="p">:</span>
+    <span class="n">xmp</span><span class="o">.</span><span class="n">spawn</span><span class="p">(</span><span class="n">fn</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="n">args</span><span class="p">,</span> <span class="n">nprocs</span><span class="o">=</span><span class="n">nprocs</span><span class="p">,</span> <span class="n">start_method</span><span class="o">=</span><span class="n">start_method</span><span class="p">)</span>
 </pre></div>
 
              </article>

master/debug.html

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

master/genindex.html

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

master/gpu.html

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

master/index.html

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

master/multi_process_distributed.html

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

master/notes/source_of_recompilation.html

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

master/py-modindex.html

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

master/runtime.html

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

master/search.html

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

master/spmd.html

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

master/torch_compile.html

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