[GitHub] zboldyga opened a new pull request #13994: Return value docs for nd.random.* and sym.random.*

[GitBox <gi...@apache.org>]

zboldyga opened a new pull request #13994:  Return value docs for nd.random.* and sym.random.*
URL: https://github.com/apache/incubator-mxnet/pull/13994
 
 
   ## Description ##
   Documented return values & types for nd.random.* and sym.random.*
   
   ## Checklist ##
   ### Essentials ###
   Please feel free to remove inapplicable items for your PR.
   **NO JIRA, PR CHANGE IS TINY (DOCUMENTATION ADDITIONS ONLY)**
   - [YES ] Changes are complete (i.e. I finished coding on this PR)
   
   ### Changes ###
   - nd.random.* , documentation for return types
   - sym.random.* , documentation for return types
   
   ## Comments ##
   Based on other parts of the Python API documentation as of V 1.3.1, I wasn't 100% clear on how detailed return type documentation should be. I also wasn't sure of the preferred terms to use for certain aspects of the MXNet Symbol library. For instance, is saying that a Symbol 'resolves' to shape (m,n,x,y) an accurate description? Given the complexity of some of the .random.* APIs, it seems useful to get into the details of the structure of the output. 
   
   Happy to make changes if someone more central to the project has preferences!
   
   Also, I was not able to build the docs on OSX or Ubuntu, this seemed to be a general problem with any version of the MXNet project. I'm going to lean on the CI tools for the moment.
   
   
   

----------------------------------------------------------------
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