[DOCS] Update API docs to reflect the status after the refactor. (#4907)

apache · Feb 18, 2020 · d2ae8c9 · d2ae8c9
1 parent 41835d1
commit d2ae8c9
Show file tree

Hide file tree

Showing 30 changed files with 122 additions and 333 deletions.
diff --git a/docs/_static/css/tvm_theme.css b/docs/_static/css/tvm_theme.css
@@ -38,3 +38,6 @@ nav .hidden-section {
     color: #404040 !important;
 }
 
+.wy-nav-content {
+    max-width: 950px !important;
+}
diff --git a/docs/api/python/dev.rst b/docs/api/python/dev.rst
diff --git a/docs/api/python/build.rst → docs/api/python/driver.rst b/docs/api/python/build.rst → docs/api/python/driver.rst
@@ -15,10 +15,10 @@
     specific language governing permissions and limitations
     under the License.
 
-tvm.build
----------
+tvm.driver
+----------
+.. automodule:: tvm.driver
+
 .. autofunction:: tvm.lower
 
 .. autofunction:: tvm.build
-
-.. autofunction:: tvm.build_config
diff --git a/docs/api/python/error.rst b/docs/api/python/error.rst
@@ -20,3 +20,4 @@ tvm.error
 .. automodule:: tvm.error
    :members:
    :imported-members:
+   :autosummary:
diff --git a/docs/api/python/hybrid.rst b/docs/api/python/hybrid.rst
@@ -18,11 +18,6 @@
 tvm.hybrid
 ----------
 .. automodule:: tvm.hybrid
-
-.. autosummary::
-
-   tvm.hybrid.parse
-   tvm.hybrid.script
-
-.. autofunction:: tvm.hybrid.parse
-.. autofunction:: tvm.hybrid.script
+   :members:
+   :imported-members:
+   :autosummary:
diff --git a/docs/api/python/index.rst b/docs/api/python/index.rst
@@ -21,23 +21,19 @@ Python API
 .. toctree::
    :maxdepth: 2
 
-   tvm
    runtime
    ndarray
    error
    ir
    target
-   intrin
-   tensor
-   schedule
-   build
-   function
+   tir
+   te
+   driver
    autotvm
    rpc
    contrib
    graph_runtime
-   dev
-   topi
-   vta/index
    hybrid
    relay/index
+   vta/index
+   topi
diff --git a/docs/api/python/intrin.rst b/docs/api/python/intrin.rst
diff --git a/docs/api/python/ir.rst b/docs/api/python/ir.rst
@@ -20,3 +20,4 @@ tvm.ir
 .. automodule:: tvm.ir
    :members:
    :imported-members:
+   :autosummary:
diff --git a/docs/api/python/ndarray.rst b/docs/api/python/ndarray.rst
@@ -23,14 +23,5 @@ tvm.runtime.ndarray
     :members:
     :inherited-members:
 
-
-.. autoclass:: tvm.runtime.TVMContext
-    :members:
-
-.. autofunction:: tvm.context
-.. autofunction:: tvm.cpu
-.. autofunction:: tvm.gpu
-.. autofunction:: tvm.opencl
-.. autofunction:: tvm.metal
 .. autofunction:: tvm.nd.array
 .. autofunction:: tvm.nd.empty
diff --git a/docs/api/python/relay/index.rst b/docs/api/python/relay/index.rst
@@ -15,7 +15,7 @@
     specific language governing permissions and limitations
     under the License.
 
-Relay API
+tvm.relay
 =========
 
 This document contains the Python API for the Relay frontend, optimizer, and
@@ -35,9 +35,7 @@ compiler stack.
    image
    analysis
    transform
-   module
    nn
    op
    scope_builder
-   ty
    vision
diff --git a/docs/api/python/relay/ty.rst b/docs/api/python/relay/ty.rst
diff --git a/docs/api/python/rpc.rst b/docs/api/python/rpc.rst
@@ -18,22 +18,6 @@
 tvm.rpc
 -------
 .. automodule:: tvm.rpc
-
-.. autofunction:: tvm.rpc.connect
-.. autofunction:: tvm.rpc.connect_tracker
-
-.. autoclass:: tvm.rpc.TrackerSession
-    :members:
-    :inherited-members:
-
-.. autoclass:: tvm.rpc.RPCSession
-    :members:
-    :inherited-members:
-
-.. autoclass:: tvm.rpc.LocalSession
-    :members:
-    :inherited-members:
-
-.. autoclass:: tvm.rpc.Server
-    :members:
-    :inherited-members:
+   :members:
+   :imported-members:
+   :autosummary:
diff --git a/docs/api/python/runtime.rst b/docs/api/python/runtime.rst
@@ -19,6 +19,11 @@ tvm.runtime
 -----------
 
 .. automodule:: tvm.runtime
+   :members:
+   :imported-members:
+   :exclude-members: NDArray
+   :autosummary:
+
 
 .. autoclass:: tvm.runtime.PackedFunc
    :members:

diff --git a/docs/api/python/target.rst b/docs/api/python/target.rst
@@ -20,3 +20,4 @@ tvm.target
 .. automodule:: tvm.target
     :members:
     :imported-members:
+    :autosummary:
diff --git a/docs/api/python/schedule.rst → docs/api/python/te.rst b/docs/api/python/schedule.rst → docs/api/python/te.rst
@@ -15,22 +15,16 @@
     specific language governing permissions and limitations
     under the License.
 
-tvm.schedule
-------------
-.. automodule:: tvm.schedule
-
-.. autoclass:: tvm.schedule.IterVar
-    :members:
-
-.. autoclass:: tvm.schedule.Buffer
-    :members:
-
-.. autofunction:: tvm.create_schedule
-
-.. autoclass:: tvm.schedule.Schedule
-    :members:
-    :inherited-members:
-
-.. autoclass:: tvm.schedule.Stage
-    :members:
-    :inherited-members:
+tvm.te
+------
+.. Exclude the ops imported from tir.
+
+.. automodule:: tvm.te
+   :members:
+   :imported-members:
+   :exclude-members:
+      exp, erf, tanh, sigmoid, log, cos, sin, atan, sqrt, rsqrt, floor, ceil,
+      trunc, abs, round, nearbyint, isnan, power, popcount, fmod, if_then_else,
+      div, indexdiv, indexmod, truncdiv, truncmod, floordiv, floormod,
+      comm_reducer, min, max, sum
+   :autosummary:
diff --git a/docs/api/python/relay/module.rst → docs/api/python/tir.rst b/docs/api/python/relay/module.rst → docs/api/python/tir.rst
@@ -15,10 +15,10 @@
     specific language governing permissions and limitations
     under the License.
 
-tvm.relay.module
-----------------
-
-.. automodule:: tvm.relay.module
-
-.. autoclass:: tvm.relay.module.Module
-    :members:
+tvm.tir
+-------
+.. automodule:: tvm.tir
+   :members:
+   :imported-members:
+   :exclude-members: PrimExpr
+   :autosummary: