Skip to content

Commit 56e6d92

Browse files
Update docs
1 parent c508755 commit 56e6d92

File tree

19 files changed

+811
-225
lines changed

19 files changed

+811
-225
lines changed

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,6 @@ 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-
3633
.. py:attribute:: target
3734
3835

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,6 @@ 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-
3633
.. py:attribute:: target
3734
3835

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,6 @@ 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-
9895
.. py:attribute:: target
9996
10097

_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: tilelang.carver.roller.rasterization.List[int]
310+
:type: List[int]
311311

312312

313313

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

317317

318318

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

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

3131
.. py:data:: logger
3232
33-
.. py:class:: TensorCorePolicy(arch, tags = None)
33+
.. py:class:: TensorCorePolicy
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-
4238
.. py:attribute:: wmma_k
4339
:type: int
4440
:value: 16
@@ -65,67 +61,16 @@ Module Contents
6561

6662
.. py:method:: infer_node_smem_usage(td, node)
6763
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-
7964
8065
.. py:method:: get_node_reduce_step_candidates(node)
8166
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-
9467
9568
.. py:method:: check_tile_shape_isvalid(td)
9669
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-
10670
10771
.. py:method:: compute_node_stride_map(node, td)
10872
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-
12073
12174
.. py:method:: plan_rasterization(td)
12275
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-
13176

_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

0 commit comments

Comments
 (0)