pastas.modelstats.Statistics.summary#

pastas.modelstats.Statistics.summary(tmin: pandas.Timestamp | str | None = None, tmax: pandas.Timestamp | str | None = None, stats: list[str] | None = None) → pandas.DataFrame#

Returns a Pandas DataFrame with goodness-of-fit metrics.

Parameters:

  • tmin (pandas.Timestamp or str, optional) – A string or pandas.Timestamp with the start date for the period (E.g. ‘1980-01-01 00:00:00’). Strings are converted to pandas.Timestamp internally.

  • tmax (pandas.Timestamp or str, optional) – A string or pandas.Timestamp with the end date for the period (E.g. ‘2020-01-01 00:00:00’). Strings are converted to pandas.Timestamp internally.

  • stats (list, optional) – list of statistics that need to be calculated. If nothing is provided, all statistics are returned.

Returns:

stats – single-column DataFrame with calculated statistics.

Return type:

Pandas.DataFrame

Examples

>>> ml.stats.summary()

or

>>> ml.stats.summary(stats=["mae", "rmse"])