Added README.md
[clueless-kmeans.git] / README.md
1 # Introduction
2
3 This procedure is a variant of k-means using labelled samples, which
4 enforces in every cluster the same proportion of samples from every
5 class. This ensures that the resulting clusters are totally
6 non-informative about the class, while maximally informative about
7 the signal.
8
9 You can get a
10 [`short report on the method,`](https://fleuret.org/papers/fleuret-clueless-kmeans2015.pdf).
11
12 # Installation
13
14 Executing
15
16 ```
17 ./test.sh
18 ```
19
20 will compile the source, run the algorithm on a 2d toy example, and
21 produce three graphs
22 ([`result-standard.png,`](https://fleuret.org/git-extract/clueless-kmeans/result-standard.png)
23 [`result-clueless.png,`](https://fleuret.org/git-extract/clueless-kmeans/result-clueless.png)
24 and [`result-clueless-absolute.png`](https://fleuret.org/git-extract/clueless-kmeans/result-clueless-absolute.png)) if you
25 have [`gnuplot`](http://www.gnuplot.info/) installed.