modify docstring

pytorch · Apr 3, 2024 · 51676eb · 51676eb
1 parent 61669ee
commit 51676eb
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/ignite/metrics/mutual_information.py b/ignite/metrics/mutual_information.py
@@ -11,9 +11,11 @@
 
 class MutualInformation(Metric):
     r"""Calculates the `mutual information <https://en.wikipedia.org/wiki/Mutual_information>`_
-        between input :math:`X` and prediction :math:`Y`.
+    between input :math:`X` and prediction :math:`Y`.
 
-    .. math:: I(X;Y) = H(Y) - H(Y|X)
+    .. math::
+
+       I(X;Y) = H(Y) - H(Y|X)
        = H \left( \frac{1}{N}\sum_{i=1}^N \hat{\mathbf{p}}_i \right)
        - \frac{1}{N}\sum_{i=1}^N H(\hat{\mathbf{p}}_i),