Commit 13b3dbba authored by Christoph Lienhard's avatar Christoph Lienhard
Browse files

Model docstring Part 01

the main introduction to the model class is missing
parent 4a362bd3
......@@ -28,18 +28,46 @@ class Model(NiftyMetaBase()):
self._position = position
def at(self, position):
""" Returns a new Model object, initialized at `position`.
Parameters
----------
position : Field or MultiField
Location in parameter space for the new Model object.
Returns
-------
Model
Model object at new position.
"""
raise NotImplementedError
@property
def position(self):
"""
Field or MultiField: selected location in parameter space.
The location in parameter space where value and gradient are
evaluated.
"""
return self._position
@property
def value(self):
"""
Field : value of the model.
The value of the model at given `position`.
"""
return self._value
@property
def gradient(self):
"""
LinearOperator : The derivative of the model at given `position`.
"""
return self._gradient
def __getitem__(self, key):
......
Supports Markdown
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