ForecastingPipeline#

class ForecastingPipeline(steps)[source]#

带有外生数据的预测管道。

ForecastingPipeline 仅将给定的转换器应用于 X。预测器也可以是一个 TransformedTargetForecaster，其中包含用于转换 y 的转换器。

对于列表 t1、t2、…、tN 和 f，: 其中 t[i] 是转换器，而 f 是一个 sktime 预测器，管道的行为如下：
fit(y, X, fh) 通过运行 t1.fit_transform（使用 X=X，y=y）来改变状态，: 然后依次在 X=t1.fit_transform 的输出、y=y 上运行 t2.fit_transform，以此类推，t[i] 接收 t[i-1] 的输出作为 X，然后运行 f.fit，其中 X 是 t[N] 的输出，y=y
predict(X, fh) - 结果是执行 f.predict 的结果，使用 fh=fh，以及 X: 作为以下过程的结果：运行 t1.fit_transform（使用 X=X），然后依次在 X=t1.fit_transform 的输出上运行 t2.fit_transform，以此类推，t[i] 接收 t[i-1] 的输出作为 X，并返回 tN 的输出作为 X 传递给 f.predict。
predict_interval(X, fh)、predict_quantiles(X, fh) - 与 predict(X, fh) 类似，: 将 predict_interval 或 predict_quantiles 替换 predict
predict_var、predict_proba - 使用基类默认值从 predict_quantiles 获取粗略的正态估计。: 来自 predict_quantiles 的粗略正态估计。

get_params、set_params 使用与 sklearn 兼容的嵌套接口

如果列表未命名，则名称将生成为类的名称

如果名称不唯一，则会在每个名称字符串后附加 f"_{str(i)}"，其中 i 是列表中该不唯一字符串在当前位置（包括当前位置）之前出现的总次数

ForecastingPipeline 也可以通过使用魔法乘法来创建: 在任何预测器上使用，即如果 my_forecaster 继承自 BaseForecaster，并且 my_t1、my_t2 继承自 BaseTransformer，那么例如 my_t1 ** my_t2 ** my_forecaster 将产生与构造函数 ForecastingPipeline([my_t1, my_t2, my_forecaster]) 获得的对象相同的结果。只要链中有一个元素是转换器，魔法乘法也可以用于 (str, transformer) 对。

参数:

stepssktime 转换器和预测器的列表，或: sktime 转换器或预测器的元组列表 (str, estimator)。该列表必须包含且仅包含一个预测器。这些是“蓝图”转换器/预测器，在调用 fit 时，预测器/转换器的状态不会改变。

属性:

steps_sktime 转换器或预测器的元组列表 (str, estimator): 管道中拟合的 steps 中的估计器的克隆始终采用 (str, estimator) 格式，即使 steps 仅是一个列表。未在 steps 中传递的字符串将被唯一的生成字符串替换。 steps_ 中的第 i 个转换器是 steps 中第 i 个转换器的克隆。
forecaster_估计器，指向 steps_ 中唯一预测器的引用: 返回管道中预测器的引用。

示例

>>> from sktime.datasets import load_longley
>>> from sktime.forecasting.naive import NaiveForecaster
>>> from sktime.forecasting.compose import ForecastingPipeline
>>> from sktime.transformations.series.impute import Imputer
>>> from sktime.forecasting.base import ForecastingHorizon
>>> from sktime.split import temporal_train_test_split
>>> from sklearn.preprocessing import MinMaxScaler
>>> y, X = load_longley()
>>> y_train, _, X_train, X_test = temporal_train_test_split(y, X)
>>> fh = ForecastingHorizon(X_test.index, is_relative=False)

示例 1: 字符串/估计器对

>>> pipe = ForecastingPipeline(steps=[
...     ("imputer", Imputer(method="mean")),
...     ("minmaxscaler", MinMaxScaler()),
...     ("forecaster", NaiveForecaster(strategy="drift")),
... ])
>>> pipe.fit(y_train, X_train)
ForecastingPipeline(...)
>>> y_pred = pipe.predict(fh=fh, X=X_test)

示例 2: 不使用字符串

>>> pipe = ForecastingPipeline([
...     Imputer(method="mean"),
...     MinMaxScaler(),
...     NaiveForecaster(strategy="drift"),
... ])

示例 3: 使用魔术方法注意: *（应用于 y）优先于 **（应用于 X）

>>> forecaster = NaiveForecaster(strategy="drift")
>>> imputer = Imputer(method="mean")
>>> pipe = (imputer * MinMaxScaler()) ** forecaster

示例 3b: 使用魔术方法，替代方案

>>> pipe = imputer ** MinMaxScaler() ** forecaster

方法

`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`()	获取对象的配置标志。
`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`([parameter_set])	返回估计器的测试参数设置。
`is_composite`()	检查对象是否是复合对象。
`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`(**kwargs)	设置估计器的参数。
`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])	使用新数据更新模型并进行预测。

property forecaster_[source]#

返回管道中预测器的引用。

在 _fit 之后有效。

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。is_fitted 属性应在调用对象的 fit 方法时设置为 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]#

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

返回:

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

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

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

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

状态改变: 将状态更改为“已拟合”。

写入 self

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

将 self.is_fitted 标志设置为 True。

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

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

参数:

y采用 sktime 兼容数据容器格式的时间序列。

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

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

Series scitype = 个体时间序列，普通预测。pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）
Panel scitype = 时间序列集合，全局/面板预测。带有 2 级行 MultiIndex（instance，time）的 pd.DataFrame，3D np.ndarray（instance，variable，time），或 Series 类型的 pd.DataFrame 列表
Hierarchical scitype = 分层集合，用于分层预测。带有 3 级或更多级行 MultiIndex（hierarchy_1，...，hierarchy_n，time）的 pd.DataFrame

有关数据格式的更多详细信息，请参见 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")，则 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)。

状态改变: 将状态更改为“已拟合”。

写入 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 = 时间序列集合，全局/面板预测。带有 2 级行 MultiIndex（instance，time）的 pd.DataFrame，3D np.ndarray（instance，variable，time），或 Series 类型的 pd.DataFrame 列表
Hierarchical scitype = 分层集合，用于分层预测。带有 3 级或更多级行 MultiIndex（hierarchy_1，...，hierarchy_n，time）的 pd.DataFrame

有关数据格式的更多详细信息，请参见 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")，则 X.index 必须包含 y.index。

X_predsktime 兼容格式的时间序列，可选（默认值=None）

用于预测的外生时间序列。如果传递，将在 predict 中使用，而不是 X。应与 fit 中 y 具有相同的 scitype（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，格式相同（见上文）

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 的键值对，通常用作控制行为的瞬时标志。

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

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

配置在调用 clone 或 reset 时会保留。

返回:

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

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态: 要求状态为“已拟合”。

参数:

deepbool，默认值=True

是否返回组件的已拟合参数。

如果为 True，将返回此对象的参数名称 : 值字典，包括可拟合组件（= BaseEstimator 值参数）的已拟合参数。
如果为 False，将返回此对象的参数名称 : 值字典，但不包括组件的已拟合参数。

返回:

fitted_params带有 str 值键的 dict

已拟合参数字典，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)[源代码]#

获取对象的参数名称。

参数:

sort布尔值, 默认为True: 是否按字母顺序返回参数名称 (True)，或者按它们在类 __init__ 中出现的顺序返回 (False)。

返回:

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

get_params(deep=True)[源代码]#

获取估计器的参数。

参数:

deep布尔值, 可选: 如果为 True，将返回此估计器及其包含的作为估计器的子对象的参数。

返回:

params字符串到任意类型的映射: 参数名称映射到其值。

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_namestr: 要检索的标签名称
tag_value_default任意类型, 可选；默认为 None: 如果未找到标签，则为默认/备用值
raise_error布尔值: 当未找到标签时是否引发 ValueError

返回:

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

引发:

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

get_tags()[源代码]#

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

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

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

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

值是相应的标签值，按以下降序优先级进行覆盖：

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

在实例构建时。

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

按继承顺序。

返回:

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

classmethod get_test_params(parameter_set='default')[源代码]#

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

参数:

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

返回:

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

is_composite()[源代码]#

检查对象是否是复合对象。

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

返回:

composite: 布尔值，表示自身是否包含一个作为 BaseObject 的参数

property is_fitted[源代码]#

是否已调用 fit。

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

返回:

布尔值: 估计器是否已 fit。

classmethod load_from_path(serial)[源代码]#

从文件位置加载对象。

参数:

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

返回:

反序列化的自身，输出在 path，是 cls.save(path) 的结果

classmethod load_from_serial(serial)[源代码]#

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

参数:

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

返回:

反序列化的自身，输出为 serial，是 cls.save(None) 的结果

property named_steps[源代码]#: 将步骤映射到字典。

predict(fh=None, X=None)[源代码]#

在未来预测期预测时间序列。

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

访问自身中的属性

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

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) 进行强制转换。

X以 sktime 兼容格式表示的时间序列, 可选 (默认为 None)

用于预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型 (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，格式相同（见上文）

predict_interval(fh=None, X=None, coverage=0.9)[源代码]#

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

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

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

访问自身中的属性

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

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

X以 sktime 兼容格式表示的时间序列, 可选 (默认为 None)

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

coverage浮点数或包含唯一浮点数值的列表, 可选 (默认为 0.90)

预测区间的标称覆盖率

返回:

pred_intpd.DataFrame

列具有多级索引：第一级是 fit 中使用的 y 的变量名，

第二级是计算区间的覆盖率。: 与输入 coverage 中的顺序相同。

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

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

来自 fit 中使用的 y，如果 fit 中使用的 y 是 Panel 或 Hierarchical。

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

对应于列索引中的 var，在第二列索引中的标称覆盖率，根据第三列索引确定下限/上限，对应于行索引。区间上限/下限预测值等同于在 alpha = 0.5 - c/2 和 0.5 + c/2 处的分位数预测值，其中 c 在 coverage 中。

predict_proba(fh=None, X=None, marginal=True)[源代码]#

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

注意

目前仅对 Series (非面板，非层次化) y 实现。
返回的分布对象需要安装 skpro。

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

访问自身中的属性

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

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

X以 sktime 兼容格式表示的时间序列, 可选 (默认为 None)

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

marginal布尔值, 可选 (默认为 True)

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

返回:

pred_distskpro BaseDistribution: 如果 marginal=True，则为预测分布，如果 marginal=False 且由方法实现，则为每个时间点的边际分布，否则为联合分布。

predict_quantiles(fh=None, X=None, alpha=None)[源代码]#

计算/返回分位数预测。

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

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

访问自身中的属性

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

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

X以 sktime 兼容格式表示的时间序列, 可选 (默认为 None)

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

alpha浮点数或包含唯一浮点数值的列表, 可选 (默认为 [0.05, 0.95])

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

返回:

quantilespd.DataFrame

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

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.cutoff, self._is_fitted
写入 self: 无。

参数:

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

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

如果为 None，则使用目前已见的 y (self._y)，特别是

如果前面只有一个 fit 调用，则生成样本内残差
如果 fit 需要 fh，它必须指向 fit 中 y 的索引

X以 sktime 兼容格式表示的时间序列, 可选 (默认为 None)

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

返回:

y_res以 sktime 兼容数据容器格式表示的时间序列: 在 fh 处的预测残差，与 fh 具有相同的索引。y_res 与最近传入的 y 具有相同的类型：Series, Panel, Hierarchical 科学类型，格式相同 (见上文)

predict_var(fh=None, X=None, cov=False)[源代码]#

计算/返回方差预测。

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

访问自身中的属性

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

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

X以 sktime 兼容格式表示的时间序列, 可选 (默认为 None)

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

cov布尔值, 可选 (默认为 False)

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

返回:

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

If cov=False

列名与 fit/update 中传入的 y 完全相同。: 对于无名的格式，列索引将是 RangeIndex。
行索引是 fh，附加级别等于实例级别，: 来自 fit 中使用的 y，如果 fit 中使用的 y 是 Panel 或 Hierarchical。

条目是方差预测，对应于列索引中的 var。给定变量和 fh 索引的方差预测是一个预测值

给定观测数据，该变量和索引的方差。

If cov=True

列索引是多级索引：第一级是变量名 (同上): 第二级是 fh。
行索引是 fh，附加级别等于实例级别，: 来自 fit 中使用的 y，如果 fit 中使用的 y 是 Panel 或 Hierarchical。
条目是 (协)方差预测，对应于列索引中的 var，以及: 行索引和列索引之间的时间索引的协方差。

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

reset()[源代码]#

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

将 self 设置回构造函数调用后的状态，保留相同的超参数。通过 set_config 设置的配置值也会保留。

调用 reset 会删除所有对象属性，但以下情况除外：

超参数 = 写入 self 的 __init__ 参数，例如 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=None)[源代码]#

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

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

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

参数:

pathNone 或文件位置 (str 或 Path)

如果为 None，自身保存到内存对象；如果为文件位置，自身保存到该文件位置。如果

path=”estimator”，则会在当前工作目录 (cwd) 创建一个 zip 文件 estimator.zip。
path=”/home/stored/estimator”，则一个 zip 文件 estimator.zip 将会

存储在 /home/stored/。

serialization_format: 字符串, 默认为 “pickle”

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

返回:

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

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

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

参数:

ypd.Series, pd.DataFrame, or np.ndarray (1D or 2D): 用于评分的时间序列
fhint、list、可强制转换为 pd.Index 的类型，或 ForecastingHorizon，默认值=None: 编码要预测时间戳的预测期。
Xpd.DataFrame, or 2D np.array, optional (default=None): 用于评分的外生时间序列；如果 self.get_tag(“X-y-must-have-same-index”) 为 True，则 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

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

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

jupyter 内核如何显示实例

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

print_changed_onlybool, default=True

打印时是否只列出与默认值不同的自参数 (False)，或列出所有参数名称和值 (False)。不进行嵌套，即仅影响自身而不影响组件估计器。

warningsstr, “on” (default), or “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={} (no parameters passed)

作为配置传递给并行化后端的附加参数。有效键取决于 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 在并行化后
  关闭。
- “logger_name”：str，默认值为 “ray”；要使用的日志记录器名称。
- “mute_warnings”：bool，默认值为 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自身的引用。

注意

改变对象状态，将 config_dict 中的配置复制到 self._config_dynamic。

set_params(**kwargs)[source]#

设置估计器的参数。

有效的参数键可以使用 get_params() 列出。

返回:

self返回自身的一个实例。

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

为对象设置 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 instance or None, default=None

伪随机数生成器，控制随机整数的生成。传递整数以在多次函数调用中获得可重现的输出。

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自身的引用

set_tags(**tag_dict)[source]#

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

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

标签是特定于实例 self 的键值对，它们是静态标志，对象构造后不会更改。它们可用于元数据检查或控制对象的行为。

set_tags 将动态标签覆盖设置为 tag_dict 中指定的值，其中键是标签名称，字典值是要设置的标签值。

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

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

参数:

**tag_dictdict: 标签名称 : 标签值对的字典。

返回:

Self: 自身的引用。

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

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

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

update_params=True：拟合到目前为止观察到的所有数据

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

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

访问自身中的属性

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

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 = 时间序列集合，全局/面板预测。带有 2 级行 MultiIndex（instance，time）的 pd.DataFrame，3D np.ndarray（instance，variable，time），或 Series 类型的 pd.DataFrame 列表
Hierarchical scitype = 分层集合，用于分层预测。带有 3 级或更多级行 MultiIndex（hierarchy_1，...，hierarchy_n，time）的 pd.DataFrame

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

X采用 sktime 兼容格式的时间序列，可选（默认值=None）。

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

update_paramsbool, optional (default=True)

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

返回:

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.cutoff, self.is_fitted

写入自身（除非 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 = 时间序列集合，全局/面板预测。带有 2 级行 MultiIndex（instance，time）的 pd.DataFrame，3D np.ndarray（instance，variable，time），或 Series 类型的 pd.DataFrame 列表
Hierarchical scitype = 分层集合，用于分层预测。带有 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

X以 sktime 兼容格式表示的时间序列, 可选 (默认为 None)

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

update_paramsbool, optional (default=True)

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

reset_forecasterbool, optional (default=True)

如果为 True，则不会改变预测器的状态，即 update/predict 序列使用副本运行，自身的截止日期、模型参数和数据记忆不会改变
如果为 False，则在 update/predict 序列运行时，自身会像直接调用 update/predict 一样进行更新

返回:

y_pred汇总多个分割批次点预测结果的对象

格式取决于总体预测的（截止日期，绝对预测期）对

如果绝对预测点集合唯一：类型是 sktime 兼容数据容器格式的时间序列，输出中省略了截止日期，与最近传递的 y 类型相同：Series、Panel、Hierarchical scitype，格式相同（见上文）
如果绝对预测点集合不唯一：类型是 pandas DataFrame，行和列索引是时间戳，行索引对应于进行预测的截止日期，列索引对应于预测的绝对预测期，条目是列索引从行索引预测的点预测值，如果在该（截止日期，预测期）对没有预测，则条目为 nan

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

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

此方法对于一步完成更新和预测非常有用。

如果未实现估计器特定的 update 方法，默认回退行为是先更新，然后预测。

所需状态: 要求状态为“已拟合”。
访问自身中的属性: 以“_”结尾的已拟合模型属性。指向已见数据的指针：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 = 时间序列集合，全局/面板预测。带有 2 级行 MultiIndex（instance，time）的 pd.DataFrame，3D np.ndarray（instance，variable，time），或 Series 类型的 pd.DataFrame 列表
Hierarchical scitype = 分层集合，用于分层预测。带有 3 级或更多级行 MultiIndex（hierarchy_1，...，hierarchy_n，time）的 pd.DataFrame

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

fhint、list、可强制转换为 pd.Index 的类型，或 ForecastingHorizon，默认值=None

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

X以 sktime 兼容格式表示的时间序列, 可选 (默认为 None)

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

update_paramsbool, optional (default=True)

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

返回:

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