Skip to content

Commit a8db1ef

Browse files
committed
emphasize sklearn compatibility
1 parent 288413f commit a8db1ef

2 files changed

Lines changed: 7 additions & 4 deletions

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ sklekmeans - Equilibrium K-Means for scikit-learn
1111
`sklekmeans` provides batch and mini-batch implementations of the
1212
Equilibrium K-Means (EKMeans) clustering algorithm. The method introduces
1313
an equilibrium weighting scheme that can yield improved robustness on
14-
imbalanced datasets compared to standard k-means.
14+
imbalanced datasets compared to standard k-means. The API is compatible
15+
with sklearn estimators.
1516

1617
Features
1718
--------

doc/index.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,11 @@ sklekmeans: a scikit-learn extension
99
`Issues & Ideas <https://github.com/ydcnanhe/sklearn-ekmeans/issues>`__ |
1010
`Build Docs Locally <https://github.com/ydcnanhe/sklearn-ekmeans/blob/main/doc/README.md>`__ |
1111

12-
This is the documentation for `sklekmeans` to help at extending
13-
`scikit-learn`. It provides some information on how to build your own custom
14-
`scikit-learn` compatible estimators as well as a template to package them.
12+
This site documents `sklekmeans`, a scikit-learn‑compatible implementation of
13+
Equilibrium K-Means (EKMeans) designed for robust clustering on imbalanced datasets.
14+
It covers installation and a quick start, algorithm details, full-batch and mini-batch
15+
training modes, optional numba acceleration, the full Python API compatible with
16+
sklearn estimators, and worked examples.
1517

1618

1719
.. grid:: 1 2 2 2

0 commit comments

Comments
 (0)