Commit 3aaa3a70 authored by Martin Reinecke's avatar Martin Reinecke
Browse files

Merge branch 'IFT_documentation' into 'NIFTy_5'

More fixes to Ift documentation

See merge request ift/nifty-dev!197
parents cce245ad b06067ff
This diff is collapsed.
...@@ -37,7 +37,7 @@ class EnergyOperator(Operator): ...@@ -37,7 +37,7 @@ class EnergyOperator(Operator):
Examples Examples
-------- --------
- Information Hamiltonian, i.e. negative-log-probabilities. - Information Hamiltonian, i.e. negative-log-probabilities.
- Gibbs free energy, i.e. an averaged Hamiltonian, aka Kullbach-Leibler - Gibbs free energy, i.e. an averaged Hamiltonian, aka Kullback-Leibler
divergence. divergence.
""" """
_target = DomainTuple.scalar_domain() _target = DomainTuple.scalar_domain()
...@@ -330,8 +330,8 @@ class AveragedEnergy(EnergyOperator): ...@@ -330,8 +330,8 @@ class AveragedEnergy(EnergyOperator):
Note Note
---- ----
Having symmetrized residual samples, with both v_i and -v_i being Having symmetrized residual samples, with both v_i and -v_i being
present ensures that the distribution mean is exactly represented. present, ensures that the distribution mean is exactly represented.
:class:`AveragedEnergy(h)` approximates :class:`AveragedEnergy(h)` approximates
:math:`\\left< H(f) \\right>_{G(f-m,D)}` if the residuals :math:`\\left< H(f) \\right>_{G(f-m,D)}` if the residuals
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment