Skip to content

Commit 3945b3e

Browse files
authored
Update README as per suggestions from @zhaozhang
1 parent ff72a2b commit 3945b3e

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

README.rst

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,9 @@ giving a distance matrix between samples.
6060
.. code:: python
6161
6262
import hdbscan
63+
from sklearn.datasets import make_blobs
64+
65+
data = make_blobs(1000)
6366
6467
clusterer = hdbscan.HDBSCAN(min_cluster_size=10)
6568
cluster_labels = clusterer.fit_predict(data)
@@ -131,6 +134,9 @@ Example usage:
131134
.. code:: python
132135
133136
import hdbscan
137+
from sklearn.datasets import make_blobs
138+
139+
data = make_blobs(1000)
134140
135141
clusterer = hdbscan.RobustSingleLinkage(cut=0.125, k=7)
136142
cluster_labels = clusterer.fit_predict(data)
@@ -154,7 +160,7 @@ Easiest install, if you have Anaconda (thanks to conda-forge which is awesome!):
154160
155161
conda install -c conda-forge hdbscan
156162
157-
PyPI install, presuming you have sklearn and all its requirements installed:
163+
PyPI install, presuming you have sklearn and all its requirements (numpy and scipy) installed:
158164

159165
.. code:: bash
160166
@@ -166,6 +172,7 @@ the dependencies manually using anaconda followed by pulling hdbscan from pip:
166172
.. code:: bash
167173
168174
conda install cython
175+
conda install numpy scipy
169176
conda install scikit-learn
170177
pip install hdbscan
171178
@@ -188,13 +195,28 @@ or
188195

189196
.. code:: bash
190197
191-
conda install scikit-learn cython
198+
conda install scikit-learn cython
192199
193200
Install the package
194201

195202
.. code:: bash
196203
197204
python setup.py install
205+
206+
----------------
207+
Help and Support
208+
----------------
209+
210+
For simple issues you can consult the `FAQ <https://hdbscan.readthedocs.io/en/latest/faq.html>`_ in the documentation.
211+
If your issue is not suitably resolved there, please check the `issues <https://github.com/scikit-learn-contrib/hdbscan/issues>`_ on github. Finally, if no solution is available there feel free to `open an issue <https://github.com/scikit-learn-contrib/hdbscan/issues/new>`_ ; the authors will attempt to respond in a reasonably timely fashion.
212+
213+
------------
214+
Contributing
215+
------------
216+
217+
We welcome contributions in any form! Assistance with documentation, particularly expanding tutorials,
218+
is always welcome. To contribute please `fork the project <https://github.com/scikit-learn-contrib/hdbscan/issues#fork-destination-box>`_ make your changes and submit a pull request. We will do our best to work through any issues with
219+
you and get your code merged into the main branch.
198220

199221
---------
200222
Licensing

0 commit comments

Comments
 (0)