Commit 176ffe50 by tqchen Committed by Tianqi Chen

[DOCS][PY] Sphinx docs about tvm.ir

parent a5661611
...@@ -24,21 +24,18 @@ Python API ...@@ -24,21 +24,18 @@ Python API
tvm tvm
runtime runtime
ndarray ndarray
error
ir
intrin intrin
tensor tensor
schedule schedule
target target
build build
module
error
container
function function
autotvm autotvm
graph_runtime
rpc rpc
bridge
contrib contrib
ffi graph_runtime
dev dev
topi topi
vta/index vta/index
......
...@@ -15,7 +15,8 @@ ...@@ -15,7 +15,8 @@
specific language governing permissions and limitations specific language governing permissions and limitations
under the License. under the License.
tvm.container tvm.ir
------------- ------
.. automodule:: tvm.container .. automodule:: tvm.ir
:members: :members:
:imported-members:
...@@ -20,9 +20,9 @@ tvm.runtime ...@@ -20,9 +20,9 @@ tvm.runtime
.. automodule:: tvm.runtime .. automodule:: tvm.runtime
.. autoclass:: tvm.runtime.PackedFunc .. autoclass:: tvm.runtime.PackedFunc
:members: :members:
:inheritated-members:
.. autofunction:: tvm.register_func .. autofunction:: tvm.register_func
......
...@@ -139,6 +139,9 @@ pygments_style = 'sphinx' ...@@ -139,6 +139,9 @@ pygments_style = 'sphinx'
# If true, `todo` and `todoList` produce output, else they produce nothing. # If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False todo_include_todos = False
# sort autodoc order by the source file.
autodoc_member_order = 'bysource'
# -- Options for HTML output ---------------------------------------------- # -- Options for HTML output ----------------------------------------------
# The theme is set by the make target # The theme is set by the make target
......
...@@ -17,11 +17,11 @@ ...@@ -17,11 +17,11 @@
# pylint: disable=unused-import # pylint: disable=unused-import
"""Common data structures across all IR variants.""" """Common data structures across all IR variants."""
from .base import SourceName, Span, Node, EnvFunc, load_json, save_json from .base import SourceName, Span, Node, EnvFunc, load_json, save_json
from .expr import BaseExpr, PrimExpr, RelayExpr, GlobalVar, BaseFunc, Range
from .type import Type, TypeKind, TypeVar, GlobalTypeVar, TupleType from .type import Type, TypeKind, TypeVar, GlobalTypeVar, TupleType
from .type import TypeConstraint, FuncType, IncompleteType, RelayRefType from .type import TypeConstraint, FuncType, IncompleteType, RelayRefType
from .type_relation import TypeCall, TypeRelation
from .tensor_type import TensorType from .tensor_type import TensorType
from .type_relation import TypeCall, TypeRelation
from .expr import BaseExpr, PrimExpr, RelayExpr, GlobalVar, BaseFunc, Range
from .adt import Constructor, TypeData from .adt import Constructor, TypeData
from .module import IRModule from .module import IRModule
from .attrs import Attrs from .attrs import Attrs
......
...@@ -112,7 +112,7 @@ class IRModule(Node): ...@@ -112,7 +112,7 @@ class IRModule(Node):
Parameters Parameters
---------- ----------
other: Module other: IRModule
The module to merge into the current Module. The module to merge into the current Module.
""" """
if isinstance(other, dict): if isinstance(other, dict):
...@@ -143,7 +143,7 @@ class IRModule(Node): ...@@ -143,7 +143,7 @@ class IRModule(Node):
Returns Returns
------- -------
global_vars: tvm.Array[GlobalVar] global_vars: Array[GlobalVar]
An array of global vars. An array of global vars.
""" """
return _ffi_api.Module_GetGlobalVars(self) return _ffi_api.Module_GetGlobalVars(self)
...@@ -153,7 +153,7 @@ class IRModule(Node): ...@@ -153,7 +153,7 @@ class IRModule(Node):
Returns Returns
------- -------
global_type_vars: tvm.Array[GlobalTypeVar] global_type_vars: Array[GlobalTypeVar]
An array of global type vars. An array of global type vars.
""" """
return _ffi_api.Module_GetGlobalTypeVars(self) return _ffi_api.Module_GetGlobalTypeVars(self)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment