DOC: Improve doc for numpy.random.Generator.choice #18223
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
rkern
reviewed
Jan 25, 2021
numpy/random/_generator.pyx
Outdated
| @@ -665,6 +665,13 @@ cdef class Generator: | |||
| array([3,1,0]) # random | |||
| >>> #This is equivalent to rng.permutation(np.arange(5))[:3] | |||
|
|
|||
| Generate a uniform random sample from a 2-D array, without | |||
| replacement: | |||
There was a problem hiding this comment.
I would prefer a wording that emphasizes that it chooses along the first axis. This wording can be read to mean that it selects values from all of the elements of the 2D array (i.e. equivalent to choice(x.ravel())).
charris
changed the title
charris
reviewed
Jan 26, 2021
| >>> rng.choice([[0, 1, 2], [3, 4, 5], [6, 7, 8]], 2, replace=False) | ||
| array([[3, 4, 5], | ||
| [0, 1, 2]]) | ||
|
|
There was a problem hiding this comment.
This example is raising a documentation error.
File "build/testenv/lib/python3.7/site-packages/numpy/random/_generator.cpython-37m-darwin.so", line ?, in Generator.choice
Failed example:
rng.choice([[0, 1, 2], [3, 4, 5], [6, 7, 8]], 2, replace=False)
Expected:
array([[3, 4, 5],
[0, 1, 2]])
Got:
array([[6, 7, 8],
[3, 4, 5]])
You need to use a seed to make it repeatable, or add # may vary to the first output line. Grep to see examples.
There was a problem hiding this comment.
Ah, it had occurred to me, but I guess I missed the # random in the other examples and couldn't find anything about it in the developer documentation. Cheers!
|
Thanks @SnoopJeDi . |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The summary of
numpy.random.Generator.choice()suggests that the function is restricted to 1-D inputs, but this is not the case.This PR removes the "1-D" qualifier from the summary and adds an example demonstrating use of this function for sampling from an array of dimension greater than one.