Skip to content

Commit 8919f18

Browse files
committed
Fix up documentation in a few places (and add tree_ attributes).
1 parent b61a4df commit 8919f18

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

hdbscan/hdbscan_.py

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ def hdbscan(X, min_cluster_size=5, min_samples=None, metric='minkowski', p=2,
156156
``metric='precomputed'``.
157157
158158
min_cluster_size : int optional
159-
The minimum number of samples in a groupo for that group to be
159+
The minimum number of samples in a group for that group to be
160160
considered a cluster; groupings smaller than this size will be left
161161
as noise.
162162
@@ -249,7 +249,7 @@ class HDBSCAN(BaseEstimator, ClusterMixin):
249249
Parameters
250250
----------
251251
min_cluster_size : int, optional
252-
The minumum size of clusters; single linkage splits that contain
252+
The minimum size of clusters; single linkage splits that contain
253253
fewer points than this will be considered points "falling out" of a
254254
cluster rather than a cluster splitting into two new clusters.
255255
@@ -271,6 +271,20 @@ class HDBSCAN(BaseEstimator, ClusterMixin):
271271
labels_ : array, shape = [n_samples]
272272
Cluster labels for each point in the dataset given to fit().
273273
Noisy samples are given the label -1.
274+
275+
condensed_tree_ : CondensedTree object
276+
The condensed tree produced by HDBSCAN. The object has methods
277+
for converting to pandas, networkx, and plotting.
278+
279+
single_linkage_tree_ : SingleLinkageTree object
280+
The single linkage tree produced by HDBSCAN. The object has methods
281+
for converting to pandas, networkx, and plotting.
282+
283+
minimum_spanning_tree_ : MinimumSpanningTree object
284+
The minimum spanning tree of the mutual reachability graph generated
285+
by HDBSCAN. Note that for efficiency on large datasets HDBSCAN may
286+
default to an algorithm that doesn't generate the minimum spanning
287+
tree.
274288
275289
References
276290
----------
@@ -328,23 +342,23 @@ def fit_predict(self, X, y=None):
328342
return self.labels_
329343

330344
@property
331-
def condensed_tree(self):
345+
def condensed_tree_(self):
332346
if self._condensed_tree is not None:
333347
return CondensedTree(self._condensed_tree)
334348
else:
335349
warn('No condensed tree was generated; try running fit first.')
336350
return None
337351

338352
@property
339-
def single_linkage_tree(self):
353+
def single_linkage_tree_(self):
340354
if self._condensed_tree is not None:
341355
return SingleLinkageTree(self._single_linkage_tree)
342356
else:
343357
warn('No single linkage tree was generated; try running fit first.')
344358
return None
345359

346360
@property
347-
def minimum_spanning_tree(self):
361+
def minimum_spanning_tree_(self):
348362
if self._min_spanning_tree is not None:
349363
return MinimumSpanningTree(self._min_spanning_tree)
350364
else:

0 commit comments

Comments
 (0)