NeuralForecastLSTM

class NeuralForecastLSTM(freq: str | int = 'auto', local_scaler_type: Literal['standard', 'robust','robust-iqr', 'minmax', 'boxcox'] | None = None, futr_exog_list: list[str] | None = None, verbose_fit: bool = False, verbose_predict: bool = False, input_size: int = -1, inference_input_size: int = -1, encoder_n_layers: int = 2, encoder_hidden_size: int = 200, encoder_bias: bool = True, encoder_dropout: float = 0.0, context_size: int = 10, decoder_hidden_size: int = 200, decoder_layers: int = 2, loss=None, valid_loss=None, max_steps: int = 1000, learning_rate: float = 0.001, num_lr_decays: int = -1, early_stop_patience_steps: int = -1, val_check_steps: int = 100, batch_size=32, valid_batch_size: int | None = None, scaler_type: str = 'robust', random_seed=1, num_workers_loader=0, drop_last_loader=False, trainer_kwargs: dict | None = None, optimizer=None, optimizer_kwargs: dict | None = None, broadcasting: bool = False, lr_scheduler=None, lr_scheduler_kwargs: dict | None = None)

NeuralForecast LSTM 模型。

由 Nixtla 开发，通过 neuralforecast.NeuralForecast [2] 封装了 neuralforecast.models.LSTM [1] 模型，该模型来自 neuralforecast 库 [3]。

长短期记忆循环神经网络 (LSTM) 使用多层 LSTM 编码器和 MLP 解码器。

参数:

freqUnion[str, int] (default=”auto”)

数据的频率，请参阅 pandas 中的可用频率 [4]，当在 y 中使用 RangeIndex 时，请使用 int 类型频率

默认值 ("auto") 会从 fit 中的 ForecastingHorizon 解释频率

local_scaler_typestr (default=None)

在拟合之前对每个时间序列的所有特征应用的缩放器，在预测之后会反转该操作

可以是以下之一

• ‘standard’

• ‘robust’

• ‘robust-iqr’

• ‘minmax’

• ‘boxcox’

futr_exog_liststr list, (default=None)

未来外生变量

verbose_fitbool (default=False)

在 fit 过程中打印处理步骤

verbose_predictbool (default=False)

在 predict 过程中打印处理步骤

input_sizeint (default=-1)

用于截断训练反向传播的最大序列长度

默认值 (-1) 使用全部历史数据

inference_input_sizeint (default=-1)

用于截断推理的最大序列长度

默认值 (-1) 使用全部历史数据

encoder_n_layersint (default=2)

LSTM 的层数

encoder_hidden_sizeint (default=200)

LSTM 隐藏状态大小的单元数

encoder_biasbool (default=True)

是否在 LSTM 单元内使用偏置 b_ih, b_hh

encoder_dropoutfloat (default=0.0)

应用于 LSTM 输出的 dropout 正则化

context_sizeint (default=10)

预测窗口上每个时间戳的上下文向量大小

decoder_hidden_sizeint (default=200)

MLP 解码器隐藏层的大小

decoder_layersint (default=2)

MLP 解码器的层数

losspytorch module (default=None)

来自 losses collection [5] 的实例化训练损失函数类

valid_losspytorch module (default=None)

来自 losses collection [5] 的实例化验证损失函数类

max_stepsint (default=1000)

最大训练步数

learning_ratefloat (default=1e-3)

介于 (0, 1) 之间的学习率

num_lr_decaysint (default=-1)

学习率衰减次数，均匀分布在 max_steps 中

early_stop_patience_stepsint (default=-1)

早停之前验证迭代次数

val_check_stepsint (default=100)

每次验证损失检查之间的训练步数

batch_sizeint (default=32)

每个批量中不同时间序列的数量

valid_batch_sizeOptional[int] (default=None)

每个验证和测试批量中不同时间序列的数量

scaler_typestr (default=”robust”)

用于时间输入归一化的缩放器类型

random_seedint (default=1)

用于 pytorch 初始化器和 numpy 生成器的随机种子

num_workers_loaderint (default=0)

TimeSeriesDataLoader 使用的 worker 数

drop_last_loaderbool (default=False)

TimeSeriesDataLoader 是否丢弃最后一个不完整的批量

trainer_kwargsdict (default=None)

继承自 PyTorch Lightning trainer 的关键字 trainer 参数 [6]

optimizerpytorch optimizer (default=None) [7]

用于训练的优化器，如果传递 None 则默认为 Adam

optimizer_kwargsdict (default=None) [8]

传递给用户定义优化器的参数字典

broadcastingbool (default=False)

如果为 True，则为每个时间序列拟合一个模型。面板数据（例如，多索引数据输入）将被广播到单个时间序列，并且对于每个单个时间序列，将应用此预测器的一个副本。

lr_schedulerpytorch learning rate scheduler (default=None) [9]

用户指定的学习率调度器，而不是默认选择 StepLR [10]

lr_scheduler_kwargsdict (default=None)

用户指定的 lr_scheduler 使用的参数列表

属性:

algorithm_class

导入底层的 NeuralForecast 算法类。

algorithm_exogenous_support

设置对外生特征的支持。

algorithm_name

设置自定义模型名称。

algorithm_parameters

获取底层 NeuralForecast 算法类的关键字参数。

dict

底层算法类的关键字参数

cutoff

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

fh

已传递的预测范围。

is_fitted

是否已调用 fit。

注意

• 如果未指定 loss，则使用 MAE 作为训练的损失函数。

• 只有 futr_exog_list 会被视为外生变量。

参考

[1]

https://nixtlaverse.nixtla.io/neuralforecast/models.lstm.html#lstm

[2]

https://nixtlaverse.nixtla.io/neuralforecast/core.html#neuralforecast

[3]

Nixtla/neuralforecast

[4]

https://pandas.ac.cn/pandas-docs/stable/user_guide/timeseries.html#offset-aliases

[5] (1,2)

https://nixtlaverse.nixtla.io/neuralforecast/losses.pytorch.html

[6]

https://lightning.ai/docs/pytorch/stable/api/pytorch_lightning.trainer.trainer.Trainer.html#lightning.pytorch.trainer.trainer.Trainer

[7]

https://pytorch.ac.cn/docs/stable/optim.html

[8]

https://pytorch.ac.cn/docs/stable/optim.html#algorithms

[9]

https://pytorch.ac.cn/docs/stable/generated/torch.optim.lr_scheduler.LRScheduler.html

[10]

https://pytorch.ac.cn/docs/stable/generated/torch.optim.lr_scheduler.StepLR.html

示例

>>>
>>> # importing necessary libraries
>>> from sktime.datasets import load_longley
>>> from sktime.forecasting.neuralforecast import NeuralForecastLSTM
>>> from sktime.split import temporal_train_test_split
>>>
>>> # loading the Longley dataset and splitting it into train and test subsets
>>> y, X = load_longley()
>>> y_train, y_test, X_train, X_test = temporal_train_test_split(y, X, test_size=4)
>>>
>>> # creating model instance configuring the hyperparameters
>>> model = NeuralForecastLSTM(  
...     "A-DEC", futr_exog_list=["ARMED", "POP"], max_steps=5
... )
>>>
>>> # fitting the model
>>> model.fit(y_train, X=X_train, fh=[1, 2, 3, 4])  
Seed set to 1
Epoch 4: 100%|█| 1/1 [00:00<00:00, 42.85it/s, v_num=870, train_loss_step=0.589, train_loss_epoc
NeuralForecastLSTM(freq='A-DEC', futr_exog_list=['ARMED', 'POP'], max_steps=5)
>>>
>>> # getting point predictions
>>> model.predict(X=X_test)  
Predicting DataLoader 0: 100%|██████████████████████████████████| 1/1 [00:00<00:00, 198.64it/s]
1959    64083.226562
1960    64426.304688
1961    64754.886719
1962    64889.496094
Freq: A-DEC, Name: TOTEMP, dtype: float64
>>>

方法

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()	检查对象是否由其他 BaseObject 组成。
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_exogenous_support: bool

设置对外生特征的支持。

property algorithm_name: str

设置自定义模型名称。

property algorithm_class

导入底层的 NeuralForecast 算法类。

property algorithm_parameters: dict

获取底层 NeuralForecast 算法类的关键字参数。

返回:

dict

底层算法类的关键字参数

classmethod get_test_params(parameter_set='default')

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

参数:

parameter_setstr, default=”default”

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

返回:

paramsdict or list of dict, default = {}

check_is_fitted(method_name=None)

检查估计器是否已拟合。

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

如果未拟合，则会引发 NotFittedError。

参数:

method_namestr, optional

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

引发:

NotFittedError

如果估计器尚未拟合。

clone()

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

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

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

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

在值上也等效于调用 self.reset，不同之处在于 clone 返回一个新对象，而不是像 reset 那样修改 self。

引发:

如果克隆不符合规范（由于 __init__ 故障），则引发 RuntimeError。

clone_tags(estimator, tag_names=None)

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

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

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

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

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

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

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

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

参数:

estimatorAn instance of :class:BaseObject or derived class

tag_namesstr or list of str, default = None

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

返回:

self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')

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

参数:

parameter_setstr, default=”default”

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

返回:

instanceinstance of the class with default parameters

classmethod create_test_instances_and_names(parameter_set='default')

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

参数:

parameter_setstr, default=”default”

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

返回:

objslist of instances of cls

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

nameslist of str, same length as objs

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

property cutoff

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

返回:

cutoffpandas compatible index element, or None

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

property fh

已传递的预测范围。

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

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

状态变化

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

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

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

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

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

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

Xsktime 兼容格式的时间序列，可选 (default=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。

参数:

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 的 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) 将其强制转换。

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

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

X_predsktime 兼容格式的时间序列，可选 (default=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 的配置标志。

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

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

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

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

返回:

config_dictdict

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

get_fitted_params(deep=True)

获取已拟合参数。

所需状态

要求状态为“已拟合”。

参数:

deepbool, default=True

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

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

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

返回:

fitted_params键为 str 的 dict

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

• 总是：此对象的所有拟合参数，通过 get_param_names 获取的值是此对象的相应拟合参数值

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

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

classmethod get_param_defaults()

获取对象的参数默认值。

返回:

default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)

获取对象的参数名称。

参数:

sortbool, default=True

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

返回:

param_names: list[str]

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

get_params(deep=True)

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

参数:

deepbool, default=True

是否返回组件的参数。

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

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

返回:

params键为 str 的 dict

参数字典，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任意类型, 可选; 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，结果在 path 处，是 cls.save(path) 的输出

classmethod load_from_serial(serial)

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

参数:

serial cls.save(None) 输出的第1个元素

返回:

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

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

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

所需状态

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

访问 self 中的

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

• self.cutoff, self.is_fitted

写入 self

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

参数:

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

预测时刻的时间戳的预测 horizon。如果已在 fit 中传入，则不应再次传入。如果在 fit 中未传入，则必须传入，不是可选的。

Xsktime 兼容格式的时间序列, 可选 (default=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 兼容格式的时间序列, 可选 (default=None)

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

返回:

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

在 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 是可迭代的，将计算多个区间。

所需状态

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

访问 self 中的

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

• self.cutoff, self.is_fitted

写入 self

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

参数:

fhint, list, np.array 或 ForecastingHorizon, 可选 (default=None)

预测时刻的时间戳的预测 horizon。如果已在 fit 中传入，则不应再次传入。如果在 fit 中未传入，则必须传入，不是可选的。

Xsktime 兼容格式的时间序列, 可选 (default=None)

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

coveragefloat 或 unique values float list, 可选 (default=0.90)

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

ysktime 兼容格式的时间序列, 可选 (default=None)

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

返回:

pred_intpd.DataFrame

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

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

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

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

行索引是 fh，如果 fit 中 y 是 Panel 或 Hierarchical，则附加 (upper) 级别等于实例级别。

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

对于列索引中的变量，在第二列索引中的名义覆盖率下，下限/上限取决于第三列索引，对于行索引。下限/上限区间预测等同于对于 coverage 中的 c，在 alpha = 0.5 - c/2, 0.5 + c/2 处的 quantile 预测。

Upper/lower interval end forecasts are equivalent to quantile forecasts at alpha = 0.5 - c/2, 0.5 + c/2 for c in coverage.

注意

如果 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

写入 self

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

参数:

fhint, list, np.array 或 ForecastingHorizon, 可选 (default=None)

预测时刻的时间戳的预测 horizon。如果已在 fit 中传入，则不应再次传入。如果在 fit 中未传入，则必须传入，不是可选的。

Xsktime 兼容格式的时间序列, 可选 (default=None)

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

marginalbool, optional (default=True)

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

ysktime 兼容格式的时间序列, 可选 (default=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

写入 self

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

参数:

fhint, list, np.array 或 ForecastingHorizon, 可选 (default=None)

预测时刻的时间戳的预测 horizon。如果已在 fit 中传入，则不应再次传入。如果在 fit 中未传入，则必须传入，不是可选的。

Xsktime 兼容格式的时间序列, 可选 (default=None)

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

alphafloat 或 unique values float list, optional (default=[0.05, 0.95])

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

ysktime 兼容格式的时间序列, 可选 (default=None)

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

返回:

quantilespd.DataFrame

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

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

行索引是 fh，如果 fit 中 y 是 Panel 或 Hierarchical，则附加 (upper) 级别等于实例级别。

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

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

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

注意

如果 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，残差将计算在 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 兼容格式的时间序列, 可选 (default=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, y=None)

计算/返回方差预测结果。

所需状态

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

访问 self 中的

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

• self.cutoff, self.is_fitted

写入 self

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

参数:

fhint, list, np.array 或 ForecastingHorizon, 可选 (default=None)

预测时刻的时间戳的预测 horizon。如果已在 fit 中传入，则不应再次传入。如果在 fit 中未传入，则必须传入，不是可选的。

Xsktime 兼容格式的时间序列, 可选 (default=None)

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

covbool, optional (default=False)

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

ysktime 兼容格式的时间序列, 可选 (default=None)

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

返回:

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

如果 cov=False

列名与 fit/update 中传入的 y 的列名完全相同。

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

行索引是 fh，如果 fit 中 y 是 Panel 或 Hierarchical，则附加级别等于实例级别。

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

条目是方差预测，对于列索引中的变量。给定变量和 fh 索引的方差预测是该变量和索引的预测

方差，给定观测数据。

如果 cov=True

列索引是多级索引：第一级是变量名（如上）

第二级是 fh。

行索引是 fh，如果 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"，则会在当前工作目录生成一个 zip 文件 estimator.zip。

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

中存储一个 zip 文件 estimator.zip。

serialization_format: str, default = “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, default=None

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

Xpd.DataFrame, 或 2D np.array, 可选 (default=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” (default), 或 “text”

jupyter kernel 如何显示 self 的实例

• “diagram” = html 框图表示

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

print_changed_onlybool, default=True

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

warningsstr, “on” (default), 或 “off”

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

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

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

backend:parallelstr, optional, default=”None”

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

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

• “loky”, “multiprocessing” 和 “threading”: 使用 joblib.Parallel

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

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

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

backend:parallel:paramsdict, optional, default={} (未传入参数)

作为配置传递给并行化后端的附加参数。有效键取决于 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, default=True; False 防止 ray 在并行化后关闭。

    “logger_name”: str, default=”ray”; 要使用的 logger 名称。

  • “mute_warnings”: bool, default=False; 如果为 True，则抑制警告。

  • “mute_warnings”: bool, default=False; if True, suppresses warnings

remember_databool, default=True

是否在 fit 中存储 self._X 和 self._y，并在 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')

设置 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 将重置任何 skikit-base 对象，即使是那些没有 random_state 参数的对象。

参数:

random_stateint, RandomState instance 或 None, default=None

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

deepbool, default=True

是否在 skbase 对象类型参数（即组件估计器）中设置随机状态。

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

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

self_policystr, one of {“copy”, “keep”, “new”}, default=”copy”

• “copy”: self.random_state 设置为输入的 random_state

• “keep”: self.random_state 保持不变

• “new”: self.random_state 设置为一个新的随机状态，

派生自输入的 random_state，通常与之不同。

返回:

self对 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_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 的 Series 类型 pd.DataFrame

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

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

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

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

update_paramsbool, optional (default=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_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 的 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 兼容格式的时间序列, 可选 (default=None)

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

update_paramsbool, optional (default=True)

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

reset_forecasterbool, optional (default=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，行和列索引均为时间戳，行索引对应于预测所使用的 cutoffs，列索引对应于预测的 absolute horizons，条目是列索引从行索引预测的点预测值，如果在该 (cutoff, horizon) 对没有预测，则条目为 nan。

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

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

此方法可用于一步完成更新和预测。

如果未实现估计器特定的更新方法，默认备用是先更新，然后预测。

所需状态

要求状态为“已拟合”。

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

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

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

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

预测时刻的时间戳的预测 horizon。如果已在 fit 中传入，则不应再次传入。如果在 fit 中未传入，则必须传入，不是可选的。

Xsktime 兼容格式的时间序列, 可选 (default=None)

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

update_paramsbool, optional (default=True)

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

返回:

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

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