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

diff --git a/docs/api/python/index.rst b/docs/api/python/index.rst
index c17f5c6..2daebad 100644 (file)
--- a/docs/api/python/index.rst
+++ b/docs/api/python/index.rst
@@ -24,21 +24,18 @@ Python API
    tvm
    runtime
    ndarray
+   error
+   ir
    intrin
    tensor
    schedule
    target
    build
-   module
-   error
-   container
    function
    autotvm
-   graph_runtime
    rpc
-   bridge
    contrib
-   ffi
+   graph_runtime
    dev
    topi
    vta/index

diff --git a/docs/api/python/container.rst b/docs/api/python/ir.rst
similarity index 91%
rename from docs/api/python/container.rst
rename to docs/api/python/ir.rst
index 5de9059..9e7df8f 100644 (file)
--- a/docs/api/python/container.rst
+++ b/docs/api/python/ir.rst
@@ -15,7 +15,8 @@
     specific language governing permissions and limitations
     under the License.
 
-tvm.container
--------------
-.. automodule:: tvm.container
-    :members:
+tvm.ir
+------
+.. automodule:: tvm.ir
+   :members:
+   :imported-members:

diff --git a/docs/api/python/runtime.rst b/docs/api/python/runtime.rst
index 37b8606..75523cf 100644 (file)
--- a/docs/api/python/runtime.rst
+++ b/docs/api/python/runtime.rst
@@ -20,9 +20,9 @@ tvm.runtime
 
 .. automodule:: tvm.runtime
 
-
 .. autoclass:: tvm.runtime.PackedFunc
    :members:
+   :inheritated-members:
 
 .. autofunction:: tvm.register_func
 

diff --git a/docs/conf.py b/docs/conf.py
index a098ad4..0b29f28 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -139,6 +139,9 @@ pygments_style = 'sphinx'
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
 
+# sort autodoc order by the source file.
+autodoc_member_order = 'bysource'
+
 # -- Options for HTML output ----------------------------------------------
 
 # The theme is set by the make target

diff --git a/python/tvm/ir/__init__.py b/python/tvm/ir/__init__.py
index e3552b5..d47e240 100644 (file)
--- a/python/tvm/ir/__init__.py
+++ b/python/tvm/ir/__init__.py
@@ -17,11 +17,11 @@
 # pylint: disable=unused-import
 """Common data structures across all IR variants."""
 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 TypeConstraint, FuncType, IncompleteType, RelayRefType
-from .type_relation import TypeCall, TypeRelation
 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 .module import IRModule
 from .attrs import Attrs

diff --git a/python/tvm/ir/module.py b/python/tvm/ir/module.py
index ae1564b..2d7481f 100644 (file)
--- a/python/tvm/ir/module.py
+++ b/python/tvm/ir/module.py
@@ -112,7 +112,7 @@ class IRModule(Node):
 
         Parameters
         ----------
-        other: Module
+        other: IRModule
             The module to merge into the current Module.
         """
         if isinstance(other, dict):
@@ -143,7 +143,7 @@ class IRModule(Node):
 
         Returns
         -------
-        global_vars: tvm.Array[GlobalVar]
+        global_vars: Array[GlobalVar]
             An array of global vars.
         """
         return _ffi_api.Module_GetGlobalVars(self)
@@ -153,7 +153,7 @@ class IRModule(Node):
 
         Returns
         -------
-        global_type_vars: tvm.Array[GlobalTypeVar]
+        global_type_vars: Array[GlobalTypeVar]
             An array of global type vars.
         """
         return _ffi_api.Module_GetGlobalTypeVars(self)