Skip to content

Commit b52e564

Browse files
committed
add references
1 parent f9e2593 commit b52e564

File tree

1 file changed

+23
-5
lines changed

1 file changed

+23
-5
lines changed

src/multi_mst/base.py

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ def umap(
212212
output_dens: bool = False,
213213
disconnection_distance: float | None = None,
214214
):
215-
"""Constructs and fits a UMAP model to the kMST graph.
215+
"""Constructs and fits a UMAP model [1]_ to the kMST graph.
216216
217217
Unlike HDBSCAN and HBCC, UMAP does not support infinite data. To ensure
218218
all UMAP's member functions work as expected, the UMAP model is NOT
@@ -403,11 +403,16 @@ def umap(
403403
set of other points. Too many such points will artificially connect
404404
your space.
405405
406-
407406
Returns
408407
-------
409408
umap : UMAP
410409
The fitted UMAP model.
410+
411+
References
412+
----------
413+
.. [1] McInnes, L., Healy, J. and Melville, J., 2018. Umap: Uniform
414+
manifold approximation and projection for dimension reduction. arXiv
415+
preprint arXiv:1802.03426.
411416
"""
412417
check_is_fitted(
413418
self,
@@ -479,7 +484,7 @@ def hdbscan(
479484
cluster_selection_persistence: float = 0.0,
480485
ss_algorithm: Literal["bc", "bc_simple"] = "bc",
481486
):
482-
"""Constructs and fits an HDBSCAN model to the kMST graph.
487+
"""Constructs and fits an HDBSCAN [1]_ model to the kMST graph.
483488
484489
Parameters
485490
----------
@@ -527,6 +532,13 @@ def hdbscan(
527532
-------
528533
clusterer : HDBSCAN
529534
The fitted HDBSCAN model.
535+
536+
References
537+
----------
538+
.. [1] McInnes L., Healy J. 2017. Accelerated Hierarchical Density Based
539+
Clustering. IEEE International Conference on Data Mining Workshops
540+
(ICDMW), pp 33-42.
541+
http://ieeexplore.ieee.org/stamp/stamp.jsp?tp=&arnumber=8215642.
530542
"""
531543
check_is_fitted(
532544
self,
@@ -810,8 +822,8 @@ def branch_detector(
810822
cluster_selection_persistence: float = 0.0,
811823
propagate_labels: bool = False,
812824
):
813-
"""Constructs and fits a metric-aware BranchDetector, ensuring valid
814-
parameter--metric combinations.
825+
"""Constructs and fits a metric-aware BranchDetector [1]_, ensuring
826+
valid parameter--metric combinations.
815827
816828
Parameters
817829
----------
@@ -874,6 +886,12 @@ def branch_detector(
874886
-------
875887
clusterer : BranchDetector
876888
A fitted BranchDetector.
889+
890+
References
891+
----------
892+
.. [1] Bot D.M., Peeters J., Liesenborgs J., Aerts J. 2025. FLASC: a
893+
flare-sensitive clustering algorithm. PeerJ Computer Science 11:e2792
894+
https://doi.org/10.7717/peerj-cs.2792.
877895
"""
878896

879897
return BranchDetector(

0 commit comments

Comments
 (0)