EnbPIForecaster#

class EnbPIForecaster(forecaster=None, bootstrap_transformer=None, random_state=None, aggregation_function='mean')[source]#

集成 Bootstrap 预测区间预测器。

该预测器结合了 sktime 预测器、tsbootstrap 自助法（bootstrappers）以及在 fortuna 中实现的 EnbPI 算法 [1]，使用了这篇博客文章 [2] 中的教程。

该预测器类似于 bagging 预测器，并在内部执行以下步骤：对于训练

使用 tsbootstrap 转换器生成 Bootstrap 样本并返回原始时间序列的相应索引

在每个 Bootstrap 样本的前 n - max(fh) 个值上拟合一个预测器

使用每个预测器预测每个 Bootstrap 样本的最后 max(fh) 个值

对于预测

使用聚合函数对每个已拟合预测器的预测值进行平均

对于概率预测

使用聚合函数对每个已拟合预测器的预测值进行平均，计算点预测
将 Bootstrap 样本的索引、fit 调用中的预测结果、测试集的点预测以及所需的误差率传递给 EnbPI 算法以计算预测区间。有关 EnbPI 算法的更多信息，请参见参考文献和 aws-fortuna 中 EnbPI 类的文档。

参数:

forecaster估计器: 用于拟合每个 Bootstrap 样本的基础预测器。
bootstrap_transformertsbootstrap.BootstrapTransformer: 用于拟合目标序列以生成 Bootstrap 样本的转换器。
random_stateint, RandomState 实例或 None，默认 None: 用于重现性的随机状态。
aggregation_functionstr，默认 “mean”: 用于组合已拟合预测器预测结果的聚合函数。可以是 “mean” 或 “median”。

属性:

cutoff: 截止点 = 预测器的“当前时间”状态。
fh: 已传递的预测范围。
is_fitted: 是否已调用 fit。

参考文献

[1]

Chen Xu & Yao Xie (2021). 动态时间序列的共形预测区间。

时间序列。.. [R09383241d85a-2] Valeriy Manokhin, PhD, MBA, CQF. 揭秘 EnbPI：掌握共形预测预测（Demystifying EnbPI: Mastering Conformal Prediction Forecasting）

示例

>>> import numpy as np
>>> from tsbootstrap import MovingBlockBootstrap
>>> from sktime.forecasting.enbpi import EnbPIForecaster
>>> from sktime.forecasting.naive import NaiveForecaster
>>> from sktime.datasets import load_airline
>>> from sktime.transformations.series.difference import Differencer
>>> from sktime.transformations.series.detrend import Deseasonalizer
>>> from sktime.forecasting.base import ForecastingHorizon
>>> y = load_airline()
>>> forecaster = Differencer(lags=[1]) * Deseasonalizer(sp=12) * EnbPIForecaster(
...    forecaster=NaiveForecaster(sp=12),
...    bootstrap_transformer=MovingBlockBootstrap(n_bootstraps=10))
>>> fh = ForecastingHorizon(np.arange(1, 13))
>>> forecaster.fit(y, fh=fh)
TransformedTargetForecaster(...)
>>> res = forecaster.predict()
>>> res_int = forecaster.predict_interval(coverage=[0.5])

方法

`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_class_tags`()	从类获取类标签，具有来自父类的标签级别继承。
`get_config`()	获取 self 的配置标志。
`get_fitted_params`([deep])	获取已拟合参数。
`get_param_defaults`()	获取对象的参数默认值。
`get_param_names`([sort])	获取对象的参数名称。
`get_params`([deep])	获取此对象的参数值字典。
`get_tag`(tag_name[, tag_value_default, ...])	从实例获取标签值，具有标签级别继承和覆盖。
`get_tags`()	从实例获取标签，具有标签级别继承和覆盖。
`get_test_params`()	返回估计器的测试参数设置。
`is_composite`()	检查对象是否由其他 BaseObjects 组成。
`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])	将序列化的 self 保存到字节类对象或 (.zip) 文件。
`score`(y[, X, fh])	使用 MAPE（非对称）对预测结果与真实值进行评分。
`set_config`(**config_dict)	将配置标志设置为给定值。
`set_params`(**params)	设置此对象的参数。
`set_random_state`([random_state, deep, ...])	为 self 设置 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])	使用新数据更新模型并进行预测。

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。在调用对象的 fit 方法时，is_fitted 属性应设置为 True。

如果不是，则会引发 NotFittedError。

参数:

method_namestr，可选: 调用此函数的方法的名称。如果提供，错误消息将包含此信息。

引发:

NotFittedError: 如果估计器尚未拟合。

clone()[source]#

获取具有相同超参数和配置的对象的克隆。

克隆是另一个没有共享引用的对象，处于初始化后状态。此函数等同于返回 sklearn.clone 的 self。

等同于构造 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)[source]#

从另一个对象克隆标签作为动态覆盖。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

clone_tags 方法只能在对象的 __init__ 方法中、构造期间，或通过 __init__ 构造后直接调用。

动态标签被设置为 estimator 中指定名称 tag_names 的标签值。

tag_names 的默认值是将 estimator 中的所有标签写入 self。

当前标签值可以通过 get_tags 或 get_tag 进行检查。

参数:

estimator:class:BaseObject 或派生类的实例
tag_namesstr 或 str 列表，默认 None: 要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回:

self: 对 self 的引用。

classmethod create_test_instance(parameter_set='default')[source]#

使用第一个测试参数集构造类的实例。

参数:

parameter_setstr，默认 “default”: 要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，则将返回 “default” 集。

返回:

instance具有默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')[source]#

创建所有测试实例的列表以及它们的名称列表。

参数:

parameter_setstr，默认 “default”: 要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，则将返回 “default” 集。

返回:

objscls 实例列表: 第 i 个实例是 cls(**cls.get_test_params()[i])
namesstr 列表，与 objs 长度相同: 第 i 个元素是测试中 objs 中第 i 个实例的名称。命名约定是如果实例多于一个，则为 {cls.__name__}-{i}，否则为 {cls.__name__}

property cutoff[source]#

截止点 = 预测器的“当前时间”状态。

返回:

cutoffpandas 兼容的索引元素，或 None: 如果截止点已设置，则为 pandas 兼容的索引元素；否则为 None

property fh[source]#: 已传递的预测范围。

fit(y, X=None, fh=None)[source]#

将预测器拟合到训练数据。

状态变化: 将状态更改为“已拟合”（fitted）。

写入 self

设置以“_”结尾的已拟合模型属性，已拟合属性可通过 get_fitted_params 进行检查。

将 self.is_fitted 标志设置为 True。

将 self.cutoff 设置为在 y 中看到的最后一个索引。

如果传递了 fh，则将其存储到 self.fh 中。

参数:

y符合 sktime 数据容器格式的时间序列。

用于拟合预测器的时间序列。

sktime 中的独立数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

Series scitype = 独立时间序列，普通预测。pd.DataFrame, pd.Series 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame，行索引为 2 级 MultiIndex (instance, time)；3D np.ndarray (instance, variable, time)；或者 list 类型的 Series pd.DataFrame 列表。
Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame，行索引为 3 级或更多级 MultiIndex (hierarchy_1, ..., hierarchy_n, time)。

有关数据格式的更多详细信息，请参见 mtype 词汇表。有关用法，请参见预测教程 examples/01_forecasting.ipynb。

fhint, 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。

返回:

self对 self 的引用。

fit_predict(y, X=None, fh=None, X_pred=None)[source]#

在未来预测范围对时间序列进行拟合和预测。

等同于 fit(y, X, fh).predict(X_pred)。如果未传递 X_pred，则等同于 fit(y, fh, X).predict(X)。

状态变化: 将状态更改为“已拟合”（fitted）。

写入 self

设置以“_”结尾的已拟合模型属性，已拟合属性可通过 get_fitted_params 进行检查。

将 self.is_fitted 标志设置为 True。

将 self.cutoff 设置为在 y 中看到的最后一个索引。

将 fh 存储到 self.fh 中。

参数:

ysktime 兼容数据容器格式的时间序列

用于拟合预测器的时间序列。

sktime 中的独立数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

Series scitype = 独立时间序列，普通预测。pd.DataFrame, pd.Series 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame，行索引为 2 级 MultiIndex (instance, time)；3D np.ndarray (instance, variable, time)；或者 list 类型的 Series pd.DataFrame 列表。
Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame，行索引为 3 级或更多级 MultiIndex (hierarchy_1, ..., hierarchy_n, time)。

有关数据格式的更多详细信息，请参见 mtype 词汇表。有关用法，请参见预测教程 examples/01_forecasting.ipynb。

fhint, 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_predsktime 兼容格式的时间序列，可选（默认 None）

用于预测的外生时间序列。如果传递，将用于预测而不是 X。应与 fit 中的 y 具有相同的 scitype（Series, Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。

返回:

y_predsktime 兼容数据容器格式的时间序列: 在 fh 处的点预测，与 fh 具有相同的索引。y_pred 与最近传递的 y 具有相同的类型：Series, Panel, Hierarchical scitype，格式相同（见上文）

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

从类获取类标签值，具有来自父类的标签级别继承。

每个 scikit-base 兼容对象都有一个标签字典，用于存储对象的元数据。

get_class_tag 方法是类方法，它检索标签值时仅考虑类级别的标签值和覆盖。

它从对象中返回名称为 tag_name 的标签值，考虑到标签覆盖，优先级从高到低如下：

在类的 _tags 属性中设置的标签。
在父类的 _tags 属性中设置的标签，

按照继承顺序。

不考虑通过 set_tags 或 clone_tags 在实例上设置的动态标签覆盖。

要检索具有潜在实例覆盖的标签值，请改用 get_tag 方法。

参数:

tag_namestr: 标签值的名称。
tag_value_default任意类型: 如果未找到标签，则为默认/回退值。

返回:

tag_value: self 中名称为 tag_name 的标签值。如果未找到，则返回 tag_value_default。

classmethod get_class_tags()[source]#

从类获取类标签，具有来自父类的标签级别继承。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

get_class_tags 方法是类方法，它检索标签值时仅考虑类级别的标签值和覆盖。

它返回一个字典，其键是类或其任何父类中设置的 _tags 的任何属性的键。

值是相应的标签值，覆盖顺序优先级从高到低如下：

在类的 _tags 属性中设置的标签。
在父类的 _tags 属性中设置的标签，

按照继承顺序。

实例可以根据超参数覆盖这些标签。

要检索具有潜在实例覆盖的标签，请改用 get_tags 方法。

不考虑通过 set_tags 或 clone_tags 在实例上设置的动态标签覆盖。

要包含来自动态标签的覆盖，请使用 get_tags。

collected_tagsdict: 标签名称：标签值对的字典。通过嵌套继承从 _tags 类属性收集。不会被通过 set_tags 或 clone_tags 设置的动态标签覆盖。

get_config()[source]#

获取 self 的配置标志。

配置是 self 的键值对，通常用作控制行为的瞬时标志。

get_config 返回动态配置，这些配置会覆盖默认配置。

默认配置在类或其父类的类属性 _config 中设置，并会被通过 set_config 设置的动态配置覆盖。

配置在 clone 或 reset 调用中保留。

返回:

config_dictdict: 配置名称：配置值对的字典。通过嵌套继承从 _config 类属性收集，然后从 _onfig_dynamic 对象属性获取任何覆盖和新标签。

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态: 需要状态为“已拟合”（fitted）。

参数:

deepbool，默认 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()[source]#

获取对象的参数默认值。

返回:

default_dict: dict[str, Any]: 键是 cls 中在 __init__ 中定义了默认值的所有参数。值是默认值，如 __init__ 中定义的那样。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数:

sortbool, default=True: 是否按字母顺序 (True) 返回参数名称，还是按它们在类的 __init__ 中出现的顺序 (False) 返回。

返回:

param_names: list[str]: cls 的参数名称列表。如果 sort=False，则按照它们在类 __init__ 中出现的顺序排列。如果 sort=True，则按字母顺序排列。

get_params(deep=True)[source]#

获取此对象的参数值字典。

参数:

deepbool，默认 True

是否返回组件的参数。

如果为 True，将返回此对象的参数名:值 dict，包括组件的参数（= BaseObject 类型参数）。
如果为 False，将返回此对象的参数名:值 dict，但不包括组件的参数。

返回:

paramsdict with str-valued keys

参数字典，包含 parametername : 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)[source]#

从实例获取标签值，具有标签级别继承和覆盖。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，同时考虑到标签覆盖，优先级按降序排列如下：

通过实例上的 set_tags 或 clone_tags 设置的标签，

在实例构造时。

在类的 _tags 属性中设置的标签。
在父类的 _tags 属性中设置的标签，

按照继承顺序。

参数:

tag_namestr: 要检索的标签名称
tag_value_default任意类型, optional; default=None: 如果未找到标签，则使用的默认/备用值
raise_errorbool: 未找到标签时是否引发 ValueError

返回:

tag_valueAny: self 中 tag_name 标签的值。如果未找到，并且 raise_error 为 True，则引发错误，否则返回 tag_value_default。

引发:

ValueError, 如果 raise_error 为 True。: 如果 tag_name 不在 self.get_tags().keys() 中，则引发 ValueError。

get_tags()[source]#

从实例获取标签，具有标签级别继承和覆盖。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

get_tags 方法返回一个标签字典，其键是类或其任何父类中设置的任何 _tags 属性的键，或通过 set_tags 或 clone_tags 设置的标签。

值是相应的标签值，覆盖顺序优先级从高到低如下：

通过实例上的 set_tags 或 clone_tags 设置的标签，

在实例构造时。

在类的 _tags 属性中设置的标签。
在父类的 _tags 属性中设置的标签，

按照继承顺序。

返回:

collected_tagsdict: 标签名:标签值对的字典。从嵌套继承的 _tags 类属性中收集，然后从 _tags_dynamic 对象属性中收集任何覆盖和新标签。

classmethod get_test_params()[source]#

返回估计器的测试参数设置。

返回:

paramsdict or list of dict, default = {}: 用于创建类的测试实例的参数。每个 dict 都是构造一个“有趣的”测试实例的参数，即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个（或唯一的）字典

is_composite()[source]#

检查对象是否由其他 BaseObjects 组成。

复合对象是包含其他对象作为参数的对象。在实例上调用，因为这可能因实例而异。

返回:

composite: bool: 对象是否具有任何参数，其值是 BaseObject 的后代实例。

property is_fitted[source]#

是否已调用 fit。

检查对象的 _is_fitted` 属性，该属性在对象构造期间应初始化为 ``False，并在调用对象的 fit 方法时设置为 True。

返回:

bool: 评估器是否已 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:

serialZipFile(path).open(“object) 的结果

返回:

反序列化的 self，导致在 path 处输出 cls.save(path) 的结果

classmethod load_from_serial(serial)[source]#

从序列化内存容器加载对象。

参数:

serialcls.save(None) 输出的第一个元素

返回:

反序列化的 self，导致输出 serial，即 cls.save(None) 的输出

predict(fh=None, X=None)[source]#

在未来预测范围对时间序列进行预测。

所需状态: 要求状态为“已拟合”，即 self.is_fitted=True。

在 self 中访问

以“_”结尾的拟合模型属性。

self.cutoff, self.is_fitted

写入 self: 如果传递了 fh 且之前未传递过，则将 fh 存储到 self.fh。

参数:

fhint, list, 可强制转换为 pd.Index 或 ForecastingHorizon，默认 None

预测期，编码要预测的时间戳。如果已在 fit 中传递，则不应再次传递。如果未在 fit 中传递，则必须传递，不可选

如果 fh 不为 None 且不是 ForecastingHorizon 类型，它将通过调用 _check_fh 被强制转换为 ForecastingHorizon。特别是，如果 fh 是 pd.Index 类型，它将通过 ForecastingHorizon(fh, is_relative=False) 被强制转换。

Xsktime 兼容格式的时间序列，可选 (default=None)

用于预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型 (Series, Panel 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 fh 索引参考。

返回:

y_predsktime 兼容数据容器格式的时间序列: 在 fh 处的点预测，与 fh 具有相同的索引。y_pred 与最近传递的 y 具有相同的类型：Series, Panel, Hierarchical scitype，格式相同（见上文）

predict_interval(fh=None, X=None, coverage=0.9)[source]#

计算/返回预测区间预测结果。

如果 coverage 是可迭代的，将计算多个区间。

所需状态: 要求状态为“已拟合”，即 self.is_fitted=True。

在 self 中访问

以“_”结尾的拟合模型属性。

self.cutoff, self.is_fitted

写入 self: 如果传递了 fh 且之前未传递过，则将 fh 存储到 self.fh。

参数:

fhint, 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)。

Xsktime 兼容格式的时间序列，可选 (default=None)

用于预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型 (Series, Panel 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 fh 索引参考。

coverage浮点数或唯一浮点数列表，可选 (default=0.90)

预测区间的名义覆盖度

返回:

pred_intpd.DataFrame

列具有多重索引：第一层是 fit 中 y 的变量名，

第二层是计算区间的覆盖分数。: 与输入 coverage 的顺序相同。

第三层是字符串“lower”或“upper”，表示区间的下限/上限。

行索引是 fh，附加（上）层等于实例层，

来自 fit 中看到的 y，如果 fit 中看到的 y 是 Panel 或 Hierarchical。

条目是下限/上限区间的预测值，

对于列索引中的变量，在第二列索引中的名义覆盖下，取决于第三列索引的 lower/upper，对于行索引。上限/下限区间预测值等同于 alpha = 0.5 - c/2, 0.5 + c/2（对于 coverage 中的 c）下的分位数预测值。

predict_proba(fh=None, X=None, marginal=True)[source]#

计算/返回完全概率预测结果。

注意

当前仅对 Series（非 Panel，非 Hierarchical）y 实现。
返回的分布对象需要安装 skpro。

所需状态: 要求状态为“已拟合”，即 self.is_fitted=True。

在 self 中访问

以“_”结尾的拟合模型属性。

self.cutoff, self.is_fitted

写入 self: 如果传递了 fh 且之前未传递过，则将 fh 存储到 self.fh。

参数:

fhint, 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)。

Xsktime 兼容格式的时间序列，可选 (default=None)

用于预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型 (Series, Panel 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 fh 索引参考。

marginalbool, optional (default=True)

返回的分布是否按时间索引是边缘分布

返回:

pred_distskpro BaseDistribution: 预测分布如果 marginal=True，将是按时间点的边缘分布如果 marginal=False 且由方法实现，将是联合分布

predict_quantiles(fh=None, X=None, alpha=None)[source]#

计算/返回分位数预测结果。

如果 alpha 是可迭代的，将计算多个分位数。

所需状态: 要求状态为“已拟合”，即 self.is_fitted=True。

在 self 中访问

以“_”结尾的拟合模型属性。

self.cutoff, self.is_fitted

写入 self: 如果传递了 fh 且之前未传递过，则将 fh 存储到 self.fh。

参数:

fhint, 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)。

Xsktime 兼容格式的时间序列，可选 (default=None)

用于预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型 (Series, Panel 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 fh 索引参考。

alpha浮点数或唯一浮点数列表，可选 (default=[0.05, 0.95])

计算分位数预测时的概率或概率列表。

返回:

quantilespd.DataFrame

列具有多重索引：第一层是 fit 中 y 的变量名，: 第二层是传递给函数的 alpha 值。
行索引是 fh，附加（上）层等于实例层，: 来自 fit 中看到的 y，如果 fit 中看到的 y 是 Panel 或 Hierarchical。
条目是分位数预测，对于列索引中的变量，: 在第二列索引中的分位数概率下，对于行索引。

predict_residuals(y=None, X=None)[source]#

返回时间序列预测的残差。

残差将针对 y.index 处的预测值进行计算。

如果在 fit 中必须传递 fh，则它必须与 y.index 一致。如果 y 是 np.ndarray，并且在 fit 中没有传递 fh，则残差将针对范围为 range(len(y.shape[0])) 的 fh 进行计算

所需状态: 要求状态为“已拟合”。如果已设置 fh，则必须与 y 的索引一致（pandas 或整数）
在 self 中访问: 以“_”结尾的拟合模型属性。self.cutoff, self._is_fitted
写入 self: 无。

参数:

ysktime 兼容数据容器格式的时间序列

用于计算残差的具有真实观察值的时间序列。必须具有与 predict 预期返回类型相同的类型、维度和索引。

如果为 None，则使用迄今为止看到的 y (self._y)，特别是

如果在单次 fit 调用之前，则生成内样本残差
如果 fit 需要 fh，则它必须指向 fit 中 y 的索引

Xsktime 兼容格式的时间序列，可选 (default=None)

用于更新和预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型 (Series, Panel 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须同时包含 fh 索引参考和 y.index。

返回:

y_ressktime 兼容数据容器格式的时间序列: fh` 处的预测残差，具有与 ``fh 相同的索引。y_res 的类型与最近传递的 y 类型相同：Series, Panel, Hierarchical 科学类型，格式相同（见上文）

predict_var(fh=None, X=None, cov=False)[source]#

计算/返回方差预测结果。

所需状态: 要求状态为“已拟合”，即 self.is_fitted=True。

在 self 中访问

以“_”结尾的拟合模型属性。

self.cutoff, self.is_fitted

写入 self: 如果传递了 fh 且之前未传递过，则将 fh 存储到 self.fh。

参数:

fhint, 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)。

Xsktime 兼容格式的时间序列，可选 (default=None)

用于预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型 (Series, Panel 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 fh 索引参考。

covbool, optional (default=False)

如果为 True，计算协方差矩阵预测。如果为 False，计算边缘方差预测。

返回:

pred_varpd.DataFrame, 格式取决于 cov 变量

如果 cov=False

列名与 fit/update 中传递的 y 的列名完全相同。: 对于无名格式，列索引将是一个 RangeIndex。
行索引是 fh，附加层等于实例层，: 来自 fit 中看到的 y，如果 fit 中看到的 y 是 Panel 或 Hierarchical。

条目是方差预测，对于列索引中的变量。给定变量和 fh 索引的方差预测是对于该变量和索引，给定观测数据时预测的

方差。

如果 cov=True

列索引是多级索引：第一层是变量名（如上）: 第二层是 fh。
行索引是 fh，附加层等于实例层，: 来自 fit 中看到的 y，如果 fit 中看到的 y 是 Panel 或 Hierarchical。
条目是（协）方差预测，对于列索引中的变量，以及: 行和列中时间索引之间的协方差。

注意：不同变量之间不返回协方差预测。

reset()[source]#

将对象重置到干净的初始化后状态。

结果是将 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')[source]#

将序列化的 self 保存到字节类对象或 (.zip) 文件。

行为：如果 path 为 None，则返回一个内存中的序列化 self；如果 path 是文件位置，则将 self 存储为 zip 文件到该位置

保存的文件是 zip 文件，包含以下内容： _metadata - 包含 self 的类，即 type(self) _obj - 序列化的 self。此方法使用默认序列化 (pickle)。

参数:

pathNone 或文件位置 (str 或 Path)

如果为 None，则将 self 保存到内存中的对象。如果为文件位置，则将 self 保存到该文件位置。如果

path=”estimator”，则将在当前工作目录 (cwd) 下创建 zip 文件 estimator.zip。
path=”/home/stored/estimator”，则将在 /home/stored/ 中存储 zip 文件 estimator.zip。

存储在/home/stored/。

serialization_format: str, default = “pickle”

用于序列化的模块。可用选项有“pickle”和“cloudpickle”。请注意，非默认格式可能需要安装其他软依赖项。

返回:

如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 引用该文件的 ZipFile

score(y, X=None, fh=None)[source]#

使用 MAPE（非对称）对预测结果与真实值进行评分。

参数:

ypd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D): 用于评分的时间序列
fhint, list, 可强制转换为 pd.Index 或 ForecastingHorizon，默认 None: 编码要预测时间戳的预测范围。
Xpd.DataFrame, 或 2D np.array, optional (default=None): 用于评分的外生时间序列如果 self.get_tag(“X-y-must-have-same-index”)，则 X.index 必须包含 y.index

返回:

scorefloat: self.predict(fh, X) 相对于 y_test 的 MAPE 损失。

另请参见

sktime.performance_metrics.forecasting.mean_absolute_percentage_error

set_config(**config_dict)[source]#

将配置标志设置为给定值。

参数:

config_dictdict

config 名称 : config 值对的字典。有效的 configs、值及其含义如下所示

displaystr, “diagram” (default), 或 “text”

jupyter 内核如何显示 self 的实例

“diagram” = html 方框图表示
“text” = 字符串打印输出

print_changed_onlybool, default=True

打印 self 时，是仅列出与默认值不同的 self 参数 (False)，还是列出所有参数名称和值 (False)。不嵌套，即仅影响 self，不影响组件评估器。

warningsstr, “on” (default), 或 “off”

是否发出警告，仅影响来自 sktime 的警告

“on” = 将发出来自 sktime 的警告
“off” = 将不发出来自 sktime 的警告

backend:parallelstr, optional, default=”None”

广播/向量化时用于并行处理的后端，选项之一：

“None”：按顺序执行循环，简单的列表推导
“loky”, “multiprocessing” 和 “threading”：使用 joblib.Parallel
“joblib”：自定义和第三方 joblib 后端，例如 spark
“dask”：使用 dask，需要在环境中安装 dask 包
“ray”：使用 ray，需要在环境中安装 ray 包

backend:parallel:paramsdict, optional, default={} (未传递参数)

作为配置传递给并行化后端的附加参数。有效键取决于 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, default=True; False 阻止 ray 在并行化后
  关闭。
- “logger_name”：str, default=”ray”; 要使用的日志记录器的名称。
- “mute_warnings”：bool, default=False; 如果为 True，则抑制警告

remember_databool, default=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)[source]#

设置此对象的参数。

此方法适用于简单的 skbase 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象（即包含其他对象的对象），以访问组件 <component> 中的 <parameter>。如果引用明确，也可以使用不带 <component>__ 的字符串 <parameter>，例如，如果组件没有两个参数名称相同为 <parameter>。

参数:

**paramsdict: BaseObject 参数，键必须是 <component>__<parameter> 字符串。__ 后缀可以作为完整字符串的别名，如果在 get_params 键中是唯一的。

返回:

self对 self 的引用（参数设置后）

set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

为 self 设置 random_state 伪随机种子参数。

通过 self.get_params 找到名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 派生的整数。这些整数通过 sample_dependent_seed 使用链式哈希采样，保证了伪随机独立性。

根据 self_policy 应用于 self 中的 random_state 参数，并且仅当 deep=True 时，也应用于其余组件对象。

注意：即使 self 没有 random_state 参数，或者没有任何组件具有 random_state 参数，也会调用 set_params。因此，set_random_state 将重置任何 scikit-base 对象，即使它们没有 random_state 参数。

参数:

random_stateint, RandomState 实例或 None，默认 None

伪随机数生成器，用于控制随机整数的生成。传递 int 值可以在多次函数调用中产生可重复的输出。

deepbool，默认 True

是否在 skbase 对象类型参数（即组件评估器）中设置随机状态。

如果为 False，将仅设置 self 的 random_state 参数（如果存在）。
如果为 True，还将设置组件对象中的 random_state 参数。

self_policystr, one of {“copy”, “keep”, “new”}, default=”copy”

“copy” : self.random_state 设置为输入 random_state
“keep” : 保留 self.random_state 不变
“new” : self.random_state 设置为新的随机状态，

从输入 random_state 派生，并且通常与它不同

返回:

self对 self 的引用

set_tags(**tag_dict)[source]#

将实例级别的标签覆盖设置为给定值。

每个 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)[source]#

更新截止值，并可选地更新已拟合参数。

如果未实现评估器特定的 update 方法，则默认回退如下：

update_params=True：对迄今为止所有观测到的数据进行拟合

update_params=False：仅更新截止点并记住数据

所需状态: 要求状态为“已拟合”，即 self.is_fitted=True。

在 self 中访问

以“_”结尾的拟合模型属性。

self.cutoff, self.is_fitted

写入 self

将 self.cutoff 更新为在 y 中看到的最新索引。

如果 update_params=True，则更新以“_”结尾的拟合模型属性。

参数:

y符合 sktime 数据容器格式的时间序列。

用于更新预测器的时间序列。

sktime 中的独立数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

Series scitype = 独立时间序列，普通预测。pd.DataFrame, pd.Series 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame，行索引为 2 级 MultiIndex (instance, time)；3D np.ndarray (instance, variable, time)；或者 list 类型的 Series pd.DataFrame 列表。
Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame，行索引为 3 级或更多级 MultiIndex (hierarchy_1, ..., hierarchy_n, time)。

有关数据格式的更多详细信息，请参见 mtype 词汇表。有关用法，请参见预测教程 examples/01_forecasting.ipynb。

X符合 sktime 格式的时间序列，可选（默认 None）。

用于更新模型拟合的外生时间序列。应与 y 具有相同的科学类型 (Series, Panel 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 y.index。

update_paramsbool, optional (default=True)

是否更新模型参数。如果为 False，则仅更新截止点，模型参数（例如，系数）不更新。

返回:

self对 self 的引用

update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#

在测试集上迭代地进行预测并更新模型。

这是一个快捷方式，用于执行多个 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。

Series scitype = 独立时间序列，普通预测。pd.DataFrame, pd.Series 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame，行索引为 2 级 MultiIndex (instance, time)；3D np.ndarray (instance, variable, time)；或者 list 类型的 Series pd.DataFrame 列表。
Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame，行索引为 3 级或更多级 MultiIndex (hierarchy_1, ..., hierarchy_n, time)。

有关数据格式的更多详细信息，请参见 mtype 词汇表。有关用法，请参见预测教程 examples/01_forecasting.ipynb。

cv继承自 BaseSplitter 的时间交叉验证生成器，可选

例如，SlidingWindowSplitter 或 ExpandingWindowSplitter；默认 = ExpandingWindowSplitter，initial_window=1，默认值 = y/X 中的单个数据点逐个添加和预测，initial_window = 1，step_length = 1 和 fh = 1

Xsktime 兼容格式的时间序列，可选 (default=None)

用于更新和预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型 (Series, Panel 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 fh 索引参考。

update_paramsbool, optional (default=True)

是否更新模型参数。如果为 False，则仅更新截止点，模型参数（例如，系数）不更新。

reset_forecasterbool, optional (default=True)

如果为 True，将不改变预测器的状态，即使用副本运行 update/predict 序列，并且 self 的 cutoff、模型参数、数据内存不改变
如果为 False，则在运行 update/predict 序列时将更新 self，就像直接调用 update/predict 一样

返回:

y_pred对来自多个分割批次的点预测进行制表的对象

格式取决于整体预测的 (cutoff, 绝对预测期) 对

如果绝对预测期点的集合是唯一的：类型是 sktime 兼容数据容器格式的时间序列输出中省略 cutoff 其类型与最近传递的 y 类型相同：Series, Panel, Hierarchical 科学类型，格式相同（见上文）
如果绝对预测期点的集合不唯一：类型是一个 pandas DataFrame，行和列索引是时间戳行索引对应于进行预测的截止点列索引对应于进行预测的绝对预测期条目是在该 (cutoff, horizon) 对下未进行预测时为 nan

update_predict_single(y=None, fh=None, X=None, update_params=True)[source]#

使用新数据更新模型并进行预测。

此方法有助于在一个步骤中完成更新和预测。

如果未实现评估器特定的 update 方法，则默认回退是先 update，然后 predict。

所需状态: 需要状态为“已拟合”（fitted）。
在 self 中访问: 以“_”结尾的拟合模型属性。指向已见数据的指针，self._y 和 self.X self.cutoff, self._is_fitted 如果 update_params=True，则以“_”结尾的模型属性。
写入 self: 通过追加行，使用 y 和 X 更新 self._y 和 self._X。将 self.cutoff 和 self._cutoff 更新为在 y 中看到的最后一个索引。如果 update_params=True，

更新以“_”结尾的拟合模型属性。

参数:

y符合 sktime 数据容器格式的时间序列。

用于更新预测器的时间序列。

sktime 中的独立数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

Series scitype = 独立时间序列，普通预测。pd.DataFrame, pd.Series 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame，行索引为 2 级 MultiIndex (instance, time)；3D np.ndarray (instance, variable, time)；或者 list 类型的 Series pd.DataFrame 列表。
Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame，行索引为 3 级或更多级 MultiIndex (hierarchy_1, ..., hierarchy_n, time)。

有关数据格式的更多详细信息，请参见 mtype 词汇表。有关用法，请参见预测教程 examples/01_forecasting.ipynb。

fhint, list, 可强制转换为 pd.Index 或 ForecastingHorizon，默认 None

预测期，编码要预测的时间戳。如果已在 fit 中传递，则不应再次传递。如果未在 fit 中传递，则必须传递，不可选

Xsktime 兼容格式的时间序列，可选 (default=None)

用于更新和预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型 (Series, Panel 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 fh 索引参考。

update_paramsbool, optional (default=True)

是否更新模型参数。如果为 False，则仅更新截止点，模型参数（例如，系数）不更新。

返回:

y_predsktime 兼容数据容器格式的时间序列: 在 fh 处的点预测，与 fh 具有相同的索引。y_pred 与最近传递的 y 具有相同的类型：Series, Panel, Hierarchical scitype，格式相同（见上文）