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

[DOC]Update doc in _api_internal.py and ir_pass.py #2514

Merged
merged 1 commit into from
Jan 29, 2019
Merged
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
[DOC]Update doc in _api_internal.py and ir_pass.py
ColdinLee committed Jan 28, 2019
commit 8df6f4afa1ed5a44a709356d4eb102d576e2c38d
10 changes: 9 additions & 1 deletion python/tvm/_api_internal.py
Original file line number Diff line number Diff line change
@@ -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".
"""
3 changes: 2 additions & 1 deletion python/tvm/ir_pass.py
Original file line number Diff line number Diff line change
@@ -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