From: Francois Fleuret Date: Mon, 29 Jun 2020 21:26:51 +0000 (+0200) Subject: Added README.md X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?a=commitdiff_plain;h=HEAD;p=clueless-kmeans.git Added README.md --- diff --git a/README.md b/README.md new file mode 100644 index 0000000..53fa4ea --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Introduction + +This procedure is a variant of k-means using labelled samples, which +enforces in every cluster the same proportion of samples from every +class. This ensures that the resulting clusters are totally +non-informative about the class, while maximally informative about +the signal. + +You can get a +[`short report on the method,`](https://fleuret.org/papers/fleuret-clueless-kmeans2015.pdf). + +# Installation + +Executing + +``` +./test.sh +``` + +will compile the source, run the algorithm on a 2d toy example, and +produce three graphs +([`result-standard.png,`](https://fleuret.org/git-extract/clueless-kmeans/result-standard.png) +[`result-clueless.png,`](https://fleuret.org/git-extract/clueless-kmeans/result-clueless.png) +and [`result-clueless-absolute.png`](https://fleuret.org/git-extract/clueless-kmeans/result-clueless-absolute.png)) if you +have [`gnuplot`](http://www.gnuplot.info/) installed.