Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Feb 18, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/_static/css/tvm_theme.css
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,6 @@ nav .hidden-section {
color: #404040 !important;
}

.wy-nav-content {
max-width: 950px !important;
}
80 changes: 0 additions & 80 deletions docs/api/python/dev.rst

This file was deleted.

8 changes: 4 additions & 4 deletions docs/api/python/build.rst → docs/api/python/driver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions docs/api/python/error.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,4 @@ tvm.error
.. automodule:: tvm.error
:members:
:imported-members:
:autosummary:
11 changes: 3 additions & 8 deletions docs/api/python/hybrid.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
14 changes: 5 additions & 9 deletions docs/api/python/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
58 changes: 0 additions & 58 deletions docs/api/python/intrin.rst

This file was deleted.

1 change: 1 addition & 0 deletions docs/api/python/ir.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,4 @@ tvm.ir
.. automodule:: tvm.ir
:members:
:imported-members:
:autosummary:
9 changes: 0 additions & 9 deletions docs/api/python/ndarray.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 1 addition & 3 deletions docs/api/python/relay/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -35,9 +35,7 @@ compiler stack.
image
analysis
transform
module
nn
op
scope_builder
ty
vision
49 changes: 0 additions & 49 deletions docs/api/python/relay/ty.rst

This file was deleted.

22 changes: 3 additions & 19 deletions docs/api/python/rpc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
5 changes: 5 additions & 0 deletions docs/api/python/runtime.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ tvm.runtime
-----------

.. automodule:: tvm.runtime
:members:
:imported-members:
:exclude-members: NDArray
:autosummary:


.. autoclass:: tvm.runtime.PackedFunc
:members:
Expand Down
1 change: 1 addition & 0 deletions docs/api/python/target.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,4 @@ tvm.target
.. automodule:: tvm.target
:members:
:imported-members:
:autosummary:
32 changes: 13 additions & 19 deletions docs/api/python/schedule.rst → docs/api/python/te.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
14 changes: 7 additions & 7 deletions docs/api/python/relay/module.rst → docs/api/python/tir.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Loading