Skip to content

Commit 860cacd

Browse files
Lunderbergylc
authored andcommitted
[Docs] Prevented docs/1 file from being generated. (apache#8029)
* [Docs] Prevented docs/1 file from being generated. Typo in tests/scripts/task_sphinx_precheck.sh caused $TVM_HOME/docs/1 file to be created with stderr output, rather than merged stderr and stdout. * [Docs] Corrected sphinx build warnings - Previously, several warnings were generated by sphinx, but were unintentionally suppressed. This PR resolves the sphinx warnings. * [Docs] Corrected additional sphinx build warnings. - Rebased on main and corrected warnings, now up to date as of commit 53e4c60. * [Docs] Corrected additional sphinx build warnings - Rebased on main and corrected warnings, now up to date as of commit 1f2ca06. * [Docs] Corrected additional sphinx build warnings - Rebased on main and corrected warnings, now up to date as of commit d0791d3. * [Docs] Ignore sphinx warnings from missing "git describe" and sckit-learn versions. Co-authored-by: Eric Lunderberg <elunderberg@octoml.ai>
1 parent 0e78b8a commit 860cacd

36 files changed

+185
-113
lines changed

docs/api/python/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
Python API
1919
==========
2020

21+
2122
.. toctree::
2223
:maxdepth: 2
2324

docs/api/python/relay/image.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,5 @@ tvm.relay.image
2222
.. automodule:: tvm.relay.image
2323
:members:
2424
:imported-members:
25+
:exclude-members: Expr, Constant
2526
:autosummary:

docs/api/python/relay/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,5 @@ tvm.relay
2626
TypeVar, GlobalTypeVar, TypeConstraint, FuncType, TupleType, IncompleteType,
2727
TypeCall, TypeRelation, TensorType, RelayRefType, GlobalVar, SourceName,
2828
Span, Var, Op, Constructor
29+
:noindex: TypeData
2930
:autosummary:

docs/api/python/tir.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ tvm.tir.analysis
3737
.. automodule:: tvm.tir.analysis
3838
:members:
3939
:imported-members:
40+
:noindex: Buffer, Stmt
4041
:autosummary:
4142

4243

docs/api/python/topi.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ tvm.topi
2020
.. automodule:: tvm.topi
2121
:members:
2222
:imported-members:
23+
:noindex: AssertStmt
2324
:autosummary:
2425

2526
tvm.topi.nn

docs/dev/device_target_interactions.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
specific language governing permissions and limitations
1616
under the License.
1717
18+
1819
.. _tvm-target-specific-overview:
1920

2021
Device/Target Interactions

docs/dev/index.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@ This page is organized as follows:
2929
The sections after are specific guides focused on each logical component, organized
3030
by the component's name.
3131

32+
- The :ref:`Device/Target Interactions <tvm-target-specific-overview>`
33+
page describes how TVM interacts with each supported physical device
34+
and code-generation target.
35+
3236
- Feel free to also check out the :ref:`dev-how-to` for useful development tips.
3337

3438
This guide provides a few complementary views of the architecture.
@@ -244,11 +248,18 @@ for learning-based optimizations.
244248
:maxdepth: 1
245249

246250
runtime
251+
252+
253+
.. toctree::
254+
:maxdepth: 1
255+
247256
debugger
248257
virtual_machine
249258
introduction_to_module_serialization
250259
device_target_interactions
251260

261+
262+
252263
tvm/node
253264
--------
254265
The node module adds additional features on top of the `runtime::Object` for IR data structures.

python/tvm/auto_scheduler/compute_dag.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ class ComputeDAG(Object):
9696
9797
Parameters
9898
----------
99-
compute : Union[List[Tensor], str, Schedule]
99+
compute : Union[List[Tensor], str, tvm.te.Schedule]
100100
Input/output tensors or workload key for a compute declaration.
101101
"""
102102

python/tvm/driver/build_module.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -98,17 +98,17 @@ def lower(
9898
9999
Parameters
100100
----------
101-
inputs : Union[schedule.Schedule, PrimFunc, IRModule]
101+
inp : Union[tvm.te.schedule.Schedule, tvm.tir.PrimFunc, IRModule]
102102
The TE schedule or TensorIR PrimFunc/IRModule to be built
103103
104-
args : Optional[List[Union[Buffer, tensor.Tensor, Var]]]
104+
args : Optional[List[Union[tvm.tir.Buffer, tensor.Tensor, Var]]]
105105
The argument lists to the function for TE schedule.
106106
It should be None if we want to lower TensorIR.
107107
108108
name : str
109109
The name of result function.
110110
111-
binds : Optional[Mapping[tensor.Tensor, Buffer]]
111+
binds : Optional[Mapping[tensor.Tensor, tvm.tir.Buffer]]
112112
Dictionary that maps the Tensor to Buffer which specified the data layout
113113
requirement of the function. By default, a new compact buffer is created
114114
for each tensor in the argument.
@@ -233,10 +233,10 @@ def build(
233233
234234
Parameters
235235
----------
236-
inputs : Union[schedule.Schedule, PrimFunc, IRModule, Mapping[str, IRModule]]
236+
inputs : Union[tvm.te.schedule.Schedule, tvm.tir.PrimFunc, IRModule, Mapping[str, IRModule]]
237237
The input to be built
238238
239-
args : Optional[List[Union[Buffer, tensor.Tensor, Var]]]
239+
args : Optional[List[Union[tvm.tir.Buffer, tensor.Tensor, Var]]]
240240
The argument lists to the function.
241241
242242
target : Optional[Union[str, Target]]
@@ -254,7 +254,7 @@ def build(
254254
name : Optional[str]
255255
The name of result function.
256256
257-
binds : Optional[Mapping[tensor.Tensor, Buffer]]
257+
binds : Optional[Mapping[tensor.Tensor, tvm.tir.Buffer]]
258258
Dictionary that maps the binding of symbolic buffer to Tensor.
259259
By default, a new buffer is created for each tensor in the argument.
260260

python/tvm/ir/op.py

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -96,14 +96,20 @@ def add_type_rel(self, rel_name, type_rel_func=None):
9696
type_rel_func : Optional[function (args: List[Type], attrs: Attrs) -> Type]
9797
The backing relation function which can solve an arbitrary relation on variables.
9898
Differences with type_rel_func in C++:
99-
1, when type_rel_func is not None:
100-
1) OpAddTypeRel on C++ side will adjust type_rel_func with TypeReporter to
99+
100+
1) When type_rel_func is not None
101+
102+
a) OpAddTypeRel on C++ side will adjust type_rel_func with TypeReporter to
101103
calling convention of relay type system.
102-
2) type_rel_func returns output argument's type, return None means can't
104+
105+
b) type_rel_func returns output argument's type, return None means can't
103106
infer output's type.
104-
3) only support single output operators for now, the last argument is output tensor.
105-
2, when type_rel_func is None, will call predefined type_rel_funcs in relay
106-
accorrding to `tvm.relay.type_relation.` + rel_name.
107+
108+
c) only support single output operators for now, the last argument is output tensor.
109+
110+
2) when type_rel_func is None, will call predefined type_rel_funcs in relay
111+
according to ``tvm.relay.type_relation.`` + rel_name.
112+
107113
"""
108114
_ffi_api.OpAddTypeRel(self, rel_name, type_rel_func)
109115

0 commit comments

Comments
 (0)