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 relay docs #5112

Merged
merged 3 commits into from
Mar 21, 2020
Merged

[docs] Update relay docs #5112

merged 3 commits into from
Mar 21, 2020

Conversation

zhiics
Copy link
Member

@zhiics zhiics commented Mar 20, 2020

#5068

This PR updates Relay docs. It removes redundant files and automatically generates automodules.

cc @tqchen @comaniac @cchung100m

@zhiics zhiics force-pushed the docs branch 4 times, most recently from 8660666 to cb72e5a Compare March 20, 2020 18:29
.. automodule:: tvm.relay
:members:
:imported-members:
:exclude-members: RelayExpr, Pass, PassInfo, function_pass, PassContext,
Copy link
Member

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

Copy link
Member Author

@zhiics zhiics Mar 20, 2020

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

@zhiics
Copy link
Member Author

zhiics commented Mar 20, 2020

@tqchen BTW, the CI still complains about the conflicts from relay_op.rst even I removed the autofunction there. I couldn't repro it locally. Is it due to some caching problem?

@tqchen
Copy link
Member

tqchen commented Mar 20, 2020

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

@zhiics
Copy link
Member Author

zhiics commented Mar 20, 2020

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.

@zhiics
Copy link
Member Author

zhiics commented Mar 21, 2020

@tqchen Yeah, it should be cached before. make clean solves the problem. Thanks.

@tqchen
Copy link
Member

tqchen commented Mar 21, 2020

@tqchen tqchen merged commit 36a83c7 into apache:master Mar 21, 2020
@zhiics zhiics deleted the docs branch March 21, 2020 17:16
trevor-m pushed a commit to trevor-m/tvm that referenced this pull request Apr 16, 2020
* Update relay docs

* any -> py:func

* make clean
zhiics added a commit to neo-ai/tvm that referenced this pull request Apr 17, 2020
* Update relay docs

* any -> py:func

* make clean
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants