Skip to content

Commit 25af73a

Browse files
committed
Update docs
1 parent 592ef37 commit 25af73a

12 files changed

+44
-9
lines changed

api/tilelang.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -781,6 +781,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
781781
</li>
782782
<li class="toctree-l2"><a class="reference internal" href="tilelang.language.html#submodules">Submodules</a><ul>
783783
<li class="toctree-l3"><a class="reference internal" href="tilelang.language.allocate.html">tilelang.language.allocate module</a><ul>
784+
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.allocate.html#tilelang.language.allocate.alloc_barrier"><code class="docutils literal notranslate"><span class="pre">alloc_barrier()</span></code></a></li>
784785
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.allocate.html#tilelang.language.allocate.alloc_fragment"><code class="docutils literal notranslate"><span class="pre">alloc_fragment()</span></code></a></li>
785786
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.allocate.html#tilelang.language.allocate.alloc_local"><code class="docutils literal notranslate"><span class="pre">alloc_local()</span></code></a></li>
786787
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.allocate.html#tilelang.language.allocate.alloc_shared"><code class="docutils literal notranslate"><span class="pre">alloc_shared()</span></code></a></li>
@@ -1074,6 +1075,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
10741075
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.LowerDeviceStorageAccessInfo"><code class="docutils literal notranslate"><span class="pre">LowerDeviceStorageAccessInfo()</span></code></a></li>
10751076
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.LowerHopperIntrin"><code class="docutils literal notranslate"><span class="pre">LowerHopperIntrin()</span></code></a></li>
10761077
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.LowerL2Persistent"><code class="docutils literal notranslate"><span class="pre">LowerL2Persistent()</span></code></a></li>
1078+
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.LowerSharedBarrier"><code class="docutils literal notranslate"><span class="pre">LowerSharedBarrier()</span></code></a></li>
10771079
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.LowerTileOp"><code class="docutils literal notranslate"><span class="pre">LowerTileOp()</span></code></a></li>
10781080
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.MakePackedAPI"><code class="docutils literal notranslate"><span class="pre">MakePackedAPI()</span></code></a></li>
10791081
<li class="toctree-l3"><a class="reference internal" href="tilelang.transform.html#tilelang.transform.MergeIfStmt"><code class="docutils literal notranslate"><span class="pre">MergeIfStmt()</span></code></a></li>

api/tilelang.language.allocate.html

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -427,6 +427,23 @@
427427
</dl>
428428
<p>Each function takes shape and dtype parameters and returns a TVM buffer object
429429
with the appropriate memory scope.</p>
430+
<dl class="py function">
431+
<dt class="sig sig-object py" id="tilelang.language.allocate.alloc_barrier">
432+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.allocate.</span></span><span class="sig-name descname"><span class="pre">alloc_barrier</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arrive_count</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.allocate.alloc_barrier" title="Permalink to this definition">#</a></dt>
433+
<dd><p>Allocate a barrier buffer.</p>
434+
<dl class="field-list simple">
435+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
436+
<dd class="field-odd"><p><strong>arrive_count</strong> (<em>int</em>) – The number of threads that need to arrive at the barrier</p>
437+
</dd>
438+
<dt class="field-even">Returns<span class="colon">:</span></dt>
439+
<dd class="field-even"><p>A TVM buffer object allocated as a barrier</p>
440+
</dd>
441+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
442+
<dd class="field-odd"><p>T.Buffer</p>
443+
</dd>
444+
</dl>
445+
</dd></dl>
446+
430447
<dl class="py function">
431448
<dt class="sig sig-object py" id="tilelang.language.allocate.alloc_fragment">
432449
<span class="sig-prename descclassname"><span class="pre">tilelang.language.allocate.</span></span><span class="sig-name descname"><span class="pre">alloc_fragment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">shape</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtype</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scope</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'local.fragment'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.allocate.alloc_fragment" title="Permalink to this definition">#</a></dt>
@@ -568,6 +585,7 @@
568585
<div class="toc-tree">
569586
<ul>
570587
<li><a class="reference internal" href="#">tilelang.language.allocate module</a><ul>
588+
<li><a class="reference internal" href="#tilelang.language.allocate.alloc_barrier"><code class="docutils literal notranslate"><span class="pre">alloc_barrier()</span></code></a></li>
571589
<li><a class="reference internal" href="#tilelang.language.allocate.alloc_fragment"><code class="docutils literal notranslate"><span class="pre">alloc_fragment()</span></code></a></li>
572590
<li><a class="reference internal" href="#tilelang.language.allocate.alloc_local"><code class="docutils literal notranslate"><span class="pre">alloc_local()</span></code></a></li>
573591
<li><a class="reference internal" href="#tilelang.language.allocate.alloc_shared"><code class="docutils literal notranslate"><span class="pre">alloc_shared()</span></code></a></li>

api/tilelang.language.builtin.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -783,11 +783,12 @@
783783

784784
<dl class="py function">
785785
<dt class="sig sig-object py" id="tilelang.language.builtin.wait_wgmma">
786-
<span class="sig-prename descclassname"><span class="pre">tilelang.language.builtin.</span></span><span class="sig-name descname"><span class="pre">wait_wgmma</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.wait_wgmma" title="Permalink to this definition">#</a></dt>
786+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.builtin.</span></span><span class="sig-name descname"><span class="pre">wait_wgmma</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.builtin.wait_wgmma" title="Permalink to this definition">#</a></dt>
787787
<dd><p>Wait for WGMMA (Warp Group Matrix Multiply-Accumulate) operations to complete.</p>
788788
<dl class="field-list simple">
789789
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
790-
<dd class="field-odd"><p><strong>*args</strong> – Variable arguments specifying which operations to wait for</p>
790+
<dd class="field-odd"><p><strong>id</strong> – int
791+
The id of the WGMMA operation to wait for</p>
791792
</dd>
792793
<dt class="field-even">Returns<span class="colon">:</span></dt>
793794
<dd class="field-even"><p>A handle to the WGMMA wait operation</p>

api/tilelang.language.copy.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@
502502

503503
<dl class="py function">
504504
<dt class="sig sig-object py" id="tilelang.language.copy.copy">
505-
<span class="sig-prename descclassname"><span class="pre">tilelang.language.copy.</span></span><span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">src</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">Buffer</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">BufferLoad</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">BufferRegion</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dst</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">Buffer</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">BufferLoad</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coalesced_width</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></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">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.copy.copy" title="Permalink to this definition">#</a></dt>
505+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.copy.</span></span><span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">src</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">Buffer</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">BufferLoad</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">BufferRegion</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dst</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">Buffer</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">BufferLoad</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coalesced_width</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disable_tma</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="headerlink" href="#tilelang.language.copy.copy" title="Permalink to this definition">#</a></dt>
506506
<dd><p>Copy data between memory regions.</p>
507507
<dl class="field-list simple">
508508
<dt class="field-odd">Parameters<span class="colon">:</span></dt>

api/tilelang.language.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -597,6 +597,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
597597
<div class="toctree-wrapper compound">
598598
<ul>
599599
<li class="toctree-l1"><a class="reference internal" href="tilelang.language.allocate.html">tilelang.language.allocate module</a><ul>
600+
<li class="toctree-l2"><a class="reference internal" href="tilelang.language.allocate.html#tilelang.language.allocate.alloc_barrier"><code class="docutils literal notranslate"><span class="pre">alloc_barrier()</span></code></a></li>
600601
<li class="toctree-l2"><a class="reference internal" href="tilelang.language.allocate.html#tilelang.language.allocate.alloc_fragment"><code class="docutils literal notranslate"><span class="pre">alloc_fragment()</span></code></a></li>
601602
<li class="toctree-l2"><a class="reference internal" href="tilelang.language.allocate.html#tilelang.language.allocate.alloc_local"><code class="docutils literal notranslate"><span class="pre">alloc_local()</span></code></a></li>
602603
<li class="toctree-l2"><a class="reference internal" href="tilelang.language.allocate.html#tilelang.language.allocate.alloc_shared"><code class="docutils literal notranslate"><span class="pre">alloc_shared()</span></code></a></li>

api/tilelang.language.logical.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -415,7 +415,7 @@
415415
<p>The language interface for tl programs.</p>
416416
<dl class="py function">
417417
<dt class="sig sig-object py" id="tilelang.language.logical.all_of">
418-
<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">0x7fea3e8cad70&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>
418+
<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">0x7f33837c2020&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>
419419
<dd><p>Check if all elements in the buffer are true.</p>
420420
<dl class="field-list simple">
421421
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -429,7 +429,7 @@
429429

430430
<dl class="py function">
431431
<dt class="sig sig-object py" id="tilelang.language.logical.any_of">
432-
<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">0x7fea3e8cad70&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>
432+
<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">0x7f33837c2020&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>
433433
<dd><p>Check if any element in the buffer is true.</p>
434434
<dl class="field-list simple">
435435
<dt class="field-odd">Parameters<span class="colon">:</span></dt>

api/tilelang.language.print.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -416,7 +416,7 @@
416416
It includes functionality to print variables, print values in buffers, and conditionally execute debug prints.</p>
417417
<dl class="py function">
418418
<dt class="sig sig-object py" id="tilelang.language.print.print">
419-
<span class="sig-prename descclassname"><span class="pre">tilelang.language.print.</span></span><span class="sig-name descname"><span class="pre">print</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">msg</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">''</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">PrimExpr</span></span></span><a class="headerlink" href="#tilelang.language.print.print" title="Permalink to this definition">#</a></dt>
419+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.print.</span></span><span class="sig-name descname"><span class="pre">print</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">msg</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">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">warp_group_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</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">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">warp_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</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">0</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">PrimExpr</span></span></span><a class="headerlink" href="#tilelang.language.print.print" title="Permalink to this definition">#</a></dt>
420420
<dd><p>A generic print function that handles both TIR buffers and primitive expressions.</p>
421421
<ul class="simple">
422422
<li><p>If the input is a TIR buffer, it prints its values, but only on the first thread (tx=0, ty=0, tz=0).</p></li>
@@ -427,6 +427,9 @@
427427
<dd class="field-odd"><ul class="simple">
428428
<li><p><strong>obj</strong> (<em>Any</em>) – The object to print. It can be either a tir.Buffer or tir.PrimExpr.</p></li>
429429
<li><p><strong>msg</strong> (<em>str</em>) – An optional message to include in the print statement.</p></li>
430+
<li><p><strong>warp_group_id</strong> (<em>int</em>) – The warp group id to print.</p></li>
431+
<li><p><strong>warp_id</strong> (<em>int</em>) – The warp id to print.</p></li>
432+
<li><p><strong>warp_id.</strong> (<em>print thread will be warp_group_id * warp_group_size +</em>) – </p></li>
430433
</ul>
431434
</dd>
432435
<dt class="field-even">Returns<span class="colon">:</span></dt>

0 commit comments

Comments
 (0)