You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mxnet.apache.org by GitBox <gi...@apache.org> on 2018/09/04 19:42:16 UTC

[GitHub] aaronmarkham opened a new pull request #12455: Add Python API docs for test_utils and visualization

aaronmarkham opened a new pull request #12455: Add Python API docs for test_utils and visualization
URL: https://github.com/apache/incubator-mxnet/pull/12455
 
 
   ## Description ##
   Fixes https://github.com/apache/incubator-mxnet/issues/11412 - by adding missing module 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_utils` and `visualization`.
   
   I put these in a "tools" folder. It seemed to make sense.
   
   ## 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.viz` doesn't work. Therefore only the long version `mxnet.visualiztion` is mentioned in these docs. This is similar to what I ran into with ONNX: #12318.
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services