Update docs

Author: LeiWang1999

api/tilelang.html

@@ -945,6 +945,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
 </li>
 <li class="toctree-l2"><a class="reference internal" href="tilelang.language.html#module-tilelang.language">Module contents</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="tilelang.language.html#tilelang.language.annotate_layout"><code class="docutils literal notranslate"><span class="pre">annotate_layout()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="tilelang.language.html#tilelang.language.annotate_padding"><code class="docutils literal notranslate"><span class="pre">annotate_padding()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="tilelang.language.html#tilelang.language.import_source"><code class="docutils literal notranslate"><span class="pre">import_source()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="tilelang.language.html#tilelang.language.symbolic"><code class="docutils literal notranslate"><span class="pre">symbolic()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="tilelang.language.html#tilelang.language.use_swizzle"><code class="docutils literal notranslate"><span class="pre">use_swizzle()</span></code></a></li>

api/tilelang.language.html

@@ -766,8 +766,87 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <p>The language interface for tl programs.</p>
 <dl class="py function">
 <dt class="sig sig-object py" id="tilelang.language.annotate_layout">
-<span class="sig-prename descclassname"><span class="pre">tilelang.language.</span></span><span class="sig-name descname"><span class="pre">annotate_layout</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layout_map</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.annotate_layout" title="Permalink to this definition">#</a></dt>
-<dd></dd></dl>
+<span class="sig-prename descclassname"><span class="pre">tilelang.language.</span></span><span class="sig-name descname"><span class="pre">annotate_layout</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layout_map</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.annotate_layout" title="Permalink to this definition">#</a></dt>
+<dd><p>Annotate the layout of the buffer</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>layout_map</strong> (<em>Dict</em>) – a dictionary of buffer to layout</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>a block attribute</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>block_attr</p>
+</dd>
+</dl>
+<p class="rubric">Example</p>
+<p>&#64;T.prim_func
+def main(</p>
+<blockquote>
+<div><p>A: T.Tensor((M, N), dtype),
+B: T.Tensor((M, N), dtype),</p>
+</div></blockquote>
+<dl>
+<dt>):</dt><dd><p># Initialize Kernel Context
+with T.Kernel(T.ceildiv(N, block_N), T.ceildiv(M, block_M), threads=128) as (bx, by):</p>
+<blockquote>
+<div><p>A_shared = T.alloc_shared((block_M, block_N), dtype)</p>
+<p>T.annotate_layout({A_shared: layout})
+for i, j in T.Parallel(block_M, block_N):</p>
+<blockquote>
+<div><p>A_shared[i, j] = A[by * block_M + i, bx * block_N + j]</p>
+</div></blockquote>
+<dl class="simple">
+<dt>for i, j in T.Parallel(block_M, block_N):</dt><dd><p>B[by * block_M + i, bx * block_N + j] = A_shared[i, j]</p>
+</dd>
+</dl>
+</div></blockquote>
+</dd>
+</dl>
+<p>return main</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="tilelang.language.annotate_padding">
+<span class="sig-prename descclassname"><span class="pre">tilelang.language.</span></span><span class="sig-name descname"><span class="pre">annotate_padding</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">padding_map</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.annotate_padding" title="Permalink to this definition">#</a></dt>
+<dd><p>Annotate the padding of the buffer</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>padding_map</strong> (<em>dict</em>) – a dictionary of buffer to padding value</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>a block attribute</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>block_attr</p>
+</dd>
+</dl>
+<p class="rubric">Example</p>
+<p>&#64;T.prim_func
+def main(</p>
+<blockquote>
+<div><p>A: T.Tensor((M, N), dtype),
+B: T.Tensor((M, N), dtype),</p>
+</div></blockquote>
+<dl>
+<dt>):</dt><dd><p># Initialize Kernel Context
+with T.Kernel(T.ceildiv(N, block_N), T.ceildiv(M, block_M), threads=128) as (bx, by):</p>
+<blockquote>
+<div><p>A_shared = T.alloc_shared((block_M, block_N), dtype)</p>
+<p>T.annotate_padding({A_shared: pad_value})
+for i, j in T.Parallel(block_M, block_N):</p>
+<blockquote>
+<div><p>A_shared[i, j] = A[by * block_M + i - 10, bx * block_N + j]</p>
+</div></blockquote>
+<dl class="simple">
+<dt>for i, j in T.Parallel(block_M, block_N):</dt><dd><p>B[by * block_M + i, bx * block_N + j] = A_shared[i, j]</p>
+</dd>
+</dl>
+</div></blockquote>
+</dd>
+</dl>
+<p>return main</p>
+</dd></dl>
 
 <dl class="py function">
 <dt class="sig sig-object py" id="tilelang.language.import_source">
@@ -847,6 +926,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <li><a class="reference internal" href="#submodules">Submodules</a></li>
 <li><a class="reference internal" href="#module-tilelang.language">Module contents</a><ul>
 <li><a class="reference internal" href="#tilelang.language.annotate_layout"><code class="docutils literal notranslate"><span class="pre">annotate_layout()</span></code></a></li>
+<li><a class="reference internal" href="#tilelang.language.annotate_padding"><code class="docutils literal notranslate"><span class="pre">annotate_padding()</span></code></a></li>
 <li><a class="reference internal" href="#tilelang.language.import_source"><code class="docutils literal notranslate"><span class="pre">import_source()</span></code></a></li>
 <li><a class="reference internal" href="#tilelang.language.symbolic"><code class="docutils literal notranslate"><span class="pre">symbolic()</span></code></a></li>
 <li><a class="reference internal" href="#tilelang.language.use_swizzle"><code class="docutils literal notranslate"><span class="pre">use_swizzle()</span></code></a></li>

api/tilelang.language.logical.html

@@ -412,7 +412,7 @@
 <p>The language interface for tl programs.</p>
 <dl class="py function">
 <dt class="sig sig-object py" id="tilelang.language.logical.all_of">
-<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">0x7fceea39b6d0&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>
+<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">0x7f5873842bf0&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>
 <dd><p>Check if all elements in the buffer are true.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -426,7 +426,7 @@
 
 <dl class="py function">
 <dt class="sig sig-object py" id="tilelang.language.logical.any_of">
-<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">0x7fceea39b6d0&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>
+<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">0x7f5873842bf0&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>
 <dd><p>Check if any element in the buffer is true.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>

api/tilelang.language.proxy.html

@@ -460,7 +460,7 @@
 <p>Buffer proxy class for constructing tir buffer.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="tilelang.language.proxy.BufferProxy.from_ptr">
-<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">0x7fceea39b700&gt;</span></span></span><a class="headerlink" href="#tilelang.language.proxy.BufferProxy.from_ptr" title="Permalink to this definition">#</a></dt>
+<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">0x7f5873842f20&gt;</span></span></span><a class="headerlink" href="#tilelang.language.proxy.BufferProxy.from_ptr" title="Permalink to this definition">#</a></dt>
 <dd><p>Create a buffer from a pointer, shape, and data type.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>

genindex.html

@@ -476,6 +476,8 @@ <h2>A</h2>
         <li><a href="api/tilelang.tools.Analyzer.html#tilelang.tools.Analyzer.Analyzer">Analyzer (class in tilelang.tools.Analyzer)</a>
 </li>
         <li><a href="api/tilelang.language.html#tilelang.language.annotate_layout">annotate_layout() (in module tilelang.language)</a>
+</li>
+        <li><a href="api/tilelang.language.html#tilelang.language.annotate_padding">annotate_padding() (in module tilelang.language)</a>
 </li>
         <li><a href="api/tilelang.transform.html#tilelang.transform.AnnotateDeviceRegions">AnnotateDeviceRegions() (in module tilelang.transform)</a>
 </li>