@@ -212,7 +212,7 @@ def umap(
212
212
output_dens : bool = False ,
213
213
disconnection_distance : float | None = None ,
214
214
):
215
- """Constructs and fits a UMAP model to the kMST graph.
215
+ """Constructs and fits a UMAP model [1]_ to the kMST graph.
216
216
217
217
Unlike HDBSCAN and HBCC, UMAP does not support infinite data. To ensure
218
218
all UMAP's member functions work as expected, the UMAP model is NOT
@@ -403,11 +403,16 @@ def umap(
403
403
set of other points. Too many such points will artificially connect
404
404
your space.
405
405
406
-
407
406
Returns
408
407
-------
409
408
umap : UMAP
410
409
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.
411
416
"""
412
417
check_is_fitted (
413
418
self ,
@@ -479,7 +484,7 @@ def hdbscan(
479
484
cluster_selection_persistence : float = 0.0 ,
480
485
ss_algorithm : Literal ["bc" , "bc_simple" ] = "bc" ,
481
486
):
482
- """Constructs and fits an HDBSCAN model to the kMST graph.
487
+ """Constructs and fits an HDBSCAN [1]_ model to the kMST graph.
483
488
484
489
Parameters
485
490
----------
@@ -527,6 +532,13 @@ def hdbscan(
527
532
-------
528
533
clusterer : HDBSCAN
529
534
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.
530
542
"""
531
543
check_is_fitted (
532
544
self ,
@@ -810,8 +822,8 @@ def branch_detector(
810
822
cluster_selection_persistence : float = 0.0 ,
811
823
propagate_labels : bool = False ,
812
824
):
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.
815
827
816
828
Parameters
817
829
----------
@@ -874,6 +886,12 @@ def branch_detector(
874
886
-------
875
887
clusterer : BranchDetector
876
888
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.
877
895
"""
878
896
879
897
return BranchDetector (
0 commit comments