🔥 Remove the Gen. Jensen-Shannon div.

ENSTA-U2IS-AI · Aug 24, 2023 · 2386247 · 2386247
1 parent e00f34a
commit 2386247
Show file tree

Hide file tree

Showing 4 changed files with 2 additions and 182 deletions.
diff --git a/tests/metrics/test_jensen_shannon_divergence.py b/tests/metrics/test_jensen_shannon_divergence.py
diff --git a/torch_uncertainty/metrics/__init__.py b/torch_uncertainty/metrics/__init__.py
@@ -3,7 +3,6 @@
 from .disagreement import Disagreement
 from .entropy import Entropy
 from .fpr95 import FPR95
-from .jensen_shannon_divergence import JensenShannonDivergence
 from .mutual_information import MutualInformation
 from .nll import GaussianNegativeLogLikelihood, NegativeLogLikelihood
 from .variation_ratio import VariationRatio
diff --git a/torch_uncertainty/metrics/jensen_shannon_divergence.py b/torch_uncertainty/metrics/jensen_shannon_divergence.py
diff --git a/torch_uncertainty/metrics/mutual_information.py b/torch_uncertainty/metrics/mutual_information.py
@@ -36,7 +36,8 @@ class MutualInformation(Metric):
 
     Note:
         A higher mutual information can be interpreted as a higher epistemic
-        uncertainty.
+        uncertainty. The Mutual Information is also computationally equivalent
+        to the Generalized Jensen-Shannon Divergence (GJSD).
 
     Warning:
         Make sure that the probabilities in :attr:`probs` are normalized to sum