[MRG] docs for random_state in decomposition module#11902
Merged
glemaitre merged 6 commits intoscikit-learn:masterfrom Jan 8, 2020
Merged
[MRG] docs for random_state in decomposition module#11902glemaitre merged 6 commits intoscikit-learn:masterfrom
glemaitre merged 6 commits intoscikit-learn:masterfrom
Conversation
jnothman
approved these changes
Aug 30, 2018
Member
jnothman
left a comment
There was a problem hiding this comment.
I like this generally. But I'm not sure about the wording of "reproducible output across multiple function calls"... I'd rather the more general "reproducible results across multiple calls" but maybe I'm being overly precise.
Update the wording for reproducible results.
Contributor
Author
|
agree with the wording, pushed updates. |
Member
Other than this LGTM. |
Contributor
Author
|
Sure, pushed updates. @jnothman could we also update this comment here, so that we could have a template inline with all the suggestions? this could be helpful for other PR authors. |
74 tasks
Member
|
I'm going to solve the conflict and merge with the new guideline. The PR is already in a good stage. |
Member
|
I will merge the test pass |
thomasjpfan
pushed a commit
to thomasjpfan/scikit-learn
that referenced
this pull request
Feb 22, 2020
…learn#11902) * [MRG] Fix random_state docstrings in decomposition module * Add more details, and specify reproducibility * [MRG] docs for random_state in decomposition module Update the wording for reproducible results. * [MRG] Update doc for optional parameter to match numpy doc style * apply new style Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
panpiort8
pushed a commit
to panpiort8/scikit-learn
that referenced
this pull request
Mar 3, 2020
…learn#11902) * [MRG] Fix random_state docstrings in decomposition module * Add more details, and specify reproducibility * [MRG] docs for random_state in decomposition module Update the wording for reproducible results. * [MRG] Update doc for optional parameter to match numpy doc style * apply new style Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
Reference Issues/PRs
Working towards #10548 .
What does this implement/fix? Explain your changes.
This PR updates the docstrings for
random_stateparameter, adding more info where I understood the changes, and specifying that output should be reproducible when an int is passed (where applicable).Any other comments?
Fixes only for
decompositionmodule.