Skip to content

Commit 4c24182

Browse files
committed
Fix docs.
1 parent 753535f commit 4c24182

File tree

7 files changed

+21
-20
lines changed

7 files changed

+21
-20
lines changed

python/tvm/meta_schedule/database/database.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ def query_schedule(
284284
285285
Returns
286286
-------
287-
schedule : Optional[Schedule]
287+
schedule : Optional[tvm.tir.Schedule]
288288
The best schedule of the given workload; None if not found.
289289
"""
290290
return _ffi_api.DatabaseQuerySchedule(self, mod, target, workload_name) # type: ignore # pylint: disable=no-member
@@ -338,7 +338,7 @@ def query(
338338
339339
Returns
340340
-------
341-
result : Union[Schedule, IRModule, TuningRecord]
341+
result : Union[tvm.tir.Schedule, IRModule, TuningRecord]
342342
The best optimization outcome of the given workload.
343343
"""
344344
if kind == "schedule":
@@ -381,7 +381,8 @@ def create( # pylint: disable=keyword-arg-before-vararg
381381
382382
Parameters
383383
----------
384-
kind : str = "json" | "memory" | "union" | "ordered_union" | Callable[[Schedule], bool]
384+
kind : str = "json" | "memory" | "union" | "ordered_union" | Callable[[tvm.tir.Schedule],
385+
bool]
385386
The kind of the database to be created. The following kinds are supported:
386387
"json", "memory", "union", "ordered_union", and a custom schedule function.
387388

python/tvm/meta_schedule/postproc/postproc.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ def apply(self, sch: Schedule) -> bool:
5454
5555
Parameters
5656
----------
57-
sch : Schedule
57+
sch : tvm.tir.Schedule
5858
The schedule to be post processed.
5959
6060
Returns

python/tvm/meta_schedule/schedule_rule/schedule_rule.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,14 +57,14 @@ def apply(self, sch: Schedule, block: BlockRV) -> List[Schedule]:
5757
5858
Parameters
5959
----------
60-
sch : Schedule
60+
sch : tvm.tir.Schedule
6161
The schedule to be modified.
6262
block : BlockRV
6363
The specific block to apply the schedule rule.
6464
6565
Returns
6666
-------
67-
design_spaces : List[Schedule]
67+
design_spaces : List[tvm.tir.Schedule]
6868
The list of schedules generated by applying the schedule rule.
6969
"""
7070
return _ffi_api.ScheduleRuleApply( # type: ignore # pylint: disable=no-member

python/tvm/meta_schedule/search_strategy/search_strategy.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ class MeasureCandidate(Object):
4444
4545
Parameters
4646
----------
47-
sch : Schedule
47+
sch : tvm.tir.Schedule
4848
The schedule to be measured.
4949
args_info : List[ArgInfo]
5050
The argument information.
@@ -62,7 +62,7 @@ def __init__(
6262
6363
Parameters
6464
----------
65-
sch : Schedule
65+
sch : tvm.tir.Schedule
6666
The schedule to be measured.
6767
args_info : List[ArgInfo]
6868
The argument information.
@@ -115,7 +115,7 @@ def pre_tuning(
115115
The maximum number of trials.
116116
num_trials_per_iter : int
117117
The number of trials per iteration.
118-
design_spaces : List[Schedule]
118+
design_spaces : List[tvm.tir.Schedule]
119119
The design spaces used during tuning process.
120120
database : Optional[Database] = None
121121
The database used during tuning process.

python/tvm/meta_schedule/space_generator/space_generator.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ def generate_design_space(self, mod: IRModule) -> List[Schedule]:
8080
8181
Returns
8282
-------
83-
design_spaces : List[Schedule]
83+
design_spaces : List[tvm.tir.Schedule]
8484
The generated design spaces, i.e., schedules.
8585
"""
8686
return _ffi_api.SpaceGeneratorGenerateDesignSpace(self, mod) # type: ignore # pylint: disable=no-member
@@ -248,7 +248,7 @@ def generate_design_space(self, mod: IRModule) -> List[Schedule]:
248248
249249
Returns
250250
-------
251-
design_spaces : List[Schedule]
251+
design_spaces : List[tvm.tir.Schedule]
252252
The generated design spaces, i.e., schedules.
253253
"""
254254
raise NotImplementedError

python/tvm/meta_schedule/tune.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -73,13 +73,13 @@ def tune_tasks(
7373
module_equality : Optional[str]
7474
A string to specify the module equality testing and hashing method.
7575
It must be one of the followings:
76-
- "structural": Use StructuralEqual/Hash
77-
- "ignore-ndarray": Same as "structural", but ignore ndarray raw data during
78-
equality testing and hashing.
79-
- "anchor-block": Apply equality testing and hashing on the anchor block extracted from a
80-
given module. The "ignore-ndarray" varint is used for the extracted
81-
blocks or in case no anchor block is found.
82-
For the definition of the anchor block, see tir/analysis/analysis.py.
76+
- "structural": Use StructuralEqual/Hash
77+
- "ignore-ndarray": Same as "structural", but ignore ndarray raw data during equality
78+
testing and hashing.
79+
- "anchor-block": Apply equality testing and hashing on the anchor block extracted from
80+
a given module. The "ignore-ndarray" varint is used for the extracted blocks or in
81+
case no anchor block is found. For the definition of the anchor block, see
82+
tir/analysis/analysis.py.
8383
8484
Returns
8585
-------

python/tvm/meta_schedule/tune_context.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ def generate_design_space(self) -> List[Schedule]:
154154
155155
Returns
156156
-------
157-
design_spaces : List[Schedule]
157+
design_spaces : List[tvm.tir.Schedule]
158158
The generated design spaces, i.e., schedules.
159159
"""
160160
if self.mod is None:
@@ -184,7 +184,7 @@ def pre_tuning(
184184
The maximum number of trials to be executed.
185185
num_trials_per_iter : int = 64
186186
The number of trials to be executed per iteration.
187-
design_spaces : Optional[List[Schedule]]
187+
design_spaces : Optional[List[tvm.tir.Schedule]]
188188
The design spaces used during tuning process.
189189
If None, use the outcome of `self.generate_design_space()`.
190190
database : Optional[Database] = None

0 commit comments

Comments
 (0)