Skip to content

Commit c8e803e

Browse files
committed
Update docs
1 parent 0f555c7 commit c8e803e

8 files changed

+38
-13
lines changed

api/tilelang.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1044,6 +1044,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
10441044
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.InjectFenceProxy"><code class="docutils literal notranslate"><span class="pre">InjectFenceProxy()</span></code></a></li>
10451045
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.InjectPTXAsyncCopy"><code class="docutils literal notranslate"><span class="pre">InjectPTXAsyncCopy()</span></code></a></li>
10461046
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.InjectSoftwarePipeline"><code class="docutils literal notranslate"><span class="pre">InjectSoftwarePipeline()</span></code></a></li>
1047+
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.InjectTmaBarrier"><code class="docutils literal notranslate"><span class="pre">InjectTmaBarrier()</span></code></a></li>
10471048
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.LayoutInference"><code class="docutils literal notranslate"><span class="pre">LayoutInference()</span></code></a></li>
10481049
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.LegalizeSafeMemoryAccess"><code class="docutils literal notranslate"><span class="pre">LegalizeSafeMemoryAccess()</span></code></a></li>
10491050
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.LegalizeVectorizedLoop"><code class="docutils literal notranslate"><span class="pre">LegalizeVectorizedLoop()</span></code></a></li>

api/tilelang.language.builtin.html

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -406,19 +406,27 @@
406406
<p>The language interface for tl programs.</p>
407407
<dl class="py function">
408408
<dt class="sig sig-object py" id="tilelang.language.builtin.create_list_of_mbarrier">
409-
<span class="sig-prename descclassname"><span class="pre">tilelang.language.builtin.</span></span><span class="sig-name descname"><span class="pre">create_list_of_mbarrier</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.builtin.create_list_of_mbarrier" title="Permalink to this definition">#</a></dt>
410-
<dd><p>Create a list of memory barrier operations.</p>
409+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.builtin.</span></span><span class="sig-name descname"><span class="pre">create_list_of_mbarrier</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Call</span></span></span><a class="headerlink" href="#tilelang.language.builtin.create_list_of_mbarrier" title="Permalink to this definition">#</a></dt>
410+
<dd><p>Create a list of memory barrier handles.</p>
411411
<dl class="field-list simple">
412412
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
413-
<dd class="field-odd"><p><strong>*args</strong> – Variable arguments passed to the memory barrier creation operation</p>
413+
<dd class="field-odd"><p><strong>*args</strong> (<em>list</em><em> or </em><em>Any</em>) – Either a single list of arguments, or multiple arguments directly.</p>
414414
</dd>
415415
<dt class="field-even">Returns<span class="colon">:</span></dt>
416-
<dd class="field-even"><p>A handle to the created list of memory barriers</p>
416+
<dd class="field-even"><p>Handle to the created list of memory barriers.</p>
417417
</dd>
418418
<dt class="field-odd">Return type<span class="colon">:</span></dt>
419-
<dd class="field-odd"><p>tir.Call</p>
419+
<dd class="field-odd"><p>tvm.tir.Call</p>
420+
</dd>
421+
<dt class="field-even">Raises<span class="colon">:</span></dt>
422+
<dd class="field-even"><p><strong>TypeError</strong> – If the input is not a list or variadic arguments.</p>
420423
</dd>
421424
</dl>
425+
<p class="rubric">Examples</p>
426+
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">create_list_of_mbarrier</span><span class="p">([</span><span class="mi">128</span><span class="p">,</span> <span class="mi">128</span><span class="p">])</span>
427+
<span class="gp">&gt;&gt;&gt; </span><span class="n">create_list_of_mbarrier</span><span class="p">(</span><span class="mi">128</span><span class="p">,</span> <span class="mi">128</span><span class="p">)</span>
428+
</pre></div>
429+
</div>
422430
</dd></dl>
423431

424432
<dl class="py function">
@@ -474,7 +482,7 @@
474482

475483
<dl class="py function">
476484
<dt class="sig sig-object py" id="tilelang.language.builtin.mbarrier_arrive">
477-
<span class="sig-prename descclassname"><span class="pre">tilelang.language.builtin.</span></span><span class="sig-name descname"><span class="pre">mbarrier_arrive</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mbarrier</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">PrimExpr</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.builtin.mbarrier_arrive" title="Permalink to this definition">#</a></dt>
485+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.builtin.</span></span><span class="sig-name descname"><span class="pre">mbarrier_arrive</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mbarrier</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">PrimExpr</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Call</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.builtin.mbarrier_arrive" title="Permalink to this definition">#</a></dt>
478486
<dd><p>Arrive at memory barrier.</p>
479487
<dl class="field-list simple">
480488
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -503,7 +511,7 @@
503511

504512
<dl class="py function">
505513
<dt class="sig sig-object py" id="tilelang.language.builtin.mbarrier_wait_parity">
506-
<span class="sig-prename descclassname"><span class="pre">tilelang.language.builtin.</span></span><span class="sig-name descname"><span class="pre">mbarrier_wait_parity</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mbarrier</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">PrimExpr</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parity</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Var</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.builtin.mbarrier_wait_parity" title="Permalink to this definition">#</a></dt>
514+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.builtin.</span></span><span class="sig-name descname"><span class="pre">mbarrier_wait_parity</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mbarrier</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">PrimExpr</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Call</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parity</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Var</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.builtin.mbarrier_wait_parity" title="Permalink to this definition">#</a></dt>
507515
<dd><p>Wait for memory barrier parity condition.</p>
508516
<dl class="field-list simple">
509517
<dt class="field-odd">Parameters<span class="colon">:</span></dt>

api/tilelang.language.logical.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -406,7 +406,7 @@
406406
<p>The language interface for tl programs.</p>
407407
<dl class="py function">
408408
<dt class="sig sig-object py" id="tilelang.language.logical.all_of">
409-
<span class="sig-prename descclassname"><span class="pre">tilelang.language.logical.</span></span><span class="sig-name descname"><span class="pre">all_of</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">buffer:</span> <span class="pre">~typing.Union[&lt;tilelang.language.proxy.TensorProxy</span> <span class="pre">object</span> <span class="pre">at</span> <span class="pre">0x7f3f5cc1a170&gt;,</span> <span class="pre">~tvm.tir.stmt.BufferRegion]</span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.logical.all_of" title="Permalink to this definition">#</a></dt>
409+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.logical.</span></span><span class="sig-name descname"><span class="pre">all_of</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">buffer:</span> <span class="pre">~typing.Union[&lt;tilelang.language.proxy.TensorProxy</span> <span class="pre">object</span> <span class="pre">at</span> <span class="pre">0x7f42caca3310&gt;,</span> <span class="pre">~tvm.tir.stmt.BufferRegion]</span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.logical.all_of" title="Permalink to this definition">#</a></dt>
410410
<dd><p>Check if all elements in the buffer are true.</p>
411411
<dl class="field-list simple">
412412
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -420,7 +420,7 @@
420420

421421
<dl class="py function">
422422
<dt class="sig sig-object py" id="tilelang.language.logical.any_of">
423-
<span class="sig-prename descclassname"><span class="pre">tilelang.language.logical.</span></span><span class="sig-name descname"><span class="pre">any_of</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">buffer:</span> <span class="pre">~typing.Union[&lt;tilelang.language.proxy.TensorProxy</span> <span class="pre">object</span> <span class="pre">at</span> <span class="pre">0x7f3f5cc1a170&gt;,</span> <span class="pre">~tvm.tir.stmt.BufferRegion]</span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.logical.any_of" title="Permalink to this definition">#</a></dt>
423+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.logical.</span></span><span class="sig-name descname"><span class="pre">any_of</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">buffer:</span> <span class="pre">~typing.Union[&lt;tilelang.language.proxy.TensorProxy</span> <span class="pre">object</span> <span class="pre">at</span> <span class="pre">0x7f42caca3310&gt;,</span> <span class="pre">~tvm.tir.stmt.BufferRegion]</span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.logical.any_of" title="Permalink to this definition">#</a></dt>
424424
<dd><p>Check if any element in the buffer is true.</p>
425425
<dl class="field-list simple">
426426
<dt class="field-odd">Parameters<span class="colon">:</span></dt>

api/tilelang.language.proxy.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -454,7 +454,7 @@
454454
<p>Buffer proxy class for constructing tir buffer.</p>
455455
<dl class="py method">
456456
<dt class="sig sig-object py" id="tilelang.language.proxy.BufferProxy.from_ptr">
457-
<span class="sig-name descname"><span class="pre">from_ptr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pointer_var</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Var</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shape</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">tvm.ir.expr.PrimExpr</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtype</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">'float32'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">&lt;tilelang.language.proxy.BufferProxy</span> <span class="pre">object</span> <span class="pre">at</span> <span class="pre">0x7f3f5cc1a1a0&gt;</span></span></span><a class="headerlink" href="#tilelang.language.proxy.BufferProxy.from_ptr" title="Permalink to this definition">#</a></dt>
457+
<span class="sig-name descname"><span class="pre">from_ptr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pointer_var</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Var</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shape</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">tvm.ir.expr.PrimExpr</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtype</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">'float32'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">&lt;tilelang.language.proxy.BufferProxy</span> <span class="pre">object</span> <span class="pre">at</span> <span class="pre">0x7f42caca32e0&gt;</span></span></span><a class="headerlink" href="#tilelang.language.proxy.BufferProxy.from_ptr" title="Permalink to this definition">#</a></dt>
458458
<dd><p>Create a buffer from a pointer, shape, and data type.</p>
459459
<dl class="field-list simple">
460460
<dt class="field-odd">Parameters<span class="colon">:</span></dt>

api/tilelang.transform.html

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -567,6 +567,19 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
567567
</dl>
568568
</dd></dl>
569569

570+
<dl class="py function">
571+
<dt class="sig sig-object py" id="tilelang.transform.InjectTmaBarrier">
572+
<span class="sig-prename descclassname"><span class="pre">tilelang.transform.</span></span><span class="sig-name descname"><span class="pre">InjectTmaBarrier</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.transform.InjectTmaBarrier" title="Permalink to this definition">#</a></dt>
573+
<dd><dl class="field-list simple">
574+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
575+
<dd class="field-odd"><p><strong>fpass</strong> – The result pass</p>
576+
</dd>
577+
<dt class="field-even">Return type<span class="colon">:</span></dt>
578+
<dd class="field-even"><p>tvm.transform.Pass</p>
579+
</dd>
580+
</dl>
581+
</dd></dl>
582+
570583
<dl class="py function">
571584
<dt class="sig sig-object py" id="tilelang.transform.LayoutInference">
572585
<span class="sig-prename descclassname"><span class="pre">tilelang.transform.</span></span><span class="sig-name descname"><span class="pre">LayoutInference</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.transform.LayoutInference" title="Permalink to this definition">#</a></dt>
@@ -885,6 +898,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
885898
<li><a class="reference internal" href="#tilelang.transform.InjectFenceProxy"><code class="docutils literal notranslate"><span class="pre">InjectFenceProxy()</span></code></a></li>
886899
<li><a class="reference internal" href="#tilelang.transform.InjectPTXAsyncCopy"><code class="docutils literal notranslate"><span class="pre">InjectPTXAsyncCopy()</span></code></a></li>
887900
<li><a class="reference internal" href="#tilelang.transform.InjectSoftwarePipeline"><code class="docutils literal notranslate"><span class="pre">InjectSoftwarePipeline()</span></code></a></li>
901+
<li><a class="reference internal" href="#tilelang.transform.InjectTmaBarrier"><code class="docutils literal notranslate"><span class="pre">InjectTmaBarrier()</span></code></a></li>
888902
<li><a class="reference internal" href="#tilelang.transform.LayoutInference"><code class="docutils literal notranslate"><span class="pre">LayoutInference()</span></code></a></li>
889903
<li><a class="reference internal" href="#tilelang.transform.LegalizeSafeMemoryAccess"><code class="docutils literal notranslate"><span class="pre">LegalizeSafeMemoryAccess()</span></code></a></li>
890904
<li><a class="reference internal" href="#tilelang.transform.LegalizeVectorizedLoop"><code class="docutils literal notranslate"><span class="pre">LegalizeVectorizedLoop()</span></code></a></li>

0 commit comments

Comments
 (0)