Skip to content

Commit 824b895

Browse files
Update docs
1 parent bed0212 commit 824b895

File tree

7 files changed

+63
-33
lines changed

7 files changed

+63
-33
lines changed

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,19 @@ Module Contents
132132

133133

134134

135+
.. py:method:: reshape(shape, rescale_num=1, rescale_den=1)
136+
137+
Reshape the input shape of the layout.
138+
139+
:param shape: The new input shape.
140+
:type shape: list[PrimExpr] or list[int]
141+
:param rescale_num: Rescale numerator for element size changes.
142+
:type rescale_num: int
143+
:param rescale_den: Rescale denominator for element size changes.
144+
:type rescale_den: int
145+
146+
147+
135148
.. py:method:: is_equal(other)
136149
137150
Check if the current layout is equal to another layout.

_sources/autoapi/tilelang/layout/swizzle/index.rst.txt

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -38,41 +38,38 @@ Module Contents
3838
3939
.. py:function:: make_tcgen05mma_swizzled_layout(buffer, continuity = None, k_major = True)
4040
41-
.. py:function:: make_full_bank_swizzled_layout(*args)
41+
.. py:function:: make_full_bank_swizzled_layout(buffer)
4242
43-
:param args: buffer/BufferLoad/BufferRegion or (stride, continuous, element_size)
43+
:param buffer: BufferLikeType
4444

4545
.. rubric:: Examples
4646

4747
make_full_bank_swizzled_layout(buffer)
48-
make_full_bank_swizzled_layout(stride, continuous, element_size)
4948

5049

51-
.. py:function:: make_half_bank_swizzled_layout(*args)
50+
.. py:function:: make_half_bank_swizzled_layout(buffer)
5251
53-
:param args: buffer/BufferLoad/BufferRegion or (stride, continuous, element_size)
52+
:param buffer: BufferLikeType
5453

5554
.. rubric:: Examples
5655

5756
make_half_bank_swizzled_layout(buffer)
58-
make_half_bank_swizzled_layout(stride, continuous, element_size)
5957

6058

61-
.. py:function:: make_quarter_bank_swizzled_layout(*args)
59+
.. py:function:: make_quarter_bank_swizzled_layout(buffer)
6260
63-
:param args: buffer/BufferLoad/BufferRegion or (stride, continuous, element_size)
61+
:param buffer: BufferLikeType
6462

6563
.. rubric:: Examples
6664

6765
make_quarter_bank_swizzled_layout(buffer)
68-
make_quarter_bank_swizzled_layout(stride, continuous, element_size)
6966

7067

7168
.. py:function:: make_linear_layout(buffer_or_load_or_region)
7269
7370
Create a row-major linear layout for any dimension.
7471

75-
:param buffer_or_load_or_region: Buffer, BufferLoad, or BufferRegion
72+
:param buffer_or_load_or_region: BufferLikeType
7673

7774
:returns: A row-major linear layout
7875
:rtype: Layout
@@ -107,7 +104,7 @@ Module Contents
107104
entire buffer. This is useful for index buffers or masks that need to be
108105
accessed uniformly across all threads.
109106

110-
:param buffer: Buffer, BufferLoad, or BufferRegion to get shape information
107+
:param buffer: BufferLikeType to get shape information
111108
:param threads: Number of threads (replicate extent)
112109

113110
:returns: A fully replicated layout where each thread has a complete copy

autoapi/tilelang/layout/layout/index.html

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -724,6 +724,24 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
724724
</dl>
725725
</dd></dl>
726726

727+
<dl class="py method">
728+
<dt class="sig sig-object py" id="tilelang.layout.layout.Layout.reshape">
729+
<span class="sig-name descname"><span class="pre">reshape</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">rescale_num</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rescale_den</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.layout.layout.Layout.reshape" title="Link to this definition"></a></dt>
730+
<dd><p>Reshape the input shape of the layout.</p>
731+
<dl class="field-list simple">
732+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
733+
<dd class="field-odd"><ul class="simple">
734+
<li><p><strong>shape</strong> (<em>list</em><em>[</em><em>PrimExpr</em><em>] or </em><em>list</em><em>[</em><em>int</em><em>]</em>) – The new input shape.</p></li>
735+
<li><p><strong>rescale_num</strong> (<em>int</em>) – Rescale numerator for element size changes.</p></li>
736+
<li><p><strong>rescale_den</strong> (<em>int</em>) – Rescale denominator for element size changes.</p></li>
737+
</ul>
738+
</dd>
739+
<dt class="field-even">Return type<span class="colon">:</span></dt>
740+
<dd class="field-even"><p><a class="reference internal" href="#tilelang.layout.layout.Layout" title="tilelang.layout.layout.Layout">Layout</a></p>
741+
</dd>
742+
</dl>
743+
</dd></dl>
744+
727745
<dl class="py method">
728746
<dt class="sig sig-object py" id="tilelang.layout.layout.Layout.is_equal">
729747
<span class="sig-name descname"><span class="pre">is_equal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.layout.layout.Layout.is_equal" title="Link to this definition"></a></dt>
@@ -829,6 +847,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
829847
<li><a class="reference internal" href="#tilelang.layout.layout.Layout.repeat"><code class="docutils literal notranslate"><span class="pre">Layout.repeat()</span></code></a></li>
830848
<li><a class="reference internal" href="#tilelang.layout.layout.Layout.expand"><code class="docutils literal notranslate"><span class="pre">Layout.expand()</span></code></a></li>
831849
<li><a class="reference internal" href="#tilelang.layout.layout.Layout.inverse"><code class="docutils literal notranslate"><span class="pre">Layout.inverse()</span></code></a></li>
850+
<li><a class="reference internal" href="#tilelang.layout.layout.Layout.reshape"><code class="docutils literal notranslate"><span class="pre">Layout.reshape()</span></code></a></li>
832851
<li><a class="reference internal" href="#tilelang.layout.layout.Layout.is_equal"><code class="docutils literal notranslate"><span class="pre">Layout.is_equal()</span></code></a></li>
833852
<li><a class="reference internal" href="#tilelang.layout.layout.Layout.__call__"><code class="docutils literal notranslate"><span class="pre">Layout.__call__()</span></code></a></li>
834853
<li><a class="reference internal" href="#tilelang.layout.layout.Layout.__repr__"><code class="docutils literal notranslate"><span class="pre">Layout.__repr__()</span></code></a></li>

autoapi/tilelang/layout/swizzle/index.html

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -575,13 +575,13 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading
575575
<tr class="row-even"><td><p><a class="reference internal" href="#tilelang.layout.swizzle.make_tcgen05mma_swizzled_layout" title="tilelang.layout.swizzle.make_tcgen05mma_swizzled_layout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">make_tcgen05mma_swizzled_layout</span></code></a>(buffer[, continuity, ...])</p></td>
576576
<td><p></p></td>
577577
</tr>
578-
<tr class="row-odd"><td><p><a class="reference internal" href="#tilelang.layout.swizzle.make_full_bank_swizzled_layout" title="tilelang.layout.swizzle.make_full_bank_swizzled_layout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">make_full_bank_swizzled_layout</span></code></a>(*args)</p></td>
578+
<tr class="row-odd"><td><p><a class="reference internal" href="#tilelang.layout.swizzle.make_full_bank_swizzled_layout" title="tilelang.layout.swizzle.make_full_bank_swizzled_layout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">make_full_bank_swizzled_layout</span></code></a>(buffer)</p></td>
579579
<td><p></p></td>
580580
</tr>
581-
<tr class="row-even"><td><p><a class="reference internal" href="#tilelang.layout.swizzle.make_half_bank_swizzled_layout" title="tilelang.layout.swizzle.make_half_bank_swizzled_layout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">make_half_bank_swizzled_layout</span></code></a>(*args)</p></td>
581+
<tr class="row-even"><td><p><a class="reference internal" href="#tilelang.layout.swizzle.make_half_bank_swizzled_layout" title="tilelang.layout.swizzle.make_half_bank_swizzled_layout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">make_half_bank_swizzled_layout</span></code></a>(buffer)</p></td>
582582
<td><p></p></td>
583583
</tr>
584-
<tr class="row-odd"><td><p><a class="reference internal" href="#tilelang.layout.swizzle.make_quarter_bank_swizzled_layout" title="tilelang.layout.swizzle.make_quarter_bank_swizzled_layout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">make_quarter_bank_swizzled_layout</span></code></a>(*args)</p></td>
584+
<tr class="row-odd"><td><p><a class="reference internal" href="#tilelang.layout.swizzle.make_quarter_bank_swizzled_layout" title="tilelang.layout.swizzle.make_quarter_bank_swizzled_layout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">make_quarter_bank_swizzled_layout</span></code></a>(buffer)</p></td>
585585
<td><p></p></td>
586586
</tr>
587587
<tr class="row-even"><td><p><a class="reference internal" href="#tilelang.layout.swizzle.make_linear_layout" title="tilelang.layout.swizzle.make_linear_layout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">make_linear_layout</span></code></a>(buffer_or_load_or_region)</p></td>
@@ -608,7 +608,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
608608
<dd><dl class="field-list simple">
609609
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
610610
<dd class="field-odd"><ul class="simple">
611-
<li><p><strong>buffer</strong> (<em>tvm.tir.Buffer</em><em> | </em><em>tvm.tir.BufferLoad</em><em> | </em><em>tvm.tir.BufferRegion</em>)</p></li>
611+
<li><p><strong>buffer</strong> (<em>tilelang._typing.BufferLikeType</em>)</p></li>
612612
<li><p><strong>k_major</strong> (<a class="reference internal" href="../../language/dtypes/index.html#tilelang.language.dtypes.bool" title="tilelang.language.dtypes.bool"><em>bool</em></a>)</p></li>
613613
<li><p><strong>allow_pad</strong> (<a class="reference internal" href="../../language/dtypes/index.html#tilelang.language.dtypes.bool" title="tilelang.language.dtypes.bool"><em>bool</em></a>)</p></li>
614614
</ul>
@@ -622,7 +622,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
622622
<dd><dl class="field-list simple">
623623
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
624624
<dd class="field-odd"><ul class="simple">
625-
<li><p><strong>buffer</strong> (<em>tvm.tir.Buffer</em><em> | </em><em>tvm.tir.BufferLoad</em><em> | </em><em>tvm.tir.BufferRegion</em>)</p></li>
625+
<li><p><strong>buffer</strong> (<em>tilelang._typing.BufferLikeType</em>)</p></li>
626626
<li><p><strong>is_a</strong> (<a class="reference internal" href="../../language/dtypes/index.html#tilelang.language.dtypes.bool" title="tilelang.language.dtypes.bool"><em>bool</em></a>)</p></li>
627627
<li><p><strong>k_inner</strong> (<a class="reference internal" href="../../language/dtypes/index.html#tilelang.language.dtypes.bool" title="tilelang.language.dtypes.bool"><em>bool</em></a>)</p></li>
628628
</ul>
@@ -636,7 +636,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
636636
<dd><dl class="field-list simple">
637637
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
638638
<dd class="field-odd"><ul class="simple">
639-
<li><p><strong>buffer</strong> (<em>tvm.tir.Buffer</em><em> | </em><em>tvm.tir.BufferLoad</em><em> | </em><em>tvm.tir.BufferRegion</em>)</p></li>
639+
<li><p><strong>buffer</strong> (<em>tilelang._typing.BufferLikeType</em>)</p></li>
640640
<li><p><strong>continuity</strong> (<em>int</em>)</p></li>
641641
<li><p><strong>k_major</strong> (<a class="reference internal" href="../../language/dtypes/index.html#tilelang.language.dtypes.bool" title="tilelang.language.dtypes.bool"><em>bool</em></a>)</p></li>
642642
</ul>
@@ -650,7 +650,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
650650
<dd><dl class="field-list simple">
651651
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
652652
<dd class="field-odd"><ul class="simple">
653-
<li><p><strong>buffer</strong> (<em>tvm.tir.Buffer</em><em> | </em><em>tvm.tir.BufferLoad</em><em> | </em><em>tvm.tir.BufferRegion</em>)</p></li>
653+
<li><p><strong>buffer</strong> (<em>tilelang._typing.BufferLikeType</em>)</p></li>
654654
<li><p><strong>continuity</strong> (<em>int</em>)</p></li>
655655
<li><p><strong>k_major</strong> (<a class="reference internal" href="../../language/dtypes/index.html#tilelang.language.dtypes.bool" title="tilelang.language.dtypes.bool"><em>bool</em></a>)</p></li>
656656
</ul>
@@ -660,41 +660,38 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
660660

661661
<dl class="py function">
662662
<dt class="sig sig-object py" id="tilelang.layout.swizzle.make_full_bank_swizzled_layout">
663-
<span class="sig-prename descclassname"><span class="pre">tilelang.layout.swizzle.</span></span><span class="sig-name descname"><span class="pre">make_full_bank_swizzled_layout</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.layout.swizzle.make_full_bank_swizzled_layout" title="Link to this definition"></a></dt>
663+
<span class="sig-prename descclassname"><span class="pre">tilelang.layout.swizzle.</span></span><span class="sig-name descname"><span class="pre">make_full_bank_swizzled_layout</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">buffer</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.layout.swizzle.make_full_bank_swizzled_layout" title="Link to this definition"></a></dt>
664664
<dd><dl class="field-list simple">
665665
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
666-
<dd class="field-odd"><p><strong>args</strong> – buffer/BufferLoad/BufferRegion or (stride, continuous, element_size)</p>
666+
<dd class="field-odd"><p><strong>buffer</strong> (<em>tilelang._typing.BufferLikeType</em>) – BufferLikeType</p>
667667
</dd>
668668
</dl>
669669
<p class="rubric">Examples</p>
670-
<p>make_full_bank_swizzled_layout(buffer)
671-
make_full_bank_swizzled_layout(stride, continuous, element_size)</p>
670+
<p>make_full_bank_swizzled_layout(buffer)</p>
672671
</dd></dl>
673672

674673
<dl class="py function">
675674
<dt class="sig sig-object py" id="tilelang.layout.swizzle.make_half_bank_swizzled_layout">
676-
<span class="sig-prename descclassname"><span class="pre">tilelang.layout.swizzle.</span></span><span class="sig-name descname"><span class="pre">make_half_bank_swizzled_layout</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.layout.swizzle.make_half_bank_swizzled_layout" title="Link to this definition"></a></dt>
675+
<span class="sig-prename descclassname"><span class="pre">tilelang.layout.swizzle.</span></span><span class="sig-name descname"><span class="pre">make_half_bank_swizzled_layout</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">buffer</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.layout.swizzle.make_half_bank_swizzled_layout" title="Link to this definition"></a></dt>
677676
<dd><dl class="field-list simple">
678677
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
679-
<dd class="field-odd"><p><strong>args</strong> – buffer/BufferLoad/BufferRegion or (stride, continuous, element_size)</p>
678+
<dd class="field-odd"><p><strong>buffer</strong> (<em>tilelang._typing.BufferLikeType</em>) – BufferLikeType</p>
680679
</dd>
681680
</dl>
682681
<p class="rubric">Examples</p>
683-
<p>make_half_bank_swizzled_layout(buffer)
684-
make_half_bank_swizzled_layout(stride, continuous, element_size)</p>
682+
<p>make_half_bank_swizzled_layout(buffer)</p>
685683
</dd></dl>
686684

687685
<dl class="py function">
688686
<dt class="sig sig-object py" id="tilelang.layout.swizzle.make_quarter_bank_swizzled_layout">
689-
<span class="sig-prename descclassname"><span class="pre">tilelang.layout.swizzle.</span></span><span class="sig-name descname"><span class="pre">make_quarter_bank_swizzled_layout</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.layout.swizzle.make_quarter_bank_swizzled_layout" title="Link to this definition"></a></dt>
687+
<span class="sig-prename descclassname"><span class="pre">tilelang.layout.swizzle.</span></span><span class="sig-name descname"><span class="pre">make_quarter_bank_swizzled_layout</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">buffer</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.layout.swizzle.make_quarter_bank_swizzled_layout" title="Link to this definition"></a></dt>
690688
<dd><dl class="field-list simple">
691689
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
692-
<dd class="field-odd"><p><strong>args</strong> – buffer/BufferLoad/BufferRegion or (stride, continuous, element_size)</p>
690+
<dd class="field-odd"><p><strong>buffer</strong> (<em>tilelang._typing.BufferLikeType</em>) – BufferLikeType</p>
693691
</dd>
694692
</dl>
695693
<p class="rubric">Examples</p>
696-
<p>make_quarter_bank_swizzled_layout(buffer)
697-
make_quarter_bank_swizzled_layout(stride, continuous, element_size)</p>
694+
<p>make_quarter_bank_swizzled_layout(buffer)</p>
698695
</dd></dl>
699696

700697
<dl class="py function">
@@ -703,7 +700,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
703700
<dd><p>Create a row-major linear layout for any dimension.</p>
704701
<dl class="field-list simple">
705702
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
706-
<dd class="field-odd"><p><strong>buffer_or_load_or_region</strong> (<em>tvm.tir.Buffer</em><em> | </em><em>tvm.tir.BufferLoad</em><em> | </em><em>tvm.tir.BufferRegion</em>) – Buffer, BufferLoad, or BufferRegion</p>
703+
<dd class="field-odd"><p><strong>buffer_or_load_or_region</strong> (<em>tilelang._typing.BufferLikeType</em>) – BufferLikeType</p>
707704
</dd>
708705
<dt class="field-even">Returns<span class="colon">:</span></dt>
709706
<dd class="field-even"><p>A row-major linear layout</p>
@@ -755,7 +752,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
755752
<dl class="field-list simple">
756753
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
757754
<dd class="field-odd"><ul class="simple">
758-
<li><p><strong>buffer</strong> (<em>tvm.tir.Buffer</em><em> | </em><em>tvm.tir.BufferLoad</em><em> | </em><em>tvm.tir.BufferRegion</em>) – Buffer, BufferLoad, or BufferRegion to get shape information</p></li>
755+
<li><p><strong>buffer</strong> (<em>tilelang._typing.BufferLikeType</em>) – BufferLikeType to get shape information</p></li>
759756
<li><p><strong>threads</strong> (<em>int</em>) – Number of threads (replicate extent)</p></li>
760757
</ul>
761758
</dd>

genindex.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6258,7 +6258,11 @@ <h2>R</h2>
62586258
<li><a href="autoapi/tilelang/autodd/index.html#tilelang.autodd.ParTaskManager.reset">reset() (tilelang.autodd.ParTaskManager method)</a>
62596259
</li>
62606260
<li><a href="autoapi/tilelang/language/customize/index.html#tilelang.language.customize.reshape">reshape() (in module tilelang.language.customize)</a>
6261+
6262+
<ul>
6263+
<li><a href="autoapi/tilelang/layout/layout/index.html#tilelang.layout.layout.Layout.reshape">(tilelang.layout.layout.Layout method)</a>
62616264
</li>
6265+
</ul></li>
62626266
<li><a href="autoapi/tilelang/jit/execution_backend/index.html#tilelang.jit.execution_backend.resolve_execution_backend">resolve_execution_backend() (in module tilelang.jit.execution_backend)</a>
62636267
</li>
62646268
<li><a href="autoapi/tilelang/transform/decouple_type_cast/index.html#tilelang.transform.decouple_type_cast.GlobalSharedBufferLoadCollector.result">result (tilelang.transform.decouple_type_cast.GlobalSharedBufferLoadCollector attribute)</a>

objects.inv

2 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)