Skip to content

ForecastingMetric

Base class that is inherited by the majority of classes in River.

This base class allows us to handle the following tasks in a uniform manner:

  • Getting and setting parameters. - Displaying information. - Cloning.

Methods

clone

Return a fresh estimator with the same parameters.

The clone has the same parameters but has not been updated with any data. This works by looking at the parameters from the class signature. Each parameter is either - recursively cloned if it's a River classes. - deep-copied via copy.deepcopy if not. If the calling object is stochastic (i.e. it accepts a seed parameter) and has not been seeded, then the clone will not be idempotent. Indeed, this method's purpose if simply to return a new instance with the same input parameters.

get

Return the current performance along the horizon.

Returns

typing.List[float]: The current performance.

update

Update the metric at each step along the horizon.

Parameters

  • y_true (List[numbers.Number])
  • y_pred (List[numbers.Number])

Returns

ForecastingMetric: self