@@ -1,5 +1,7 @@ h1. Clustering algorithms for Clojure +Two clustering algorithms for Clojure: k-means and hierarchical. + h2. Usage <pre> @@ -19,11 +21,12 @@ Currently we expose two clustering algorithms: k-means and hierarchical. Use the ;; :count - number of clusters to find ;; :range-start - lower limit for the randomized cluster nodes ;; :range-end - upper limit for the randomized cluster nodes + (kcluster [[1 2 3] [3 4 5] [5 6 7]] 2 0 7) </code> </pre> -So, _range-start_ and _range-end_ may needa bit of clarification. A k-means algorithm works by randomly +So, _range-start_ and _range-end_ may need a bit of clarification. A k-means algorithm works by randomly placing a number of nodes amonst the nodes you want clustered, then moving those nodes until they fall into the center of a cluster. Those random nodes need upper and lower limits. Usually these are just the highest and lowest possible values for numbers in the vectors which you're clustering. @@ -39,6 +42,7 @@ h3. Hierarchical <code> ;; hcluster -- ;; :nodes - a sequence of maps in the form: { :vec [1 2 3] } + (hcluster [{:vec [1 2 3]} {:vec [3 4 5]} {:vec [7 9 9]}]) </code> </pre> @@ -55,3 +59,14 @@ The return value of _hcluster_ is a tree of Maps. It might look something like </code> </pre> + + +h2. Known Bugs + +Passing vectors of all the same number to either clustering function will cause a division-by-zero error due +to my sucking at implementing Pearson correctly. + +h2. To Do + +* Fix Pearson +* Add more similarity functions and allow use to choose which to use \ No newline at end of file README.textile e2ce11f348c3fd346437d340022de2747d13d3ec Tyler McMullen tbmcmullen@gmail.com http://github.com/tyler/clojure-cluster/commit/b85bfb1a0959f5607f6afc73d77fc60172b92652 b85bfb1a0959f5607f6afc73d77fc60172b92652 2008-10-12T01:13:29-07:00 2008-10-12T01:13:29-07:00 To Do, Known Bugs, and typographic fixes. d15bd7bedff8119f5077e8f1accee31a683e8e62 Tyler McMullen tbmcmullen@gmail.com