BaggingForecaster#
- class BaggingForecaster(bootstrap_transformer: BaseTransformer = None, forecaster: BaseForecaster = None, sp: int = 2, random_state: int | RandomState = None)[源]#
通过聚合其自助样本的预测来预测时间序列。
Bagged “Bootstrap Aggregating”(自助聚合)预测是通过预测自助时间序列然后聚合所得预测结果获得的。对于点预测,使用均值函数 [1] 聚合不同的预测结果。预测区间和分位数通过计算预测时域内每个时间点的抽样预测分位数来计算。
Bergmeir 等人 (2016) [2] 表明,平均而言,对 ETS 预测进行 bagging 比直接应用 ETS 能获得更好的预测结果。默认的自助变换器和预测器如 [2] 中所选。
- 参数:
- bootstrap_transformer : sktime 变换器 BaseTransformer 后代实例
(默认 = sktime.transformations.bootstrap.STLBootstrapTransformer) 自助变换器,输入时间序列(标签 scitype:transform-input=Series)并返回自助时间序列的面板数据(标签 scitype:transform-input=Panel),如果未指定,则使用 sktime.transformations.bootstrap.STLBootstrapTransformer。
- forecaster : sktime 预测器,BaseForecaster 后代实例,可选
(默认 = sktime.forecating.ets.AutoETS) 如果未指定,则使用 sktime.forecating.ets.AutoETS。
- sp: int (默认=2)
默认预测器和变换器的季节周期。必须大于或等于 2。如果指定了 bootstrap_transformer 和 forecaster,则忽略此参数。
- random_state: int 或 np.random.RandomState (默认=None)
估计器的随机状态,用于控制随机数生成器。
- 属性:
另请参阅
sktime.transformations.bootstrap.MovingBlockBootstrapTransformer应用移动块自助采样方法创建合成时间序列面板的变换器。
sktime.transformations.bootstrap.STLBootstrapTransformer利用 BoxCox、STL 和移动块自助采样创建相似时间序列面板的变换器。
参考文献
[1]Hyndman, R.J., & Athanasopoulos, G. (2021) Forecasting: principles and practice, 第 3 版,OTexts: 澳大利亚墨尔本。OTexts.com/fpp3,第 12.5 章。于 2022 年 2 月 13 日访问。
[2]Bergmeir, C., Hyndman, R. J., & Benítez, J. M. (2016)。使用 STL 分解和 Box-Cox 变换对指数平滑方法进行 Bagging。International Journal of Forecasting, 32(2), 303-312
示例
>>> from sktime.transformations.bootstrap import STLBootstrapTransformer >>> from sktime.forecasting.naive import NaiveForecaster >>> from sktime.forecasting.compose import BaggingForecaster >>> from sktime.datasets import load_airline >>> y = load_airline() >>> forecaster = BaggingForecaster( ... STLBootstrapTransformer(sp=12), NaiveForecaster(sp=12) ... ) >>> forecaster.fit(y) BaggingForecaster(...) >>> y_hat = forecaster.predict([1,2,3])
方法
check_is_fitted([method_name])检查估计器是否已拟合。
clone()获取具有相同超参数和配置的对象的克隆。
clone_tags(estimator[, tag_names])从另一个对象克隆标签作为动态覆盖。
create_test_instance([parameter_set])使用第一个测试参数集构造类的实例。
create_test_instances_and_names([parameter_set])创建所有测试实例及其名称列表。
fit(y[, X, fh])将预测器拟合到训练数据。
fit_predict(y[, X, fh, X_pred])在未来时域拟合和预测时间序列。
get_class_tag(tag_name[, tag_value_default])从类中获取类标签值,并继承父类的标签级别。
从类中获取类标签,并继承父类的标签级别。
获取自身的配置标志。
get_fitted_params([deep])获取拟合参数。
获取对象的默认参数。
get_param_names([sort])获取对象的参数名称。
get_params([deep])获取此对象的参数值字典。
get_tag(tag_name[, tag_value_default, ...])从实例中获取标签值,包含标签级别继承和覆盖。
get_tags()从实例中获取标签,包含标签级别继承和覆盖。
返回估计器的测试参数设置。
检查对象是否由其他 BaseObject 组成。
load_from_path(serial)从文件位置加载对象。
load_from_serial(serial)从序列化的内存容器加载对象。
predict([fh, X])在未来时域预测时间序列。
predict_interval([fh, X, coverage])计算/返回预测区间预测。
predict_proba([fh, X, marginal])计算/返回完全概率预测。
predict_quantiles([fh, X, alpha])计算/返回分位数预测。
predict_residuals([y, X])返回时间序列预测的残差。
predict_var([fh, X, cov])计算/返回方差预测。
reset()将对象重置为干净的初始化后状态。
save([path, serialization_format])将序列化的自身保存到字节对象或 (.zip) 文件。
score(y[, X, fh])使用 MAPE(非对称)对预测结果与真实值进行评分。
set_config(**config_dict)将配置标志设置为给定值。
set_params(**params)设置此对象的参数。
set_random_state([random_state, deep, ...])设置自身的 random_state 伪随机种子参数。
set_tags(**tag_dict)将实例级标签覆盖设置为给定值。
update(y[, X, update_params])更新截止点值,并可选地更新拟合参数。
update_predict(y[, cv, X, update_params, ...])在测试集上迭代进行预测和模型更新。
update_predict_single([y, fh, X, update_params])使用新数据更新模型并进行预测。
- classmethod get_test_params()[源]#
返回估计器的测试参数设置。
- 返回:
- params : dict 或 dict 列表,默认 = {}
用于创建类测试实例的参数。每个 dict 都是构造一个“有趣”测试实例的参数,即
MyClass(**params)或MyClass(**params[i])创建一个有效的测试实例。create_test_instance使用params中的第一个(或唯一一个)字典。
- check_is_fitted(method_name=None)[源]#
检查估计器是否已拟合。
检查
_is_fitted属性是否存在且为True。在调用对象的fit方法时,应将is_fitted属性设置为True。如果不是,则抛出
NotFittedError。- 参数:
- method_name : str,可选
调用此方法的函数名称。如果提供,错误消息将包含此信息。
- 抛出:
- NotFittedError
如果估计器尚未拟合。
- clone()[源]#
获取具有相同超参数和配置的对象的克隆。
克隆是一个没有共享引用、处于初始化后状态的不同对象。此函数等同于返回
self的sklearn.clone。等同于构造一个
type(self)的新实例,参数与self相同,即type(self)(**self.get_params(deep=False))。如果在
self上设置了配置,克隆也将具有与原始对象相同的配置,等同于调用cloned_self.set_config(**self.get_config())。在值上也等同于调用
self.reset,但不同之处在于clone返回一个新对象,而不是像reset那样修改self。- 抛出:
- 如果由于错误的
__init__导致克隆不符合要求,则抛出 RuntimeError。
- 如果由于错误的
- clone_tags(estimator, tag_names=None)[源]#
从另一个对象克隆标签作为动态覆盖。
每个
scikit-base兼容对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。标签是特定于实例
self的键值对,它们是静态标志,在对象构造后不会改变。clone_tags从另一个对象estimator设置动态标签覆盖。clone_tags方法应仅在对象的__init__方法中调用,在构造过程中,或通过__init__构造后立即调用。动态标签被设置为
estimator中标签的值,其名称在tag_names中指定。tag_names的默认设置是将estimator中的所有标签写入self。当前标签值可以通过
get_tags或get_tag进行检查。- 参数:
- estimator : BaseObject 或派生类的实例。
- tag_names : str 或 str 列表,默认 = None
要克隆的标签名称。默认值(
None)克隆estimator中的所有标签。
- 返回:
- self
对
self的引用。
- classmethod create_test_instance(parameter_set='default')[源]#
使用第一个测试参数集构造类的实例。
- 参数:
- parameter_set : str,默认=”default”
要返回的测试参数集的名称,用于测试。如果某个值未定义特殊参数,则返回 “default” 集。
- 返回:
- instance : 类的实例,带有默认参数。
- classmethod create_test_instances_and_names(parameter_set='default')[源]#
创建所有测试实例及其名称列表。
- 参数:
- parameter_set : str,默认=”default”
要返回的测试参数集的名称,用于测试。如果某个值未定义特殊参数,则返回 “default” 集。
- 返回:
- objs : cls 实例列表
第 i 个实例是
cls(**cls.get_test_params()[i])。- names : str 列表,长度与 objs 相同
第 i 个元素是测试中 objs 中第 i 个实例的名称。如果实例多于一个,命名约定为
{cls.__name__}-{i},否则为{cls.__name__}。
- property cutoff[源]#
截止点 = 预测器的“当前时间”状态。
- 返回:
- cutoff : pandas 兼容的索引元素,或 None
pandas 兼容的索引元素,如果已设置截止点;否则为 None。
- fit(y, X=None, fh=None)[源]#
将预测器拟合到训练数据。
- 状态改变
将状态更改为“已拟合”。
写入自身
设置以“_”结尾的拟合模型属性,拟合属性可以通过
get_fitted_params查看。将
self.is_fitted标志设置为True。将
self.cutoff设置为y中看到的最后一个索引。如果传递了
fh,则将fh存储到self.fh。
- 参数:
- y :
sktime兼容数据容器格式的时间序列。 用于拟合预测器的时间序列。
sktime中的单个数据格式是所谓的 mtype 规范,每个 mtype 实现一个抽象的 scitype。Seriesscitype = 单个时间序列,香草预测。pd.DataFrame、pd.Series或np.ndarray(1D 或 2D)。Panelscitype = 时间序列集合,全局/面板预测。具有 2 级行MultiIndex(instance, time)的pd.DataFrame,3D np.ndarray(instance, variable, time),list类型的Series格式pd.DataFrame。Hierarchicalscitype = 分层集合,用于分层预测。具有 3 级或更多级行MultiIndex(hierarchy_1, ..., hierarchy_n, time)的pd.DataFrame。
有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅预测教程
examples/01_forecasting.ipynb。- fh : int, list, pd.Index 可强制转换,或
ForecastingHorizon,默认=None 编码要预测的时间戳的预测时域。如果
self.get_tag("requires-fh-in-fit")为True,则必须在fit中传递,不可选。- X :
sktime兼容格式的时间序列,可选(默认=None)。 用于拟合模型的外生时间序列。应与
y具有相同的 scitype(Series、Panel或Hierarchical)。如果self.get_tag("X-y-must-have-same-index")为 True,则X.index必须包含y.index。
- y :
- 返回:
- self : 对自身的引用。
- fit_predict(y, X=None, fh=None, X_pred=None)[源]#
在未来时域拟合和预测时间序列。
与
fit(y, X, fh).predict(X_pred)相同。如果未传递X_pred,则与fit(y, fh, X).predict(X)相同。- 状态改变
将状态更改为“已拟合”。
写入自身
设置以“_”结尾的拟合模型属性,拟合属性可以通过
get_fitted_params查看。将
self.is_fitted标志设置为True。将
self.cutoff设置为y中看到的最后一个索引。将
fh存储到self.fh。
- 参数:
- y : sktime 兼容数据容器格式的时间序列。
用于拟合预测器的时间序列。
sktime中的单个数据格式是所谓的 mtype 规范,每个 mtype 实现一个抽象的 scitype。Seriesscitype = 单个时间序列,香草预测。pd.DataFrame、pd.Series或np.ndarray(1D 或 2D)。Panelscitype = 时间序列集合,全局/面板预测。具有 2 级行MultiIndex(instance, time)的pd.DataFrame,3D np.ndarray(instance, variable, time),list类型的Series格式pd.DataFrame。Hierarchicalscitype = 分层集合,用于分层预测。具有 3 级或更多级行MultiIndex(hierarchy_1, ..., hierarchy_n, time)的pd.DataFrame。
有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅预测教程
examples/01_forecasting.ipynb。- fh : int, list, pd.Index 可强制转换,或
ForecastingHorizon(非可选) 编码要预测的时间戳的预测时域。
如果 fh 不是 None 且不是 ForecastingHorizon 类型,则通过调用 _check_fh 强制转换为 ForecastingHorizon。特别是,如果 fh 是 pd.Index 类型,则通过 ForecastingHorizon(fh, is_relative=False) 进行强制转换。
- X :
sktime兼容格式的时间序列,可选(默认=None)。 用于拟合模型的外生时间序列。应与
y具有相同的 scitype(Series、Panel或Hierarchical)。如果self.get_tag("X-y-must-have-same-index")为 True,则X.index必须包含y.index。- X_pred : sktime 兼容格式的时间序列,可选(默认=None)。
用于预测的外生时间序列。如果传递,将在预测中代替 X 使用。应与
fit中的y具有相同的 scitype(Series、Panel或Hierarchical)。如果self.get_tag("X-y-must-have-same-index")为 True,则X.index必须包含fh索引引用。
- 返回:
- y_pred : sktime 兼容数据容器格式的时间序列。
在
fh处的点预测,索引与fh相同。y_pred的类型与最近传递的y类型相同:Series、Panel或Hierarchicalscitype,格式相同(参见上文)。
- classmethod get_class_tag(tag_name, tag_value_default=None)[源]#
从类中获取类标签值,并继承父类的标签级别。
每个
scikit-base兼容对象都有一个标签字典,用于存储关于对象的元数据。get_class_tag方法是类方法,它只考虑类级别的标签值和覆盖来检索标签的值。它从对象中返回名称为
tag_name的标签值,按以下优先级降序考虑标签覆盖:在类的
_tags属性中设置的标签。在父类的
_tags属性中设置的标签,
按继承顺序。
不考虑通过
set_tags或clone_tags在实例上设置的动态标签覆盖。要检索带有潜在实例覆盖的标签值,请改用
get_tag方法。- 参数:
- tag_name : str
标签值的名称。
- tag_value_default : 任意类型
回调值,如果未找到标签。
- 返回:
- tag_value
self中tag_name标签的值。如果未找到,则返回tag_value_default。
- classmethod get_class_tags()[源]#
从类中获取类标签,并继承父类的标签级别。
每个
scikit-base兼容对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。标签是特定于实例
self的键值对,它们是静态标志,在对象构造后不会改变。get_class_tags方法是类方法,它只考虑类级别的标签值和覆盖来检索标签的值。它返回一个字典,其键是类或其任何父类中设置的
_tags属性的任何键。值是相应的标签值,覆盖按以下优先级降序排列:
在类的
_tags属性中设置的标签。在父类的
_tags属性中设置的标签,
按继承顺序。
实例可以根据超参数覆盖这些标签。
要检索带有潜在实例覆盖的标签,请改用
get_tags方法。不考虑通过
set_tags或clone_tags在实例上设置的动态标签覆盖。要包含动态标签的覆盖,请使用
get_tags。- collected_tags : dict
标签名称: 标签值对的字典。通过嵌套继承从
_tags类属性收集。不会被通过set_tags或clone_tags设置的动态标签覆盖。
- get_config()[源]#
获取自身的配置标志。
配置是
self的键值对,通常用作控制行为的瞬时标志。get_config返回动态配置,它会覆盖默认配置。默认配置在类或其父类的类属性
_config中设置,并通过set_config设置的动态配置覆盖它们。在
clone或reset调用下保留配置。- 返回:
- config_dict : dict
配置名称: 配置值对的字典。通过嵌套继承从 _config 类属性收集,然后包含来自 _onfig_dynamic 对象属性的任何覆盖和新标签。
- get_fitted_params(deep=True)[源]#
获取拟合参数。
- 状态要求
要求状态为“已拟合”。
- 参数:
- deep : bool,默认=True
是否返回组件的拟合参数。
如果为 True,则返回此对象的参数名称: 值字典,包括可拟合组件(= BaseEstimator 值参数)的拟合参数。
如果为 False,则返回此对象的参数名称: 值字典,但不包括组件的拟合参数。
- 返回:
- fitted_params : 键为 str 的字典
拟合参数字典, paramname : paramvalue 键值对包括:
总是:此对象的所有拟合参数,如通过
get_param_names获取的那样,值为该键的拟合参数值,属于此对象。如果
deep=True,还包含组件参数的键/值对,组件的参数索引为[componentname]__[paramname],componentname的所有参数都以paramname及其值的形式出现。如果
deep=True,还包含任意级别的组件递归,例如[componentname]__[componentcomponentname]__[paramname]等。
- classmethod get_param_defaults()[源]#
获取对象的默认参数。
- 返回:
- default_dict: dict[str, Any]
键是
cls中在__init__中定义了默认值的所有参数。值是在__init__中定义的默认值。
- classmethod get_param_names(sort=True)[源]#
获取对象的参数名称。
- 参数:
- sort : bool,默认=True
是否按字母顺序(True)或按它们在类
__init__中出现的顺序(False)返回参数名称。
- 返回:
- param_names: list[str]
cls的参数名称列表。如果sort=False,则按它们在类__init__中出现的顺序排列。如果sort=True,则按字母顺序排列。
- get_params(deep=True)[源]#
获取此对象的参数值字典。
- 参数:
- deep : bool,默认=True
是否返回组件的参数。
如果为
True,则返回此对象的参数名称: 值dict,包括组件(=BaseObject值参数)的参数。如果为
False,则返回此对象的参数名称: 值dict,但不包括组件的参数。
- 返回:
- params : 键为 str 的 dict
参数字典, paramname : paramvalue 键值对包括:
总是:此对象的所有参数,如通过
get_param_names获取的那样,值为该键的参数值,属于此对象。值总是与构造时传递的值相同。如果
deep=True,还包含组件参数的键/值对,组件的参数索引为[componentname]__[paramname],componentname的所有参数都以paramname及其值的形式出现。如果
deep=True,还包含任意级别的组件递归,例如[componentname]__[componentcomponentname]__[paramname]等。
- get_tag(tag_name, tag_value_default=None, raise_error=True)[源]#
从实例中获取标签值,包含标签级别继承和覆盖。
每个
scikit-base兼容对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。标签是特定于实例
self的键值对,它们是静态标志,在对象构造后不会改变。get_tag方法从实例中检索名称为tag_name的单个标签的值,按以下优先级降序考虑标签覆盖:通过
set_tags或clone_tags在实例上设置的标签,
在实例构造时。
在类的
_tags属性中设置的标签。在父类的
_tags属性中设置的标签,
按继承顺序。
- 参数:
- tag_name : str
要检索的标签名称。
- tag_value_default : 任意类型,可选;默认=None
如果未找到标签的默认/回调值。
- raise_error : bool
未找到标签时是否抛出
ValueError。
- 返回:
- tag_value : Any
self中tag_name标签的值。如果未找到,且raise_error为 True,则抛出错误;否则返回tag_value_default。
- 抛出:
- ValueError,如果
raise_error为True。 如果
tag_name不在self.get_tags().keys()中,则抛出ValueError。
- ValueError,如果
- get_tags()[源]#
从实例中获取标签,包含标签级别继承和覆盖。
每个
scikit-base兼容对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。标签是特定于实例
self的键值对,它们是静态标志,在对象构造后不会改变。get_tags方法返回一个标签字典,其键是类或其任何父类中设置的_tags属性的任何键,或通过set_tags或clone_tags设置的标签。值是相应的标签值,覆盖按以下优先级降序排列:
通过
set_tags或clone_tags在实例上设置的标签,
在实例构造时。
在类的
_tags属性中设置的标签。在父类的
_tags属性中设置的标签,
按继承顺序。
- 返回:
- collected_tags : dict
标签名称: 标签值对的字典。通过嵌套继承从
_tags类属性收集,然后包含来自_tags_dynamic对象属性的任何覆盖和新标签。
- is_composite()[源代码]#
检查对象是否由其他 BaseObject 组成。
复合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回:
- composite: bool
一个对象的某些参数值是否为
BaseObject后代实例。
- property is_fitted[源代码]#
`fit` 方法是否已被调用。
检查对象的
_is_fitted` 属性,该属性应在对象构建期间初始化为 ``False,并在调用对象的 fit 方法时设置为 True。- 返回:
- bool
估计器是否已经过 fit。
- classmethod load_from_path(serial)[源代码]#
从文件位置加载对象。
- 参数:
- serialZipFile(path).open(“object) 的结果
- 返回:
- 反序列化后的 self,其输出路径为
path,与cls.save(path)的输出一致
- 反序列化后的 self,其输出路径为
- classmethod load_from_serial(serial)[源代码]#
从序列化的内存容器加载对象。
- 参数:
- serial
cls.save(None)输出的第一个元素
- serial
- 返回:
- 反序列化后的 self,其输出为
serial,与cls.save(None)的输出一致
- 反序列化后的 self,其输出为
- predict(fh=None, X=None)[源代码]#
在未来时域预测时间序列。
- 状态要求
要求状态为“已拟合”,即
self.is_fitted=True。
访问 self 中的属性:
以“_”结尾的已拟合模型属性。
self.cutoff,self.is_fitted
- 写入自身
如果传入了
fh且之前未传入,则将fh存储到self.fh。
- 参数:
- fh : int, list, pd.Index 可强制转换,或
ForecastingHorizon,默认=None 预测未来的时间戳所构成的预测期。如果在
fit中已传入,则不应再次传入。如果在 fit 中未传入,则必须传入,而非可选参数。如果 fh 不是 None 且不是 ForecastingHorizon 类型,则通过调用 _check_fh 强制转换为 ForecastingHorizon。特别是,如果 fh 是 pd.Index 类型,则通过 ForecastingHorizon(fh, is_relative=False) 进行强制转换。
- X
sktime兼容格式的时间序列,可选 (默认值=None) 用于预测的外生时间序列。应与
fit中y的 scitype(Series、Panel或Hierarchical)相同。如果self.get_tag("X-y-must-have-same-index")为 True,则X.index必须包含fh的索引引用。
- fh : int, list, pd.Index 可强制转换,或
- 返回:
- y_pred : sktime 兼容数据容器格式的时间序列。
在
fh处的点预测,索引与fh相同。y_pred的类型与最近传递的y类型相同:Series、Panel或Hierarchicalscitype,格式相同(参见上文)。
- predict_interval(fh=None, X=None, coverage=0.9)[源代码]#
计算/返回预测区间预测。
如果
coverage是可迭代的,将计算多个区间。- 状态要求
要求状态为“已拟合”,即
self.is_fitted=True。
访问 self 中的属性:
以“_”结尾的已拟合模型属性。
self.cutoff,self.is_fitted
- 写入自身
如果传入了
fh且之前未传入,则将fh存储到self.fh。
- 参数:
- fh : int, list, pd.Index 可强制转换,或
ForecastingHorizon,默认=None 预测未来的时间戳所构成的预测期。如果在
fit中已传入,则不应再次传入。如果在 fit 中未传入,则必须传入,而非可选参数。如果
fh不为 None 且类型不是ForecastingHorizon,则内部会将其强制转换为ForecastingHorizon(通过_check_fh)。如果
fh是int或类似数组的int,则解释为相对预测期,并强制转换为相对的ForecastingHorizon(fh, is_relative=True)。如果
fh类型为pd.Index,则解释为绝对预测期,并强制转换为绝对的ForecastingHorizon(fh, is_relative=False)。
- X
sktime兼容格式的时间序列,可选 (默认值=None) 用于预测的外生时间序列。应与
fit中y的 scitype(Series、Panel或Hierarchical)相同。如果self.get_tag("X-y-must-have-same-index")为 True,则X.index必须包含fh的索引引用。- coverage浮点数或包含唯一值的浮点数列表,可选 (默认值=0.90)
预测区间名义覆盖率
- fh : int, list, pd.Index 可强制转换,或
- 返回:
- pred_intpd.DataFrame
- 列具有多级索引:第一级是 fit 中 y 的变量名,
- 第二级是计算区间的覆盖率分数。
顺序与输入的
coverage一致。
第三级是字符串“lower”或“upper”,表示区间的下限/上限。
- 行索引是 fh,如果 fit 中 y 是 Panel 或 Hierarchical,则还有额外的(上层)级别等于实例级别,
来自 fit 中看到的 y。
- 条目是区间下限/上限的预测值,
对应列索引中的变量、第二列索引中的名义覆盖率、取决于第三列索引的下限/上限,以及行索引。上限/下限区间预测值等效于对 coverage 中的 c 计算 alpha = 0.5 - c/2, 0.5 + c/2 时的分位数预测值。
- predict_proba(fh=None, X=None, marginal=True)[源代码]#
计算/返回完全概率预测。
注意
目前仅对 Series (非 Panel,非 Hierarchical) y 实现。
需要安装
skpro以返回分布对象。
- 状态要求
要求状态为“已拟合”,即
self.is_fitted=True。
访问 self 中的属性:
以“_”结尾的已拟合模型属性。
self.cutoff,self.is_fitted
- 写入自身
如果传入了
fh且之前未传入,则将fh存储到self.fh。
- 参数:
- fh : int, list, pd.Index 可强制转换,或
ForecastingHorizon,默认=None 预测未来的时间戳所构成的预测期。如果在
fit中已传入,则不应再次传入。如果在 fit 中未传入,则必须传入,而非可选参数。如果
fh不为 None 且类型不是ForecastingHorizon,则内部会将其强制转换为ForecastingHorizon(通过_check_fh)。如果
fh是int或类似数组的int,则解释为相对预测期,并强制转换为相对的ForecastingHorizon(fh, is_relative=True)。如果
fh类型为pd.Index,则解释为绝对预测期,并强制转换为绝对的ForecastingHorizon(fh, is_relative=False)。
- X
sktime兼容格式的时间序列,可选 (默认值=None) 用于预测的外生时间序列。应与
fit中y的 scitype(Series、Panel或Hierarchical)相同。如果self.get_tag("X-y-must-have-same-index")为 True,则X.index必须包含fh的索引引用。- marginalbool, 可选 (默认值=True)
返回的分布是否按时间索引进行边际化
- fh : int, list, pd.Index 可强制转换,或
- 返回:
- pred_distskpro BaseDistribution
预测分布,如果 marginal=True,则按时间点为边际分布;如果 marginal=False 且方法已实现,则为联合分布。
- predict_quantiles(fh=None, X=None, alpha=None)[源代码]#
计算/返回分位数预测。
如果
alpha是可迭代的,将计算多个分位数。- 状态要求
要求状态为“已拟合”,即
self.is_fitted=True。
访问 self 中的属性:
以“_”结尾的已拟合模型属性。
self.cutoff,self.is_fitted
- 写入自身
如果传入了
fh且之前未传入,则将fh存储到self.fh。
- 参数:
- fh : int, list, pd.Index 可强制转换,或
ForecastingHorizon,默认=None 预测未来的时间戳所构成的预测期。如果在
fit中已传入,则不应再次传入。如果在 fit 中未传入,则必须传入,而非可选参数。如果
fh不为 None 且类型不是ForecastingHorizon,则内部会将其强制转换为ForecastingHorizon(通过_check_fh)。如果
fh是int或类似数组的int,则解释为相对预测期,并强制转换为相对的ForecastingHorizon(fh, is_relative=True)。如果
fh类型为pd.Index,则解释为绝对预测期,并强制转换为绝对的ForecastingHorizon(fh, is_relative=False)。
- X
sktime兼容格式的时间序列,可选 (默认值=None) 用于预测的外生时间序列。应与
fit中y的 scitype(Series、Panel或Hierarchical)相同。如果self.get_tag("X-y-must-have-same-index")为 True,则X.index必须包含fh的索引引用。- alpha浮点数或包含唯一值的浮点数列表,可选 (默认值=[0.05, 0.95])
计算分位数预测值时的概率或概率列表。
- fh : int, list, pd.Index 可强制转换,或
- 返回:
- quantilespd.DataFrame
- 列具有多级索引:第一级是 fit 中 y 的变量名,
第二级是传递给函数的 alpha 值。
- 行索引是 fh,如果 fit 中 y 是 Panel 或 Hierarchical,则还有额外的(上层)级别等于实例级别,
来自 fit 中看到的 y。
- 条目是分位数预测值,对应列索引中的变量,
第二列索引中的分位数概率,以及行索引。
- predict_residuals(y=None, X=None)[源代码]#
返回时间序列预测的残差。
将在 y.index 处计算预测值的残差。
如果在 fit 中必须传入 fh,则必须与 y.index 一致。如果 y 是 np.ndarray,且在 fit 中未传入 fh,则残差将在 fh 为 range(len(y.shape[0])) 时计算。
- 状态要求
要求状态为“已拟合”。如果已设置 fh,则必须对应于 y 的索引 (pandas 或整数)。
- 访问 self 中的属性:
以“_”结尾的已拟合模型属性。self.cutoff, self._is_fitted
- 写入自身
无。
- 参数:
- y : sktime 兼容数据容器格式的时间序列。
用于计算残差的真实观测时间序列。必须与 predict 的预期返回值的类型、维度和索引相同。
如果为 None,则使用到目前为止见到的 y (self._y),特别是
如果在单个 fit 调用之后,则产生样本内残差
如果 fit 需要
fh,则它必须指向 fit 中 y 的索引
- Xsktime 兼容格式的时间序列,可选 (默认值=None)
用于更新和预测的外生时间序列。应与
fit中y的 科学类型(Series、Panel或Hierarchical)相同。如果self.get_tag("X-y-must-have-same-index")为 True,则X.index必须包含fh的索引引用和y.index。
- 返回:
- y_ressktime 兼容数据容器格式的时间序列
在
fh` 处的预测残差,具有与 ``fh相同的索引。y_res的类型与最近传入的y类型相同:Series、Panel、Hierarchical 科学类型,格式相同(见上文)。
- predict_var(fh=None, X=None, cov=False)[源代码]#
计算/返回方差预测。
- 状态要求
要求状态为“已拟合”,即
self.is_fitted=True。
访问 self 中的属性:
以“_”结尾的已拟合模型属性。
self.cutoff,self.is_fitted
- 写入自身
如果传入了
fh且之前未传入,则将fh存储到self.fh。
- 参数:
- fh : int, list, pd.Index 可强制转换,或
ForecastingHorizon,默认=None 预测未来的时间戳所构成的预测期。如果在
fit中已传入,则不应再次传入。如果在 fit 中未传入,则必须传入,而非可选参数。如果
fh不为 None 且类型不是ForecastingHorizon,则内部会将其强制转换为ForecastingHorizon(通过_check_fh)。如果
fh是int或类似数组的int,则解释为相对预测期,并强制转换为相对的ForecastingHorizon(fh, is_relative=True)。如果
fh类型为pd.Index,则解释为绝对预测期,并强制转换为绝对的ForecastingHorizon(fh, is_relative=False)。
- X
sktime兼容格式的时间序列,可选 (默认值=None) 用于预测的外生时间序列。应与
fit中y的 scitype(Series、Panel或Hierarchical)相同。如果self.get_tag("X-y-must-have-same-index")为 True,则X.index必须包含fh的索引引用。- covbool, 可选 (默认值=False)
如果为 True,则计算协方差矩阵预测值。如果为 False,则计算边际方差预测值。
- fh : int, list, pd.Index 可强制转换,或
- 返回:
- pred_varpd.DataFrame,格式取决于
cov变量 - 如果 cov=False
- 列名与
fit/update中传入的y完全相同。 对于无名格式,列索引将是 RangeIndex。
- 行索引是 fh,附加级别等于实例级别,
来自 fit 中看到的 y。
条目是方差预测值,对应列索引中的变量。给定变量和 fh 索引的方差预测值是给定观测数据对该变量和索引的预测方差。
给定观测数据下,该变量和索引的方差。
- 列名与
- 如果 cov=True
- 列索引是多级索引:第一级是变量名(如上)
第二级是 fh。
- 行索引是 fh,附加级别等于实例级别,
来自 fit 中看到的 y。
- 条目是(协)方差预测值,对应列索引中的变量,以及
行和列中时间索引之间的协方差。
注意:不同变量之间不返回协方差预测值。
- pred_varpd.DataFrame,格式取决于
- reset()[源代码]#
将对象重置为干净的初始化后状态。
将
self设置回构造函数调用后直接的状态,并保留相同的超参数。通过set_config设置的配置值也会保留。reset调用会删除所有对象属性,除了超参数 =
__init__的参数并写入self的属性,例如self.paramname,其中paramname是__init__的参数包含双下划线字符串“__”的对象属性。例如,名为“__myattr”的属性会保留。
配置属性,配置不变地保留。也就是说,
reset前后get_config的结果相等。
类方法和对象方法,以及类属性也不受影响。
等效于
clone,不同之处在于reset会改变self而非返回新对象。调用
self.reset()后,self在值和状态上等同于构造函数调用type(self)(**self.get_params(deep=False))后获得的对象。- 返回:
- self
类实例重置为初始构造后的干净状态,但保留当前的超参数值。
- save(path=None, serialization_format='pickle')[源代码]#
将序列化的自身保存到字节对象或 (.zip) 文件。
行为:如果
path为 None,则返回内存中的序列化 self;如果path是文件位置,则将 self 以 zip 文件形式存储在该位置保存的文件是 zip 文件,包含以下内容:_metadata - 包含 self 的类,即 type(self);_obj - 序列化后的 self。此类使用默认的序列化方式 (pickle)。
- 参数:
- pathNone 或文件位置 (str 或 Path)
如果为 None,则 self 保存到内存对象;如果为文件位置,则 self 保存到该文件位置。例如
path=”estimator” 将在当前工作目录创建 zip 文件
estimator.zip。path=”/home/stored/estimator” 将在
/home/stored/创建 zip 文件estimator.zip。
存储在
/home/stored/中。- serialization_format: str, 默认值 = “pickle”
用于序列化的模块。可用选项有 “pickle” 和 “cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
path为 None - 内存中的序列化 self - 如果
path是文件位置 - 引用该文件的 ZipFile
- 如果
- score(y, X=None, fh=None)[源代码]#
使用 MAPE(非对称)对预测结果与真实值进行评分。
- 参数:
- ypd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D)
用于评分的时间序列
- fh : int, list, pd.Index 可强制转换,或
ForecastingHorizon,默认=None 编码要预测的时间戳的预测时域。
- Xpd.DataFrame, 或 2D np.array, 可选 (默认值=None)
用于评分的外生时间序列,如果 self.get_tag(“X-y-must-have-same-index”) 为 True,则 X.index 必须包含 y.index。
- 返回:
- score浮点数
self.predict(fh, X) 相对于 y_test 的 MAPE 损失。
- set_config(**config_dict)[源代码]#
将配置标志设置为给定值。
- 参数:
- config_dict : dict
配置名称 : 配置值的字典对。有效的配置、值及其含义如下所示。
- displaystr, “diagram” (默认值), 或 “text”
jupyter 内核如何显示 self 的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool, 默认值=True
打印 self 时,是否仅列出与默认值不同的自参数 (False),或所有参数名称和值 (False)。不进行嵌套,即仅影响 self 而不影响组件估计器。
- warningsstr, “on” (默认值), 或 “off”
是否发出警告,仅影响来自 sktime 的警告
“on” = 将发出来自 sktime 的警告
“off” = 将不发出来自 sktime 的警告
- backend:parallelstr, 可选, 默认值=”None”
广播/向量化时用于并行化的后端之一
“None”:顺序执行循环,简单列表推导
“loky”、“multiprocessing”和“threading”:使用
joblib.Parallel“joblib”:自定义和第三方
joblib后端,例如spark“dask”:使用
dask,需要在环境中安装dask包“ray”:使用
ray,需要在环境中安装ray包
- backend:parallel:paramsdict, 可选, 默认值={} (不传递参数)
作为配置传递给并行化后端的额外参数。有效的键取决于
backend:parallel的值。“None”:无额外参数,忽略
backend_params“loky”、“multiprocessing”和“threading”:默认的
joblib后端,可以在此处传递joblib.Parallel的任何有效键,例如n_jobs,但backend除外,它由backend直接控制。如果未传递n_jobs,则默认为-1,其他参数将默认为joblib的默认值。“joblib”:自定义和第三方
joblib后端,例如spark。可以在此处传递joblib.Parallel的任何有效键,例如n_jobs,在这种情况下,必须将backend作为backend_params的一个键传递。如果未传递n_jobs,则默认为-1,其他参数将默认为joblib的默认值。“dask”:可以传递
dask.compute的任何有效键,例如scheduler“ray”:可以传递以下键
“ray_remote_args”:
ray.init有效键的字典- “shutdown_ray”:bool,默认值=True;False 会阻止
ray在并行化后关闭。 在并行化之后关闭。
- “shutdown_ray”:bool,默认值=True;False 会阻止
“logger_name”:str,默认值=”ray”;要使用的日志记录器名称。
“mute_warnings”:bool,默认值=False;如果为 True,则抑制警告。
- remember_databool, 默认值=True
是否在 fit 中存储 self._X 和 self._y,并在 update 中更新。如果为 True,则 self._X 和 self._y 被存储和更新。如果为 False,则 self._X 和 self._y 不被存储和更新。这在使用 save 时会减少序列化大小,但 update 将默认为“不执行任何操作”,而不是“重新拟合所有已见数据”。
- 返回:
- self对 self 的引用。
注意
更改对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[源代码]#
设置此对象的参数。
此方法适用于简单的 skbase 对象以及复合对象。对于复合对象(即包含其他对象的对象),可以使用参数键字符串
<component>__<parameter>来访问组件<component>中的<parameter>。如果引用是明确的,也可以使用不带<component>__的字符串<parameter>,例如,没有两个组件的参数名称相同。- 参数:
- **paramsdict
BaseObject 参数,键必须是
<component>__<parameter>字符串。__后缀可以作为完整字符串的别名,如果在 get_params 键中是唯一的。
- 返回:
- self对 self 的引用(设置参数后)
- set_random_state(random_state=None, deep=True, self_policy='copy')[源代码]#
设置自身的 random_state 伪随机种子参数。
通过
self.get_params查找名为random_state的参数,并通过set_params将其设置为从random_state派生的整数。这些整数通过sample_dependent_seed进行链式哈希采样,保证了种子随机生成器的伪随机独立性。取决于
self_policy,仅当deep=True时,才应用于self中的random_state参数以及其余组件对象。注意:即使
self没有random_state参数,或者没有任何组件具有random_state参数,也会调用set_params。因此,set_random_state将重置任何scikit-base对象,即使是没有random_state参数的对象。- 参数:
- random_stateint, RandomState 实例或 None, 默认值=None
伪随机数生成器,用于控制随机整数的生成。传递 int 可在多次函数调用中获得可重现的输出。
- deep : bool,默认=True
是否在值为 skbase 对象的参数中设置随机状态,即组件估计器。
如果为 False,则仅设置
self的random_state参数(如果存在)。如果为 True,则也设置组件对象中的
random_state参数。
- self_policystr, 以下之一: {“copy”, “keep”, “new”}, 默认值=”copy”
“copy”:
self.random_state设置为输入random_state“keep”:保留
self.random_state的当前值“new”:
self.random_state设置为一个新的随机状态,
从输入
random_state派生,通常与输入不同
- 返回:
- self对 self 的引用
- set_tags(**tag_dict)[源代码]#
将实例级标签覆盖设置为给定值。
每个
scikit-base兼容对象都有一个标签字典,用于存储关于对象的元数据。标签是特定于实例
self的键值对,它们是静态标志,在对象构造后不会更改。它们可用于元数据检查或控制对象的行为。set_tags将动态标签覆盖设置为tag_dict中指定的值,其中键是标签名称,字典值是要设置的标签值。set_tags方法应仅在对象的__init__方法中(构造期间)或在__init__后直接调用。当前标签值可以通过
get_tags或get_tag进行检查。- 参数:
- **tag_dictdict
标签名:标签值对的字典。
- 返回:
- Self
对 self 的引用。
- update(y, X=None, update_params=True)[源代码]#
更新截止点值,并可选地更新拟合参数。
如果尚未实现特定于估计器的 update 方法,则默认回退如下:
update_params=True:拟合到目前为止所有观测到的数据update_params=False:仅更新截止点并记住数据
- 状态要求
要求状态为“已拟合”,即
self.is_fitted=True。
访问 self 中的属性:
以“_”结尾的已拟合模型属性。
self.cutoff,self.is_fitted
写入自身
将
self.cutoff更新为y中看到的最新索引。如果
update_params=True,则更新以“_”结尾的已拟合模型属性。
- 参数:
- y :
sktime兼容数据容器格式的时间序列。 用于更新预测器的时间序列。
sktime中的单个数据格式是所谓的 mtype 规范,每个 mtype 实现一个抽象的 scitype。Seriesscitype = 单个时间序列,香草预测。pd.DataFrame、pd.Series或np.ndarray(1D 或 2D)。Panelscitype = 时间序列集合,全局/面板预测。具有 2 级行MultiIndex(instance, time)的pd.DataFrame,3D np.ndarray(instance, variable, time),list类型的Series格式pd.DataFrame。Hierarchicalscitype = 分层集合,用于分层预测。具有 3 级或更多级行MultiIndex(hierarchy_1, ..., hierarchy_n, time)的pd.DataFrame。
有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅预测教程
examples/01_forecasting.ipynb。- X :
sktime兼容格式的时间序列,可选(默认=None)。 用于更新模型拟合的外生时间序列。应与
y的 科学类型(Series、Panel或Hierarchical)相同。如果self.get_tag("X-y-must-have-same-index")为 True,则X.index必须包含y.index。- update_paramsbool, 可选 (默认值=True)
是否更新模型参数。如果为
False,则仅更新截止点,模型参数(例如,系数)不更新。
- y :
- 返回:
- self对 self 的引用
- update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[源代码]#
在测试集上迭代进行预测和模型更新。
执行多个
update/predict链式调用的简写,数据回放基于时间分割器cv。与以下操作相同(如果只有
y和cv是非默认值)self.update(y=cv.split_series(y)[0][0])记住
self.predict()(稍后一次性返回)self.update(y=cv.split_series(y)[1][0])记住
self.predict()(稍后一次性返回)等等
返回所有记住的预测值
如果尚未实现特定于估计器的 update 方法,则默认回退如下:
update_params=True:拟合到目前为止所有观测到的数据update_params=False:仅更新截止点并记住数据
- 状态要求
要求状态为“已拟合”,即
self.is_fitted=True。
访问 self 中的属性:
以“_”结尾的已拟合模型属性。
self.cutoff,self.is_fitted
- 写入 self(除非
reset_forecaster=True) 将
self.cutoff更新为y中看到的最新索引。如果
update_params=True,则更新以“_”结尾的已拟合模型属性。
如果
reset_forecaster=True,则不更新状态。- 参数:
- y :
sktime兼容数据容器格式的时间序列。 用于更新预测器的时间序列。
sktime中的单个数据格式是所谓的 mtype 规范,每个 mtype 实现一个抽象的 scitype。Seriesscitype = 单个时间序列,香草预测。pd.DataFrame、pd.Series或np.ndarray(1D 或 2D)。Panelscitype = 时间序列集合,全局/面板预测。具有 2 级行MultiIndex(instance, time)的pd.DataFrame,3D np.ndarray(instance, variable, time),list类型的Series格式pd.DataFrame。Hierarchicalscitype = 分层集合,用于分层预测。具有 3 级或更多级行MultiIndex(hierarchy_1, ..., hierarchy_n, time)的pd.DataFrame。
有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅预测教程
examples/01_forecasting.ipynb。- cv继承自 BaseSplitter 的时间交叉验证生成器,可选
例如,
SlidingWindowSplitter或ExpandingWindowSplitter;默认值 = ExpandingWindowSplitter,initial_window=1且默认值 = y/X 中的单个数据点被逐个添加和预测,initial_window = 1,step_length = 1,fh = 1- Xsktime 兼容格式的时间序列,可选 (默认值=None)
用于更新和预测的外生时间序列。应与
fit中y的 科学类型(Series、Panel或Hierarchical)相同。如果self.get_tag("X-y-must-have-same-index")为 True,则X.index必须包含fh的索引引用。- update_paramsbool, 可选 (默认值=True)
是否更新模型参数。如果为
False,则仅更新截止点,模型参数(例如,系数)不更新。- reset_forecasterbool, 可选 (默认值=True)
如果为 True,则不会更改预测器的状态,即 update/predict 序列使用副本运行,self 的截止点、模型参数、数据内存不变。
如果为 False,则当 update/predict 序列运行时,self 会像直接调用 update/predict 一样进行更新。
- y :
- 返回:
- y_pred表格化多个分割批次点预测结果的对象
格式取决于预测的(截止点,绝对预测期)对
如果绝对预测期点的集合是唯一的:类型为 sktime 兼容数据容器格式的时间序列,输出中抑制截止点,类型与最近传入的 y 相同:Series、Panel、Hierarchical 科学类型,格式相同(见上文)
如果绝对预测期点的集合不唯一:类型为 pandas DataFrame,行和列索引为时间戳,行索引对应预测所基于的截止点,列索引对应预测的绝对预测期,条目是该(截止点,预测期)对的点预测值,如果在此对没有预测,则条目为 nan。
- update_predict_single(y=None, fh=None, X=None, update_params=True)[源代码]#
使用新数据更新模型并进行预测。
此方法可用于一步完成更新和预测。
如果尚未实现特定于估计器的 update 方法,则默认回退为先 update,然后 predict。
- 状态要求
要求状态为“已拟合”。
- 访问 self 中的属性:
以“_”结尾的已拟合模型属性。指向已见数据的指针 self._y 和 self.X;self.cutoff, self._is_fitted。如果 update_params=True,则更新以“_”结尾的模型属性。
- 写入自身
通过追加行来更新 self._y 和 self._X,使其包含
y和X。将 self.cutoff 和 self._cutoff 更新为在y中看到的最后一个索引。如果 update_params=True,更新以“_”结尾的已拟合模型属性。
- 参数:
- y :
sktime兼容数据容器格式的时间序列。 用于更新预测器的时间序列。
sktime中的单个数据格式是所谓的 mtype 规范,每个 mtype 实现一个抽象的 scitype。Seriesscitype = 单个时间序列,香草预测。pd.DataFrame、pd.Series或np.ndarray(1D 或 2D)。Panelscitype = 时间序列集合,全局/面板预测。具有 2 级行MultiIndex(instance, time)的pd.DataFrame,3D np.ndarray(instance, variable, time),list类型的Series格式pd.DataFrame。Hierarchicalscitype = 分层集合,用于分层预测。具有 3 级或更多级行MultiIndex(hierarchy_1, ..., hierarchy_n, time)的pd.DataFrame。
有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅预测教程
examples/01_forecasting.ipynb。- fh : int, list, pd.Index 可强制转换,或
ForecastingHorizon,默认=None 预测未来的时间戳所构成的预测期。如果在
fit中已传入,则不应再次传入。如果在 fit 中未传入,则必须传入,而非可选参数。- Xsktime 兼容格式的时间序列,可选 (默认值=None)
用于更新和预测的外生时间序列。应与
fit中y的 科学类型(Series、Panel或Hierarchical)相同。如果self.get_tag("X-y-must-have-same-index")为 True,则X.index必须包含fh的索引引用。- update_paramsbool, 可选 (默认值=True)
是否更新模型参数。如果为
False,则仅更新截止点,模型参数(例如,系数)不更新。
- y :
- 返回:
- y_pred : sktime 兼容数据容器格式的时间序列。
在
fh处的点预测,索引与fh相同。y_pred的类型与最近传递的y类型相同:Series、Panel或Hierarchicalscitype,格式相同(参见上文)。