Skip to content

Commit 141a565

Browse files
committed
Updated docs & initiated draft v0.1.5
1 parent 40cf17b commit 141a565

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

docs/src/index.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,10 @@ git checkout experimental
7272
- [X] Implementation of [Hamerly implementation](https://www.researchgate.net/publication/220906984_Making_k-means_Even_Faster).
7373
- [X] Interface for inclusion in Alan Turing Institute's [MLJModels](https://github.com/alan-turing-institute/MLJModels.jl#who-is-this-repo-for).
7474
- [X] Full Implementation of Triangle inequality based on [Elkan - 2003 Using the Triangle Inequality to Accelerate K-Means"](https://www.aaai.org/Papers/ICML/2003/ICML03-022.pdf).
75-
- [X] Implementation of [Yinyang K-Means: A Drop-In Replacement of the Classic K-Means
76-
with Consistent Speedup](https://www.microsoft.com/en-us/research/wp-content/uploads/2016/02/ding15.pdf)
75+
- [X] Implementation of [Yinyang K-Means: A Drop-In Replacement of the Classic K-Means with Consistent Speedup](https://www.microsoft.com/en-us/research/wp-content/uploads/2016/02/ding15.pdf)
7776
- [ ] Implementation of [Geometric methods to accelerate k-means algorithm](http://cs.baylor.edu/~hamerly/papers/sdm2016_rysavy_hamerly.pdf).
7877
- [ ] Support for other distance metrics supported by [Distances.jl](https://github.com/JuliaStats/Distances.jl#supported-distances).
79-
- [ ] Implementation of [Yinyang K-Means](https://www.microsoft.com/en-us/research/wp-content/uploads/2016/02/ding15.pdf).
78+
- [ ] Support of MLJ Random generation hyperparameter.
8079
- [ ] Native support for tabular data inputs outside of MLJModels' interface.
8180
- [ ] Refactoring and finalizaiton of API desgin.
8281
- [ ] GPU support.
@@ -121,11 +120,11 @@ r.converged # whether the procedure converged
121120
### Supported KMeans algorithm variations and recommended use cases
122121

123122
- [Lloyd()](https://cs.nyu.edu/~roweis/csc2515-2006/readings/lloyd57.pdf) - Default algorithm but only recommended for very small matrices (switch to `n_threads = 1` to avoid overhead).
124-
- [Hamerly()](https://www.researchgate.net/publication/220906984_Making_k-means_Even_Faster) - Useful in most cases. If uncertain about your use case, use this!
123+
- [Hamerly()](https://www.researchgate.net/publication/220906984_Making_k-means_Even_Faster) - Useful in most cases. If uncertain about your use case, try this!
125124
- [Elkan()](https://www.aaai.org/Papers/ICML/2003/ICML03-022.pdf) - Recommended for high dimensional data.
125+
- [Yinyang()](https://www.microsoft.com/en-us/research/wp-content/uploads/2016/02/ding15.pdf) - An excellent choice for most cases. Swiss blade for many use cases.
126126
- [Geometric()](http://cs.baylor.edu/~hamerly/papers/sdm2016_rysavy_hamerly.pdf) - (Coming soon)
127127
- [MiniBatch()](https://www.eecs.tufts.edu/~dsculley/papers/fastkmeans.pdf) - (Coming soon)
128-
- [Yinyang](https://www.microsoft.com/en-us/research/wp-content/uploads/2016/02/ding15.pdf) - (Coming soon)
129128

130129
### Practical Usage Examples
131130

@@ -199,7 +198,7 @@ ________________________________________________________________________________
199198
- 0.1.1 Added interface for MLJ.
200199
- 0.1.2 Added `Elkan` algorithm.
201200
- 0.1.3 Faster & optimized execution.
202-
- 0.1.4 Bug fixes
201+
- 0.1.4 Bug fixes.
203202
- 0.1.5 Added `Yinyang` algorithm.
204203

205204
## Contributing

0 commit comments

Comments
 (0)