-
-
Notifications
You must be signed in to change notification settings - Fork 25.8k
DOC link to example explaining init
usage in KMeans
#26981
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
init
usage in KMeans
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple of improvements
@@ -1240,6 +1240,10 @@ class KMeans(_BaseKMeans): | |||
If a callable is passed, it should take arguments X, n_clusters and a | |||
random state and return an initialization. | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that I would like to use item for the different options above (using -
). It will make it obvious which part of the discussion is about the options for init
and which part is to go further (the new link to the example).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi Guillaume, thank you for reviewing😄
What do you mean by 'using -'?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you mean by 'using -'?
Transforming the sentence into a list, e.g.
This, that, and everything
vs
- This
- That
- Everything
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If I understood the original suggestion correctly, I believe it was more intended to separate "If an array is passed..." and "If a callable is passed..." as separate list entries, as opposed to the inputs of the callable that is now listed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for your reply!
I modified it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lines underneath a list symbol *
that contain text to be included in the body of the list entry need to be indented with two spaces (I think. May be four spaces?). The formatting is a bit tricky sometimes. I still struggle with it myself😅
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you.
I fixed the indentation 😊
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
LGTM Thanks @cynthias13w Merging. |
…6981) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
…6981) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
…6981) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
…6981) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Reference Issues/PRs
Towards #26927
What does this implement/fix? Explain your changes.
Added a link to https://scikit-learn.org/stable/modules/generated/sklearn.cluster.KMeans.html
Any other comments?
cc @adrinjalali @glemaitre
Thank you☺️ 🙏