From 7a6052d774ed0a77c76850712a2c81514255fe8c Mon Sep 17 00:00:00 2001
From: Reimar Leike <reimar@mpa-garhcing.mpg.de>
Date: Fri, 6 Mar 2020 12:12:55 +0000
Subject: [PATCH] more documentation
---
nifty6/operators/energy_operators.py | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/nifty6/operators/energy_operators.py b/nifty6/operators/energy_operators.py
index b923823aa..30b6f7c77 100644
--- a/nifty6/operators/energy_operators.py
+++ b/nifty6/operators/energy_operators.py
@@ -98,20 +98,22 @@ class QuadraticFormOperator(EnergyOperator):
class VariableCovarianceGaussianEnergy(EnergyOperator):
- """Computes a negative-log Gaussian with unknown covariance.
+ """Computes the negative log pdf of a Gaussian with unknown covariance.
- Represents up to constants in :math:`s`:
+ The covariance is assumed to be diagonal.
.. math ::
- E(f) = - \\log G(s, D) = 0.5 (s)^\\dagger D^{-1} (s) + 0.5 tr log(D),
+ E(s,D) = - \\log G(s, D) = 0.5 (s)^\\dagger D^{-1} (s) + 0.5 tr log(D),
an information energy for a Gaussian distribution with residual s and
diagonal covariance D.
+ The domain of this energy will be a MultiDomain with two keys,
+ the target will be the scalar domain.
Parameters
----------
domain : Domain, DomainTuple, tuple of Domain
- Operator domain.
+ domain of the residual and domain of the covariance diagonal.
residual : key
Residual key of the Gaussian.
--
GitLab