From 51676eb7543f5f2c14b7d311ef8c55b1fe364069 Mon Sep 17 00:00:00 2001 From: Kazuki Adachi Date: Wed, 3 Apr 2024 23:28:32 +0900 Subject: [PATCH] modify docstring --- ignite/metrics/mutual_information.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/ignite/metrics/mutual_information.py b/ignite/metrics/mutual_information.py index 7b2be477d0b..b01c967dce1 100644 --- a/ignite/metrics/mutual_information.py +++ b/ignite/metrics/mutual_information.py @@ -11,9 +11,11 @@ class MutualInformation(Metric): r"""Calculates the `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),