Update KMeans init docstring to include 'random' option #1020
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
The docstring for the dask_ml.cluster.KMeans class currently omits 'random' as a valid option for the init parameter. However, this option is fully implemented in the underlying k_init function and serves as a critical scalable alternative to the default 'k-means||', which can overwhelm the scheduler on large datasets.
Contributor
Author
|
@TomAugspurger Could you please take a look |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
The docstring for the
dask_ml.cluster.KMeansclass currently omitsrandomas a valid option for theinitparameter. However, this option is fully implemented in the underlyingk_initfunction and serves as a critical scalable alternative to the defaultk-means||, which can overwhelm the scheduler on large datasets.These changes make the documentation accurately reflect the implementation and help users make better-informed decisions when choosing an initialization strategy for large-scale clustering tasks.
Also covers #918