Skip to content

Commit a8e444e

Browse files
Update docs
1 parent 5998bb5 commit a8e444e

File tree

12 files changed

+70
-15
lines changed

12 files changed

+70
-15
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/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/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.

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -466,7 +466,7 @@ <h2>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶
466466
<table class="autosummary longtable docutils align-default">
467467
<tbody>
468468
<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>
469-
<td><p></p></td>
469+
<td><p>Base class template for hardware-aware configurations.</p></td>
470470
</tr>
471471
</tbody>
472472
</table>
@@ -478,6 +478,9 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
478478
<dt class="sig sig-object py" id="tilelang.carver.template.flashattention.FlashAttentionTemplate">
479479
<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>
480480
<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>
481+
<p>Base class template for hardware-aware configurations.
482+
This serves as an abstract base class (ABC) that defines the structure
483+
for subclasses implementing hardware-specific optimizations.</p>
481484
<dl class="py attribute">
482485
<dt class="sig sig-object py" id="tilelang.carver.template.flashattention.FlashAttentionTemplate.batch_size">
483486
<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
@@ -466,7 +466,7 @@ <h2>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶
466466
<table class="autosummary longtable docutils align-default">
467467
<tbody>
468468
<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>
469-
<td><p></p></td>
469+
<td><p>Base class template for hardware-aware configurations.</p></td>
470470
</tr>
471471
</tbody>
472472
</table>
@@ -478,6 +478,9 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
478478
<dt class="sig sig-object py" id="tilelang.carver.template.general_reduce.GeneralReductionTemplate">
479479
<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>
480480
<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>
481+
<p>Base class template for hardware-aware configurations.
482+
This serves as an abstract base class (ABC) that defines the structure
483+
for subclasses implementing hardware-specific optimizations.</p>
481484
<dl class="py attribute">
482485
<dt class="sig sig-object py" id="tilelang.carver.template.general_reduce.GeneralReductionTemplate.structure">
483486
<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>
@@ -496,15 +499,21 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
496499
<dl class="py method">
497500
<dt class="sig sig-object py" id="tilelang.carver.template.general_reduce.GeneralReductionTemplate.get_hardware_aware_configs">
498501
<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>
499-
<dd><dl class="field-list simple">
502+
<dd><p>Abstract method that must be implemented by subclasses.
503+
It should return a list of hardware-aware configurations (hints)
504+
based on the specified architecture.</p>
505+
<dl class="field-list simple">
500506
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
501507
<dd class="field-odd"><ul class="simple">
502-
<li><p><strong>arch</strong> (<em>tilelang.carver.arch.TileDevice</em>)</p></li>
503-
<li><p><strong>topk</strong> (<em>int</em>)</p></li>
508+
<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>
509+
<li><p><strong>topk</strong> (<em>int</em><em>, </em><em>optional</em>) – Number of top configurations to return. Defaults to 10.</p></li>
504510
</ul>
505511
</dd>
506-
<dt class="field-even">Return type<span class="colon">:</span></dt>
507-
<dd class="field-even"><p>List[tilelang.carver.roller.Hint]</p>
512+
<dt class="field-even">Returns<span class="colon">:</span></dt>
513+
<dd class="field-even"><p>A list of recommended hardware-aware configurations.</p>
514+
</dd>
515+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
516+
<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>
508517
</dd>
509518
</dl>
510519
</dd></dl>

autoapi/tilelang/jit/adapter/dlpack/index.html

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -467,7 +467,7 @@ <h2>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶
467467
<table class="autosummary longtable docutils align-default">
468468
<tbody>
469469
<tr class="row-odd"><td><p><a class="reference internal" href="#tilelang.jit.adapter.dlpack.TorchDLPackKernelAdapter" title="tilelang.jit.adapter.dlpack.TorchDLPackKernelAdapter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TorchDLPackKernelAdapter</span></code></a></p></td>
470-
<td><p></p></td>
470+
<td><p>Helper class that provides a standard way to create an ABC using</p></td>
471471
</tr>
472472
</tbody>
473473
</table>
@@ -477,8 +477,18 @@ <h2>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶
477477
<h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to this heading"></a></h2>
478478
<dl class="py class">
479479
<dt class="sig sig-object py" id="tilelang.jit.adapter.dlpack.TorchDLPackKernelAdapter">
480-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tilelang.jit.adapter.dlpack.</span></span><span class="sig-name descname"><span class="pre">TorchDLPackKernelAdapter</span></span><a class="headerlink" href="#tilelang.jit.adapter.dlpack.TorchDLPackKernelAdapter" title="Link to this definition"></a></dt>
480+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tilelang.jit.adapter.dlpack.</span></span><span class="sig-name descname"><span class="pre">TorchDLPackKernelAdapter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mod</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">result_idx</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.jit.adapter.dlpack.TorchDLPackKernelAdapter" title="Link to this definition"></a></dt>
481481
<dd><p>Bases: <a class="reference internal" href="../base/index.html#tilelang.jit.adapter.base.BaseKernelAdapter" title="tilelang.jit.adapter.base.BaseKernelAdapter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tilelang.jit.adapter.base.BaseKernelAdapter</span></code></a></p>
482+
<p>Helper class that provides a standard way to create an ABC using
483+
inheritance.</p>
484+
<dl class="field-list simple">
485+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
486+
<dd class="field-odd"><ul class="simple">
487+
<li><p><strong>params</strong> (<em>List</em><em>[</em><a class="reference internal" href="../../../engine/param/index.html#tilelang.engine.param.KernelParam" title="tilelang.engine.param.KernelParam"><em>tilelang.engine.param.KernelParam</em></a><em>]</em>)</p></li>
488+
<li><p><strong>result_idx</strong> (<em>List</em><em>[</em><em>int</em><em>]</em>)</p></li>
489+
</ul>
490+
</dd>
491+
</dl>
482492
</dd></dl>
483493

484494
</section>

autoapi/tilelang/jit/adapter/nvrtc/adapter/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -579,7 +579,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
579579

580580
<dl class="py attribute">
581581
<dt class="sig sig-object py" id="tilelang.jit.adapter.nvrtc.adapter.NVRTCKernelAdapter.target">
582-
<span class="sig-name descname"><span class="pre">target</span></span><a class="headerlink" href="#tilelang.jit.adapter.nvrtc.adapter.NVRTCKernelAdapter.target" title="Link to this definition"></a></dt>
582+
<span class="sig-name descname"><span class="pre">target</span></span><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.jit.adapter.nvrtc.adapter.NVRTCKernelAdapter.target" title="Link to this definition"></a></dt>
583583
<dd></dd></dl>
584584

585585
<dl class="py attribute">

autoapi/tilelang/language/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -544,7 +544,7 @@ <h2>Package Contents<a class="headerlink" href="#package-contents" title="Link t
544544
<dd class="field-odd"><ul class="simple">
545545
<li><p><strong>panel_size</strong> (<em>int</em>)</p></li>
546546
<li><p><strong>order</strong> (<em>str</em>)</p></li>
547-
<li><p><strong>enable</strong> (<em>bool</em>)</p></li>
547+
<li><p><strong>enable</strong> (<em>tvm.script.parser.tir.bool</em>)</p></li>
548548
</ul>
549549
</dd>
550550
</dl>
@@ -654,7 +654,7 @@ <h2>Package Contents<a class="headerlink" href="#package-contents" title="Link t
654654
<span class="sig-prename descclassname"><span class="pre">tilelang.language.</span></span><span class="sig-name descname"><span class="pre">import_source</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source</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.import_source" title="Link to this definition"></a></dt>
655655
<dd><dl class="field-list simple">
656656
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
657-
<dd class="field-odd"><p><strong>source</strong> (<em>Optional</em><em>[</em><em>str</em><em>]</em>)</p>
657+
<dd class="field-odd"><p><strong>source</strong> (<em>tvm.script.parser.tir.Optional</em><em>[</em><em>str</em><em>]</em>)</p>
658658
</dd>
659659
</dl>
660660
</dd></dl>

0 commit comments

Comments
 (0)