From 8df6f4afa1ed5a44a709356d4eb102d576e2c38d Mon Sep 17 00:00:00 2001 From: ColdinLee Date: Mon, 28 Jan 2019 22:35:07 +0800 Subject: [PATCH] [DOC]Update doc in _api_internal.py and ir_pass.py --- python/tvm/_api_internal.py | 10 +++++++++- python/tvm/ir_pass.py | 3 ++- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/python/tvm/_api_internal.py b/python/tvm/_api_internal.py index c0301ceeac3e..2435c6d54db2 100644 --- a/python/tvm/_api_internal.py +++ b/python/tvm/_api_internal.py @@ -1 +1,9 @@ -"""namespace of internal API""" +"""Namespace of internal API + +The functions in this namespace are automatically exported from C++ side via PackedFunc +that is registered by "TVM_REGISTER_*" macro. This way makes calling Python functions from C++ +side very easily. + +Each string starts with "_" in the "TVM_REGISTER_*" macro is an internal API. You can find +all the functions in "api_lang.cc", "api_base.cc", "api_arith.cc" and "api_ir.cc" under "src/api". +""" diff --git a/python/tvm/ir_pass.py b/python/tvm/ir_pass.py index 2f47ac4c6898..35a07d8a4bff 100644 --- a/python/tvm/ir_pass.py +++ b/python/tvm/ir_pass.py @@ -4,7 +4,8 @@ The functions are automatically exported from C++ side via PackedFunc. Each api is a PackedFunc that can be called in a positional argument manner. -You can read "include/tvm/pass.h" for the function signature of these functions. +You can read "include/tvm/ir_pass.h" for the function signature and +"src/api/api_pass.cc" for the PackedFunc's body of these functions. """ from ._ffi.function import _init_api