Skip to content

Commit

Permalink
Update docs and requirements as we move to 0.5
Browse files Browse the repository at this point in the history
  • Loading branch information
lmcinnes committed Nov 15, 2015
1 parent bba3705 commit d44782e
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 4 deletions.
16 changes: 13 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,12 @@ Performance
-----------

Significant effort has been put into making the hdbscan implementation as fast as
possible. It is more than twice as fast as the reference implementation in Java
possible. It is more than ten as fast as the reference implementation in Java (full
benchmarks forthcoming),
and is currently faster highly optimized single linkage implementations in C and C++.
`version 0.3 performance can be seen in this notebook <http://nbviewer.jupyter.org/github/lmcinnes/hdbscan/blob/master/notebooks/Benchmarking%20scalability%20of%20clustering%20implementations.ipynb>`_ .
Version 0.4 brings a new minimum spanning tree algorithm and dramatic speedups, particularly
for low dimensional data.
Versions 0.4 and 0.5 bring a new minimum spanning tree algorithm, and further
optimizations that provide dramatic speedups, particularly for low dimensional data.

------------------------
Additional functionality
Expand Down Expand Up @@ -105,6 +106,15 @@ Fast install, presuming you have sklearn and all its requirements installed:
pip install hdbscan
If pip is having difficulties pulling the dependencies then we'd suggest installing
the dependencies manually using anaconda followed by pulling hdscan from pip:

.. code:: bash
conda install cython
conda install sklearn
pip install hdbscan
For a manual install get this package:

.. code:: bash
Expand Down
3 changes: 3 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
cython>=0.22
numpy>=1.9
scipy >= 0.9
scikit-learn>=0.16

2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ def readme():

configuration = {
'name' : 'hdbscan',
'version' : '0.4.2',
'version' : '0.5',
'description' : 'Clustering based on density with variable density clusters',
'long_description' : readme(),
'classifiers' : [
Expand Down

2 comments on commit d44782e

@h-krishna
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi,
Does the dependency to scikit-learn means it also requires numpy with MKL libraries?
Thanks
Hari

@lmcinnes
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ordinary numpy should be fine. Obviously the MKL compiled version may offer some performance improvements, but I have not done any benchmarking so I can't comment on that.

Please sign in to comment.