This repository has been archived by the owner on Nov 17, 2023. It is now read-only.
Doc sample change #6094
Merged
Doc sample change #6094
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
|
@zackchase @madjam @bhavinthaker review |
madjam
reviewed
May 4, 2017
There was a problem hiding this comment.
Looks good @asmushetzel . Few minor formatting suggestions.
src/operator/tensor/sample_op.cc
Outdated
| .describe("Sample a gamma distribution") | ||
| .describe(R"code(Draw random samples from a gamma distribution. | ||
|
|
||
| Samples are distributed according to a gamma distribution parametrized by alpha (shape) and beta (scale). |
There was a problem hiding this comment.
alpha -> alpha
beta -> beta
So that we are following a consistent formatting for these distribution parameters.
src/operator/tensor/sample_op.cc
Outdated
| .describe("Sample an exponential distribution") | ||
| .describe(R"code(Draw random samples from an exponential distribution. | ||
|
|
||
| Samples are distributed according to an exponential distribution parametrized by lambda (rate). |
src/operator/tensor/sample_op.cc
Outdated
| .describe("Sample a Poisson distribution") | ||
| .describe(R"code(Draw random samples from a Poisson distribution. | ||
|
|
||
| Samples are distributed according to a Poisson distribution parametrized by lambda (rate). |
src/operator/tensor/sample_op.cc
Outdated
| .describe(R"code(Draw random samples from a negative binomial distribution. | ||
|
|
||
| Samples are distributed according to a negative binomial distribution parametrized by | ||
| k (limit of unsuccessful experiments) and p (failure probability in each experiment). |
src/operator/tensor/sample_op.cc
Outdated
| .describe(R"code(Draw random samples from a generalized negative binomial distribution. | ||
|
|
||
| Samples are distributed according to a generalized negative binomial distribution parametrized by | ||
| mu (mean) and alpha (dispersion). alpha is defined as 1/k where k is the failure limit of the |
There was a problem hiding this comment.
Incorporated the suggested improvements.
|
Tremendous! Thank you! |
rishita
pushed a commit
to rishita/mxnet
that referenced
this pull request
May 10, 2017
* documentation changes for random sampling operators * added myself to contributor list * lint fixes * used italic font for variables according to review comment
Guneet-Dhillon
pushed a commit
to Guneet-Dhillon/mxnet
that referenced
this pull request
Sep 13, 2017
* documentation changes for random sampling operators * added myself to contributor list * lint fixes * used italic font for variables according to review comment
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.
Revised documentation including providing examples in response to issue #6000 for following operators:
random_uniform
random_normal
random_gamma
random_exponential
random_poisson
random_negative_binomial
random_generalized_negative_binomial
sample_uniform
sample_normal
sample_gamma
sample_exponential
sample_poisson
sample_negative_binomial
sample_generalized_negative_binomial
Screenshots attached
