Skip to content

Commit b3a17bb

Browse files
committed
Update docs
1 parent 8f48e27 commit b3a17bb

9 files changed

+115
-9
lines changed

api/tilelang.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -807,6 +807,8 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
807807
</ul>
808808
</li>
809809
<li class="toctree-l3"><a class="reference internal" href="tilelang.language.builtin.html">tilelang.language.builtin module</a><ul>
810+
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.barrier_arrive"><code class="docutils literal notranslate"><span class="pre">barrier_arrive()</span></code></a></li>
811+
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.barrier_wait"><code class="docutils literal notranslate"><span class="pre">barrier_wait()</span></code></a></li>
810812
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.create_list_of_mbarrier"><code class="docutils literal notranslate"><span class="pre">create_list_of_mbarrier()</span></code></a></li>
811813
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.create_tma_descriptor"><code class="docutils literal notranslate"><span class="pre">create_tma_descriptor()</span></code></a></li>
812814
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.dec_max_nreg"><code class="docutils literal notranslate"><span class="pre">dec_max_nreg()</span></code></a></li>
@@ -818,6 +820,9 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
818820
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.mbarrier_wait_parity"><code class="docutils literal notranslate"><span class="pre">mbarrier_wait_parity()</span></code></a></li>
819821
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.no_set_max_nreg"><code class="docutils literal notranslate"><span class="pre">no_set_max_nreg()</span></code></a></li>
820822
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.set_max_nreg"><code class="docutils literal notranslate"><span class="pre">set_max_nreg()</span></code></a></li>
823+
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.shfl_down"><code class="docutils literal notranslate"><span class="pre">shfl_down()</span></code></a></li>
824+
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.shfl_up"><code class="docutils literal notranslate"><span class="pre">shfl_up()</span></code></a></li>
825+
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.shfl_xor"><code class="docutils literal notranslate"><span class="pre">shfl_xor()</span></code></a></li>
821826
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.tma_load"><code class="docutils literal notranslate"><span class="pre">tma_load()</span></code></a></li>
822827
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.tma_store_arrive"><code class="docutils literal notranslate"><span class="pre">tma_store_arrive()</span></code></a></li>
823828
<li class="toctree-l4"><a class="reference internal" href="tilelang.language.builtin.html#tilelang.language.builtin.tma_store_wait"><code class="docutils literal notranslate"><span class="pre">tma_store_wait()</span></code></a></li>

api/tilelang.language.builtin.html

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -404,6 +404,41 @@
404404
<section id="module-tilelang.language.builtin">
405405
<span id="tilelang-language-builtin-module"></span><h1>tilelang.language.builtin module<a class="headerlink" href="#module-tilelang.language.builtin" title="Permalink to this heading">#</a></h1>
406406
<p>The language interface for tl programs.</p>
407+
<dl class="py function">
408+
<dt class="sig sig-object py" id="tilelang.language.builtin.barrier_arrive">
409+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.builtin.</span></span><span class="sig-name descname"><span class="pre">barrier_arrive</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">barrier_id</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.barrier_arrive" title="Permalink to this definition">#</a></dt>
410+
<dd><p>Arrive at a memory barrier.</p>
411+
<dl class="field-list simple">
412+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
413+
<dd class="field-odd"><p><strong>barrier_id</strong> – Optional[int, PrimExpr]
414+
The memory barrier to arrive at</p>
415+
</dd>
416+
</dl>
417+
</dd></dl>
418+
419+
<dl class="py function">
420+
<dt class="sig sig-object py" id="tilelang.language.builtin.barrier_wait">
421+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.builtin.</span></span><span class="sig-name descname"><span class="pre">barrier_wait</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">barrier_id</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">Optional</span><span class="p"><span class="pre">[</span></span><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 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.builtin.barrier_wait" title="Permalink to this definition">#</a></dt>
422+
<dd><p>Wait for a memory barrier to complete.</p>
423+
<dl class="field-list simple">
424+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
425+
<dd class="field-odd"><ul class="simple">
426+
<li><p><strong>barrier_id</strong> – Optional[int, PrimExpr]
427+
The memory barrier to wait on</p></li>
428+
<li><p><strong>parity</strong> – Optional[int, Var]
429+
The parity value to wait for</p></li>
430+
</ul>
431+
</dd>
432+
<dt class="field-even">Returns<span class="colon">:</span></dt>
433+
<dd class="field-even"><p>A handle to the barrier wait operation</p>
434+
</dd>
435+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
436+
<dd class="field-odd"><p>tir.Call</p>
437+
</dd>
438+
</dl>
439+
<p>Current implementation is a sugar syntax for mbarrier_wait_parity, as we only support parity 0 and 1.</p>
440+
</dd></dl>
441+
407442
<dl class="py function">
408443
<dt class="sig sig-object py" id="tilelang.language.builtin.create_list_of_mbarrier">
409444
<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>
@@ -604,6 +639,52 @@
604639
</dl>
605640
</dd></dl>
606641

642+
<dl class="py function">
643+
<dt class="sig sig-object py" id="tilelang.language.builtin.shfl_down">
644+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.builtin.</span></span><span class="sig-name descname"><span class="pre">shfl_down</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</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">offset</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.shfl_down" title="Permalink to this definition">#</a></dt>
645+
<dd><p>Perform a shuffle operation with down offset.</p>
646+
<dl class="field-list simple">
647+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
648+
<dd class="field-odd"><p><strong>value</strong> – Optional[int, PrimExpr]
649+
The value to shuffle</p>
650+
</dd>
651+
</dl>
652+
</dd></dl>
653+
654+
<dl class="py function">
655+
<dt class="sig sig-object py" id="tilelang.language.builtin.shfl_up">
656+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.builtin.</span></span><span class="sig-name descname"><span class="pre">shfl_up</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</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">offset</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.shfl_up" title="Permalink to this definition">#</a></dt>
657+
<dd><p>Perform a shuffle operation with up offset.</p>
658+
<dl class="field-list simple">
659+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
660+
<dd class="field-odd"><p><strong>value</strong> – Optional[int, PrimExpr]
661+
The value to shuffle</p>
662+
</dd>
663+
</dl>
664+
</dd></dl>
665+
666+
<dl class="py function">
667+
<dt class="sig sig-object py" id="tilelang.language.builtin.shfl_xor">
668+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.builtin.</span></span><span class="sig-name descname"><span class="pre">shfl_xor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</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">offset</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.shfl_xor" title="Permalink to this definition">#</a></dt>
669+
<dd><p>Perform a shuffle operation with XOR offset.</p>
670+
<dl class="field-list simple">
671+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
672+
<dd class="field-odd"><ul class="simple">
673+
<li><p><strong>value</strong> – Optional[int, PrimExpr]
674+
The value to shuffle</p></li>
675+
<li><p><strong>offset</strong> – Optional[int, PrimExpr]
676+
The offset for the shuffle operation</p></li>
677+
</ul>
678+
</dd>
679+
<dt class="field-even">Returns<span class="colon">:</span></dt>
680+
<dd class="field-even"><p>A handle to the shuffle operation</p>
681+
</dd>
682+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
683+
<dd class="field-odd"><p>tir.Call</p>
684+
</dd>
685+
</dl>
686+
</dd></dl>
687+
607688
<dl class="py function">
608689
<dt class="sig sig-object py" id="tilelang.language.builtin.tma_load">
609690
<span class="sig-prename descclassname"><span class="pre">tilelang.language.builtin.</span></span><span class="sig-name descname"><span class="pre">tma_load</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.tma_load" title="Permalink to this definition">#</a></dt>
@@ -730,6 +811,8 @@
730811
<div class="toc-tree">
731812
<ul>
732813
<li><a class="reference internal" href="#">tilelang.language.builtin module</a><ul>
814+
<li><a class="reference internal" href="#tilelang.language.builtin.barrier_arrive"><code class="docutils literal notranslate"><span class="pre">barrier_arrive()</span></code></a></li>
815+
<li><a class="reference internal" href="#tilelang.language.builtin.barrier_wait"><code class="docutils literal notranslate"><span class="pre">barrier_wait()</span></code></a></li>
733816
<li><a class="reference internal" href="#tilelang.language.builtin.create_list_of_mbarrier"><code class="docutils literal notranslate"><span class="pre">create_list_of_mbarrier()</span></code></a></li>
734817
<li><a class="reference internal" href="#tilelang.language.builtin.create_tma_descriptor"><code class="docutils literal notranslate"><span class="pre">create_tma_descriptor()</span></code></a></li>
735818
<li><a class="reference internal" href="#tilelang.language.builtin.dec_max_nreg"><code class="docutils literal notranslate"><span class="pre">dec_max_nreg()</span></code></a></li>
@@ -741,6 +824,9 @@
741824
<li><a class="reference internal" href="#tilelang.language.builtin.mbarrier_wait_parity"><code class="docutils literal notranslate"><span class="pre">mbarrier_wait_parity()</span></code></a></li>
742825
<li><a class="reference internal" href="#tilelang.language.builtin.no_set_max_nreg"><code class="docutils literal notranslate"><span class="pre">no_set_max_nreg()</span></code></a></li>
743826
<li><a class="reference internal" href="#tilelang.language.builtin.set_max_nreg"><code class="docutils literal notranslate"><span class="pre">set_max_nreg()</span></code></a></li>
827+
<li><a class="reference internal" href="#tilelang.language.builtin.shfl_down"><code class="docutils literal notranslate"><span class="pre">shfl_down()</span></code></a></li>
828+
<li><a class="reference internal" href="#tilelang.language.builtin.shfl_up"><code class="docutils literal notranslate"><span class="pre">shfl_up()</span></code></a></li>
829+
<li><a class="reference internal" href="#tilelang.language.builtin.shfl_xor"><code class="docutils literal notranslate"><span class="pre">shfl_xor()</span></code></a></li>
744830
<li><a class="reference internal" href="#tilelang.language.builtin.tma_load"><code class="docutils literal notranslate"><span class="pre">tma_load()</span></code></a></li>
745831
<li><a class="reference internal" href="#tilelang.language.builtin.tma_store_arrive"><code class="docutils literal notranslate"><span class="pre">tma_store_arrive()</span></code></a></li>
746832
<li><a class="reference internal" href="#tilelang.language.builtin.tma_store_wait"><code class="docutils literal notranslate"><span class="pre">tma_store_wait()</span></code></a></li>

api/tilelang.language.copy.html

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

428428
<dl class="py function">
429429
<dt class="sig sig-object py" id="tilelang.language.copy.buffer_region_to_tile_region">
430-
<span class="sig-prename descclassname"><span class="pre">tilelang.language.copy.</span></span><span class="sig-name descname"><span class="pre">buffer_region_to_tile_region</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">buffer_region</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">BufferRegion</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">access_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.copy.buffer_region_to_tile_region" title="Permalink to this definition">#</a></dt>
430+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.copy.</span></span><span class="sig-name descname"><span class="pre">buffer_region_to_tile_region</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">buffer_region</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">BufferRegion</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">access_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extents</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></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.copy.buffer_region_to_tile_region" title="Permalink to this definition">#</a></dt>
431431
<dd><p>Convert a buffer region to a tile region descriptor.</p>
432432
<dl class="field-list simple">
433433
<dt class="field-odd">Parameters<span class="colon">:</span></dt>

0 commit comments

Comments
 (0)