Skip to content

Commit fde941e

Browse files
Update docs
1 parent 880372f commit fde941e

File tree

18 files changed

+146
-35
lines changed

18 files changed

+146
-35
lines changed

_sources/autoapi/tilelang/carver/template/flashattention/index.rst.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@ Module Contents
2020
Bases: :py:obj:`tilelang.carver.template.base.BaseTemplate`
2121

2222

23+
Base class template for hardware-aware configurations.
24+
This serves as an abstract base class (ABC) that defines the structure
25+
for subclasses implementing hardware-specific optimizations.
26+
27+
2328
.. py:attribute:: batch_size
2429
:type: int
2530
:value: 1

_sources/autoapi/tilelang/carver/template/general_reduce/index.rst.txt

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@ Module Contents
2020
Bases: :py:obj:`tilelang.carver.template.base.BaseTemplate`
2121

2222

23+
Base class template for hardware-aware configurations.
24+
This serves as an abstract base class (ABC) that defines the structure
25+
for subclasses implementing hardware-specific optimizations.
26+
27+
2328
.. py:attribute:: structure
2429
:type: Union[str, List[str]]
2530
:value: None
@@ -40,6 +45,19 @@ Module Contents
4045

4146
.. py:method:: get_hardware_aware_configs(arch = None, topk = 10)
4247
48+
Abstract method that must be implemented by subclasses.
49+
It should return a list of hardware-aware configurations (hints)
50+
based on the specified architecture.
51+
52+
:param arch: The target architecture. Defaults to None.
53+
:type arch: TileDevice, optional
54+
:param topk: Number of top configurations to return. Defaults to 10.
55+
:type topk: int, optional
56+
57+
:returns: A list of recommended hardware-aware configurations.
58+
:rtype: List[Hint]
59+
60+
4361

4462
.. py:method:: initialize_function()
4563

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

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,26 +32,41 @@ Module Contents
3232
Bases: :py:obj:`tvm.ir.base.Node`, :py:obj:`tvm.runtime.Scriptable`
3333

3434

35+
Base class of all IR Nodes.
36+
37+
3538
.. py:class:: AtomicAdd
3639
3740
Bases: :py:obj:`tvm.ir.base.Node`, :py:obj:`tvm.runtime.Scriptable`
3841

3942

43+
Base class of all IR Nodes.
44+
45+
4046
.. py:class:: Copy
4147
4248
Bases: :py:obj:`tvm.ir.base.Node`, :py:obj:`tvm.runtime.Scriptable`
4349

4450

51+
Base class of all IR Nodes.
52+
53+
4554
.. py:class:: Conv2DIm2ColOp
4655
4756
Bases: :py:obj:`tvm.ir.base.Node`, :py:obj:`tvm.runtime.Scriptable`
4857

4958

59+
Base class of all IR Nodes.
60+
61+
5062
.. py:class:: GemmWarpPolicy
5163
5264
Bases: :py:obj:`tvm.ir.base.Node`, :py:obj:`tvm.runtime.Scriptable`
5365

5466

67+
Base class of all IR Nodes.
68+
69+
5570
.. py:attribute:: policy_type
5671
:type: int
5772

@@ -72,38 +87,62 @@ Module Contents
7287
Bases: :py:obj:`tvm.ir.base.Node`, :py:obj:`tvm.runtime.Scriptable`
7388

7489

90+
Base class of all IR Nodes.
91+
92+
7593
.. py:class:: GemmSP
7694
7795
Bases: :py:obj:`tvm.ir.base.Node`, :py:obj:`tvm.runtime.Scriptable`
7896

7997

98+
Base class of all IR Nodes.
99+
100+
80101
.. py:class:: FinalizeReducerOp
81102
82103
Bases: :py:obj:`tvm.ir.base.Node`, :py:obj:`tvm.runtime.Scriptable`
83104

84105

106+
Base class of all IR Nodes.
107+
108+
85109
.. py:class:: ParallelOp
86110
87111
Bases: :py:obj:`tvm.ir.base.Node`, :py:obj:`tvm.runtime.Scriptable`
88112

89113

114+
Base class of all IR Nodes.
115+
116+
90117
.. py:class:: ReduceOp
91118
92119
Bases: :py:obj:`tvm.ir.base.Node`, :py:obj:`tvm.runtime.Scriptable`
93120

94121

122+
Base class of all IR Nodes.
123+
124+
95125
.. py:class:: CumSumOp
96126
97127
Bases: :py:obj:`tvm.ir.base.Node`, :py:obj:`tvm.runtime.Scriptable`
98128

99129

130+
Base class of all IR Nodes.
131+
132+
100133
.. py:class:: RegionOp
101134
102135
Bases: :py:obj:`tvm.ir.base.Node`, :py:obj:`tvm.runtime.Scriptable`
103136

104137

138+
Base class of all IR Nodes.
139+
140+
105141
.. py:class:: ReduceType
106142
107143
Bases: :py:obj:`tvm.ir.base.Node`, :py:obj:`tvm.runtime.Scriptable`
108144

109145

146+
Base class of all IR Nodes.
147+
148+

_sources/autoapi/tilelang/jit/adapter/dlpack/index.rst.txt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,12 @@ Classes
2020
Module Contents
2121
---------------
2222

23-
.. py:class:: TorchDLPackKernelAdapter
23+
.. py:class:: TorchDLPackKernelAdapter(mod, params, result_idx)
2424
2525
Bases: :py:obj:`tilelang.jit.adapter.base.BaseKernelAdapter`
2626

2727

28+
Helper class that provides a standard way to create an ABC using
29+
inheritance.
30+
31+

_sources/autoapi/tilelang/jit/adapter/nvrtc/adapter/index.rst.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,8 @@ Module Contents
8080
8181
8282
.. py:attribute:: target
83+
:value: None
84+
8385

8486

8587
.. py:attribute:: verbose

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -302,13 +302,13 @@ Module Contents
302302

303303
.. py:function:: sync_threads()
304304
305-
Synchronize all threads in a warp.
305+
Synchronize all threads in a block.
306306

307307

308308

309309
.. py:function:: sync_global()
310310
311-
Synchronize all threads in a block.
311+
Synchronize all threads in the entire grid.
312312

313313

314314

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ Module Contents
2525
Bases: :py:obj:`tvm.ir.Node`
2626

2727

28+
Base class of all IR Nodes.
29+
30+
2831
.. py:property:: index
2932
3033
Property to retrieve the forward index of the layout.

_sources/autoapi/tilelang/tileop/gemm/index.rst.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@ Package Contents
4343
Bases: :py:obj:`tvm.ir.base.Node`, :py:obj:`tvm.runtime.Scriptable`
4444

4545

46+
Base class of all IR Nodes.
47+
48+
4649
.. py:attribute:: A
4750
:type: tvm.tir.Buffer
4851

autoapi/tilelang/carver/template/flashattention/index.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,7 @@ <h2>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶
476476
<table class="autosummary longtable docutils align-default">
477477
<tbody>
478478
<tr class="row-odd"><td><p><a class="reference internal" href="#tilelang.carver.template.flashattention.FlashAttentionTemplate" title="tilelang.carver.template.flashattention.FlashAttentionTemplate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FlashAttentionTemplate</span></code></a></p></td>
479-
<td><p></p></td>
479+
<td><p>Base class template for hardware-aware configurations.</p></td>
480480
</tr>
481481
</tbody>
482482
</table>
@@ -488,6 +488,9 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
488488
<dt class="sig sig-object py" id="tilelang.carver.template.flashattention.FlashAttentionTemplate">
489489
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tilelang.carver.template.flashattention.</span></span><span class="sig-name descname"><span class="pre">FlashAttentionTemplate</span></span><a class="headerlink" href="#tilelang.carver.template.flashattention.FlashAttentionTemplate" title="Link to this definition"></a></dt>
490490
<dd><p>Bases: <a class="reference internal" href="../base/index.html#tilelang.carver.template.base.BaseTemplate" title="tilelang.carver.template.base.BaseTemplate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tilelang.carver.template.base.BaseTemplate</span></code></a></p>
491+
<p>Base class template for hardware-aware configurations.
492+
This serves as an abstract base class (ABC) that defines the structure
493+
for subclasses implementing hardware-specific optimizations.</p>
491494
<dl class="py attribute">
492495
<dt class="sig sig-object py" id="tilelang.carver.template.flashattention.FlashAttentionTemplate.batch_size">
493496
<span class="sig-name descname"><span class="pre">batch_size</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#tilelang.carver.template.flashattention.FlashAttentionTemplate.batch_size" title="Link to this definition"></a></dt>

autoapi/tilelang/carver/template/general_reduce/index.html

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,7 @@ <h2>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶
476476
<table class="autosummary longtable docutils align-default">
477477
<tbody>
478478
<tr class="row-odd"><td><p><a class="reference internal" href="#tilelang.carver.template.general_reduce.GeneralReductionTemplate" title="tilelang.carver.template.general_reduce.GeneralReductionTemplate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GeneralReductionTemplate</span></code></a></p></td>
479-
<td><p></p></td>
479+
<td><p>Base class template for hardware-aware configurations.</p></td>
480480
</tr>
481481
</tbody>
482482
</table>
@@ -488,6 +488,9 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
488488
<dt class="sig sig-object py" id="tilelang.carver.template.general_reduce.GeneralReductionTemplate">
489489
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tilelang.carver.template.general_reduce.</span></span><span class="sig-name descname"><span class="pre">GeneralReductionTemplate</span></span><a class="headerlink" href="#tilelang.carver.template.general_reduce.GeneralReductionTemplate" title="Link to this definition"></a></dt>
490490
<dd><p>Bases: <a class="reference internal" href="../base/index.html#tilelang.carver.template.base.BaseTemplate" title="tilelang.carver.template.base.BaseTemplate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tilelang.carver.template.base.BaseTemplate</span></code></a></p>
491+
<p>Base class template for hardware-aware configurations.
492+
This serves as an abstract base class (ABC) that defines the structure
493+
for subclasses implementing hardware-specific optimizations.</p>
491494
<dl class="py attribute">
492495
<dt class="sig sig-object py" id="tilelang.carver.template.general_reduce.GeneralReductionTemplate.structure">
493496
<span class="sig-name descname"><span class="pre">structure</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#tilelang.carver.template.general_reduce.GeneralReductionTemplate.structure" title="Link to this definition"></a></dt>
@@ -506,15 +509,21 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
506509
<dl class="py method">
507510
<dt class="sig sig-object py" id="tilelang.carver.template.general_reduce.GeneralReductionTemplate.get_hardware_aware_configs">
508511
<span class="sig-name descname"><span class="pre">get_hardware_aware_configs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arch</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">topk</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.carver.template.general_reduce.GeneralReductionTemplate.get_hardware_aware_configs" title="Link to this definition"></a></dt>
509-
<dd><dl class="field-list simple">
512+
<dd><p>Abstract method that must be implemented by subclasses.
513+
It should return a list of hardware-aware configurations (hints)
514+
based on the specified architecture.</p>
515+
<dl class="field-list simple">
510516
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
511517
<dd class="field-odd"><ul class="simple">
512-
<li><p><strong>arch</strong> (<em>tilelang.carver.arch.TileDevice</em>)</p></li>
513-
<li><p><strong>topk</strong> (<em>int</em>)</p></li>
518+
<li><p><strong>arch</strong> (<a class="reference internal" href="../../arch/arch_base/index.html#tilelang.carver.arch.arch_base.TileDevice" title="tilelang.carver.arch.arch_base.TileDevice"><em>TileDevice</em></a><em>, </em><em>optional</em>) – The target architecture. Defaults to None.</p></li>
519+
<li><p><strong>topk</strong> (<em>int</em><em>, </em><em>optional</em>) – Number of top configurations to return. Defaults to 10.</p></li>
514520
</ul>
515521
</dd>
516-
<dt class="field-even">Return type<span class="colon">:</span></dt>
517-
<dd class="field-even"><p>List[tilelang.carver.roller.Hint]</p>
522+
<dt class="field-even">Returns<span class="colon">:</span></dt>
523+
<dd class="field-even"><p>A list of recommended hardware-aware configurations.</p>
524+
</dd>
525+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
526+
<dd class="field-odd"><p>List[<a class="reference internal" href="../../roller/hint/index.html#tilelang.carver.roller.hint.Hint" title="tilelang.carver.roller.hint.Hint">Hint</a>]</p>
518527
</dd>
519528
</dl>
520529
</dd></dl>

0 commit comments

Comments
 (0)