This repository was archived by the owner on Nov 17, 2023. It is now read-only.
Add Python API docs for test_utils and visualization #12455
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Author
|
@sandeep-krishnamurthy Could you provide some feedback on the other missing modules and whether |
|
Thanks @aaronmarkham . This looks good to me and a very useful addition. @aaronmarkham - Can you please rebase this PR and we are good to go here. |
sandeep-krishnamurthy
added
the
pr-awaiting-merge
aaronmarkham
added a commit
to aaronmarkham/incubator-mxnet
that referenced
this pull request
Sep 11, 2018
* adding missing python modules as tools folder for docs * adding missing python modules as tools folder for docs * adjusted paths after testing build
anirudh2290
pushed a commit
to anirudh2290/mxnet
that referenced
this pull request
Sep 19, 2018
* adding missing python modules as tools folder for docs * adding missing python modules as tools folder for docs * adjusted paths after testing build
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixes #11412 - by adding missing modules to the docs coverage.
There appear to be several modules that are not included in the Python docs. This PR specifically addresses those mentioned in #11412 -
test_utilsandvisualization.I put these in a "tools" folder. It seemed to make sense.
Preview
http://34.201.8.176/versions/python_tools/api/python/index.html#tools
Comments
LMK what other missing APIs should go in the tools folder. There seem to be a lot of things in https://github.com/apache/incubator-mxnet/tree/master/python/mxnet that aren't covered. If someone wants to make an issue and tag me in it, I can handle those in another PR.
Something is wrong with the shorthand invocations. The way the docs pipeline is setup and the way Sphinx is reading things makes it so
mxnet.vizdoesn't work. Therefore only the long versionmxnet.visualiztionis mentioned in these docs. This is similar to what I ran into with ONNX: #12318.