Fitting

Functions for fitting

Fit result

class pyddm.fitresult.FitResult(fitting_method, method, loss, value, **kwargs)[source]

An object to describe the result of a model fit.

This keeps track of information related to the fitting procedure. It has the following elements:

  • method: the name of the solver used to solve the model, e.g. “analytical” or “implicit”

  • fitting_method: the name of the algorithm used to minimize the loss function method (e.g. “differential_evolution”)

  • loss: the name of the loss function (e.g. “BIC”)

  • properties: a dictionary containing any additional values saved by the loss function or fitting procedure (e.g. “likelihood” for BIC loss function, or “mess” for a message describing the output).

So, for example, can access FitResult.method to get the name of the numerical algorithm used to solve the equation.

To access the output value of the loss function, use FitResult.value().

value()[source]

Returns the objective function value of the fit.

If there was an error, or if no fit was performed, return inf.

class pyddm.fitresult.FitResultEmpty[source]

A default Fit object before a model has been fit.