Package parsimony :: Package functions :: Module properties :: Class StepSize
[hide private]
[frames] | no frames]

Class StepSize

source code

object --+
         |
        StepSize
Known Subclasses:

Nested Classes [hide private]
  __metaclass__
Metaclass for defining Abstract Base Classes (ABCs).
Instance Methods [hide private]
 
step(self, beta, index=0)
The step size to use in descent methods.
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  __abstractmethods__ = frozenset(['step'])
  _abc_cache = <_weakrefset.WeakSet object at 0x30d8910>
  _abc_negative_cache = <_weakrefset.WeakSet object at 0x30d8990>
  _abc_negative_cache_version = 10
  _abc_registry = <_weakrefset.WeakSet object at 0x30d8850>
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

step(self, beta, index=0)

source code 
The step size to use in descent methods.

Parameters
----------
beta : Numpy array. The point at which to determine the step size.

index : Non-negative integer. For multiblock functions, to know which
        variable the step is for.

Decorators:
  • @abc.abstractmethod