Update docs

Author: LeiWang1999

_sources/autoapi/tilelang/carver/arch/cuda/index.rst.txt

@@ -92,6 +92,9 @@ Module Contents
    Bases: :py:obj:`tilelang.carver.arch.arch_base.TileDevice`
 
 
+   Represents the architecture of a computing device, capturing various hardware specifications.
+
+
    .. py:attribute:: target
 
 

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

@@ -20,6 +20,11 @@ Module Contents
    Bases: :py:obj:`tilelang.carver.template.base.BaseTemplate`
 
 
+   Base class template for hardware-aware configurations.
+   This serves as an abstract base class (ABC) that defines the structure
+   for subclasses implementing hardware-specific optimizations.
+
+
    .. py:attribute:: batch_size
       :type:  int
       :value: 1

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

@@ -20,6 +20,11 @@ Module Contents
    Bases: :py:obj:`tilelang.carver.template.base.BaseTemplate`
 
 
+   Base class template for hardware-aware configurations.
+   This serves as an abstract base class (ABC) that defines the structure
+   for subclasses implementing hardware-specific optimizations.
+
+
    .. py:attribute:: structure
       :type:  Union[str, List[str]]
       :value: None
@@ -40,6 +45,19 @@ Module Contents
 
    .. py:method:: get_hardware_aware_configs(arch = None, topk = 10)
 
+      Abstract method that must be implemented by subclasses.
+      It should return a list of hardware-aware configurations (hints)
+      based on the specified architecture.
+
+      :param arch: The target architecture. Defaults to None.
+      :type arch: TileDevice, optional
+      :param topk: Number of top configurations to return. Defaults to 10.
+      :type topk: int, optional
+
+      :returns: A list of recommended hardware-aware configurations.
+      :rtype: List[Hint]
+
+
 
    .. py:method:: initialize_function()
 

autoapi/tilelang/carver/arch/cuda/index.html

@@ -489,7 +489,7 @@ <h2>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶
 <td><p></p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="#tilelang.carver.arch.cuda.CUDA" title="tilelang.carver.arch.cuda.CUDA"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CUDA</span></code></a></p></td>
-<td><p></p></td>
+<td><p>Represents the architecture of a computing device, capturing various hardware specifications.</p></td>
 </tr>
 </tbody>
 </table>
@@ -686,6 +686,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
 <dt class="sig sig-object py" id="tilelang.carver.arch.cuda.CUDA">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tilelang.carver.arch.cuda.</span></span><span class="sig-name descname"><span class="pre">CUDA</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tilelang.carver.arch.cuda.CUDA" title="Link to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="../arch_base/index.html#tilelang.carver.arch.arch_base.TileDevice" title="tilelang.carver.arch.arch_base.TileDevice"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tilelang.carver.arch.arch_base.TileDevice</span></code></a></p>
+<p>Represents the architecture of a computing device, capturing various hardware specifications.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><p><strong>target</strong> (<em>Union</em><em>[</em><em>tvm.target.Target</em><em>, </em><em>str</em><em>]</em>)</p>

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

@@ -465,7 +465,7 @@ <h2>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶
 <table class="autosummary longtable docutils align-default">
 <tbody>
 <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>
-<td><p></p></td>
+<td><p>Base class template for hardware-aware configurations.</p></td>
 </tr>
 </tbody>
 </table>
@@ -477,6 +477,9 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
 <dt class="sig sig-object py" id="tilelang.carver.template.flashattention.FlashAttentionTemplate">
 <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>
 <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>
+<p>Base class template for hardware-aware configurations.
+This serves as an abstract base class (ABC) that defines the structure
+for subclasses implementing hardware-specific optimizations.</p>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="tilelang.carver.template.flashattention.FlashAttentionTemplate.batch_size">
 <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

@@ -465,7 +465,7 @@ <h2>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶
 <table class="autosummary longtable docutils align-default">
 <tbody>
 <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>
-<td><p></p></td>
+<td><p>Base class template for hardware-aware configurations.</p></td>
 </tr>
 </tbody>
 </table>
@@ -477,6 +477,9 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
 <dt class="sig sig-object py" id="tilelang.carver.template.general_reduce.GeneralReductionTemplate">
 <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>
 <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>
+<p>Base class template for hardware-aware configurations.
+This serves as an abstract base class (ABC) that defines the structure
+for subclasses implementing hardware-specific optimizations.</p>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="tilelang.carver.template.general_reduce.GeneralReductionTemplate.structure">
 <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>
@@ -495,15 +498,21 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
 <dl class="py method">
 <dt class="sig sig-object py" id="tilelang.carver.template.general_reduce.GeneralReductionTemplate.get_hardware_aware_configs">
 <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>
-<dd><dl class="field-list simple">
+<dd><p>Abstract method that must be implemented by subclasses.
+It should return a list of hardware-aware configurations (hints)
+based on the specified architecture.</p>
+<dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>arch</strong> (<em>tilelang.carver.arch.TileDevice</em>)</p></li>
-<li><p><strong>topk</strong> (<em>int</em>)</p></li>
+<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>
+<li><p><strong>topk</strong> (<em>int</em><em>, </em><em>optional</em>) – Number of top configurations to return. Defaults to 10.</p></li>
 </ul>
 </dd>
-<dt class="field-even">Return type<span class="colon">:</span></dt>
-<dd class="field-even"><p>List[tilelang.carver.roller.Hint]</p>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>A list of recommended hardware-aware configurations.</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<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>
 </dd>
 </dl>
 </dd></dl>