This repository has been archived by the owner on Nov 17, 2023. It is now read-only.
Return value docs for nd.random.* and sym.random.* #13994
Merged
Conversation
This file contains 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
ChaiBapchya
approved these changes
Jan 26, 2019
sandeep-krishnamurthy
added
Doc
Python
pr-awaiting-review
|
Thanks for the contribution, @zboldyga. The preview is at http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-13994/2/api/python/ndarray/random.html#api-reference. Doc looks good to me. |
stephenrawls
pushed a commit
to stephenrawls/incubator-mxnet
that referenced
this pull request
Feb 16, 2019
* mx.random.multinomial python documentation updated, return type details added * multinomial documentation clarified * added basic case for negative_binomial * added basic case for generalized_negative_binomial * basic case added for gamma * added basic case for exponential * basic case added for randn * remaining base cases added. * randint case added * cleaned up return types for random.py * zboldyga added to contributors * spacing typo correction * updated symbol.random return types, minor correction to ndarray.random return types * removed trailing whitespace in docs
haohuanw
pushed a commit
to haohuanw/incubator-mxnet
that referenced
this pull request
Jun 23, 2019
* mx.random.multinomial python documentation updated, return type details added * multinomial documentation clarified * added basic case for negative_binomial * added basic case for generalized_negative_binomial * basic case added for gamma * added basic case for exponential * basic case added for randn * remaining base cases added. * randint case added * cleaned up return types for random.py * zboldyga added to contributors * spacing typo correction * updated symbol.random return types, minor correction to ndarray.random return types * removed trailing whitespace in docs
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
Documented return values & types for nd.random.* and sym.random.*
Issue: #13227
Checklist
Essentials
Please feel free to remove inapplicable items for your PR.
NO JIRA, PR CHANGE IS TINY (DOCUMENTATION ADDITIONS ONLY)
Changes
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.