Skip to content

Commit 26ffa4b

Browse files
committed
Update README.rst
Explain some of the further features of the library.
1 parent 245fff3 commit 26ffa4b

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,44 @@ Note that clustering larger datasets will require significant memory
3838
(as with any algorithm that needs all pairwise distances). Support for
3939
low memory/better scaling is planned but not yet implemented.
4040

41+
------------------------
42+
Additional functionality
43+
------------------------
44+
45+
The hdbscan package comes equipped with visualization tools to help you
46+
understand your clustering results. After fitting data the clusterer
47+
object has attributes for:
48+
49+
* The condensed cluster hierarchy
50+
* The robust single linkage cluster hierarchy
51+
* The reachability distance minimal spanning tree
52+
53+
All of which come equipped with methods for plotting and converting
54+
to Pandas or NetworkX for further analysis. See the notebook on
55+
`how HDBSCAN works <http://nbviewer.jupyter.org/github/lmcinnes/hdbscan/blob/master/notebooks/How%20HDBSCAN%20Works.ipynb>`_ for examples and further details.
56+
57+
The clusterer objects also have an attribute providing cluster membership
58+
strengths, resulting in optional soft clustering (and no further compute
59+
expense)
60+
61+
---------------------
62+
Robust single linkage
63+
---------------------
64+
65+
The hdbscan package also provides support for the *robust single linkage*
66+
clustering algorithm of Chaudhuri and Dasgupta. As with the HDBSCAN
67+
implementation this is a high performance version of the algorithm
68+
outperforming scipy's standard single linkage implementation. The
69+
robust single linkage hierarchy is available as an attribute of
70+
the robust single linkage clusterer, again with the ability to plot
71+
or export the hierarchy, and to extract flat clusterings at a given
72+
cut level and gamma value.
73+
74+
Based on the paper:
75+
K. Chaudhuri and S. Dasgupta.
76+
*"Rates of convergence for the cluster tree."*
77+
In Advances in Neural Information Processing Systems, 2010.
78+
4179
----------
4280
Installing
4381
----------

0 commit comments

Comments
 (0)