PytorchForecastingNHiTS

class PytorchForecastingNHiTS(model_params: dict[str, Any] | None = None, dataset_params: dict[str, Any] | None = None, train_to_dataloader_params: dict[str, Any] | None = None, validation_to_dataloader_params: dict[str, Any] | None = None, trainer_params: dict[str, Any] | None = None, model_path: str | None = None, random_log_path: bool = False, broadcasting: bool =False)

pytorch-forecasting NHiTS 模型。

参数：

model_paramsdict[str, Any] (默认为 None)

用于初始化 pytorch-forecasting NBeats 模型 [1] 的参数，例如：{“interpolation_mode”: “nearest”, “activation”: “Tanh”}

dataset_paramsdict[str, Any] (默认为 None)

用于从 pandas.DataFrame 初始化 TimeSeriesDataSet [2] 的参数。max_prediction_length 将根据 fh 被覆盖，time_idx, target, group_ids, time_varying_known_reals, time_varying_unknown_reals 将从数据中推断，因此您无需传递它们

train_to_dataloader_paramsdict[str, Any] (默认为 None)

用于传递给 TimeSeriesDataSet.to_dataloader() 的参数，默认为 {“train”: True}

validation_to_dataloader_paramsdict[str, Any] (默认为 None)

用于传递给 TimeSeriesDataSet.to_dataloader() 的参数，默认为 {“train”: False}

model_path: string (默认为 None)

尝试加载现有模型而不进行拟合。仍然需要调用 fit 函数，但不会执行实际的拟合。

random_log_path: bool (默认为 False)

使用随机根目录进行日志记录。此参数用于 Github action 中的 CI 测试，并非为最终用户设计。

属性：

algorithm_class

导入底层的 pytorch-forecasting 算法类。

algorithm_parameters

获取 NHiTS 类的关键字参数。

dict

底层算法类的关键字参数

cutoff

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

fh

传入的预测范围。

is_fitted

是否已调用 fit。

参考资料

[1]

https://pytorch-forecasting.readthedocs.io/en/stable/api/pytorch_forecasting.models.nbeats.NBeats.html

[2]

https://pytorch-forecasting.readthedocs.io/en/stable/api/pytorch_forecasting.data.timeseries.TimeSeriesDataSet.html

示例

>>> # import packages
>>> from sktime.forecasting.base import ForecastingHorizon
>>> from sktime.forecasting.pytorchforecasting import PytorchForecastingNHiTS
>>> from sktime.utils._testing.hierarchical import _make_hierarchical
>>> from sklearn.model_selection import train_test_split
>>> # generate random data
>>> data = _make_hierarchical(
...     hierarchy_levels=(5, 200), max_timepoints=50, min_timepoints=50, n_columns=3
... )
>>> # define forecast horizon
>>> max_prediction_length = 5
>>> fh = ForecastingHorizon(range(1, max_prediction_length + 1), is_relative=True)
>>> # split X, y data for train and test
>>> x = data["c0", "c1"]
>>> y = data["c2"].to_frame()
>>> X_train, X_test, y_train, y_test = train_test_split(
...     x, y, test_size=0.2, train_size=0.8, shuffle=False
... )
>>> len_levels = len(y_test.index.names)
>>> y_test = y_test.groupby(level=list(range(len_levels - 1))).apply(
...     lambda x: x.droplevel(list(range(len_levels - 1))).iloc[:-max_prediction_length]
... )
>>> # define the model
>>> model = PytorchForecastingNHiTS(
...     trainer_params={
...         "max_epochs": 5,  # for quick test
...         "limit_train_batches": 10,  # for quick test
...     },
... )
>>> # fit and predict
>>> model.fit(y=y_train, X=X_train, fh=fh) # doctest skip
PytorchForecastingNHiTS(trainer_params={'limit_train_batches': 10,
                                        'max_epochs': 5})
>>> y_pred = model.predict(fh, X=X_test, y=y_test)
>>> print(y_test)
                            c2
h0   h1     time
h0_0 h1_180 2000-01-01  8.184178
            2000-01-02  5.444128
            2000-01-03  5.992600
            2000-01-04  5.223143
            2000-01-05  6.191883
...                          ...
h0_4 h1_199 2000-02-10  7.498591
            2000-02-11  5.910466
            2000-02-12  7.409602
            2000-02-13  4.670040
            2000-02-14  5.454403

[4500 rows x 1 columns] >>> print(y_pred)

c2

h0 h1 time h0_0 h1_180 2000-02-15 5.764410

2000-02-16 5.826406 2000-02-17 5.925301 2000-02-18 5.792100 2000-02-19 5.760923

... ... h0_4 h1_199 2000-02-15 5.376267

2000-02-16 5.227071 2000-02-17 5.070744 2000-02-18 5.249713 2000-02-19 5.047630

[500 rows x 1 columns]

方法

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([parameter_set])	返回评估器的测试参数设置。
is_composite()	检查对象是否由其他 BaseObjects 组成。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化内存容器加载对象。
predict([fh, X, y])	在未来范围内预测时间序列。
predict_interval([fh, X, coverage, y])	计算/返回预测区间预测。
predict_proba([fh, X, marginal, y])	计算/返回完全概率预测。
predict_quantiles([fh, X, alpha, y])	计算/返回分位数预测。
predict_residuals([y, X])	返回时间序列预测的残差。
predict_var([fh, X, cov, y])	计算/返回方差预测。
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])	使用新数据更新模型并进行预测。

property algorithm_class

导入底层的 pytorch-forecasting 算法类。

property algorithm_parameters: dict

获取 NHiTS 类的关键字参数。

返回：

dict

底层算法类的关键字参数

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 的 self。

等同于构造一个新的 type(self) 实例，其参数为 self，也就是说，type(self)(**self.get_params(deep=False))。

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

在值上也等同于调用 self.reset，但例外是 clone 返回一个新对象，而不是修改 self。

引发：

如果由于有缺陷的 __init__，则克隆不符合要求，引发 RuntimeError。

clone_tags(estimator, tag_names=None)

将另一个对象的标签克隆为动态覆盖。

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

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

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

方法应仅在对象的 __init__ 方法中调用，在构造期间，或在 __init__ 之后立即调用。

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

tag_names 的默认值（None）会将 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 个元素是测试中第 i 个 obj 实例的名称。命名约定是 {cls.__name__}-{i} 如果实例多于一个，否则为 {cls.__name__}

property cutoff

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

返回：

cutoffpandas 兼容索引元素，或 None

pandas 兼容索引元素，如果 cutoff 已设置；否则为 None

property fh

传入的预测范围。

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

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

状态更改

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

写入 self

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

• 设置 self.is_fitted 标志为 True。

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

• 存储 fh 到 self.fh 如果 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")，则 X.index 必须包含 y.index。

返回：

self引用 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) 相同。

状态更改

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

写入 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 （不可选）

表示要预测的时间戳的预测范围。

如果 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_pred时间序列，采用 sktime 兼容格式，可选（默认为 None）

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

返回：

y_pred时间序列，采用 sktime 兼容数据容器格式

在 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任意类型，可选；默认为 None

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

返回：

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 设置的动态标签覆盖。

collected_tagsdict

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

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

get_config()

获取 self 的配置标志。

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_params键为字符串的字典

拟合参数字典，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 此对象的参数名称 : 值 的字典，但不包括组件的参数。

返回：

params键为字符串的字典

参数字典，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_error布尔值

是否在未找到标签时引发 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()

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

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

返回：

composite: bool

对象是否有任何参数，其值是 BaseObject 的子类实例。

property is_fitted

是否已调用 fit。

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

返回：

bool

估计器是否已 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数：

serialresult of ZipFile(path).open(“object)

返回：

反序列化后的 self，其结果位于 path，是 cls.save(path) 的输出。

classmethod load_from_serial(serial)

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

参数：

serial1st element of output of cls.save(None)

返回：

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

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

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

所需状态

要求状态为“fitted”，即 self.is_fitted=True。

访问 self 中的

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

• self.cutoff, self.is_fitted

写入 self

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

参数：

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

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

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

用于预测的外生时间序列。应与 fit 中的 y 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。如果未传入 y（未执行全局预测），X 应仅包含要预测的时间点。如果传入 y（执行全局预测），X 必须包含所有历史值和要预测的时间点。

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

应预测的时间序列的历史值。如果不是 None，将执行全局预测。仅传入历史值，不传入要预测的时间点。

返回：

y_pred时间序列，采用 sktime 兼容数据容器格式

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

注意

如果 y 不是 None，将执行全局预测。在全局预测模式下，X 应包含所有历史值和要预测的时间点，而 y 应仅包含历史值，不包含要预测的时间点。

如果 y 是 None，将执行非全局预测。在非全局预测模式下，X 应仅包含要预测的时间点，而 y 应仅包含历史值，不包含要预测的时间点。

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

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

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

所需状态

要求状态为“fitted”，即 self.is_fitted=True。

访问 self 中的

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

• self.cutoff, self.is_fitted

写入 self

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

参数：

fhint, list, np.array 或 ForecastingHorizon，可选（默认=None）

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

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

用于预测的外生时间序列。应与 fit 中的 y 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。如果传入 y（执行全局预测），X 必须包含所有历史值和要预测的时间点。

coveragefloat 或唯一 float 值的列表，可选（默认=0.90）

预测区间(s)的名义覆盖率(s)

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

应预测的时间序列的历史值。如果不是 None，将执行全局预测。仅传入历史值，不传入要预测的时间点。

返回：

pred_intpd.DataFrame

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

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

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

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

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

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

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

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

注意

如果 y 不是 None，将执行全局预测。在全局预测模式下，X 应包含所有历史值和要预测的时间点，而 y 应仅包含历史值，不包含要预测的时间点。

如果 y 是 None，将执行非全局预测。在非全局预测模式下，X 应仅包含要预测的时间点，而 y 应仅包含历史值，不包含要预测的时间点。

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

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

注意：目前仅对 Series（非面板，非层级）y 实现。

所需状态

要求状态为“fitted”，即 self.is_fitted=True。

访问 self 中的

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

• self.cutoff, self.is_fitted

写入 self

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

参数：

fhint, list, np.array 或 ForecastingHorizon，可选（默认=None）

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

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

用于预测的外生时间序列。应与 fit 中的 y 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。如果传入 y（执行全局预测），X 必须包含所有历史值和要预测的时间点。

marginalbool，可选（默认=True）

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

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

应预测的时间序列的历史值。如果不是 None，将执行全局预测。仅传入历史值，不传入要预测的时间点。

返回：

pred_distsktime BaseDistribution

如果 marginal=True，则是预测分布；如果 marginal=False 且方法已实现，则将是按时间点的边际分布，否则将是联合分布。

注意

如果 y 不是 None，将执行全局预测。在全局预测模式下，X 应包含所有历史值和要预测的时间点，而 y 应仅包含历史值，不包含要预测的时间点。

如果 y 是 None，将执行非全局预测。在非全局预测模式下，X 应仅包含要预测的时间点，而 y 应仅包含历史值，不包含要预测的时间点。

predict_quantiles(fh=None, X=None, alpha=None, y=None)

计算/返回分位数预测。

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

所需状态

要求状态为“fitted”，即 self.is_fitted=True。

访问 self 中的

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

• self.cutoff, self.is_fitted

写入 self

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

参数：

fhint, list, np.array 或 ForecastingHorizon，可选（默认=None）

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

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

用于预测的外生时间序列。应与 fit 中的 y 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。如果传入 y（执行全局预测），X 必须包含所有历史值和要预测的时间点。

alphafloat 或唯一 float 值的列表，可选（默认=[0.05, 0.95]）

一个概率或概率列表，用于计算分位数预测。

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

应预测的时间序列的历史值。如果不是 None，将执行全局预测。仅传入历史值，不传入要预测的时间点。

返回：

quantilespd.DataFrame

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

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

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

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

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

在第二级列索引中的分位数概率下，对应于行索引。

注意

如果 y 不是 None，将执行全局预测。在全局预测模式下，X 应包含所有历史值和要预测的时间点，而 y 应仅包含历史值，不包含要预测的时间点。

如果 y 是 None，将执行非全局预测。在非全局预测模式下，X 应仅包含要预测的时间点，而 y 应仅包含历史值，不包含要预测的时间点。

predict_residuals(y=None, X=None)

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

将计算在 y.index 处的预测的残差。

如果必须在 fit 中传入 fh，则必须与 y.index 一致。如果 y 是一个 np.ndarray，并且在 fit 中没有传入 fh，则将在 range(len(y.shape[0])) 的 fh 处计算残差。

所需状态

要求状态为“fitted”。如果已设置 fh，则必须与 y 的索引（pandas 或整数）对应。

访问 self 中的

以“_”结尾的拟合模型属性。self.cutoff, self._is_fitted

写入 self

无。

参数：

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

具有真实观测值的时间序列，用于计算残差。必须与 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") 为 True，则 X.index 必须同时包含 fh 索引引用和 y.index。

返回：

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

在 fh`, with same index as ``fh 处的预测残差，与 fh 具有相同的索引。y_res 的类型与最近传入的 y 的类型相同：Series、Panel、Hierarchical scitype，格式相同（见上文）。

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

计算/返回方差预测。

所需状态

要求状态为“fitted”，即 self.is_fitted=True。

访问 self 中的

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

• self.cutoff, self.is_fitted

写入 self

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

参数：

fhint, list, np.array 或 ForecastingHorizon，可选（默认=None）

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

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

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

covbool，可选（默认=False）

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

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

应预测的时间序列的历史值。如果不是 None，将执行全局预测。仅传入历史值，不传入要预测的时间点。

返回：

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。

条目是（协）方差预测，对于列索引中的变量，以及

行和列中的时间索引之间的协方差。

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

注意

如果 y 不是 None，将执行全局预测。在全局预测模式下，X 应包含所有历史值和要预测的时间点，而 y 应仅包含历史值，不包含要预测的时间点。

如果 y 是 None，将执行非全局预测。在非全局预测模式下，X 应仅包含要预测的时间点，而 y 应仅包含历史值，不包含要预测的时间点。

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

将序列化的 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” 则 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)

用于评分的时间序列

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

返回：

scorefloat

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

另请参阅

sktime.performance_metrics.forecasting.mean_absolute_percentage_error

set_config(**config_dict)

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

参数：

config_dictdict

配置名 : 配置值 对的字典。下面列出了有效的配置、值及其含义

displaystr，“diagram”（默认），或“text”

jupyter 内核如何显示 self 的实例

• “diagram” = html 盒状图表示

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

print_changed_onlybool，默认=True

打印 self 时，是仅列出与默认值不同的 self 参数 (True)，还是列出所有参数名和值 (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

    在并行化后关闭。

  • “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')

为 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，可选值之一：{“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：仅更新 cutoff 并记住数据

所需状态

要求状态为“fitted”，即 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 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 y.index。

update_paramsbool，可选（默认=True）

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

返回：

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：仅更新 cutoff 并记住数据

所需状态

要求状态为“fitted”，即 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；默认值 = 带有 initial_window=1 的 ExpandingWindowSplitter，并且默认值 = 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") 为 True，则 X.index 必须包含 fh 索引引用。

update_paramsbool，可选（默认=True）

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

reset_forecasterbool，可选（默认=True）

• 如果为 True，则不会改变预测器的状态，即 update/predict 序列会使用一个副本运行，并且 self 的 cutoff、模型参数、数据内存不会改变

• 如果为 False，则在运行 update/predict 序列时会更新 self，如同直接调用 update/predict 一样

返回：

y_pred一个对象，用于制表来自多个分割批次的点预测

格式取决于整体预测的 (cutoff, absolute horizon) 对

• 如果 absolute horizon 点的集合是唯一的：类型是 sktime 兼容数据容器格式的时间序列，输出中隐藏 cutoff，类型与最近传入的 y 相同：Series, Panel, Hierarchical scitype，格式相同（见上文）

• 如果 absolute horizon 点的集合不唯一：类型是 pandas DataFrame，行和列索引是时间戳。行索引对应于从中预测的 cutoff，列索引对应于预测的 absolute horizon。条目是根据行索引预测的列索引的点预测。如果在该 (cutoff, horizon) 对没有进行预测，则条目为 nan。

update_predict_single(y=None, fh=None, X=None, update_params=True)

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

此方法对于在单个步骤中更新和进行预测很有用。

如果没有实现特定于估计器的 update 方法，默认的后备行为是先更新，然后预测。

所需状态

要求状态为“已拟合”。

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

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

update_paramsbool，可选（默认=True）

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

返回：

y_pred时间序列，采用 sktime 兼容数据容器格式

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