[DOC][Relay]: Add API docs for Relay. (#1750)

docs/api/python/index.rst

@@ -24,3 +24,4 @@ Python API
    vta/index
    nnvm/index
    hybrid
+   relay/index

docs/api/python/relay/backend.rst

+tvm.relay.backend
+-----------------
+
+.. automodule:: tvm.relay.backend
+
+Interpreter
+-----------
+
+.. automodule:: tvm.relay.backend.interpreter
+    :members:
+
+.. automodule:: tvm.relay.backend.compile_engine
+    :members:
+
+.. automodule:: tvm.relay.backend.graph_runtime_codegen
+    :members:

docs/api/python/relay/base.rst

+tvm.relay.base
+--------------
+.. automodule:: tvm.relay.base
+
+.. autofunction:: tvm.relay.base.register_relay_node
+
+.. autofunction:: tvm.relay.base.register_relay_attr_node
+
+.. autoclass:: tvm.relay.base.RelayNode
+    :members:
+
+.. autoclass:: tvm.relay.base.Span
+    :members:
+
+.. autoclass:: tvm.relay.base.Id
+    :members:

docs/api/python/relay/build_module.rst

+tvm.relay.build_module
+----------------------
+
+.. automodule:: tvm.relay.build_module
+
+.. autofunction:: tvm.relay.build_module.build
+
+.. autofunction:: tvm.relay.build_module.optimize
+
+.. autofunction:: tvm.relay.build_module.create_executor
+
+.. autoclass:: tvm.relay.build_module.BuildConfig
+    :members:
+
+.. autofunction:: tvm.relay.build_module.build_config
+    :members:
+
+.. autoclass:: tvm.relay.build_module.GraphExecutor
+    :members:

docs/api/python/relay/expr.rst

+tvm.relay.expr
+--------------
+
+.. automodule:: tvm.relay.expr
+
+.. autofunction:: tvm.relay.expr.var
+
+.. autofunction:: tvm.relay.expr.const
+
+.. autofunction:: tvm.relay.expr.bind
+
+.. autoclass:: tvm.relay.expr.Expr
+    :members:
+
+.. autoclass:: tvm.relay.expr.Constant
+    :members:
+
+.. autoclass:: tvm.relay.expr.Tuple
+    :members:
+
+.. autoclass:: tvm.relay.expr.Var
+    :members:
+
+.. autoclass:: tvm.relay.expr.GlobalVar
+    :members:
+
+.. autoclass:: tvm.relay.expr.Function
+    :members:
+
+.. autoclass:: tvm.relay.expr.Call
+    :members:
+
+.. autoclass:: tvm.relay.expr.Let
+    :members:
+
+.. autoclass:: tvm.relay.expr.If
+    :members:
+
+.. autoclass:: tvm.relay.expr.TupleGetItem
+    :members:
+
+.. autoclass:: tvm.relay.expr.TempExpr
+    :members:
+
+.. autoclass:: tvm.relay.expr.ExprFunctor
+    :members:
+
+.. autoclass:: tvm.relay.expr.ExprMutator
+    :members:
+
+.. autoclass:: tvm.relay.expr.TupleWrapper
+    :members
+

docs/api/python/relay/frontend.rst

+
+tvm.relay.frontend
+------------------
+
+.. automodule:: tvm.relay.frontend
+
+.. autofunction:: tvm.relay.frontend.from_mxnet

docs/api/python/relay/image.rst

+
+tvm.relay.image
+---------------
+
+.. automodule:: tvm.relay.image
+    :members:
+
+.. automodule:: tvm.relay.op.image.image
+    :members:

docs/api/python/relay/index.rst

+Relay API
+=========
+
+This document contains the Python API for the Relay frontend, optimizer, and
+compiler toolchain.
+
+Relay is the second-generation, high-level intermediate representation (IR) for the TVM
+compiler stack.
+
+.. toctree::
+   :maxdepth: 2
+
+   backend
+   base
+   build_module
+   expr
+   frontend
+   image
+   ir_pass
+   module
+   nn
+   op
+   scope_builder
+   ty
+   vision

docs/api/python/relay/ir_pass.rst

+tvm.relay.ir_pass
+-----------------
+.. automodule:: tvm.relay.ir_pass
+    :members:
\ No newline at end of file

docs/api/python/relay/module.rst

+tvm.relay.module
+----------------
+
+.. automodule:: tvm.relay.module
+
+.. autoclass:: tvm.relay.module.Module
+    :members:

docs/api/python/relay/nn.rst

+tvm.relay.nn
+------------
+.. automodule:: tvm.relay.nn
+    :members:
+
+.. automodule:: tvm.relay.op.nn.nn
+    :members:

docs/api/python/relay/op.rst

+tvm.relay.op
+------------
+.. automodule:: tvm.relay.op
+    :members:
+
+.. automodule:: tvm.relay.op.op
+    :members:
+
+.. automodule:: tvm.relay.op.reduce
+    :members:
+
+.. automodule:: tvm.relay.op.tensor
+    :members:
+
+.. automodule:: tvm.relay.op.transform
+    :members:
+
+.. automodule:: tvm.relay.op.nn.nn
+    :members:
+
+.. automodule:: tvm.relay.op.vision.multibox
+    :members:
+
+.. automodule:: tvm.relay.op.vision.nms
+    :members:

docs/api/python/relay/scope_builder.rst

+tvm.relay.scope_builder
+-----------------------
+
+.. automodule:: tvm.relay.scope_builder
+
+.. autoclass:: tvm.relay.scope_builder.ScopeBuilder
+    :members:

docs/api/python/relay/ty.rst

+tvm.relay.ty
+------------
+
+.. automodule:: tvm.relay.ty
+    :members:
+
+.. autoclass:: tvm.relay.ty.Type
+    :members:
+
+.. autoclass:: tvm.relay.ty.TensorType
+    :members:
+
+.. autoclass:: tvm.relay.ty.Kind
+    :members:
+
+.. autoclass:: tvm.relay.ty.TypeVar
+    :members:
+
+.. autoclass:: tvm.relay.ty.TypeConstraint
+    :members:
+
+.. autoclass:: tvm.relay.ty.TupleType
+    :members:
+
+.. autoclass:: tvm.relay.ty.FuncType
+    :members:
+
+.. autoclass:: tvm.relay.ty.IncompleteType
+    :members:
+
+.. autoclass:: tvm.relay.ty.TypeRelation
+    :members:

docs/api/python/relay/vision.rst

+
+tvm.relay.vision
+----------------
+
+.. automodule:: tvm.relay.vision
+    :members:
+
+.. automodule:: tvm.relay.op.vision.multibox
+    :members:
+
+.. automodule:: tvm.relay.op.vision.nms
+    :members:

python/tvm/relay/backend/interpreter.py

 #pylint: disable=no-else-return
-"""An interface to the Realy interpreter."""
+"""The Python interface to the Relay reference interpreter."""
 from __future__ import absolute_import
 
 import numpy as np
@@ -23,6 +23,7 @@ class Value(NodeBase):
 
 @register_relay_node
 class TupleValue(Value):
+    """A tuple value produced by the interpreter."""
     def __init__(self, *fields):
         self.__init_handle_by_constructor__(
             _make.TupleValue, fields)
@@ -33,12 +34,13 @@ class TupleValue(Value):
 
 @register_relay_node
 class Closure(Value):
+    """A closure produced by the interpreter."""
     pass
 
 
 @register_relay_node
 class TensorValue(Value):
-    """A Tensor value produced by the evaluator."""
+    """A Tensor value produced by the interpreter."""
 
     def __init__(self, data):
         """Allocate a new TensorValue and copy the data from `array` into

python/tvm/relay/base.py

@@ -8,12 +8,12 @@ from . import _expr
 NodeBase = NodeBase
 
 def register_relay_node(type_key=None):
-    """register relay node type
+    """Register a Relay node type.
 
     Parameters
     ----------
     type_key : str or cls
-        The type key of the node
+        The type key of the node.
     """
     if not isinstance(type_key, str):
         return _register_tvm_node(
@@ -22,12 +22,12 @@ def register_relay_node(type_key=None):
 
 
 def register_relay_attr_node(type_key=None):
-    """register relay attribute node
+    """Register a Relay attribute node.
 
     Parameters
     ----------
     type_key : str or cls
-        The type key of the node
+        The type key of the node.
     """
     if not isinstance(type_key, str):
         return _register_tvm_node(
@@ -36,7 +36,7 @@ def register_relay_attr_node(type_key=None):
 
 
 class RelayNode(NodeBase):
-    """Base class of all relay node."""
+    """Base class of all Relay nodes."""
     def astext(self, show_meta_data=True, annotate=None):
         """Get the text format of the expression.
 
@@ -52,8 +52,8 @@ class RelayNode(NodeBase):
 
         Note
         ----
-        meta data section is necessary to fully parse the text format.
-        However, it can contain dumps that are big(constat weights),
+        The metadata section is necessary to fully parse the text format.
+        However, it can contain dumps that are big (e.g constant weights)a,
         so it can be helpful to skip printing the meta data section.
 
         Returns
@@ -66,12 +66,16 @@ class RelayNode(NodeBase):
 
 @register_relay_node
 class Span(RelayNode):
+    """Specifies a location in a source program."""
+
     def __init__(self, source, lineno, col_offset):
         self.__init_handle_by_constructor__(_make.Span, source, lineno, col_offset)
 
 
 @register_relay_node
 class Id(NodeBase):
-    """Unique identifier(name) for Var across type checking."""
+    """Unique identifier(name) used in Var.
+       Guaranteed to be stable across all passes.
+    """
     def __init__(self):
         raise RuntimeError("Cannot directly construct Id")

python/tvm/relay/build_module.py

@@ -240,13 +240,13 @@ class GraphExecutor(_interpreter.Executor):
 
     Parameters
     ----------
-    mod : tvm.relay.Module
+    mod : :py:class:`~tvm.relay.module.Module`
         The module to support the execution.
 
-    ctx : tvm.TVMContext
+    ctx : :py:class:`TVMContext`
         The runtime context to run the code on.
 
-    target : tvm.Target
+    target : :py:class:`Target`
         The target option to build the function.
     """
     def __init__(self, mod, ctx, target):
@@ -282,13 +282,13 @@ def create_executor(kind="debug",
     kind : str
         The type of executor
 
-    mod : tvm.relay.Module
+    mod : :py:class:`~tvm.relay.module.Module`
         The Relay module containing collection of functions
 
-    ctx : tvm.TVMContext
+    ctx : :py:class:`tvm.TVMContext`
         The context to execute the code.
 
-    target : tvm.Target
+    target : :py:class:`tvm.Target`
         The corresponding context
     """
     if ctx is not None:

python/tvm/relay/frontend/__init__.py

-"""Relay frontends."""
+"""
+Frontends for constructing Relay programs.
+
+Contains the model importers currently defined
+for Relay.
+"""
+
 from __future__ import absolute_import
 
 from .mxnet import from_mxnet

python/tvm/relay/image.py

 # pylint: disable=wildcard-import, unused-import, unused-wildcard-import
-"""Image nets related operators."""
+"""Image network related operators."""
 # Re-export in a specific file name so that autodoc can pick it up
 from .op.image import *