Skip to content

Commit 4a76229

Browse files
Update docs
1 parent 6f36dbc commit 4a76229

File tree

15 files changed

+161
-22
lines changed

15 files changed

+161
-22
lines changed

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ Module Contents
3030
Bases: :py:obj:`tilelang.carver.arch.arch_base.TileDevice`
3131

3232

33+
Represents the architecture of a computing device, capturing various hardware specifications.
34+
35+
3336
.. py:attribute:: target
3437
3538

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@ Module Contents
4848
Bases: :py:obj:`tilelang.carver.arch.arch_base.TileDevice`
4949

5050

51+
Represents the architecture of a computing device, capturing various hardware specifications.
52+
53+
5154
.. py:attribute:: target
5255
5356

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ Module Contents
3030
Bases: :py:obj:`tilelang.carver.arch.arch_base.TileDevice`
3131

3232

33+
Represents the architecture of a computing device, capturing various hardware specifications.
34+
35+
3336
.. py:attribute:: target
3437
3538

_sources/autoapi/tilelang/carver/roller/policy/tensorcore/index.rst.txt

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,15 @@ Module Contents
3030

3131
.. py:data:: logger
3232
33-
.. py:class:: TensorCorePolicy
33+
.. py:class:: TensorCorePolicy(arch, tags = None)
3434
3535
Bases: :py:obj:`tilelang.carver.roller.policy.default.DefaultPolicy`
3636

3737

38+
Default Policy for fastdlight, a heuristic plan that tries to
39+
minimize memory traffic and maximize parallelism.for BitBLAS Schedule.
40+
41+
3842
.. py:attribute:: wmma_k
3943
:type: int
4044
:value: 16
@@ -61,16 +65,67 @@ Module Contents
6165

6266
.. py:method:: infer_node_smem_usage(td, node)
6367
68+
Infers the shared memory usage of a node given a TileDict configuration.
69+
70+
:param td: The TileDict object containing the tile configuration.
71+
:type td: TileDict
72+
:param node: The node for which to infer the shared memory usage.
73+
:type node: PrimFuncNode
74+
75+
:returns: The estimated amount of shared memory used by the node.
76+
:rtype: int
77+
78+
6479

6580
.. py:method:: get_node_reduce_step_candidates(node)
6681
82+
Calculates reduction step candidates for each reduction axis in a PrimFuncNode. General idea : use factor first, since it does not require extra boundary check. for large prime number, which is rare case, use power of 2.
83+
84+
:param node: The node for which to calculate reduction step candidates. It contains reduction axes (raxis)
85+
with their domains (dom.extent).
86+
:type node: PrimFuncNode
87+
88+
:returns: A dictionary mapping axis variable names to lists of step candidates. For each axis in the node,
89+
this function calculates possible step sizes. For axes with a large prime domain, it uses powers of 2
90+
as step candidates; for others, it uses all factors of the domain.
91+
:rtype: Dict[str, List[int]]
92+
93+
6794

6895
.. py:method:: check_tile_shape_isvalid(td)
6996
97+
Checks if the tile shapes in the TileDict are valid for the nodes in this context.
98+
99+
Parameters:
100+
- td (TileDict): The TileDict object containing tile shapes and other configurations.
101+
102+
Returns:
103+
- bool: True if all tile shapes are valid, False otherwise.
104+
105+
70106

71107
.. py:method:: compute_node_stride_map(node, td)
72108
109+
Computes the stride map for a given node based on the TileDict configuration.
110+
111+
:param node: The node for which to compute the stride map.
112+
:type node: PrimFuncNode
113+
:param td: The TileDict object containing the tile configuration.
114+
:type td: TileDict
115+
116+
:returns: A tuple of dictionaries containing the output strides and tensor strides.
117+
:rtype: Tuple[Dict, Dict]
118+
119+
73120

74121
.. py:method:: plan_rasterization(td)
75122
123+
Plans the rasterization for the given TileDict. This function is not implemented yet.
124+
125+
:param td: The TileDict object to plan rasterization for.
126+
:type td: TileDict
127+
128+
:raises RasterRationPlan: This function is not implemented yet.
129+
130+
76131

_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/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/kernel/index.rst.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,8 @@ Module Contents
116116

117117

118118
.. py:attribute:: target
119+
:value: 'auto'
120+
119121

120122

121123
.. py:method:: from_database(func, kernel_global_source, kernel_lib_path, params, target, target_host, out_idx, execution_backend, pass_configs = None, compile_flags = None)

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -488,7 +488,7 @@ <h2>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶
488488
<table class="autosummary longtable docutils align-default">
489489
<tbody>
490490
<tr class="row-odd"><td><p><a class="reference internal" href="#tilelang.carver.arch.cdna.CDNA" title="tilelang.carver.arch.cdna.CDNA"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CDNA</span></code></a></p></td>
491-
<td><p></p></td>
491+
<td><p>Represents the architecture of a computing device, capturing various hardware specifications.</p></td>
492492
</tr>
493493
</tbody>
494494
</table>
@@ -525,6 +525,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
525525
<dt class="sig sig-object py" id="tilelang.carver.arch.cdna.CDNA">
526526
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tilelang.carver.arch.cdna.</span></span><span class="sig-name descname"><span class="pre">CDNA</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.cdna.CDNA" title="Link to this definition"></a></dt>
527527
<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>
528+
<p>Represents the architecture of a computing device, capturing various hardware specifications.</p>
528529
<dl class="field-list simple">
529530
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
530531
<dd class="field-odd"><p><strong>target</strong> (<em>tvm.target.Target</em><em> | </em><em>str</em>)</p>

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -488,7 +488,7 @@ <h2>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶
488488
<table class="autosummary longtable docutils align-default">
489489
<tbody>
490490
<tr class="row-odd"><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>
491-
<td><p></p></td>
491+
<td><p>Represents the architecture of a computing device, capturing various hardware specifications.</p></td>
492492
</tr>
493493
</tbody>
494494
</table>
@@ -625,6 +625,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
625625
<dt class="sig sig-object py" id="tilelang.carver.arch.cuda.CUDA">
626626
<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>
627627
<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>
628+
<p>Represents the architecture of a computing device, capturing various hardware specifications.</p>
628629
<dl class="field-list simple">
629630
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
630631
<dd class="field-odd"><p><strong>target</strong> (<em>tvm.target.Target</em><em> | </em><em>str</em>)</p>

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -488,7 +488,7 @@ <h2>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶
488488
<table class="autosummary longtable docutils align-default">
489489
<tbody>
490490
<tr class="row-odd"><td><p><a class="reference internal" href="#tilelang.carver.arch.metal.METAL" title="tilelang.carver.arch.metal.METAL"><code class="xref py py-obj docutils literal notranslate"><span class="pre">METAL</span></code></a></p></td>
491-
<td><p></p></td>
491+
<td><p>Represents the architecture of a computing device, capturing various hardware specifications.</p></td>
492492
</tr>
493493
</tbody>
494494
</table>
@@ -525,6 +525,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
525525
<dt class="sig sig-object py" id="tilelang.carver.arch.metal.METAL">
526526
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tilelang.carver.arch.metal.</span></span><span class="sig-name descname"><span class="pre">METAL</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.metal.METAL" title="Link to this definition"></a></dt>
527527
<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>
528+
<p>Represents the architecture of a computing device, capturing various hardware specifications.</p>
528529
<dl class="field-list simple">
529530
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
530531
<dd class="field-odd"><p><strong>target</strong> (<em>tvm.target.Target</em><em> | </em><em>str</em>)</p>

0 commit comments

Comments
 (0)