Skip to content

Commit d62e628

Browse files
committed
Updated docs for v0.1.1
1 parent c770563 commit d62e628

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

docs/src/index.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Say hello to `ParallelKMeans`!
1313

1414
This package aims to utilize the speed of Julia and parallelization (both CPU & GPU) to offer an extremely fast implementation of the K-Means clustering algorithm and its variations via a friendly interface for practioners.
1515

16-
In short, we hope this package will eventually mature as the "one stop" shop for everything KMeans on both CPUs and GPUs.
16+
In short, we hope this package will eventually mature as the "one stop" shop for everything K-Means on both CPUs and GPUs.
1717

1818
## K-Means Algorithm Implementation Notes
1919

@@ -51,19 +51,20 @@ git checkout experimental
5151
## Features
5252

5353
- Lightening fast implementation of Kmeans clustering algorithm even on a single thread in native Julia.
54-
- Support for multi-theading implementation of Kmeans clustering algorithm.
54+
- Support for multi-theading implementation of K-Means clustering algorithm.
5555
- 'Kmeans++' initialization for faster and better convergence.
56-
- Modified version of Elkan's Triangle inequality to speed up K-Means algorithm.
56+
- Implementation of available classic and contemporary variants of the K-Means algorithm.
5757

5858
## Pending Features
5959

6060
- [X] Implementation of [Hamerly implementation](https://www.researchgate.net/publication/220906984_Making_k-means_Even_Faster).
61+
- [X] Interface for inclusion in Alan Turing Institute's [MLJModels](https://github.com/alan-turing-institute/MLJModels.jl#who-is-this-repo-for).
6162
- [ ] 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).
6263
- [ ] Implementation of [Geometric methods to accelerate k-means algorithm](http://cs.baylor.edu/~hamerly/papers/sdm2016_rysavy_hamerly.pdf).
63-
- [ ] Support for DataFrame inputs.
64+
- [ ] Native support for tabular data inputs outside of MLJModels' interface.
6465
- [ ] Refactoring and finalizaiton of API desgin.
6566
- [ ] GPU support.
66-
- [ ] Even faster Kmeans implementation based on current literature.
67+
- [ ] Even faster Kmeans implementation based on recent literature.
6768
- [ ] Optimization of code base.
6869
- [ ] Improved Documentation
6970
- [ ] More benchmark tests
@@ -175,14 +176,15 @@ ________________________________________________________________________________
175176
## Release History
176177

177178
- 0.1.0 Initial release
179+
- 0.1.1 Added interface for MLJ
178180

179181
## Contributing
180182

181183
Ultimately, we see this package as potentially the one stop shop for everything related to KMeans algorithm and its speed up variants. We are open to new implementations and ideas from anyone interested in this project.
182184

183185
Detailed contribution guidelines will be added in upcoming releases.
184186

185-
<!--- Insert Contribution Guidelines Below --->
187+
<!--- TODO: Contribution Guidelines --->
186188

187189
```@index
188190
```

0 commit comments

Comments
 (0)