UpdateEvery

class UpdateEvery(forecaster, update_interval=None)[source]

Update only periodically when update is called.

If update is called, behaves like update_params=False, unless update_interval time has elapsed since the last “true” update, i.e., call to forecaster.update with update_params=False.

update_interval controls the minimum time that needs to elapse.

Caution: default value of update_interval means no updates after fit.

Parameters:

update_intervaldifference of sktime time indices (int or timedelta), optional

interval that needs to elapse until inner update call with update_params=True default = None = infinity, i.e., never updates

if index of y seen in fit is integer or y is index-free container type, refit_interval must be int, and is interpreted as difference of int location
if index of y seen in fit is timestamp, must be int or pd.Timedelta
- if pd.Timedelta, will be interpreted as time since last refit elapsed
- if int, will be interpreted as number of time stamps seen since last refit

Attributes:

cutoff: Cut-off = “present time” state of forecaster.
fh: Forecasting horizon that was passed.
is_fitted: Whether fit has been called.
state: State of the estimator.

Examples

>>> from sktime.forecasting.trend import TrendForecaster
>>> from sktime.forecasting.stream import UpdateEvery
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> y0 = y.iloc[:-20]
>>> y1 = y.iloc[-20:-10]
>>> y2 = y.iloc[-10:]
>>> inner_forecaster = TrendForecaster()
>>> forecaster = UpdateEvery(inner_forecaster, update_interval=12)
>>> forecaster.fit(y0, fh=[1,2,3])
UpdateEvery(...)
>>> # predict etc could be called here
>>> # e.g., forecaster.predict()
>>>
>>> # first update, 10 < update_interval = 12, so calls update with
>>> # update_params=False
>>> forecaster.update(y1)
UpdateEvery(...)
>>> # second update, 20 >= update_interval = 12, so calls update with
>>> # update_params=True
>>> forecaster.update(y2)
UpdateEvery(...)

Methods

`check_is_fitted`([method_name])	Check if the estimator has been fitted.
`clone`()	Obtain a clone of the object with same hyper-parameters and config.
`clone_tags`(estimator[, tag_names])	Clone tags from another object as dynamic override.
`create_test_instance`([parameter_set])	Construct an instance of the class, using first test parameter set.
`create_test_instances_and_names`([parameter_set])	Create list of all test instances and a list of names for them.
`fit`(y[, X, fh])	Fit forecaster to training data.
`fit_predict`(y[, X, fh, X_pred])	Fit and forecast time series at future horizon.
`get_class_tag`(tag_name[, tag_value_default])	Get class tag value from class, with tag level inheritance from parents.
`get_class_tags`()	Get class tags from class, with tag level inheritance from parent classes.
`get_config`()	Get config flags for self.
`get_fitted_params`([deep])	Get fitted parameters.
`get_param_defaults`()	Get object's parameter defaults.
`get_param_names`([sort])	Get object's parameter names.
`get_params`([deep])	Get a dict of parameters values for this object.
`get_pretrained_params`([deep])	Get pretrained parameters of this estimator.
`get_tag`(tag_name[, tag_value_default, ...])	Get tag value from instance, with tag level inheritance and overrides.
`get_tags`()	Get tags from instance, with tag level inheritance and overrides.
`get_test_params`()	Return testing parameter settings for the estimator.
`is_composite`()	Check if the object is composed of other BaseObjects.
`load_from_path`(serial)	Load object from file location.
`load_from_serial`(serial)	Load object from serialized memory container.
`predict`([fh, X])	Forecast time series at future horizon.
`predict_interval`([fh, X, coverage])	Compute/return prediction interval forecasts.
`predict_proba`([fh, X, marginal])	Compute/return fully probabilistic forecasts.
`predict_quantiles`([fh, X, alpha])	Compute/return quantile forecasts.
`predict_residuals`([y, X])	Return residuals of time series forecasts.
`predict_var`([fh, X, cov])	Compute/return variance forecasts.
`pretrain`(y[, X, fh])	Pre-train forecaster on panel (global) data.
`reset`()	Reset the object to a clean post-init state.
`save`([path, serialization_format])	Save serialized self to bytes-like object or to (.zip) file.
`score`(y[, X, fh])	Scores forecast against ground truth, using MAPE (non-symmetric).
`set_config`(**config_dict)	Set config flags to given values.
`set_params`(**params)	Set the parameters of this object.
`set_random_state`([random_state, deep, ...])	Set random_state pseudo-random seed parameters for self.
`set_tags`(**tag_dict)	Set instance level tag overrides to given values.
`update`(y[, X, update_params])	Update cutoff value and, optionally, fitted parameters.
`update_predict`(y[, cv, X, update_params, ...])	Make predictions and update model iteratively over the test set.
`update_predict_single`([y, fh, X, update_params])	Update model with new data and make forecasts.