DOC improve docsting following the user guide in mean-shift module #16216
Conversation
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
NicolasHug
reviewed
Jan 25, 2020
sklearn/cluster/_mean_shift.py
Outdated
| quantile : float, default=0.3 | ||
| should be between [0, 1] | ||
| 0.5 means that the median of all pairwise distances is used. | ||
| The default is 0.3 |
Contributor
Author
There was a problem hiding this comment.
I've edited the descriptions to remove the defaults I had added.
NicolasHug
reviewed
Jan 25, 2020
Member
NicolasHug
left a comment
NicolasHug
left a comment
There was a problem hiding this comment.
thanks for the PR @ETay203 , this looks good but there is no need to specify the default inside of the description now that you have them in the first line
sklearn/cluster/_mean_shift.py
Outdated
| The generator used to randomly select the samples from input points | ||
| for bandwidth estimation. Use an int to make the randomness | ||
| deterministic. | ||
| deterministic.The default value is None. |
Member
There was a problem hiding this comment.
no need either, here and in the other places
Contributor
Author
There was a problem hiding this comment.
I've removed all the defaults I'd added in the descriptions.
glemaitre
requested changes
Jan 26, 2020
glemaitre
changed the title
Co-Authored-By: Guillaume Lemaitre <[email protected]>
Co-Authored-By: Guillaume Lemaitre <[email protected]>
Co-Authored-By: Guillaume Lemaitre <[email protected]>
Co-Authored-By: Guillaume Lemaitre <[email protected]>
Co-Authored-By: Guillaume Lemaitre <[email protected]>
Co-Authored-By: Guillaume Lemaitre <[email protected]>
Co-Authored-By: Guillaume Lemaitre <[email protected]>
Co-Authored-By: Guillaume Lemaitre <[email protected]>
Contributor
Author
|
@glemaitre Thank you for the review and suggested changes. I've commited all changes. |
glemaitre
approved these changes
Jan 26, 2020
Member
|
@ETay203 Thanks for your contribution. |
thomasjpfan
pushed a commit
to thomasjpfan/scikit-learn
that referenced
this pull request
Feb 22, 2020
panpiort8
pushed a commit
to panpiort8/scikit-learn
that referenced
this pull request
Mar 3, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
removed 'optional' and fixing all default values in _mean_shift.py
fixes #15761
with @mjmolina
@adrinjalali
@noatamir