Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
N
NIFTy
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Monitor
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
ift
NIFTy
Commits
b7cf87b6
Commit
b7cf87b6
authored
6 years ago
by
Philipp Arras
Browse files
Options
Downloads
Patches
Plain Diff
Activate special docs
parent
7f15d17f
No related branches found
No related tags found
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
docs/source/code.rst
+1
-1
1 addition, 1 deletion
docs/source/code.rst
docs/source/conf.py
+1
-0
1 addition, 0 deletions
docs/source/conf.py
nifty5/minimization/minimizer.py
+0
-1
0 additions, 1 deletion
nifty5/minimization/minimizer.py
with
2 additions
and
2 deletions
docs/source/code.rst
+
1
−
1
View file @
b7cf87b6
...
@@ -379,7 +379,7 @@ Minimization algorithms
...
@@ -379,7 +379,7 @@ Minimization algorithms
All minimization algorithms in NIFTy inherit from the abstract
All minimization algorithms in NIFTy inherit from the abstract
:class:`~minimizer.Minimizer` class, which presents a minimalistic interface
: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
:class:`~energy.Energy` object and optionally a preconditioning operator, and
returning the energy at the discovered minimum and a status code.
returning the energy at the discovered minimum and a status code.
...
...
This diff is collapsed.
Click to expand it.
docs/source/conf.py
+
1
−
0
View file @
b7cf87b6
...
@@ -13,6 +13,7 @@ napoleon_use_ivar = True
...
@@ -13,6 +13,7 @@ napoleon_use_ivar = True
napoleon_use_admonition_for_notes
=
True
napoleon_use_admonition_for_notes
=
True
napoleon_use_admonition_for_examples
=
True
napoleon_use_admonition_for_examples
=
True
napoleon_use_admonition_for_references
=
True
napoleon_use_admonition_for_references
=
True
napoleon_include_special_with_doc
=
True
project
=
u
'
NIFTy5
'
project
=
u
'
NIFTy5
'
copyright
=
u
'
2013-2019, Max-Planck-Society
'
copyright
=
u
'
2013-2019, Max-Planck-Society
'
...
...
This diff is collapsed.
Click to expand it.
nifty5/minimization/minimizer.py
+
0
−
1
View file @
b7cf87b6
...
@@ -21,7 +21,6 @@ from ..utilities import NiftyMeta
...
@@ -21,7 +21,6 @@ from ..utilities import NiftyMeta
class
Minimizer
(
metaclass
=
NiftyMeta
):
class
Minimizer
(
metaclass
=
NiftyMeta
):
"""
A base class used by all minimizers.
"""
"""
A base class used by all minimizers.
"""
# MR FIXME: the docstring is partially ignored by Sphinx. Why?
def
__call__
(
self
,
energy
,
preconditioner
=
None
):
def
__call__
(
self
,
energy
,
preconditioner
=
None
):
"""
Performs the minimization of the provided Energy functional.
"""
Performs the minimization of the provided Energy functional.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment