Skip to content

Commit 9c9ff8b

Browse files
Update docs
1 parent 2a0ecac commit 9c9ff8b

File tree

9 files changed

+178
-360
lines changed

9 files changed

+178
-360
lines changed

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

Lines changed: 0 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -14,73 +14,13 @@ Functions
1414

1515
.. autoapisummary::
1616

17-
tilelang.language.copy.region
18-
tilelang.language.copy.buffer_to_tile_region
19-
tilelang.language.copy.buffer_load_to_tile_region
20-
tilelang.language.copy.buffer_region_to_tile_region
2117
tilelang.language.copy.copy
2218
tilelang.language.copy.c2d_im2col
2319

2420

2521
Module Contents
2622
---------------
2723

28-
.. py:function:: region(buffer, access_type, *args)
29-
30-
Create a memory region descriptor for tile operations.
31-
32-
:param buffer: The buffer to create a region for
33-
:type buffer: tir.BufferLoad
34-
:param access_type: Type of access - 'r' for read, 'w' for write, 'rw' for read-write
35-
:type access_type: str
36-
:param \*args: Extent expressions defining the region size
37-
:type \*args: tir.PrimExpr
38-
39-
:returns: A region descriptor for tile operations
40-
:rtype: tir.Call
41-
42-
43-
.. py:function:: buffer_to_tile_region(buffer, access_type)
44-
45-
Convert a TVM buffer to a tile region descriptor.
46-
47-
:param buffer: The buffer to convert
48-
:type buffer: tir.Buffer
49-
:param access_type: Type of access - 'r' for read, 'w' for write, 'rw' for read-write
50-
:type access_type: str
51-
52-
:returns: A region descriptor covering the entire buffer
53-
:rtype: tir.Call
54-
55-
56-
.. py:function:: buffer_load_to_tile_region(load, access_type, extents)
57-
58-
Convert a buffer load operation to a tile region descriptor.
59-
60-
:param load: The buffer load operation
61-
:type load: tir.BufferLoad
62-
:param access_type: Type of access - 'r' for read, 'w' for write, 'rw' for read-write
63-
:type access_type: str
64-
:param extents: List of expressions defining the region size
65-
:type extents: List[tir.PrimExpr]
66-
67-
:returns: A region descriptor for the loaded area
68-
:rtype: tir.Call
69-
70-
71-
.. py:function:: buffer_region_to_tile_region(buffer_region, access_type, extents)
72-
73-
Convert a buffer region to a tile region descriptor.
74-
75-
:param buffer_region: The buffer region to convert
76-
:type buffer_region: tir.BufferRegion
77-
:param access_type: Type of access - 'r' for read, 'w' for write, 'rw' for read-write
78-
:type access_type: str
79-
80-
:returns: A region descriptor for the specified buffer region
81-
:rtype: tir.Call
82-
83-
8424
.. py:function:: copy(src, dst, coalesced_width = None, disable_tma = False, eviction_policy = None)
8525
8626
Copy data between memory regions.

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

Lines changed: 0 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,6 @@ Functions
1414

1515
.. autoapisummary::
1616

17-
tilelang.language.customize.region
18-
tilelang.language.customize.buffer_to_tile_region
19-
tilelang.language.customize.buffer_load_to_tile_region
20-
tilelang.language.customize.buffer_region_to_tile_region
2117
tilelang.language.customize.dp4a
2218
tilelang.language.customize.clamp
2319
tilelang.language.customize.reshape
@@ -28,71 +24,6 @@ Functions
2824
Module Contents
2925
---------------
3026

31-
.. py:function:: region(buffer, access_type, *args)
32-
33-
Create a tile memory-region descriptor for a BufferLoad.
34-
35-
Maps access_type ('r', 'w', 'rw') to the numeric codes expected by the `tl.region` intrinsic
36-
(1, 2, 3 respectively) and returns a tir.Call representing the region with the provided extents.
37-
38-
:param buffer: The BufferLoad that identifies the underlying buffer and indices.
39-
:type buffer: tir.BufferLoad
40-
:param access_type: One of 'r', 'w', or 'rw' indicating read, write, or read-write access.
41-
:type access_type: str
42-
:param \*args: Extent expressions for each region dimension.
43-
:type \*args: tir.PrimExpr
44-
45-
:returns: A call to the `tl.region` intrinsic describing the memory region.
46-
:rtype: tir.Call
47-
48-
:raises KeyError: If access_type is not one of 'r', 'w', or 'rw'.
49-
50-
51-
.. py:function:: buffer_to_tile_region(buffer, access_type)
52-
53-
Convert a TVM buffer to a tile region descriptor.
54-
55-
:param buffer: The buffer to convert
56-
:type buffer: tir.Buffer
57-
:param access_type: Type of access - 'r' for read, 'w' for write, 'rw' for read-write
58-
:type access_type: str
59-
60-
:returns: A region descriptor covering the entire buffer
61-
:rtype: tir.Call
62-
63-
64-
.. py:function:: buffer_load_to_tile_region(load, access_type, extents)
65-
66-
Convert a buffer load operation to a tile region descriptor.
67-
68-
:param load: The buffer load operation
69-
:type load: tir.BufferLoad
70-
:param access_type: Type of access - 'r' for read, 'w' for write, 'rw' for read-write
71-
:type access_type: str
72-
:param extents: List of expressions defining the region size
73-
:type extents: List[tir.PrimExpr]
74-
75-
:returns: A region descriptor for the loaded area
76-
:rtype: tir.Call
77-
78-
79-
.. py:function:: buffer_region_to_tile_region(buffer_region, access_type, extents)
80-
81-
Create a tl region descriptor for the given BufferRegion.
82-
83-
:param buffer_region: Source buffer region whose `region` items provide mins and extents.
84-
:type buffer_region: tir.BufferRegion
85-
:param access_type: Access mode: "r", "w", or "rw".
86-
:type access_type: str
87-
:param extents: Requested extents; must have length <= the number of extents in buffer_region.region.
88-
:type extents: List[PrimExpr]
89-
90-
:returns: A tile-region descriptor (tl.region) covering the buffer_region.
91-
:rtype: tir.Call
92-
93-
:raises AssertionError: If the number of extents in buffer_region.region is smaller than len(extents).
94-
95-
9627
.. py:function:: dp4a(A, B, C)
9728
9829
Perform a 4-element dot product with accumulation (DP4A).

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

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,78 @@ Functions
99

1010
.. autoapisummary::
1111

12+
tilelang.language.utils.region
13+
tilelang.language.utils.buffer_to_tile_region
14+
tilelang.language.utils.buffer_load_to_tile_region
15+
tilelang.language.utils.buffer_region_to_tile_region
1216
tilelang.language.utils.index_to_coordinates
1317
tilelang.language.utils.linear_index
1418

1519

1620
Module Contents
1721
---------------
1822

23+
.. py:function:: region(buffer, access_type, *args)
24+
25+
Create a tile memory-region descriptor for a BufferLoad.
26+
27+
Maps access_type ('r', 'w', 'rw') to the numeric codes expected by the `tl.region` intrinsic
28+
(1, 2, 3 respectively) and returns a tir.Call representing the region with the provided extents.
29+
30+
:param buffer: The BufferLoad that identifies the underlying buffer and indices.
31+
:type buffer: tir.BufferLoad
32+
:param access_type: One of 'r', 'w', or 'rw' indicating read, write, or read-write access.
33+
:type access_type: str
34+
:param \*args: Extent expressions for each region dimension.
35+
:type \*args: tir.PrimExpr
36+
37+
:returns: A call to the `tl.region` intrinsic describing the memory region.
38+
:rtype: tir.Call
39+
40+
:raises KeyError: If access_type is not one of 'r', 'w', or 'rw'.
41+
42+
43+
.. py:function:: buffer_to_tile_region(buffer, access_type)
44+
45+
Convert a TVM buffer to a tile region descriptor.
46+
47+
:param buffer: The buffer to convert
48+
:type buffer: tir.Buffer
49+
:param access_type: Type of access - 'r' for read, 'w' for write, 'rw' for read-write
50+
:type access_type: str
51+
52+
:returns: A region descriptor covering the entire buffer
53+
:rtype: tir.Call
54+
55+
56+
.. py:function:: buffer_load_to_tile_region(load, access_type, extents)
57+
58+
Convert a buffer load operation to a tile region descriptor.
59+
60+
:param load: The buffer load operation
61+
:type load: tir.BufferLoad
62+
:param access_type: Type of access - 'r' for read, 'w' for write, 'rw' for read-write
63+
:type access_type: str
64+
:param extents: List of expressions defining the region size
65+
:type extents: List[tir.PrimExpr]
66+
67+
:returns: A region descriptor for the loaded area
68+
:rtype: tir.Call
69+
70+
71+
.. py:function:: buffer_region_to_tile_region(buffer_region, access_type, extents)
72+
73+
Convert a buffer region to a tile region descriptor.
74+
75+
:param buffer_region: The buffer region to convert
76+
:type buffer_region: tir.BufferRegion
77+
:param access_type: Type of access - 'r' for read, 'w' for write, 'rw' for read-write
78+
:type access_type: str
79+
80+
:returns: A region descriptor for the specified buffer region
81+
:rtype: tir.Call
82+
83+
1984
.. py:function:: index_to_coordinates(index, shape)
2085
2186
Convert a flat (linear) index into multi-dimensional coordinates for a given shape.

autoapi/tilelang/language/copy/index.html

Lines changed: 0 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -470,18 +470,6 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading
470470
<div class="table-wrapper autosummary longtable docutils container">
471471
<table class="autosummary longtable docutils align-default">
472472
<tbody>
473-
<tr class="row-odd"><td><p><a class="reference internal" href="#tilelang.language.copy.region" title="tilelang.language.copy.region"><code class="xref py py-obj docutils literal notranslate"><span class="pre">region</span></code></a>(buffer, access_type, *args)</p></td>
474-
<td><p>Create a memory region descriptor for tile operations.</p></td>
475-
</tr>
476-
<tr class="row-even"><td><p><a class="reference internal" href="#tilelang.language.copy.buffer_to_tile_region" title="tilelang.language.copy.buffer_to_tile_region"><code class="xref py py-obj docutils literal notranslate"><span class="pre">buffer_to_tile_region</span></code></a>(buffer, access_type)</p></td>
477-
<td><p>Convert a TVM buffer to a tile region descriptor.</p></td>
478-
</tr>
479-
<tr class="row-odd"><td><p><a class="reference internal" href="#tilelang.language.copy.buffer_load_to_tile_region" title="tilelang.language.copy.buffer_load_to_tile_region"><code class="xref py py-obj docutils literal notranslate"><span class="pre">buffer_load_to_tile_region</span></code></a>(load, access_type, extents)</p></td>
480-
<td><p>Convert a buffer load operation to a tile region descriptor.</p></td>
481-
</tr>
482-
<tr class="row-even"><td><p><a class="reference internal" href="#tilelang.language.copy.buffer_region_to_tile_region" title="tilelang.language.copy.buffer_region_to_tile_region"><code class="xref py py-obj docutils literal notranslate"><span class="pre">buffer_region_to_tile_region</span></code></a>(buffer_region, ...)</p></td>
483-
<td><p>Convert a buffer region to a tile region descriptor.</p></td>
484-
</tr>
485473
<tr class="row-odd"><td><p><a class="reference internal" href="#tilelang.language.copy.copy" title="tilelang.language.copy.copy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">copy</span></code></a>(src, dst[, coalesced_width, disable_tma, ...])</p></td>
486474
<td><p>Copy data between memory regions.</p></td>
487475
</tr>
@@ -494,89 +482,6 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading
494482
</section>
495483
<section id="module-contents">
496484
<h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to this heading"></a></h2>
497-
<dl class="py function">
498-
<dt class="sig sig-object py" id="tilelang.language.copy.region">
499-
<span class="sig-prename descclassname"><span class="pre">tilelang.language.copy.</span></span><span class="sig-name descname"><span class="pre">region</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">buffer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">access_type</span></span></em>, <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.copy.region" title="Link to this definition"></a></dt>
500-
<dd><p>Create a memory region descriptor for tile operations.</p>
501-
<dl class="field-list simple">
502-
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
503-
<dd class="field-odd"><ul class="simple">
504-
<li><p><strong>buffer</strong> (<em>tir.BufferLoad</em>) – The buffer to create a region for</p></li>
505-
<li><p><strong>access_type</strong> (<em>str</em>) – Type of access - ‘r’ for read, ‘w’ for write, ‘rw’ for read-write</p></li>
506-
<li><p><strong>*args</strong> (<em>tir.PrimExpr</em>) – Extent expressions defining the region size</p></li>
507-
</ul>
508-
</dd>
509-
<dt class="field-even">Returns<span class="colon">:</span></dt>
510-
<dd class="field-even"><p>A region descriptor for tile operations</p>
511-
</dd>
512-
<dt class="field-odd">Return type<span class="colon">:</span></dt>
513-
<dd class="field-odd"><p>tir.Call</p>
514-
</dd>
515-
</dl>
516-
</dd></dl>
517-
518-
<dl class="py function">
519-
<dt class="sig sig-object py" id="tilelang.language.copy.buffer_to_tile_region">
520-
<span class="sig-prename descclassname"><span class="pre">tilelang.language.copy.</span></span><span class="sig-name descname"><span class="pre">buffer_to_tile_region</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">buffer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">access_type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.copy.buffer_to_tile_region" title="Link to this definition"></a></dt>
521-
<dd><p>Convert a TVM buffer to a tile region descriptor.</p>
522-
<dl class="field-list simple">
523-
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
524-
<dd class="field-odd"><ul class="simple">
525-
<li><p><strong>buffer</strong> (<em>tir.Buffer</em>) – The buffer to convert</p></li>
526-
<li><p><strong>access_type</strong> (<em>str</em>) – Type of access - ‘r’ for read, ‘w’ for write, ‘rw’ for read-write</p></li>
527-
</ul>
528-
</dd>
529-
<dt class="field-even">Returns<span class="colon">:</span></dt>
530-
<dd class="field-even"><p>A region descriptor covering the entire buffer</p>
531-
</dd>
532-
<dt class="field-odd">Return type<span class="colon">:</span></dt>
533-
<dd class="field-odd"><p>tir.Call</p>
534-
</dd>
535-
</dl>
536-
</dd></dl>
537-
538-
<dl class="py function">
539-
<dt class="sig sig-object py" id="tilelang.language.copy.buffer_load_to_tile_region">
540-
<span class="sig-prename descclassname"><span class="pre">tilelang.language.copy.</span></span><span class="sig-name descname"><span class="pre">buffer_load_to_tile_region</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">load</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">access_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extents</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.copy.buffer_load_to_tile_region" title="Link to this definition"></a></dt>
541-
<dd><p>Convert a buffer load operation to a tile region descriptor.</p>
542-
<dl class="field-list simple">
543-
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
544-
<dd class="field-odd"><ul class="simple">
545-
<li><p><strong>load</strong> (<em>tir.BufferLoad</em>) – The buffer load operation</p></li>
546-
<li><p><strong>access_type</strong> (<em>str</em>) – Type of access - ‘r’ for read, ‘w’ for write, ‘rw’ for read-write</p></li>
547-
<li><p><strong>extents</strong> (<em>List</em><em>[</em><em>tir.PrimExpr</em><em>]</em>) – List of expressions defining the region size</p></li>
548-
</ul>
549-
</dd>
550-
<dt class="field-even">Returns<span class="colon">:</span></dt>
551-
<dd class="field-even"><p>A region descriptor for the loaded area</p>
552-
</dd>
553-
<dt class="field-odd">Return type<span class="colon">:</span></dt>
554-
<dd class="field-odd"><p>tir.Call</p>
555-
</dd>
556-
</dl>
557-
</dd></dl>
558-
559-
<dl class="py function">
560-
<dt class="sig sig-object py" id="tilelang.language.copy.buffer_region_to_tile_region">
561-
<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></em>, <em class="sig-param"><span class="n"><span class="pre">access_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extents</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.language.copy.buffer_region_to_tile_region" title="Link to this definition"></a></dt>
562-
<dd><p>Convert a buffer region to a tile region descriptor.</p>
563-
<dl class="field-list simple">
564-
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
565-
<dd class="field-odd"><ul class="simple">
566-
<li><p><strong>buffer_region</strong> (<em>tir.BufferRegion</em>) – The buffer region to convert</p></li>
567-
<li><p><strong>access_type</strong> (<em>str</em>) – Type of access - ‘r’ for read, ‘w’ for write, ‘rw’ for read-write</p></li>
568-
<li><p><strong>extents</strong> (<em>List</em><em>[</em><em>tvm.tir.PrimExpr</em><em>]</em>)</p></li>
569-
</ul>
570-
</dd>
571-
<dt class="field-even">Returns<span class="colon">:</span></dt>
572-
<dd class="field-even"><p>A region descriptor for the specified buffer region</p>
573-
</dd>
574-
<dt class="field-odd">Return type<span class="colon">:</span></dt>
575-
<dd class="field-odd"><p>tir.Call</p>
576-
</dd>
577-
</dl>
578-
</dd></dl>
579-
580485
<dl class="py function">
581486
<dt class="sig sig-object py" id="tilelang.language.copy.copy">
582487
<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></em>, <em class="sig-param"><span class="n"><span class="pre">dst</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coalesced_width</span></span><span class="o"><span class="pre">=</span></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="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eviction_policy</span></span><span class="o"><span class="pre">=</span></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="Link to this definition"></a></dt>
@@ -691,10 +596,6 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
691596
<li><a class="reference internal" href="#">tilelang.language.copy</a><ul>
692597
<li><a class="reference internal" href="#functions">Functions</a></li>
693598
<li><a class="reference internal" href="#module-contents">Module Contents</a><ul>
694-
<li><a class="reference internal" href="#tilelang.language.copy.region"><code class="docutils literal notranslate"><span class="pre">region()</span></code></a></li>
695-
<li><a class="reference internal" href="#tilelang.language.copy.buffer_to_tile_region"><code class="docutils literal notranslate"><span class="pre">buffer_to_tile_region()</span></code></a></li>
696-
<li><a class="reference internal" href="#tilelang.language.copy.buffer_load_to_tile_region"><code class="docutils literal notranslate"><span class="pre">buffer_load_to_tile_region()</span></code></a></li>
697-
<li><a class="reference internal" href="#tilelang.language.copy.buffer_region_to_tile_region"><code class="docutils literal notranslate"><span class="pre">buffer_region_to_tile_region()</span></code></a></li>
698599
<li><a class="reference internal" href="#tilelang.language.copy.copy"><code class="docutils literal notranslate"><span class="pre">copy()</span></code></a></li>
699600
<li><a class="reference internal" href="#tilelang.language.copy.c2d_im2col"><code class="docutils literal notranslate"><span class="pre">c2d_im2col()</span></code></a></li>
700601
</ul>

0 commit comments

Comments
 (0)