pastas.model.Model.fit_report#

Model.fit_report(output='basic', warnings=True, warnbounds=None)[source]#

Method that reports on the fit after a model is optimized.

Parameters:
  • output (str, optional) – If any other value than “full” is provided, the parameter correlations will be removed from the output.

  • warnings (bool, optional) – print warnings in case of optimization failure, parameters hitting bounds, or length of responses exceeding calibration period.

  • warnbounds (bool, optional) – Deprecated.

Returns:

report – String with the report.

Return type:

str

Examples

This method is called by the solve method if report=True, but can also be called on its own:

>>> print(ml.fit_report)

Notes

The reported values for the fit use the residuals time series where possible. If interpolation is used this means that the result may slightly differ compared to using ml.simulate() and ml.observations().