PytorchForecastingNBeats

class PytorchForecastingNBeats(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 NBeats 模型。

参数:

model_paramsdict[str, Any] (默认值=None)

用于初始化 pytorch-forecasting NBeats 模型的参数 [1] 例如：{“num_blocks”: [5, 5], “widths”: [128, 1024]}

dataset_paramsdict[str, Any] (默认值=None)

用于根据 fh 初始化 TimeSeriesDataSet [2] 从 pandas.DataFrame max_prediction_length 将被覆盖 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

获取 NBeats 类的关键字参数。

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 PytorchForecastingNBeats
>>> 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 y data for train and test
>>> y_train, y_test = train_test_split(
...     data["c2"].to_frame(), 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 = PytorchForecastingNBeats(
...     trainer_params={
...         "max_epochs": 5,  # for quick test
...         "limit_train_batches": 10,  # for quick test
...     },
... )
>>> # fit and predict
>>> model.fit(y=y_train, fh=fh) # doctest skip
PytorchForecastingNBeats(trainer_params={'limit_train_batches': 10,
                                        'max_epochs': 5})
>>> y_pred = model.predict(fh, y=y_test)
>>> print(y_test)
                            c2
h0   h1     time
h0_0 h1_180 2000-01-01  6.308914
            2000-01-02  3.471440
            2000-01-03  4.169305
            2000-01-04  5.990554
            2000-01-05  5.611347
...                          ...
h0_4 h1_199 2000-02-10  6.448248
            2000-02-11  4.290731
            2000-02-12  5.494657
            2000-02-13  4.752948
            2000-02-14  5.243385

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

c2

h0 h1 time h0_0 h1_180 2000-02-15 5.167375

2000-02-16 5.178759 2000-02-17 5.251082 2000-02-18 5.331861 2000-02-19 5.372994

… … h0_4 h1_199 2000-02-15 5.005799

2000-02-16 4.998720 2000-02-17 5.031197 2000-02-18 5.081184 2000-02-19 5.113482

[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()	获取自身的配置标志。
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])	将序列化的对象保存到字节类对象或 (.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])	使用新数据更新模型并进行预测。

property algorithm_class

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

property algorithm_parameters: dict

获取 NBeats 类的关键字参数。

返回:

dict

底层算法类的关键字参数

classmethod get_test_params(parameter_set='default')

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

参数:

parameter_set字符串，默认值=”default”

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

返回:

params字典或字典列表，默认值 = {}

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

check_is_fitted(method_name=None)

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError 异常。

参数:

method_name字符串，可选

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

引发:

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 返回一个新对象，而不是像 reset 那样修改 self。

引发:

如果克隆不符合规范，则引发 RuntimeError，原因在于 __init__ 错误。

clone_tags(estimator, tag_names=None)

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

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

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

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

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

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

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

estimator:class:BaseObject 或派生类的实例

参数:

tag_names字符串或字符串列表，默认值 = None

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

self

返回:

self 的引用。

classmethod create_test_instance(parameter_set='default')

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

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

参数:

parameter_set字符串，默认值=”default”

instance具有默认参数的类实例

返回:

classmethod create_test_instances_and_names(parameter_set='default')

objscls 实例列表

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

参数:

parameter_set字符串，默认值=”default”

instance具有默认参数的类实例

返回:

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

names字符串列表，与 objs 长度相同

第 i 个元素是测试中 obj 第 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 被传递，则将 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、列表、可强制转换为 pd.Index 或 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。

selfself 的引用。

返回:

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

在未来预测范围上拟合和预测时间序列。

将 fh 存储到 self.fh。

状态变为“已拟合”。

写入自身

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

• 将 self.is_fitted 标志设置为 True。

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

• 如果 fh 被传递，则将 fh 存储到 self.fh。

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

参数:

fhint、列表、可强制转换为 pd.Index 或 ForecastingHorizon（非可选）

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、列表、可强制转换为 pd.Index 或 ForecastingHorizon，默认值=None

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

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

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

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

selfself 的引用。

用于预测的外生时间序列。如果传递，将在 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 的标签值，并考虑标签覆盖，按以下优先级从高到低排序

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

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

2. 按继承顺序。

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

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

tag_name字符串

参数:

标签值的名称。

tag_value_default任何类型

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

tag_value

返回:

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

classmethod get_class_tags()

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

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

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

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

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

值是对应的标签值，按以下优先级从高到低排序的覆盖

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

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

2. 按继承顺序。

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

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

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

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

collected_tags字典

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

get_config()

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

获取自身的配置标志。

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

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

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

config_dict字典

返回:

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

get_fitted_params(deep=True)

所需状态

获取已拟合的参数。

要求状态为“已拟合”。

deep布尔值，默认值=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__中定义的默认值。

类方法 get_param_names(sort=True)

获取对象的参数名称。

参数:

sort布尔值，默认=True

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

返回:

param_names: list[str]

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

get_params(deep=True)

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

参数:

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

是否返回组件的参数。

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

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

返回:

params键为字符串值的dict

参数字典，paramname : paramvalue 键值对包括

• 总是：此对象的所有参数，如通过get_param_names获取的值是该键的参数值，此对象的值总是与构建时传递的值相同

• 如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

• classmethod get_param_defaults()

get_tag(tag_name, tag_value_default=None, raise_error=True)

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

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

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

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

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

在实例构建时设置的标签。

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

3. 按继承顺序。

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

参数:

标签值的名称。

要检索的标签名称

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 兼容对象都有一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

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

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

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

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

在实例构建时设置的标签。

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

3. 按继承顺序。

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

返回:

collected_tagsdict

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

is_composite()

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

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

返回:

composite: 布尔值

对象的任何参数的值是否为BaseObject的派生实例。

属性 is_fitted

是否已调用过 fit。

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

返回:

布尔值

估计器是否已经过拟合（fit）。

类方法 load_from_path(serial)

从文件位置加载对象。

参数:

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

返回:

反序列化 self 产生的输出位于 path，对应于 cls.save(path)

类方法 load_from_serial(serial)

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

参数:

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

返回:

反序列化 self 产生的输出是 serial，对应于 cls.save(None)

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

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

要求状态为“已拟合”。

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

访问self中的内容

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

• self.cutoff, self.is_fitted

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

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

参数:

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

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

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

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

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

应被预测的时间序列的历史值。如果不为None，将执行全局预测。只传递历史值，不传递要预测的时间点。

返回:

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

classmethod get_class_tag(tag_name, tag_value_default=None)

注意

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

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

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

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

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

要求状态为“已拟合”。

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

访问self中的内容

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

• self.cutoff, self.is_fitted

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

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

参数:

fhint, list, np.array 或 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索引引用。如果传递了y（执行全局预测），则X必须包含所有历史值和要预测的时间点。

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

预测区间的标称覆盖率

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

应被预测的时间序列的历史值。如果不为None，将执行全局预测。只传递历史值，不传递要预测的时间点。

返回:

pred_intpd.DataFrame

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

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

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

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

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

来自fit中看到的y（如果fit中看到的y是Panel或Hierarchical类型）。

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

对于列索引中的变量，在第二列索引中的标称覆盖率下，取决于第三列索引的lower/upper，针对行索引。区间上限/下限预测等同于对于覆盖率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（非panel，非hierarchical）y实现。

要求状态为“已拟合”。

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

访问self中的内容

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

• self.cutoff, self.is_fitted

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

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

参数:

fhint, list, np.array 或 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索引引用。如果传递了y（执行全局预测），则X必须包含所有历史值和要预测的时间点。

marginal布尔值，可选（默认=True）

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

y符合sktime格式的时间序列，可选（默认=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是可迭代的，将计算多个分位数。

要求状态为“已拟合”。

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

访问self中的内容

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

• self.cutoff, self.is_fitted

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

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

参数:

fhint, list, np.array 或 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索引引用。如果传递了y（执行全局预测），则X必须包含所有历史值和要预测的时间点。

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

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

y符合sktime格式的时间序列，可选（默认=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，则将在fh为range(len(y.shape[0]))时计算残差。

要求状态为“已拟合”。

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

访问self中的内容

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

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

无。

参数:

fhint、列表、可强制转换为 pd.Index 或 ForecastingHorizon（非可选）

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

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

• 如果之前只调用了一次fit，则产生样本内残差

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

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

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

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

计算/返回方差预测。

要求状态为“已拟合”。

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

访问self中的内容

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

• self.cutoff, self.is_fitted

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

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

参数:

fhint, list, np.array 或 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索引引用。

cov布尔值，可选（默认=False）

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

y符合sktime格式的时间序列，可选（默认=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')

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

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

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

参数:

pathNone 或 文件位置 (str 或 Path)

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

• path=”estimator”，则会在当前工作目录创建zip文件estimator.zip。

• path=”/home/stored/estimator”，则会在

存储在/home/stored/中。

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)

要评分的时间序列

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

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

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 类属性以及来自 _onfig_dynamic 对象属性的任何覆盖和新标签收集。

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

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

jupyter kernel如何显示self的实例

• “diagram” = html框图表示

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

print_changed_only布尔值，默认=True

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

warningsstr, “on”（默认）或 “off”

是否引发警告，只影响sktime的警告

• “on” = 将引发sktime的警告

• “off” = 将不会引发sktime的警告

backend:parallelstr，可选，默认=”None”

广播/向量化时用于并行化的后端，以下之一：

• “None”：按顺序执行循环，简单的列表推导式

• “loky”、“multiprocessing”和“threading”：使用joblib.Parallel

• “joblib”：自定义和第三方joblib后端，例如spark

• “dask”：使用dask，需要环境中安装dask包

• “ray”：使用ray，需要环境中安装ray包

backend:parallel:paramsdict，可选，默认={}（不传递参数）

作为配置传递给并行化后端的附加参数。有效键取决于backend:parallel的值。

• “None”：无附加参数，backend_params被忽略

• “loky”、“multiprocessing”和“threading”：默认joblib后端；此处可以传递joblib.Parallel的任何有效键，例如n_jobs，但backend除外，它直接由backend控制。如果未传递n_jobs，则默认为-1，其他参数将默认为joblib默认值。

• “joblib”：自定义和第三方joblib后端，例如spark。此处可以传递joblib.Parallel的任何有效键，例如n_jobs；在这种情况下，backend必须作为backend_params的一个键传递。如果未传递n_jobs，则默认为-1，其他参数将默认为joblib默认值。

• “dask”：可以传递dask.compute的任何有效键，例如scheduler

• “ray”：可以传递以下键：

  • “ray_remote_args”：ray.init的有效键字典

  • “shutdown_ray”：布尔值，默认=True；False阻止ray在并行化后关闭。

    并行化后关闭。

  • “logger_name”：str，默认=”ray”；要使用的logger名称。

  • “mute_warnings”：布尔值，默认=False；如果为True，则禁止警告。

remember_data布尔值，默认=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>。如果引用明确，也可以使用不带<component>__的字符串<parameter>，例如，没有两个组件参数具有相同的名称<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

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

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

是否设置 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)

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

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

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

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

set_tags方法只能在对象的__init__方法中（构建期间）或在通过__init__构建后直接调用。

estimator:class:BaseObject 或派生类的实例

参数:

**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

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

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

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

参数:

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

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

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、列表、可强制转换为 pd.Index 或 ForecastingHorizon，默认值=None

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

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

update_params布尔值，可选（默认=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，则不更新状态。

参数:

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

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

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、列表、可强制转换为 pd.Index 或 ForecastingHorizon，默认值=None

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

例如，SlidingWindowSplitter或ExpandingWindowSplitter；默认 = initial_window=1的ExpandingWindowSplitter，且默认值 = 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_params布尔值，可选（默认=True）

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

reset_forecaster布尔值，可选（默认=True）

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

• 如果为False，当update/predict序列运行时，将像直接调用update/predict一样更新self。

返回:

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。

要求状态为“已拟合”。

deep布尔值，默认值=True

访问self中的内容

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

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

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

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

参数:

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

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

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、列表、可强制转换为 pd.Index 或 ForecastingHorizon，默认值=None

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

编码预测时间点的时间范围。如果在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_params布尔值，可选（默认=True）

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

返回:

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

classmethod get_class_tag(tag_name, tag_value_default=None)