Skip to content

Commit eb4a5ec

Browse files
Update docs
1 parent 6f2cf45 commit eb4a5ec

File tree

5 files changed

+22
-17
lines changed

5 files changed

+22
-17
lines changed

_sources/autoapi/tilelang/language/index.rst.txt

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Functions
4848
tilelang.language.symbolic
4949
tilelang.language.use_swizzle
5050
tilelang.language.annotate_layout
51-
tilelang.language.annotate_padding
51+
tilelang.language.annotate_safe_value
5252
tilelang.language.annotate_l2_hit_ratio
5353
tilelang.language.import_source
5454

@@ -102,12 +102,15 @@ Package Contents
102102
return main
103103

104104

105-
.. py:function:: annotate_padding(padding_map)
105+
.. py:function:: annotate_safe_value(safe_value_map)
106106
107-
Annotate the padding of the buffer
107+
Annotate the safe value of the buffer.
108108

109-
:param padding_map: a dictionary of buffer to padding value
110-
:type padding_map: dict
109+
A safe value of a buffer is the value that will be used when the
110+
buffer is accessed out of bounds.
111+
112+
:param safe_value_map: a dictionary of buffer to safe value
113+
:type safe_value_map: dict
111114

112115
:returns: a block attribute
113116
:rtype: block_attr
@@ -123,7 +126,7 @@ Package Contents
123126
with T.Kernel(T.ceildiv(N, block_N), T.ceildiv(M, block_M), threads=128) as (bx, by):
124127
A_shared = T.alloc_shared((block_M, block_N), dtype)
125128

126-
T.annotate_padding({A_shared: pad_value})
129+
T.annotate_safe_value({A: safe_value})
127130
for i, j in T.Parallel(block_M, block_N):
128131
A_shared[i, j] = A[by * block_M + i - 10, bx * block_N + j]
129132

autoapi/tilelang/language/index.html

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -523,8 +523,8 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading
523523
<tr class="row-odd"><td><p><a class="reference internal" href="#tilelang.language.annotate_layout" title="tilelang.language.annotate_layout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">annotate_layout</span></code></a>(layout_map)</p></td>
524524
<td><p>Annotate the layout of the buffer</p></td>
525525
</tr>
526-
<tr class="row-even"><td><p><a class="reference internal" href="#tilelang.language.annotate_padding" title="tilelang.language.annotate_padding"><code class="xref py py-obj docutils literal notranslate"><span class="pre">annotate_padding</span></code></a>(padding_map)</p></td>
527-
<td><p>Annotate the padding of the buffer</p></td>
526+
<tr class="row-even"><td><p><a class="reference internal" href="#tilelang.language.annotate_safe_value" title="tilelang.language.annotate_safe_value"><code class="xref py py-obj docutils literal notranslate"><span class="pre">annotate_safe_value</span></code></a>(safe_value_map)</p></td>
527+
<td><p>Annotate the safe value of the buffer.</p></td>
528528
</tr>
529529
<tr class="row-odd"><td><p><a class="reference internal" href="#tilelang.language.annotate_l2_hit_ratio" title="tilelang.language.annotate_l2_hit_ratio"><code class="xref py py-obj docutils literal notranslate"><span class="pre">annotate_l2_hit_ratio</span></code></a>(l2_hit_ratio_map)</p></td>
530530
<td><p>Annotate the L2 hit ratio of the buffer, detailed explanation please refer to:</p></td>
@@ -615,12 +615,14 @@ <h2>Package Contents<a class="headerlink" href="#package-contents" title="Link t
615615
</dd></dl>
616616

617617
<dl class="py function">
618-
<dt class="sig sig-object py" id="tilelang.language.annotate_padding">
619-
<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></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.annotate_padding" title="Link to this definition"></a></dt>
620-
<dd><p>Annotate the padding of the buffer</p>
618+
<dt class="sig sig-object py" id="tilelang.language.annotate_safe_value">
619+
<span class="sig-prename descclassname"><span class="pre">tilelang.language.</span></span><span class="sig-name descname"><span class="pre">annotate_safe_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">safe_value_map</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.annotate_safe_value" title="Link to this definition"></a></dt>
620+
<dd><p>Annotate the safe value of the buffer.</p>
621+
<p>A safe value of a buffer is the value that will be used when the
622+
buffer is accessed out of bounds.</p>
621623
<dl class="field-list simple">
622624
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
623-
<dd class="field-odd"><p><strong>padding_map</strong> (<em>dict</em>) – a dictionary of buffer to padding value</p>
625+
<dd class="field-odd"><p><strong>safe_value_map</strong> (<em>dict</em>) – a dictionary of buffer to safe value</p>
624626
</dd>
625627
<dt class="field-even">Returns<span class="colon">:</span></dt>
626628
<dd class="field-even"><p>a block attribute</p>
@@ -641,7 +643,7 @@ <h2>Package Contents<a class="headerlink" href="#package-contents" title="Link t
641643
with T.Kernel(T.ceildiv(N, block_N), T.ceildiv(M, block_M), threads=128) as (bx, by):</p>
642644
<blockquote>
643645
<div><p>A_shared = T.alloc_shared((block_M, block_N), dtype)</p>
644-
<p>T.annotate_padding({A_shared: pad_value})
646+
<p>T.annotate_safe_value({A: safe_value})
645647
for i, j in T.Parallel(block_M, block_N):</p>
646648
<blockquote>
647649
<div><p>A_shared[i, j] = A[by * block_M + i - 10, bx * block_N + j]</p>
@@ -746,7 +748,7 @@ <h2>Package Contents<a class="headerlink" href="#package-contents" title="Link t
746748
<li><a class="reference internal" href="#tilelang.language.symbolic"><code class="docutils literal notranslate"><span class="pre">symbolic()</span></code></a></li>
747749
<li><a class="reference internal" href="#tilelang.language.use_swizzle"><code class="docutils literal notranslate"><span class="pre">use_swizzle()</span></code></a></li>
748750
<li><a class="reference internal" href="#tilelang.language.annotate_layout"><code class="docutils literal notranslate"><span class="pre">annotate_layout()</span></code></a></li>
749-
<li><a class="reference internal" href="#tilelang.language.annotate_padding"><code class="docutils literal notranslate"><span class="pre">annotate_padding()</span></code></a></li>
751+
<li><a class="reference internal" href="#tilelang.language.annotate_safe_value"><code class="docutils literal notranslate"><span class="pre">annotate_safe_value()</span></code></a></li>
750752
<li><a class="reference internal" href="#tilelang.language.annotate_l2_hit_ratio"><code class="docutils literal notranslate"><span class="pre">annotate_l2_hit_ratio()</span></code></a></li>
751753
<li><a class="reference internal" href="#tilelang.language.import_source"><code class="docutils literal notranslate"><span class="pre">import_source()</span></code></a></li>
752754
</ul>

genindex.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -764,10 +764,10 @@ <h2>A</h2>
764764
<li><a href="autoapi/tilelang/language/index.html#tilelang.language.annotate_l2_hit_ratio">annotate_l2_hit_ratio() (in module tilelang.language)</a>
765765
</li>
766766
<li><a href="autoapi/tilelang/language/index.html#tilelang.language.annotate_layout">annotate_layout() (in module tilelang.language)</a>
767-
</li>
768-
<li><a href="autoapi/tilelang/language/index.html#tilelang.language.annotate_padding">annotate_padding() (in module tilelang.language)</a>
769767
</li>
770768
<li><a href="autoapi/tilelang/language/builtin/index.html#tilelang.language.builtin.annotate_producer_reg_dealloc">annotate_producer_reg_dealloc() (in module tilelang.language.builtin)</a>
769+
</li>
770+
<li><a href="autoapi/tilelang/language/index.html#tilelang.language.annotate_safe_value">annotate_safe_value() (in module tilelang.language)</a>
771771
</li>
772772
<li><a href="autoapi/tilelang/transform/index.html#tilelang.transform.AnnotateDeviceRegions">AnnotateDeviceRegions() (in module tilelang.transform)</a>
773773
</li>

objects.inv

-1 Bytes
Binary file not shown.

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)