Skip to content

Commit d87ab97

Browse files
authored
docs: add KMeans example (#1234)
* docs: add KMeans example * fix test * skip non deterministic examples
1 parent c6ef52c commit d87ab97

File tree

1 file changed

+22
-0
lines changed
  • third_party/bigframes_vendored/sklearn/cluster

1 file changed

+22
-0
lines changed

third_party/bigframes_vendored/sklearn/cluster/_kmeans.py

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,28 @@ class _BaseKMeans(BaseEstimator, ABC):
2727
class KMeans(_BaseKMeans):
2828
"""K-Means clustering.
2929
30+
**Examples:**
31+
32+
>>> import bigframes.pandas as bpd
33+
>>> bpd.options.display.progress_bar = None
34+
>>> from bigframes.ml.cluster import KMeans
35+
36+
>>> X = bpd.DataFrame({"feat0": [1, 1, 1, 10, 10, 10], "feat1": [2, 4, 0, 2, 4, 0]})
37+
>>> kmeans = KMeans(n_clusters=2).fit(X)
38+
>>> kmeans.predict(bpd.DataFrame({"feat0": [0, 12], "feat1": [0, 3]}))["CENTROID_ID"] # doctest:+SKIP
39+
0 1
40+
1 2
41+
Name: CENTROID_ID, dtype: Int64
42+
43+
>>> kmeans.cluster_centers_ # doctest:+SKIP
44+
centroid_id feature numerical_value categorical_value
45+
0 1 feat0 5.5 []
46+
1 1 feat1 1.0 []
47+
2 2 feat0 5.5 []
48+
3 2 feat1 4.0 []
49+
50+
[4 rows x 4 columns]
51+
3052
Args:
3153
n_clusters (int, default 8):
3254
The number of clusters to form as well as the number of centroids to generate.

0 commit comments

Comments
 (0)