Package PyDSTool :: Package Toolbox :: Package optimizers :: Package criterion
[hide private]
[frames] | no frames]

Package criterion

source code

Module containing every criteria for converge test

Functions :

Criteria :

Composite criteria :

Information criteria :

Submodules [hide private]

Classes [hide private]
  RelativeValueCriterion
The relative criterion stops the optimization when the relative error of the value is below a certain level (ftol)
  GradientCriterion
The gradient criterion stops the optimization when the gradient at the current point is less that a given tolerance
  AbsoluteValueCriterion
The absolute criterion stops the optimization when the absolute error of the value is below a certain level (ftol)
  AbsoluteParametersCriterion
The absolute criterion stops the optimization when the relative error of the parameters is below a certain level (xtol)
  RelativeParametersCriterion
The relative criterion stops the optimization when the relative error of the parameters is below a certain level (xtol)
  IterationCriterion
A simple criterion that stops when the iteration limit is reached
  MonotonyCriterion
A simple criterion that stops when the values of the function starts to rise again
  AndComposition
Compose several criteria with an and rule
  OrComposition
Compose several criteria with an or rule
  AICCriterion
The Akaike information criterion
  ModifiedAICCriterion
The Akaike information criterion with several trials authorized
Functions [hide private]
 
criterion(**kwargs)
Creates a composite criterion based on the formal parameters :
source code
Variables [hide private]
  criterion__all__ = ['IterationCriterion', 'MonotonyCriterion',...
Function Details [hide private]

criterion(**kwargs)

source code 

Creates a composite criterion based on the formal parameters :

  • iterations_max indicates the maximum number of iteration
  • ftol is the maximum relative change of the value function
  • xtol is the maximum relative change of the parameters
  • gtol is the maximum gradient

Variables Details [hide private]

criterion__all__

Value:
['IterationCriterion',
 'MonotonyCriterion',
 'RelativeValueCriterion',
 'AbsoluteValueCriterion',
 'RelativeParametersCriterion',
 'AbsoluteParametersCriterion',
 'GradientCriterion',
 'OrComposition',
...