Skip to content

Commit db58c6f

Browse files
authored
DOC Add links to AgglomerativeClustering examples in docs and the user guide (#28885)
1 parent 171e124 commit db58c6f

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

doc/modules/clustering.rst

+8-1
Original file line numberDiff line numberDiff line change
@@ -702,6 +702,9 @@ Single linkage can also perform well on non-globular data.
702702
* :ref:`sphx_glr_auto_examples_cluster_plot_digits_linkage.py`: exploration of
703703
the different linkage strategies in a real dataset.
704704

705+
* :ref:`sphx_glr_auto_examples_cluster_plot_linkage_comparison.py`: exploration of
706+
the different linkage strategies in toy datasets.
707+
705708

706709
Visualization of cluster hierarchy
707710
----------------------------------
@@ -714,6 +717,10 @@ of the data, though more so in the case of small sample sizes.
714717
:target: ../auto_examples/cluster/plot_agglomerative_dendrogram.html
715718
:scale: 42
716719

720+
.. topic:: Examples:
721+
722+
* :ref:`sphx_glr_auto_examples_cluster_plot_agglomerative_dendrogram.py`
723+
717724

718725
Adding connectivity constraints
719726
-------------------------------
@@ -1042,7 +1049,7 @@ scales by building an alternative representation of the clustering problem.
10421049
.. topic:: Examples:
10431050

10441051
* :ref:`sphx_glr_auto_examples_cluster_plot_hdbscan.py`
1045-
1052+
10461053
Mutual Reachability Graph
10471054
-------------------------
10481055

sklearn/cluster/_agglomerative.py

+6
Original file line numberDiff line numberDiff line change
@@ -846,6 +846,9 @@ class AgglomerativeClustering(ClusterMixin, BaseEstimator):
846846
.. versionadded:: 0.20
847847
Added the 'single' option
848848
849+
For examples comparing different `linkage` criteria, see
850+
:ref:`sphx_glr_auto_examples_cluster_plot_linkage_comparison.py`.
851+
849852
distance_threshold : float, default=None
850853
The linkage distance threshold at or above which clusters will not be
851854
merged. If not ``None``, ``n_clusters`` must be ``None`` and
@@ -860,6 +863,9 @@ class AgglomerativeClustering(ClusterMixin, BaseEstimator):
860863
861864
.. versionadded:: 0.24
862865
866+
For an example of dendrogram visualization, see
867+
:ref:`sphx_glr_auto_examples_cluster_plot_agglomerative_dendrogram.py`.
868+
863869
Attributes
864870
----------
865871
n_clusters_ : int

0 commit comments

Comments
 (0)