-
Notifications
You must be signed in to change notification settings - Fork 3.5k
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 relay docs #5112
[docs] Update relay docs #5112
Conversation
8660666
to
cb72e5a
Compare
.. automodule:: tvm.relay | ||
:members: | ||
:imported-members: | ||
:exclude-members: RelayExpr, Pass, PassInfo, function_pass, PassContext, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can also consider allow these members, but modify https://github.com/apache/incubator-tvm/blob/master/docs/conf.py#L254 to mark them as alias
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I tried this before. But there are a lot of places that directly use the classes without namespace. It causes many ambiguous reference. For example:
https://github.com/apache/incubator-tvm/blob/master/python/tvm/ir/adt.py#L82
Constructor
here could be tvm.ir.Constructor
or tvm.relay.Constructor
@tqchen BTW, the CI still complains about the conflicts from |
interesting, can you try to use the exact same docker image? Iet us also try to add make clean before https://github.com/apache/incubator-tvm/blob/master/tests/scripts/task_sphinx_precheck.sh#L36 |
I checked out the image and ran the same command before. It seemed working fine. Hopefully I didn't do something silly. I will double check. |
@tqchen Yeah, it should be cached before. |
Great, let us also add make clean to https://github.com/apache/incubator-tvm/blob/master/tests/scripts/task_python_docs.sh#L47 |
* Update relay docs * any -> py:func * make clean
* Update relay docs * any -> py:func * make clean
#5068
This PR updates Relay docs. It removes redundant files and automatically generates automodules.
cc @tqchen @comaniac @cchung100m