Commit 0dccab5d authored by Julian Ruestig's avatar Julian Ruestig 📡
Browse files

Documentation on model.py

parent 95215f88
......@@ -24,6 +24,24 @@ from ..utilities import NiftyMetaBase
class Model(NiftyMetaBase()):
"""
The Model object is an implementation of a * which knows:
- position in parameterspace. (Field, MulitField)
- value of according to its modelfunction A. A(position)
- gradient of the modelfunction at the current position.
Parameters
----------
position : Field, MulitField
The input parameter of the model
Notes
-----
An instance of the model class knows its position, value and gradient.
One can 'jump' to a new position, with the help of the 'at' method, whereby
one automatically gets the value and gradient of the model. The 'at' method
creates a new instance of the class.
"""
def __init__(self, position):
self._position = position
......
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