SkforecastRecursive

class SkforecastRecursive(regressor: object, lags: int | list | ndarray | range | None = None, window_features: object | list | None = None, transformer_y: object | None = None, transformer_X: object | None = None, weight_func: Callable | None = None, differentiation: int | None = None, fit_kwargs: dict | None = None, binner_kwargs: dict | None = None)

skforecast.recursive.ForecasterRecursive 类的适配器 [1]。

这个类将任何兼容 scikit-learn API 的回归器转换为递归自回归（多步）预测器。

参数：

regressor兼容 scikit-learn API 的回归器或管道

兼容 scikit-learn API 的回归器或管道实例

lagsint, list, numpy ndarray, range, 默认值 None

用作预测变量的滞后项。索引从 1 开始，因此滞后项 1 等于 t-1。

• int: 包括从 1 到 lags（含）的滞后项。

• list, 1d numpy ndarray 或 range: 仅包含 lags 中存在的滞后项，

所有元素必须是 int。- None: 不包含任何滞后项作为预测变量。

window_features对象, list, 默认值 None

用于创建窗口特征的实例或实例列表。窗口特征从原始时间序列创建并作为预测变量包含。此参数旨在与 RollingFeatures 类 [2] 一起使用。

transformer_y对象变换器（预处理器）, 默认值 None

兼容 scikit-learn 预处理 API 的变换器（预处理器）实例，具有方法：fit, transform, fit_transform 和 inverse_transform。ColumnTransformer 不允许使用，因为它们没有 inverse_transform 方法。该变换在训练预测器之前应用于 y。

transformer_X对象变换器（预处理器）, 默认值 None

兼容 scikit-learn 预处理 API 的变换器（预处理器）实例。该变换在训练预测器之前应用于 X。使用 ColumnTransformer 时，inverse_transform 不可用。

weight_funcCallable, 默认值 None

根据索引定义每个样本个体权重的函数。例如，一个函数为某些日期分配较低的权重。如果 regressor 在其 fit 方法中没有 sample_weight 参数，则忽略此参数。结果 sample_weight 不能为负值。

differentiationint, 默认值 None

在训练预测器之前应用于时间序列的差分阶数。如果为 None，则不应用差分。差分阶数是应用于时间序列的差分操作次数。差分涉及计算序列中连续数据点之间的差值。差分在 predict() 和 predict_interval() 的输出中被反转。

fit_kwargsdict, 默认值 None

传递给回归器 fit 方法的附加参数。

binner_kwargsdict, 默认值 None

传递给 QuantileBinner 类 [3] 的附加参数，用于根据与每个残差相关的预测值将残差离散化为 k 个 bin。可用参数有：

• n_bins

• method

• subsample

• random_state

• dtype

参数 method 在内部传递给函数 numpy.percentile。

属性：

cutoff

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

fh

传递的预测范围。

is_fitted

是否已调用 fit。

参考

[1]

https://skforecast.org/latest/api/forecasterrecursive#forecasterrecursive

[2]

https://skforecast.org/0.14.0/api/preprocessing#skforecast.preprocessing.preprocessing.RollingFeatures

[3]

https://skforecast.org/latest/api/preprocessing.html#skforecast.preprocessing.preprocessing.QuantileBinner

示例

>>> from sktime.forecasting.compose import SkforecastRecursive

不带外部特征

>>> from sklearn.linear_model import LinearRegression
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> forecaster = SkforecastRecursive(  
...     LinearRegression(), 2
... )
>>> forecaster.fit(y)  
SkforecastRecursive(lags=2, regressor=LinearRegression())
>>> y_pred = forecaster.predict(fh=[1, 2, 3])  
>>> y_pred_int = forecaster.predict_interval(  
...     fh=[2], coverage=[0.9, 0.95]
... )
>>> y_pred_qtl = forecaster.predict_quantiles(  
...     fh=[1, 3], alpha=[0.8, 0.3, 0.2, 0.7]
... )

带外部特征

>>> from sklearn.ensemble import RandomForestRegressor
>>> from sktime.datasets import load_longley
>>> y, X = load_longley()
>>> y_train = y.head(n=12)
>>> y_test = y.tail(n=4)
>>> X_train = X.head(n=12)
>>> X_test = X.tail(n=4)
>>> forecaster = SkforecastRecursive(  
...     RandomForestRegressor(), [2, 4]
... )
>>> forecaster.fit(y_train, X=X_train)  
SkforecastRecursive(lags=[2, 4], regressor=RandomForestRegressor())
>>> y_pred = forecaster.predict(fh=[1, 2, 3], X=X_test)  
>>> y_pred_int = forecaster.predict_interval(  
...     fh=[1, 3], X=X_test, coverage=[0.6, 0.4]
... )
>>> y_pred_qtl = forecaster.predict_quantiles(  
...     fh=[1, 3], X=X_test, alpha=[0.01, 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()	获取对象的配置标志。
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()	检查对象是否由其他 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(parameter_set='default')

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

参数：

parameter_setstr, 默认值=”default”

要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，则将返回 “default” 集。当前没有为预测器保留的值。

返回：

paramsdict 或 dict 列表, 默认值 = {}

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

check_is_fitted(method_name=None)

检查评估器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数：

method_namestr, 可选

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

引发：

NotFittedError

如果评估器尚未拟合。

clone()

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

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

等效于构造一个新的 type(self) 实例，使用对象的参数，即 type(self)(**self.get_params(deep=False))。

如果对象设置了配置，克隆也将具有与原始对象相同的配置，等效于调用 cloned_self.set_config(**self.get_config())。

其值也等效于调用 self.reset，但例外是 clone 返回一个新对象，而不是像 reset 那样修改对象本身。

引发：

如果由于错误的 __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:class:BaseObject 或派生类的实例

tag_namesstr 或 str 列表, 默认值 = None

要克隆的标签名称。默认值 (None) 克隆来自 estimator 的所有标签。

返回：

self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')

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

参数：

parameter_setstr, 默认值=”default”

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

返回：

instance具有默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')

创建所有测试实例列表及其名称列表。

参数：

parameter_setstr, 默认值=”default”

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

返回：

objscls 实例列表

第 i 个实例是 cls(**cls.get_test_params()[i])

namesstr 列表, 与 objs 长度相同

第 i 个元素是测试中 objs 中第 i 个实例的名称。如果多于一个实例，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}。

property cutoff

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

返回：

cutoffpandas 兼容索引元素, 或 None

pandas 兼容索引元素，如果截止时间已设置；否则为 None

property fh

传递的预测范围。

fit(y, X=None, fh=None)

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

状态改变

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

写入对象

• 设置以“_”结尾的拟合模型属性，拟合属性可通过 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 of Series 类型的 pd.DataFrame

• Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

fhint, list, pd.Index coercible, 或 ForecastingHorizon, 默认值=None

编码要预测时间戳的预测范围。如果 self.get_tag("requires-fh-in-fit") 为 True，则必须在 fit 中传递，不可选

Xsktime 兼容格式的时间序列，可选 (默认值=None)。

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

返回：

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。

参数：

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 of Series 类型的 pd.DataFrame

• Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

fhint, list, pd.Index coercible, 或 ForecastingHorizon (非可选)

编码要预测时间戳的预测范围。

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

Xsktime 兼容格式的时间序列，可选 (默认值=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)

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

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

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

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

1. 类中 _tags 属性中设置的标签。

2. 父类中 _tags 属性中设置的标签，

按继承顺序。

不考虑实例上通过 set_tags 或 clone_tags 设置的动态标签覆盖，这些覆盖是在实例上定义的。

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

参数：

tag_namestr

标签值的名称。

tag_value_default任意类型

如果未找到标签，则使用默认/回退值。

返回：

tag_value

self 中 tag_name 标签的值。如果未找到，返回 tag_value_default。

classmethod get_class_tags()

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

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

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

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

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

值是相应的标签值，覆盖优先级降序如下：

1. 类中 _tags 属性中设置的标签。

2. 父类中 _tags 属性中设置的标签，

按继承顺序。

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

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

不考虑实例上通过 set_tags 或 clone_tags 设置的动态标签覆盖，这些覆盖是在实例上定义的。

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

collected_tagsdict

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

get_config()

获取对象的配置标志。

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

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

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

配置在 clone 或 reset 调用下被保留。

返回：

config_dictdict

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

get_fitted_params(deep=True)

获取拟合的参数。

所需状态

要求状态为“已拟合”。

参数：

deepbool, 默认=True

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

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

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

返回：

fitted_paramsdict，键为 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)

获取对象的参数名称。

参数：

sortbool, 默认=True

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

返回：

param_names: list[str]

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

get_params(deep=True)

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

参数：

deepbool, 默认=True

是否返回组件的参数。

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

• 如果为 False，将返回此对象的参数名称: 值 dict，但不包括组件的参数。

返回：

paramsdict，键为 str 类型

参数字典，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 的单个标签的值，考虑标签覆盖，优先级按降序排列如下

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

在实例构造时设置的。

2. 类中 _tags 属性中设置的标签。

3. 父类中 _tags 属性中设置的标签，

按继承顺序。

参数：

tag_namestr

要检索的标签名称

tag_value_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()

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

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

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

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

值是相应的标签值，覆盖优先级降序如下：

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

在实例构造时设置的。

2. 类中 _tags 属性中设置的标签。

3. 父类中 _tags 属性中设置的标签，

按继承顺序。

返回：

collected_tagsdict

标签名称 : 标签值对字典。通过嵌套继承从 _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，结果是 cls.save(path) 在 path 处的输出

classmethod load_from_serial(serial)

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

参数：

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

返回：

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

predict(fh=None, X=None)

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

所需状态

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

访问 self 中的

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

• self.cutoff, self.is_fitted

写入对象

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

参数：

fhint, list, pd.Index coercible, 或 ForecastingHorizon, 默认值=None

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

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

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

预测中使用的外生时间序列。应与 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，相同格式（见上文）

predict_interval(fh=None, X=None, coverage=0.9)

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

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

所需状态

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

访问 self 中的

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

• self.cutoff, self.is_fitted

写入对象

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

参数：

fhint, list, pd.Index coercible, 或 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 兼容格式的时间序列，可选 (默认=None)

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

coveragefloat 或包含唯一值的 float 列表，可选 (默认=0.90)

预测区间(s) 的标称覆盖率

返回：

pred_intpd.DataFrame

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

第二级是计算区间的覆盖率分数值。

顺序与输入 coverage 中的顺序相同。

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

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

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

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

对应列索引中的变量，第二列索引中的标称覆盖率，第三列索引决定下限/上限，以及行索引。区间上限/下限预测相当于对于 coverage 中的 c，在 alpha = 0.5 - c/2, 0.5 + c/2 处的 quantile 预测。

predict_proba(fh=None, X=None, marginal=True)

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

注意

• 目前仅对 Series (非面板、非层次结构) y 实现。

• 返回的分布对象需要安装 skpro。

所需状态

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

访问 self 中的

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

• self.cutoff, self.is_fitted

写入对象

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

参数：

fhint, list, pd.Index coercible, 或 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 兼容格式的时间序列，可选 (默认=None)

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

marginalbool，可选 (默认=True)

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

返回：

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。

参数：

fhint, list, pd.Index coercible, 或 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 兼容格式的时间序列，可选 (默认=None)

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

alphafloat 或包含唯一值的 float 列表，可选 (默认=[0.05, 0.95])

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

返回：

quantilespd.DataFrame

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

第二级是传递给函数的 alpha 值。

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

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

条目是分位数预测值，对应列索引中的变量，

对应第二列索引中的分位数概率，以及行索引。

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

写入对象

无返回值。

参数：

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

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

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

• 如果之前仅进行了一次 fit 调用，则生成样本内残差

• 如果 fit 需要 fh，它必须指向 fit 中 y 的索引

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

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

predict_var(fh=None, X=None, cov=False)

计算/返回方差预测。

所需状态

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

访问 self 中的

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

• self.cutoff, self.is_fitted

写入对象

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

参数：

fhint, list, pd.Index coercible, 或 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 兼容格式的时间序列，可选 (默认=None)

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

covbool，可选 (默认=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()

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

结果是将 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='pickle')

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

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

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

参数：

pathNone 或文件位置 (str 或 Path)

如果为 None，self 保存到内存对象；如果是文件位置，self 保存到该文件位置。例如，如果

• path=”estimator”，则在当前工作目录 (cwd) 中创建一个 estimator.zip 文件。

• path=”/home/stored/estimator”，则将 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, or np.ndarray (1D or 2D)

用于评分的时间序列

fhint, list, pd.Index coercible, 或 ForecastingHorizon, 默认值=None

编码要预测时间戳的预测范围。

Xpd.DataFrame, or 2D np.array, 可选 (默认=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)

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

参数：

config_dictdict

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

displaystr, “diagram” (默认), or “text”

jupyter kernel 如何显示 self 的实例

• “diagram” = HTML 框图表示

• “text” = 字符串打印输出

print_changed_onlybool, 默认=True

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

warningsstr, “on” (默认), or “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 在

    并行化后关闭。

  • “logger_name”: str, 默认=”ray”；要使用的日志记录器名称。

  • “mute_warnings”: bool, 默认=False；如果为 True，抑制警告

remember_databool, 默认=True

self._X 和 self._y 是否在 fit 中存储，并在 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>。如果引用明确（例如，没有两个组件参数同名为 <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，适用于 self 中的 random_state 参数，并且仅当 deep=True 时适用于其余组件对象。

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

参数：

random_stateint, RandomState 实例或 None, 默认=None

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

deepbool, 默认=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，更新以“_”结尾的已拟合模型属性。

参数：

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 of Series 类型的 pd.DataFrame

• Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

Xsktime 兼容格式的时间序列，可选 (默认值=None)。

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

update_paramsbool，可选 (默认=True)

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

返回：

self引用 self

update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)

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

此方法用于一步执行多个 update / predict 链式操作，数据回放基于时间分割器 cv。

与以下操作相同（如果只有 y, cv 不是默认值）

1. self.update(y=cv.split_series(y)[0][0])

2. 记住 self.predict()（稍后在单个批次中返回）

3. self.update(y=cv.split_series(y)[1][0])

4. 记住 self.predict()（稍后在单个批次中返回）

5. 等等

6. 返回所有记住的预测

如果未实现估计器特定的 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，不更新状态。

参数：

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 of 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 兼容格式的时间序列，可选 (默认=None)

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

update_paramsbool，可选 (默认=True)

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

reset_forecasterbool，可选 (默认=True)

• 如果为 True，将不会改变预测器的状态，即 update/predict 序列在副本上运行，self 的截止点、模型参数、数据内存不会改变

• 如果为 False，则在运行 update/predict 序列时会更新 self，如同直接调用 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)

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

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

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

所需状态

要求状态为“已拟合”。

访问 self 中的

以“_”结尾的已拟合模型属性。指向已见数据的指针，self._y 和 self.X。self.cutoff, self._is_fitted。如果 update_params=True，则还有以“_”结尾的模型属性。

写入对象

通过追加行，用 y 和 X 更新 self._y 和 self._X。将 self.cutoff 和 self._cutoff 更新为 y 中看到的最后一个索引。如果 update_params=True，

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

参数：

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 of Series 类型的 pd.DataFrame

• Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

fhint, list, pd.Index coercible, 或 ForecastingHorizon, 默认值=None

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

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

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

update_paramsbool，可选 (默认=True)

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

返回：

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

在 fh 处的点预测，与 fh 具有相同的索引。y_pred 与最近传递的 y 具有相同的类型：Series, Panel, Hierarchical scitype，相同格式（见上文）