Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
On Thursday, 7th July from 1 to 3 pm there will be a maintenance with a short downtime of GitLab.
Open sidebar
ift
NIFTy
Commits
b7cf87b6
Commit
b7cf87b6
authored
Jan 17, 2019
by
Philipp Arras
Browse files
Activate special docs
parent
7f15d17f
Changes
3
Hide whitespace changes
Inline
Side-by-side
docs/source/code.rst
View file @
b7cf87b6
...
...
@@ -379,7 +379,7 @@ Minimization algorithms
All minimization algorithms in NIFTy inherit from the abstract
:class:`~minimizer.Minimizer` class, which presents a minimalistic interface
consisting only of a :meth:`~minimizer.Minimizer.__call__()`
*FIXME*
method taking an
consisting only of a :meth:`~minimizer.Minimizer.__call__()` method taking an
:class:`~energy.Energy` object and optionally a preconditioning operator, and
returning the energy at the discovered minimum and a status code.
...
...
docs/source/conf.py
View file @
b7cf87b6
...
...
@@ -13,6 +13,7 @@ napoleon_use_ivar = True
napoleon_use_admonition_for_notes
=
True
napoleon_use_admonition_for_examples
=
True
napoleon_use_admonition_for_references
=
True
napoleon_include_special_with_doc
=
True
project
=
u
'NIFTy5'
copyright
=
u
'2013-2019, Max-Planck-Society'
...
...
nifty5/minimization/minimizer.py
View file @
b7cf87b6
...
...
@@ -21,7 +21,6 @@ from ..utilities import NiftyMeta
class
Minimizer
(
metaclass
=
NiftyMeta
):
"""A base class used by all minimizers."""
# MR FIXME: the docstring is partially ignored by Sphinx. Why?
def
__call__
(
self
,
energy
,
preconditioner
=
None
):
"""Performs the minimization of the provided Energy functional.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment