NeuralForecastRNN#

class NeuralForecastRNN(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_activation: str = 'tanh', 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)[source]#

NeuralForecast RNN 模型。

通过 neuralforecast.NeuralForecast [2] 接口调用 neuralforecast.models.RNN [1] 模型，该模型来自 Nixtla 的 neuralforecast [3]。

多层 Elman RNN (RNN)，带有 MLP 解码器。该网络具有 tanh 或 relu 非线性，使用 ADAM 随机梯度下降进行训练。

参数:

freqUnion[str, int] (默认值=”auto”)

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

默认值（“auto”）在 fit 中从 ForecastingHorizon 解释频率

local_scaler_typestr (默认值=None)

每个序列应用于所有特征的缩放器，拟合前应用，预测后反转

可以是以下之一

‘standard’
‘robust’
‘robust-iqr’
‘minmax’
‘boxcox’

futr_exog_liststr 列表, (默认值=None)

未来外生变量

verbose_fitbool (默认值=False)

拟合期间打印处理步骤

verbose_predictbool (默认值=False)

预测期间打印处理步骤

input_sizeint (默认值=-1)

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

默认值 (-1) 使用所有历史数据

inference_input_sizeint (默认值=-1)

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

默认值 (-1) 使用所有历史数据

encoder_n_layersint (默认值=2)

RNN 的层数

encoder_hidden_sizeint (默认值=200)

RNN 隐藏状态的大小单位

encoder_activationstr (默认值=”tanh”)

来自 tanh 或 relu 的 RNN 激活类型

encoder_biasbool (默认值=True)

是否在 RNN 单元中使用偏差 b_ih, b_hh

encoder_dropoutfloat (默认值=0.0)

应用于 RNN 输出的 dropout 正则化

context_sizeint (默认值=10)

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

decoder_hidden_sizeint (默认值=200)

MLP 解码器的隐藏层大小

decoder_layersint (默认值=2)

MLP 解码器的层数

losspytorch 模块 (默认值=None)

实例化自损失集合 [Re6526eedb6ab-5] 的训练损失类

valid_losspytorch 模块 (默认值=None)

实例化自损失集合 [Re6526eedb6ab-5] 的验证损失类

max_stepsint (默认值=1000)

最大训练步数

learning_ratefloat (默认值=1e-3)

学习率，范围在 (0, 1) 之间

num_lr_decaysint (默认值=-1)

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

early_stop_patience_stepsint (默认值=-1)

早停前验证迭代次数

val_check_stepsint (默认值=100)

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

batch_sizeint (默认值=32)

每个批次中不同序列的数量

valid_batch_sizeOptional[int] (默认值=None)

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

scaler_typestr (默认值=”robust”)

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

random_seedint (默认值=1)

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

num_workers_loaderint (默认值=0)

TimeSeriesDataLoader 使用的工作进程数

drop_last_loaderbool (默认值=False)

TimeSeriesDataLoader 是否丢弃最后一个非完整批次

trainer_kwargsdict (默认值=None)

继承自 PyTorch Lightning 训练器 [Re6526eedb6ab-6] 的关键字训练器参数

optimizerpytorch 优化器 (默认值=None) [Re6526eedb6ab-7]

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

optimizer_kwargsdict (默认值=None) [Re6526eedb6ab-8]

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

broadcastingbool (默认值=False)

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

lr_schedulerpytorch 学习率调度器 (默认值=None) [Re6526eedb6ab-9]

用户指定的 lr_scheduler，而不是默认选择 StepLR [Re6526eedb6ab-10]

lr_scheduler_kwargsdict (默认值=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.rnn.html#rnn

[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 .. [Re6526eedb6ab-5] https://nixtlaverse.nixtla.io/neuralforecast/losses.pytorch.html .. [Re6526eedb6ab-6] https://lightning.ai/docs/pytorch/stable/api/pytorch_lightning.trainer.trainer.Trainer.html#lightning.pytorch.trainer.trainer.Trainer .. [Re6526eedb6ab-7] https://pytorch.ac.cn/docs/stable/optim.html .. [Re6526eedb6ab-8] https://pytorch.ac.cn/docs/stable/optim.html#algorithms .. [Re6526eedb6ab-9] https://pytorch.ac.cn/docs/stable/generated/torch.optim.lr_scheduler.LRScheduler.html .. [Re6526eedb6ab-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 NeuralForecastRNN
>>> 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 = NeuralForecastRNN(  
...     "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
NeuralForecastRNN(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    66241.984375
1960    66700.125000
1961    66550.195312
1962    67310.007812
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`()	获取自身的配置标志。
`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_exogenous_support: bool[source]#: 设置对外生特征的支持。

property algorithm_name: str[source]#: 设置自定义模型名称。

property algorithm_class[source]#: 导入底层 NeuralForecast 算法类。

property algorithm_parameters: dict[source]#

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

返回:

dict: 底层算法类的关键字参数

classmethod get_test_params(parameter_set='default')[source]#

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

参数:

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

返回:

paramsdict 或 dict 列表, 默认值 = {}: 用于创建类测试实例的参数每个 dict 是构造一个“有趣”测试实例的参数，即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个（或唯一一个）字典

check_is_fitted(method_name=None)[source]#

检查估算器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:

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

引发:

NotFittedError: 如果估算器尚未拟合。

clone()[source]#

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

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

等同于使用 self 的参数构造 type(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)[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 或 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 个元素是测试中 obj 的第 i 个实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

property cutoff[source]#

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

返回:

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

property fh[source]#: 传递的预测范围。

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

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

状态变化: 状态变为“已拟合”。

写入自身

设置以“_”结尾的拟合模型属性，拟合属性可通过 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 的 list
Hierarchical scitype = 分层集合，用于分层预测。具有 3 级或更多行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

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

fhint, list, 可强制转换为 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。

返回:

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

状态变化: 状态变为“已拟合”。

写入自身

设置以“_”结尾的拟合模型属性，拟合属性可通过 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 = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，或 Series 类型 pd.DataFrame 的 list
Hierarchical scitype = 分层集合，用于分层预测。具有 3 级或更多行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

有关数据格式的更多详细信息，请参阅关于 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 兼容格式的时间序列，可选 (默认值=None)。

用于拟合模型的外部时间序列。应与 y 具有相同的 scitype (Series, Panel, 或 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 的标签值，考虑标签覆盖，优先级从高到低顺序如下：

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

按继承顺序。

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

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

参数:

tag_namestr: 标签值的名称。
tag_value_default任意类型: 如果未找到标签，则为默认/备用值。

返回:

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

classmethod get_class_tags()[source]#

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

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

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

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

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

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

在类的 _tags 属性中设置的标签。
在父类的 _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_params键为 str 类型的字典

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

始终：此对象的所有拟合参数，通过 get_param_names 获取。值是此对象该键对应的拟合参数值
如果 deep=True，还包含组件参数的键/值对。组件参数以 [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，但不包括组件的参数。

返回:

params键为 str 类型的字典

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

始终：此对象的所有参数，通过 get_param_names 获取。值是此对象该键对应的参数值。值始终与构造时传递的值相同
如果 deep=True，还包含组件参数的键/值对。组件参数以 [componentname]__[paramname] 索引。componentname 的所有参数都以 paramname 及其值的形式出现
如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

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

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

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

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

get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，考虑标签覆盖，优先级从高到低顺序如下：

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

在实例构造时。

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

按继承顺序。

参数:

tag_namestr: 要检索的标签名称
tag_value_default任意类型，可选；默认值=None: 如果未找到标签，则为默认/备用值
raise_errorbool: 未找到标签时是否引发 ValueError

返回:

tag_valueAny: self 中 tag_name 标签的值。如果未找到，且 raise_error 为 True，则引发错误，否则返回 tag_value_default。

引发:

ValueError，如果 raise_error 为 True。: 如果 tag_name 不在 self.get_tags().keys() 中，则会引发 ValueError。

get_tags()[source]#

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

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

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

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

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

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

在实例构造时。

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

按继承顺序。

返回:

collected_tagsdict: 标签名称 : 标签值对的字典。通过嵌套继承从 _tags 类属性收集，然后从 _tags_dynamic 对象属性获取任何覆盖和新标签。

is_composite()[source]#

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

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

返回:

composite: bool: 对象是否有任何参数的值是 BaseObject 后代实例。

property is_fitted[source]#

fit 是否已被调用。

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

返回:

bool: 估计器是否已 fit（拟合）。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:

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

返回:

反序列化的 self，其输出位于 path，来自 cls.save(path)

classmethod load_from_serial(serial)[source]#

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

参数:

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

返回:

反序列化的 self，其输出为 serial，来自 cls.save(None)

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

预测未来范围内的时序数据。

所需状态: 要求状态为“fitted”（已拟合），即 self.is_fitted=True。

在 self 中的访问

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

self.cutoff, self.is_fitted

写入自身: 如果传递了 fh 且之前未传递，则将 fh 存储到 self.fh。

参数:

fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认值=None: 预测范围，编码要预测的时间戳。如果在 fit 中已传递，则不应再传递。如果未在 fit 中传递，则必须传递，不可选。
Xsktime 兼容格式的时间序列，可选 (默认值=None): 用于预测的外部时间序列。应与 fit 中的 y 具有相同的 scitype (Series, Panel`, 或 ``Hierarchical)。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 fh 索引引用。如果未传递 y (未执行全局预测)，X 应仅包含要预测的时间点。如果传递了 y (执行全局预测)，X 必须包含所有历史值和要预测的时间点。
ysktime 兼容格式的时间序列，可选 (默认值=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)[source]#

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

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

所需状态: 要求状态为“fitted”（已拟合），即 self.is_fitted=True。

在 self 中的访问

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

self.cutoff, self.is_fitted

写入自身: 如果传递了 fh 且之前未传递，则将 fh 存储到 self.fh。

参数:

fhint, list, np.array 或 ForecastingHorizon, 可选 (默认值=None): 预测范围，编码要预测的时间戳。如果在 fit 中已传递，则不应再传递。如果未在 fit 中传递，则必须传递，不可选。
Xsktime 兼容格式的时间序列，可选 (默认值=None): 用于预测的外部时间序列。应与 fit 中的 y 具有相同的 scitype (Series, Panel`, 或 ``Hierarchical)。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 fh 索引引用。如果传递了 y (执行全局预测)，X 必须包含所有历史值和要预测的时间点。
coveragefloat 或唯一 float 值的列表，可选 (默认值=0.90): 预测区间(s) 的名义覆盖度(s)
ysktime 兼容格式的时间序列，可选 (默认值=None): 应预测的时间序列历史值。如果不是 None，将执行全局预测。只传递历史值，不传递要预测的时间点。

返回:

pred_intpd.DataFrame

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

第二级是计算区间的覆盖度分数。: 与输入 coverage 中的顺序相同。

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

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

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

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

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

注意

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

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

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

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

注意：目前仅针对 Series (非面板，非分层) 类型的 y 实现。

所需状态: 要求状态为“fitted”（已拟合），即 self.is_fitted=True。

在 self 中的访问

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

self.cutoff, self.is_fitted

写入自身: 如果传递了 fh 且之前未传递，则将 fh 存储到 self.fh。

参数:

fhint, list, np.array 或 ForecastingHorizon, 可选 (默认值=None): 预测范围，编码要预测的时间戳。如果在 fit 中已传递，则不应再传递。如果未在 fit 中传递，则必须传递，不可选。
Xsktime 兼容格式的时间序列，可选 (默认值=None): 用于预测的外部时间序列。应与 fit 中的 y 具有相同的 scitype (Series, Panel`, 或 ``Hierarchical)。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 fh 索引引用。如果传递了 y (执行全局预测)，X 必须包含所有历史值和要预测的时间点。
marginalbool, 可选 (默认值=True): 返回的分布是否按时间索引是边际的
ysktime 兼容格式的时间序列，可选 (默认值=None): 应预测的时间序列历史值。如果不是 None，将执行全局预测。只传递历史值，不传递要预测的时间点。

返回:

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

注意

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

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

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

计算/返回分位数预测。

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

所需状态: 要求状态为“fitted”（已拟合），即 self.is_fitted=True。

在 self 中的访问

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

self.cutoff, self.is_fitted

写入自身: 如果传递了 fh 且之前未传递，则将 fh 存储到 self.fh。

参数:

fhint, list, np.array 或 ForecastingHorizon, 可选 (默认值=None): 预测范围，编码要预测的时间戳。如果在 fit 中已传递，则不应再传递。如果未在 fit 中传递，则必须传递，不可选。
Xsktime 兼容格式的时间序列，可选 (默认值=None): 用于预测的外部时间序列。应与 fit 中的 y 具有相同的 scitype (Series, Panel`, 或 ``Hierarchical)。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 fh 索引引用。如果传递了 y (执行全局预测)，X 必须包含所有历史值和要预测的时间点。
alphafloat 或唯一 float 值的列表，可选 (默认值=[0.05, 0.95]): 计算分位数预测值时的概率或概率列表。
ysktime 兼容格式的时间序列，可选 (默认值=None): 应预测的时间序列历史值。如果不是 None，将执行全局预测。只传递历史值，不传递要预测的时间点。

返回:

quantilespd.DataFrame

列具有多级索引：第一级是 fit 中 y 的变量名称，: 第二级是传递给函数的 alpha 值。
行索引是 fh，附加（更高级别）级别等于实例级别，: 来自 fit 中看到的 y，如果 fit 中看到的 y 是 Panel 或 Hierarchical 类型。
条目是分位数预测值，对应于列索引中的 var，: 在第二列索引中的分位数概率，对应于行索引。

注意

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

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

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

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

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

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

所需状态: 要求状态为“fitted”（已拟合）。如果已设置 fh，则必须与 y 的索引对应 (pandas 或 integer)
在 self 中的访问: 以“_”结尾的拟合模型属性。self.cutoff, self._is_fitted
写入自身: 无。

参数:

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

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

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

如果之前只进行了一次 fit 调用，则产生样本内残差
如果 fit 需要 fh，则它必须指向 fit 中 y 的索引

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

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

返回:

y_ressktime 兼容数据容器格式的时间序列: 在 fh` 处的预测残差，与 ``fh 具有相同的索引。y_res 具有与最近传递的 y 相同的类型：Series, Panel`, ``Hierarchical scitype，格式相同（参见上文）

predict_var(fh=None, X=None, cov=False, y=None)[source]#

计算/返回方差预测。

所需状态: 要求状态为“fitted”（已拟合），即 self.is_fitted=True。

在 self 中的访问

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

self.cutoff, self.is_fitted

写入自身: 如果传递了 fh 且之前未传递，则将 fh 存储到 self.fh。

参数:

fhint, list, np.array 或 ForecastingHorizon, 可选 (默认值=None): 预测范围，编码要预测的时间戳。如果在 fit 中已传递，则不应再传递。如果未在 fit 中传递，则必须传递，不可选。
Xsktime 兼容格式的时间序列，可选 (默认值=None): 用于预测的外部时间序列。应与 fit 中的 y 具有相同的 scitype (Series, Panel`, 或 ``Hierarchical)。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 fh 索引引用。
covbool, 可选 (默认值=False): 如果为 True，计算协方差矩阵预测。如果为 False，计算边际方差预测。
ysktime 兼容格式的时间序列，可选 (默认值=None): 应预测的时间序列历史值。如果不是 None，将执行全局预测。只传递历史值，不传递要预测的时间点。

返回:

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

如果 cov=False

列名与 fit/update 中传递的 y 完全相同。: 对于无名称格式，列索引将是 RangeIndex。
行索引是 fh，附加级别等于实例级别，: 来自 fit 中看到的 y，如果 fit 中看到的 y 是 Panel 或 Hierarchical 类型。

条目是方差预测值，对应于列索引中的 var。给定变量和 fh 索引的方差预测值是一个预测的

该变量和索引的方差，给定观测数据。

如果 cov=True

列索引是多级索引：第一级是变量名称（如上所述）: 第二级是 fh。
行索引是 fh，附加级别等于实例级别，: 来自 fit 中看到的 y，如果 fit 中看到的 y 是 Panel 或 Hierarchical 类型。
条目是（协）方差预测值，对应于列索引中的 var，以及: 行和列中时间索引之间的协方差。

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

注意

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

如果 y 是 None，将执行非全局预测。在非全局预测模式下，X 应仅包含要预测的时间点，而 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，返回内存中的序列化 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, 默认值 = “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, 或 ForecastingHorizon, 默认值=None: 预测范围，编码要预测的时间戳。
Xpd.DataFrame, 或 2D np.array, 可选 (默认值=None): 用于评分的外部时间序列。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 y.index

返回:

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

另请参阅

sktime.performance_metrics.forecasting.mean_absolute_percentage_error

set_config(**config_dict)[source]#

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

参数:

config_dictdict

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

displaystr, “diagram” (默认值), 或 “text”

jupyter 内核如何显示 self 的实例

“diagram” = html 方框图表示
“text” = 字符串打印输出

print_changed_onlybool, 默认值=True

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

warningsstr, “on” (默认值), 或 “off”

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

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

backend:parallelstr, 可选, 默认值=”None”

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

“None”: 顺序执行循环，简单的列表推导式
“loky”, “multiprocessing” 和 “threading”: 使用 joblib.Parallel
“joblib”: 自定义和第三方 joblib 后端，例如 spark
“dask”: 使用 dask，需要在环境中安装 dask 包
“ray”: 使用 ray，需要在环境中安装 ray 包

backend:parallel:paramsdict, 可选, 默认值={} (未传递参数)

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

“None”: 没有附加参数，backend_params 被忽略
“loky”, “multiprocessing” 和 “threading”: 默认的 joblib 后端。joblib.Parallel 的任何有效键都可以在此处传递，例如 n_jobs，但 backend 除外，它由 backend 直接控制。如果未传递 n_jobs，它将默认为 -1，其他参数将默认为 joblib 的默认值。
“joblib”: 自定义和第三方 joblib 后端，例如 spark。joblib.Parallel 的任何有效键都可以在此处传递，例如 n_jobs。backend 在这种情况下必须作为 backend_params 的键传递。如果未传递 n_jobs，它将默认为 -1，其他参数将默认为 joblib 的默认值。
“dask”: 可以传递 dask.compute 的任何有效键，例如 scheduler
“ray”: 可以传递以下键：
- “ray_remote_args”: ray.init 的有效键字典
- “shutdown_ray”: bool, 默认值=True；False 阻止 ray 在
  并行化后关闭。
- “logger_name”: str, 默认值=”ray”；要使用的日志记录器名称。
- “mute_warnings”: bool, 默认值=False；如果为 True，抑制警告

remember_databool, 默认值=True

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

返回:

self对 self 的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

此方法适用于简单的 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')[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_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)[source]#

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

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

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

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

update_params=True: 拟合迄今为止所有观测数据

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

所需状态: 要求状态为“fitted”（已拟合），即 self.is_fitted=True。

在 self 中的访问

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

self.cutoff, self.is_fitted

写入自身

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

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

参数:

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

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

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

Series scitype = 单个时间序列，普通预测。pd.DataFrame、pd.Series 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，或 Series 类型 pd.DataFrame 的 list
Hierarchical scitype = 分层集合，用于分层预测。具有 3 级或更多行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

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

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

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

update_paramsbool, 可选 (默认值=True)

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

返回:

self对 self 的引用

update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#

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

执行多次 update / predict 的链式操作的简写，数据回放基于时间分割器 cv。

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

self.update(y=cv.split_series(y)[0][0])
记住 self.predict() (稍后在单个批次中返回)
self.update(y=cv.split_series(y)[1][0])
记住 self.predict() (稍后在单个批次中返回)
等等
返回所有记住的预测

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

update_params=True: 拟合迄今为止所有观测数据

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

所需状态: 要求状态为“fitted”（已拟合），即 self.is_fitted=True。

在 self 中的访问

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

self.cutoff, self.is_fitted

写入 self (除非 reset_forecaster=True)

将 self.cutoff 更新为 y 中看到的最新索引。
如果 update_params=True，更新以“_”结尾的拟合模型属性。

如果 reset_forecaster=True，不更新状态。

参数:

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 的 list
Hierarchical scitype = 分层集合，用于分层预测。具有 3 级或更多行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

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

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

例如，SlidingWindowSplitter 或 ExpandingWindowSplitter；默认值 = initial_window=1 的 ExpandingWindowSplitter，默认值 = y/X 中的单个数据点逐个添加和预测，initial_window = 1, step_length = 1 和 fh = 1

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

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

update_paramsbool, 可选 (默认值=True)

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

reset_forecasterbool, 可选 (默认值=True)

如果为 True，将不改变预测器的状态，即使用副本运行 update/predict 序列，self 的 cutoff、模型参数、数据内存都不会改变
如果为 False，当运行 update/predict 序列时，将更新 self，如同直接调用 update/predict 一样

返回:

y_pred汇总来自多个分割批次的点预测的对象

格式取决于总体预测的 (cutoff, 绝对范围) 对

如果绝对范围点的集合是唯一的：类型是 sktime 兼容数据容器格式的时间序列；输出中省略 cutoff；具有与最近传递的 y 相同的类型：Series, Panel, Hierarchical scitype，格式相同（参见上文）
如果绝对范围点的集合不唯一：类型是 pandas DataFrame，行和列索引是时间戳；行索引对应于预测起始的 cutoff；列索引对应于预测的绝对范围；条目是从行索引预测的列索引处的点预测值；如果在该 (cutoff, horizon) 对没有预测，则条目为 nan

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

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

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

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

所需状态: 要求状态为“fitted”（已拟合）。
在 self 中的访问: 以“_”结尾的拟合模型属性。指向已见数据的指针，self._y 和 self.X；self.cutoff, self._is_fitted。如果 update_params=True，则更新以“_”结尾的模型属性。
写入自身: 通过追加行，用 y 和 X 更新 self._y 和 self._X。将 self.cutoff 和 self._cutoff 更新为 y 中看到的最后一个索引。如果 update_params=True，

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

参数:

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

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

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

Series scitype = 单个时间序列，普通预测。pd.DataFrame、pd.Series 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，或 Series 类型 pd.DataFrame 的 list
Hierarchical scitype = 分层集合，用于分层预测。具有 3 级或更多行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

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

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

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

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

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

update_paramsbool, 可选 (默认值=True)

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

返回:

y_predsktime 兼容数据容器格式的时间序列: 在 fh 处的点预测，与 fh 具有相同的索引。y_pred 具有与最近传递的 y 相同的类型：Series, Panel, Hierarchical scitype，格式相同（参见上文）