diff --git a/ignite/metrics/clustering/calinski_harabasz_score.py b/ignite/metrics/clustering/calinski_harabasz_score.py index 4cd713d7b99..d358fe09fbd 100644 --- a/ignite/metrics/clustering/calinski_harabasz_score.py +++ b/ignite/metrics/clustering/calinski_harabasz_score.py @@ -35,7 +35,7 @@ class CalinskiHarabaszScore(_ClusteringMetricBase): `_. - ``update`` must receive output of the form ``(features, labels)`` - or ``{'features': features, 'labels': labels}``. + or ``{'features': features, 'labels': labels}``. - `features` and `labels` must be of same shape `(B, D)` and `(B,)`. Parameters are inherited from ``EpochMetric.__init__``. @@ -47,6 +47,9 @@ class CalinskiHarabaszScore(_ClusteringMetricBase): you want to compute the metric with respect to one of the outputs. By default, metrics require the output as ``(features, labels)`` or ``{'features': features, 'labels': labels}``. + check_compute_fn: if True, ``compute_fn`` is run on the first batch of data to ensure there are no + issues. If issues exist, user is warned that there might be an issue with the ``compute_fn``. + Default, True. device: specifies which device updates are accumulated on. Setting the metric's device to be the same as your ``update`` arguments ensures the ``update`` method is non-blocking. By default, CPU. diff --git a/ignite/metrics/clustering/davies_bouldin_score.py b/ignite/metrics/clustering/davies_bouldin_score.py index 1a469d6a8d2..f117b69b092 100644 --- a/ignite/metrics/clustering/davies_bouldin_score.py +++ b/ignite/metrics/clustering/davies_bouldin_score.py @@ -35,7 +35,7 @@ class DaviesBouldinScore(_ClusteringMetricBase): `_. - ``update`` must receive output of the form ``(features, labels)`` - or ``{'features': features, 'labels': labels}``. + or ``{'features': features, 'labels': labels}``. - `features` and `labels` must be of same shape `(B, D)` and `(B,)`. Parameters are inherited from ``EpochMetric.__init__``. @@ -47,6 +47,9 @@ class DaviesBouldinScore(_ClusteringMetricBase): you want to compute the metric with respect to one of the outputs. By default, metrics require the output as ``(features, labels)`` or ``{'features': features, 'labels': labels}``. + check_compute_fn: if True, ``compute_fn`` is run on the first batch of data to ensure there are no + issues. If issues exist, user is warned that there might be an issue with the ``compute_fn``. + Default, True. device: specifies which device updates are accumulated on. Setting the metric's device to be the same as your ``update`` arguments ensures the ``update`` method is non-blocking. By default, CPU. diff --git a/ignite/metrics/clustering/silhouette_score.py b/ignite/metrics/clustering/silhouette_score.py index 1ecc120f7e2..2f4e82cd2d1 100644 --- a/ignite/metrics/clustering/silhouette_score.py +++ b/ignite/metrics/clustering/silhouette_score.py @@ -43,7 +43,7 @@ class SilhouetteScore(_ClusteringMetricBase): `_. - ``update`` must receive output of the form ``(features, labels)`` - or ``{'features': features, 'labels': labels}``. + or ``{'features': features, 'labels': labels}``. - `features` and `labels` must be of same shape `(B, D)` and `(B,)`. Parameters are inherited from ``EpochMetric.__init__``. @@ -55,6 +55,9 @@ class SilhouetteScore(_ClusteringMetricBase): you want to compute the metric with respect to one of the outputs. By default, metrics require the output as ``(features, labels)`` or ``{'features': features, 'labels': labels}``. + check_compute_fn: if True, ``compute_fn`` is run on the first batch of data to ensure there are no + issues. If issues exist, user is warned that there might be an issue with the ``compute_fn``. + Default, True. device: specifies which device updates are accumulated on. Setting the metric's device to be the same as your ``update`` arguments ensures the ``update`` method is non-blocking. By default, CPU.