Skip to content

Commit 4454773

Browse files
Update docs
1 parent 56e6d92 commit 4454773

File tree

15 files changed

+149
-69
lines changed

15 files changed

+149
-69
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/cpu/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
@@ -92,6 +92,9 @@ Module Contents
9292
Bases: :py:obj:`tilelang.carver.arch.arch_base.TileDevice`
9393

9494

95+
Represents the architecture of a computing device, capturing various hardware specifications.
96+
97+
9598
.. py:attribute:: target
9699
97100

_sources/autoapi/tilelang/carver/roller/hint/index.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -307,12 +307,12 @@ Module Contents
307307
308308
309309
.. py:property:: raxis_order
310-
:type: List[int]
310+
:type: tilelang.carver.roller.rasterization.List[int]
311311

312312

313313

314314
.. py:property:: step
315-
:type: List[int]
315+
:type: tilelang.carver.roller.rasterization.List[int]
316316

317317

318318

_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: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,6 @@ 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-
2823
.. py:attribute:: batch_size
2924
:type: int
3025
:value: 1

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

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,6 @@ 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-
2823
.. py:attribute:: structure
2924
:type: Union[str, List[str]]
3025
:value: None
@@ -45,19 +40,6 @@ Module Contents
4540

4641
.. py:method:: get_hardware_aware_configs(arch = None, topk = 10)
4742
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-
6143
6244
.. py:method:: initialize_function()
6345

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

Lines changed: 2 additions & 1 deletion
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.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>
470-
<td><p></p></td>
470+
<td><p>Represents the architecture of a computing device, capturing various hardware specifications.</p></td>
471471
</tr>
472472
</tbody>
473473
</table>
@@ -504,6 +504,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
504504
<dt class="sig sig-object py" id="tilelang.carver.arch.cdna.CDNA">
505505
<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>
506506
<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>
507+
<p>Represents the architecture of a computing device, capturing various hardware specifications.</p>
507508
<dl class="field-list simple">
508509
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
509510
<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/arch/cpu/index.html

Lines changed: 2 additions & 1 deletion
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.carver.arch.cpu.CPU" title="tilelang.carver.arch.cpu.CPU"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CPU</span></code></a></p></td>
470-
<td><p></p></td>
470+
<td><p>Represents the architecture of a computing device, capturing various hardware specifications.</p></td>
471471
</tr>
472472
</tbody>
473473
</table>
@@ -504,6 +504,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
504504
<dt class="sig sig-object py" id="tilelang.carver.arch.cpu.CPU">
505505
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tilelang.carver.arch.cpu.</span></span><span class="sig-name descname"><span class="pre">CPU</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.cpu.CPU" title="Link to this definition"></a></dt>
506506
<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>
507+
<p>Represents the architecture of a computing device, capturing various hardware specifications.</p>
507508
<dl class="field-list simple">
508509
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
509510
<dd class="field-odd"><p><strong>target</strong> (<em>tvm.target.Target</em>)</p>

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -491,7 +491,7 @@ <h2>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶
491491
<td><p></p></td>
492492
</tr>
493493
<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>
494-
<td><p></p></td>
494+
<td><p>Represents the architecture of a computing device, capturing various hardware specifications.</p></td>
495495
</tr>
496496
</tbody>
497497
</table>
@@ -688,6 +688,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
688688
<dt class="sig sig-object py" id="tilelang.carver.arch.cuda.CUDA">
689689
<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>
690690
<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>
691+
<p>Represents the architecture of a computing device, capturing various hardware specifications.</p>
691692
<dl class="field-list simple">
692693
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
693694
<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>

0 commit comments

Comments
 (0)