machine_learning: add numeric doctests to k_means_clust - #15285
Merged
Conversation
cclauss
approved these changes
Sep 12, 2026
13 tasks
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
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.
Follow-up to #13919 (per that discussion, one focused per-file PR rather than a broad umbrella change).
machine_learning/k_means_clust.pyhad no doctests, so nothing pinned its numeric behaviour. This adds doctests to the deterministic core functions using a tiny fixed 2-cluster dataset:assign_clusters— nearest-centroid labels →[0, 0, 1, 1]revise_centroids— per-cluster means →[[0.0, 0.5], [10.0, 10.5]]compute_heterogeneity— sum of squared distances to assigned centroid →1.0kmeans— end-to-end on fixed initial centroids, pinning both returned centroids and assignmentsThe dataset is chosen so the expected values are easy to verify by hand, and outputs are converted with
.tolist()/float()so the doctests are exact and platform-independent. All doctests pass locally (python -m doctest/testmod), andruff check/ruff formatare clean.No behaviour changes — documentation/tests only.
Fixes #13919