SCINetForecaster#

class SCINetForecaster(seq_len, *, num_epochs=16, batch_size=8, criterion=None, criterion_kwargs=None, optimizer=None, optimizer_kwargs=None, lr=0.001, custom_dataset_train=None, custom_dataset_pred=None, hid_size=1, num_stacks=1, num_levels=3, num_decoder_layer=1, concat_len=0, groups=1, kernel=5, dropout=0.5, single_step_output_One=0, positionalE=False, modified=True, RIN=False)[source]#

SCINet 预测器。

SCINet 预测器的实现，由 Minhao Liu* 撰写 [1]。

核心逻辑直接复制自 curelab SCINet 实现 [2]，不幸的是该实现无法作为包使用。

参数：
seq_lenint

输入序列的长度。确保 seq_len 可以被 2^num_levels 整除。

num_epochsint, 默认值=16

训练模型的 epoch 数量。

batch_sizeint, 默认值=8

每个批次中的训练样本数量。

criteriontorch.nn Loss Function, 默认值=None

用于训练的损失函数。如果未提供，通常使用默认值，例如 torch.nn.MSELoss。

criterion_kwargsdict, 默认值=None

传递给 criterion (损失函数) 的关键字参数。

optimizertorch.optim.Optimizer, 默认值=None

用于训练的优化器。如果未提供，通常使用默认值，例如 torch.optim.Adam。

optimizer_kwargsdict, 默认值=None

传递给优化器的关键字参数。

lrfloat, 默认值=0.001

优化器的学习率。

custom_dataset_trainDataset, 默认值=None

用于训练的自定义数据集。如果未提供，则使用默认数据集结构。

custom_dataset_predDataset, 默认值=None

用于预测的自定义数据集。

hid_sizeint, 默认值=1

模型中隐藏层的大小。

num_stacksint, 默认值=1

模型中使用的 SCINet 栈数量。

num_levelsint, 默认值=3

每个栈的层数（深度）。

num_decoder_layerint, 默认值=1

模型中解码器部分的层数。

concat_lenint, 默认值=0

跳跃连接中要拼接的输入长度。

groupsint, 默认值=1

分组卷积中卷积层的分组数量。

kernelint, 默认值=5

卷积层的核大小。

dropoutfloat, 默认值=0.5

应用于网络中的 dropout 比率。

single_step_output_Oneint, 默认值=0

确定是输出单步 (1) 还是多步 (0)。

positionalEbool, 默认值=False

启用或禁用位置编码的使用。

modifiedbool, 默认值=True

指示是否使用修改版本的 SCINet 模型。

RINbool, 默认值=False

启用或禁用 RevIN (可逆实例归一化) 的标志。

属性：
cutoff

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

fh

已传入的预测范围。

is_fitted

是否已调用 fit。

抛出：
AssertionError

如果 seq_len 不能被 2^num_levels 整除。

参考文献

[1]

Minhao Liu*, Ailing Zeng, Muxi Chen, Zhijian Xu, Qiuxia Lai,

Lingna Ma, Qiang Xu* SCINet: 时间序列建模和预测与样本卷积和交互

示例

>>> from sktime.forecasting.scinet import SCINetForecaster 
>>> from sktime.datasets import load_airline 
>>> model = SCINetForecaster(seq_len=8) 
>>> y = load_airline() 
>>> model.fit(y, fh=[1, 2, 3]) 
SCINetForecaster(seq_len=8)
>>> y_pred = model.predict() 
>>> y_pred 
1961-01    759.448425
1961-02    291.098541
1961-03    566.977295
Freq: M, Name: Number of airline passengers, dtype: float32

方法

build_pytorch_pred_dataloader(y, fh)

构建用于预测的 PyTorch DataLoader。

build_pytorch_train_dataloader(y)

构建用于训练的 PyTorch DataLoader。

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

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

get_y_true(y)

获取用于验证的 y_true 值。

is_composite()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict([fh, X])

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

predict_interval([fh, X, coverage])

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

predict_proba([fh, X, marginal])

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

predict_quantiles([fh, X, alpha])

计算/返回分位数预测。

predict_residuals([y, X])

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

predict_var([fh, X, cov])

计算/返回方差预测。

reset()

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

save([path, serialization_format])

将序列化对象保存到字节对象或 (.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')[source]#

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

参数：
parameter_setstr, 默认值=”default”

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

返回：
paramsdict or list of dict
build_pytorch_pred_dataloader(y, fh)[source]#

构建用于预测的 PyTorch DataLoader。

build_pytorch_train_dataloader(y)[source]#

构建用于训练的 PyTorch DataLoader。

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则抛出 NotFittedError。

参数：
method_namestr, optional

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

抛出：
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。

抛出：
如果克隆不符合规范，则抛出 RuntimeError，原因是 __init__ 有误。
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 or list of 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 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

property cutoff[source]#

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

返回：
cutoffpandas 兼容索引元素，或 None

如果设置了截止点，则为 pandas 兼容索引元素；否则为 None。

property fh[source]#

已传入的预测范围。

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

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

状态更改

将状态更改为“fitted”。

写入 self

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

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

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

  • 如果传入了 fh，则将 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 typed 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, or 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) 相同。

状态更改

将状态更改为“fitted”。

写入 self

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

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

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

  • 将 fh 存储到 self.fh。

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

要拟合预测器的时间序列。

sktime 中的单个数据格式称为 mtype 规范，每个 mtype 实现一个抽象 scitype。

  • Series scitype = 单个时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list of Series typed pd.DataFrame

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

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

fhint, list, pd.Index coercible, or ForecastingHorizon (not optional)

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

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

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

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

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

用于预测的外部时间序列。如果传入，将在预测中代替 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 的标签值，考虑标签覆盖，优先级从高到低如下：

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

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

按继承顺序。

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

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

参数：
tag_namestr

标签值的名称。

tag_value_defaultany type

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

返回：
tag_value

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

classmethod get_class_tags()[source]#

从类中获取类标签，并继承父类的标签级别。

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

获取对象的配置标志。

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

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

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

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

返回：
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取已拟合的参数。

所需状态

需要状态为“fitted”。

参数：
deepbool, 默认值=True

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

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

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

返回：
fitted_paramskey 为 str 的 dict

拟合参数字典，key-value 对 paramname : paramvalue 包括

  • 始终：此对象的所有拟合参数，如通过 get_param_names 获取的值为此对象该 key 的拟合参数值

  • 如果 deep=True，还包含组件参数的 key/value 对参数按 [componentname]__[paramname] 索引 componentname 的所有参数都显示为 paramname 及其值

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

classmethod get_param_defaults()[source]#

获取对象的参数默认值。

返回：
default_dict: dict[str, Any]

键是 cls 中在 __init__ 中定义了默认值的所有参数。值是在 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数：
sortbool, 默认值=True

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

返回：
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数：
deepbool, 默认值=True

是否返回组件的参数。

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

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

返回：
paramskey 为 str 的 dict

参数字典，paramname : paramvalue key-value 对包括

  • always: 此对象的所有参数，通过 get_param_names 获取，其值均为该键对应的参数值；此对象的值总是与构造时传入的值相同

  • 如果 deep=True，还包含组件参数的 key/value 对参数按 [componentname]__[paramname] 索引 componentname 的所有参数都显示为 paramname 及其值

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

get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

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

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

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

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

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

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

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

  2. 在父类的 _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()[source]#

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

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

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

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

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

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

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

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

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

按继承顺序。

返回：
collected_tags字典

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

get_y_true(y)[source]#

获取用于验证的 y_true 值。

is_composite()[source]#

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

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

返回：
composite: 布尔值

对象是否包含值是 BaseObject 后代实例的参数。

property is_fitted[source]#

是否已调用 fit。

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

返回：
布尔值

评估器是否已 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数：
serialZipFile(path).open("object") 的结果
返回：
反序列化的 self，其结果是 cls.save(path) 在 path 处产生的输出
classmethod load_from_serial(serial)[source]#

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

参数：
serialcls.save(None) 输出的第一个元素
返回：
反序列化的 self，其结果是 cls.save(None) 产生的输出 serial
predict(fh=None, X=None)[source]#

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

所需状态

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

访问 self 中的

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

  • self.cutoff, self.is_fitted

写入 self

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

参数：
fhint, list, pd.Index 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)[source]#

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

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

所需状态

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

访问 self 中的

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

  • self.cutoff, self.is_fitted

写入 self

如果传递了 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 索引参考。

coverage浮点数或浮点数列表（唯一值），可选（默认=0.90）

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

返回：
pred_intpd.DataFrame
列具有多重索引：第一层是 fit 中 y 的变量名，
第二层是计算区间所对应的覆盖分数，

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

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

行索引是 fh，如果 fit 中看到的 y 是 Panel 或 Hierarchical，则具有额外的（上层）级别等于实例级别。

来自 fit 中看到的 y。

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

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

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

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

注意

  • 目前仅针对 Series（非 Panel，非 Hierarchical）y 实现。

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

所需状态

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

访问 self 中的

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

  • self.cutoff, self.is_fitted

写入 self

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

参数：
fhint, list, pd.Index 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 索引参考。

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

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

返回：
pred_distskpro BaseDistribution

如果 marginal=True，则为预测分布；如果 marginal=False 且方法已实现，则为按时间点的边缘分布；如果 marginal=False 且方法已实现，则为联合分布

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

计算/返回分位数预测。

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

所需状态

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

访问 self 中的

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

  • self.cutoff, self.is_fitted

写入 self

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

参数：
fhint, list, pd.Index 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 索引参考。

alpha浮点数或浮点数列表（唯一值），可选（默认=[0.05, 0.95]）

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

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

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

行索引是 fh，如果 fit 中看到的 y 是 Panel 或 Hierarchical，则具有额外的（上层）级别等于实例级别。

来自 fit 中看到的 y。

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

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

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

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

残差将根据 y.index 处的预测值计算。

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

所需状态

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

访问 self 中的

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

写入 self

无。

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

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

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

  • 如果前面只有一个 fit 调用，则生成样本内残差

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

Xsktime 兼容格式的时间序列，可选（默认=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)[source]#

计算/返回方差预测。

所需状态

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

访问 self 中的

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

  • self.cutoff, self.is_fitted

写入 self

如果传递了 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 索引参考。

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

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

返回：
pred_varpd.DataFrame，格式取决于 cov 变量
如果 cov=False
列名与在 fit/update 中传入的 y 的列名完全相同。

对于无名格式，列索引将是 RangeIndex。

行索引是 fh，并带有等于实例级别的额外级别，

来自 fit 中看到的 y。

来自在 fit 中看到的 y 的级别。条目是方差预测值，对应于列索引中的变量。

给定变量和 fh 索引的方差预测值是该变量和索引在给定观测数据下的预测方差。

如果 cov=True
列索引是多重索引：第一级是变量名（如上）

第二级是 fh。

行索引是 fh，并带有等于实例级别的额外级别，

来自 fit 中看到的 y。

条目是（协）方差预测值，对应于列索引中的变量，并且

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

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

reset()[source]#

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

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

reset 调用会删除所有对象属性，除了

  • 超参数 = __init__ 的参数，写入到 self，例如，self.paramname，其中 paramname 是 __init__ 的参数。

  • 包含双下划线的对象属性，即包含字符串 "__"。例如，名为 "__myattr" 的属性会被保留。

  • 配置属性，配置将保持不变。也就是说，在 reset 之前和之后 get_config 的结果是相等的。

类和对象方法以及类属性也不会受到影响。

等同于 clone，不同之处在于 reset 会改变 self 而不是返回一个新对象。

调用 self.reset() 后，self 在值和状态上等于调用构造函数 type(self)(**self.get_params(deep=False)) 后获得的对象。

返回：
self

将类实例重置为干净的初始化后状态，但保留当前的超参数值。

save(path=None, serialization_format='pickle')[source]#

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

行为：如果 path 为 None，则返回序列化的 in-memory 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"，则 zip 文件 estimator.zip 将存储在

/home/stored/ 中。

serialization_format: str，默认 = "pickle"

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

返回：
如果 path 为 None - 内存中的序列化 self
如果 path 为文件位置 - 引用该文件的 ZipFile
score(y, X=None, fh=None)[source]#

使用 MAPE（非对称）评估预测与真实值之间的分数。

参数：
ypd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D)

要评分的时间序列

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

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

Xpd.DataFrame，或 2D np.array，可选（默认=None）

用于评分的外生时间序列，如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 y.index

返回：
score浮点数

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

另请参阅

sktime.performance_metrics.forecasting.mean_absolute_percentage_error
set_config(**config_dict)[source]#

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

参数：
config_dictdict

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

display字符串，"diagram"（默认）或 "text"

Jupyter 内核如何显示 self 的实例

  • "diagram" = HTML 框图表示

  • "text" = 字符串打印输出

print_changed_only布尔值，默认=True

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

warnings字符串，"on"（默认）或 "off"

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

  • "on" = 将发出来自 sktime 的警告

  • "off" = 将不会发出来自 sktime 的警告

backend:parallel字符串，可选，默认="None"

广播/向量化时用于并行处理的后端，可选值包括

  • "None"：顺序执行循环，简单的列表推导

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

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

  • "dask"：使用 dask，需要在环境中安装 dask 包

  • "ray"：使用 ray，需要在环境中安装 ray 包

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

作为配置传递给并行处理后端的附加参数。有效的键取决于 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"：字符串，默认="ray"；要使用的日志记录器名称。

    • "mute_warnings"：布尔值，默认=False；如果为 True，则抑制警告。

remember_data布尔值，默认=True

在 fit 中是否存储 self._X 和 self._y，并在 update 中更新。如果为 True，则存储并更新 self._X 和 self._y。如果为 False，则不存储和更新 self._X 和 self._y。这在使用 save 时可以减小序列化大小，但 update 会默认为“不执行任何操作”，而不是“重新拟合所有已见数据”。

返回：
selfself 的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数：
**params字典

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

返回：
selfself 的引用（设置参数后）
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 实例或 None，默认=None

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

deepbool, 默认值=True

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

  • 如果为 False，则仅设置 self 的 random_state 参数（如果存在）。

  • 如果为 True，则也会设置组件对象中的 random_state 参数。

self_policy字符串，{"copy", "keep", "new"} 之一，默认="copy"

  • "copy" : self.random_state 被设置为输入的 random_state

  • "keep" : self.random_state 保持不变

  • "new" : self.random_state 被设置为新的随机状态，

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

返回：
selfself 的引用
set_tags(**tag_dict)[source]#

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

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

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

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

set_tags 方法应仅在对象的 __init__ 方法中、构造期间或构造后（通过 __init__）直接调用。

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

参数：
**tag_dict字典

标签名称：标签值对的字典。

返回：
Self

对 self 的引用。

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

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

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

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

  • update_params=False：仅更新 cutoff 并记住数据

所需状态

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

访问 self 中的

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

  • self.cutoff, self.is_fitted

写入 self

  • 将 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 typed 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_params布尔值，可选（默认=True）

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

返回：
selfself 的引用
update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#

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

使用基于时间分割器 cv 的数据回放，一步执行多个 update / predict 执行链的简写。

与以下操作相同（如果仅 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 并记住数据

所需状态

需要状态为“已拟合”，即 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 typed 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_params布尔值，可选（默认=True）

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

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

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

  • 如果为 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)[source]#

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

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

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

所需状态

需要状态为“fitted”。

访问 self 中的

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

写入 self

通过附加行更新 self._y 和 self._X 以及 y 和 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 typed 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_params布尔值，可选（默认=True）

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

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

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