DOC: document default behaviour of sample methods when random_state = None
#59073
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
Previously the default random state of the Series/DataFrame/GroupBy `sample` methods was unclear as the documentation for the behaviour when `random_state=None` was hidden in the `pandas.core.common.random_state` helper function. This commit documents how `sample` will just defer to the random state of `numpy.random` when no `random_state` parameter is passed.
mroeschke
reviewed
Jun 24, 2024
mroeschke
reviewed
Jun 24, 2024
mroeschke
approved these changes
Jun 25, 2024
|
Thanks @alexmalins |
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.
Docs improvement to make it clear what the DataFrame/Series/GroupBy
samplemethods do when no argument is supplied forrandom_state. TLDR it just defers tonp.randomto draw random samples, so the state is whatever the current random state ofnp.randomis.doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.