LTSFNLinearForecaster#

class LTSFNLinearForecaster(seq_len, pred_len, *, num_epochs=16, batch_size=8, in_channels=1, individual=False, criterion=None, criterion_kwargs=None, optimizer=None, optimizer_kwargs=None, lr=0.001, custom_dataset_train=None, custom_dataset_pred=None)[源]#

LTSF-NLinear 预测器。

Zeng 等人 [1] 实现的长期短期特征 (LTSF) 归一化线性预测器，也称为 LTSF-NLinear。

核心逻辑直接复制自 cure-lab 的 LTSF-Linear 实现 [R658c94d8ec96-2]，该实现遗憾的是没有作为包提供。

参数：
seq_lenint

输入序列长度

pred_lenint

预测长度（预测范围）

num_epochsint, default=16

训练轮次数量

batch_sizeint, default=8

每批次的训练样本数量

in_channelsint, default=1

传递给网络的输入通道数量

individualbool, default=False

布尔标志，控制网络是独立处理每个通道还是在所有通道上应用单个线性层。如果 individual=True，则为每个输入通道创建一个单独的线性层。如果 individual=False，则对所有通道使用一个共享的线性层。

criteriontorch.nn 损失函数, default=torch.nn.MSELoss

用于训练的损失函数

criterion_kwargsdict, default=None

传递给 criterion 的关键字参数

optimizertorch.optim 优化器, default=torch.optim.Adam

用于训练的优化器

optimizer_kwargsdict, default=None

传递给 optimizer 的关键字参数

lrfloat, default=0.003

模型训练的学习率

属性：
cutoff

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

fh

已传递的预测范围。

is_fitted

是否已调用 fit。

参考文献

[1]

Zeng A, Chen M, Zhang L, Xu Q. 2023。

Transformers 对时间序列预测有效吗？AAAI 人工智能大会论文集 2023（第 37 卷，第 9 期，第 11121-11128 页）。.. [R658c94d8ec96-2] cure-lab/LTSF-Linear

示例

>>> from sktime.forecasting.ltsf import LTSFNLinearForecaster 
>>> from sktime.datasets import load_airline
>>> model = LTSFNLinearForecaster(10, 3) 
>>> y = load_airline()
>>> model.fit(y, fh=[1,2,3]) 
LTSFNLinearForecaster(pred_len=3, seq_len=10)
>>> y_pred = model.predict() 
>>> y_pred 
1961-01    455.628082
1961-02    433.349640
1961-03    437.045502
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')[源]#

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

参数：
parameter_setstr, default=”default”

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

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

构建用于预测的 PyTorch DataLoader。

build_pytorch_train_dataloader(y)[源]#

构建用于训练的 PyTorch DataLoader。

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 进行检查。

参数：
estimator:class:BaseObject 或派生类的实例
tag_namesstr or list of str, default = None

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

返回：
self

self 的引用。

classmethod create_test_instance(parameter_set='default')[源]#

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

参数：
parameter_setstr, default=”default”

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

返回：
instance具有默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[源]#

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

参数：
parameter_setstr, default=”default”

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

返回：
objscls 实例列表

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

namesstr 列表，与 objs 长度相同

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

property cutoff[源]#

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

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

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

property fh[源]#

已传递的预测范围。

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

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

状态改变

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

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

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

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

fhint, list, pd.Index coercible, or 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对自身的引用。
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), Series 类型 pd.DataFrame 的 list

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

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

X_predsktime 兼容格式的时间序列，可选 (default=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)[源]#

从类中获取类标签值，具有父类的标签级别继承。

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

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

它从对象中返回名称为 tag_name 的标签值，考虑标签覆盖，优先级从高到低排序如下

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

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

按继承顺序排列。

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

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

参数：
tag_namestr

标签值的名称。

tag_value_defaultany type, optional; default=None

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

返回：
tag_value

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

classmethod get_class_tags()[源]#

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

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

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

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

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

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

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

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

按继承顺序排列。

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

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

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

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

collected_tagsdict

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

get_config()[源]#

获取自身的配置标志。

配置是 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 类型的字典

拟合参数的字典，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 类型的字典

参数的字典，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 在实例上、实例构造时设置的标签。

要检索的标签名称

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

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

按继承顺序排列。

参数：
tag_namestr

tag_value_defaultany type, optional; default=None

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

raise_errorbool

当未找到标签时是否抛出 ValueError

tag_valueAny

返回：
self 中 tag_name 标签的值。如果未找到，如果 raise_error 为 True，则抛出错误，否则返回 tag_value_default。

ValueError, if raise_error is True.

抛出：
如果 tag_name 不在 self.get_tags().keys() 中，则抛出 ValueError。

get_tags()[源]#

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

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

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

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

collected_tagsdict

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

  1. 通过 set_tags 或 clone_tags 在实例上、实例构造时设置的标签。

要检索的标签名称

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

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

按继承顺序排列。

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

get_y_true(y)[源]#

is_composite()[源]#

获取用于验证的 y_true 值。

复合对象是指其参数包含其他对象的对象。此方法作用于实例，因为不同实例可能有所不同。

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

composite: bool

返回：
对象是否具有其值是 BaseObject 后代实例的任何参数。

property is_fitted[源]#

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

是否已调用 fit。

bool

返回：
评估器是否已 fit。

classmethod load_from_path(serial)[源]#

从文件位置加载对象。

从文件位置加载对象。

参数：
serialresult of ZipFile(path).open(“object)
返回：
反序列化的 self，结果输出在 path，来自 cls.save(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 且之前未传入，则将其存储到 self.fh。

参数：
fhint, list, pd.Index coercible, or ForecastingHorizon, default=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") 为 True，则 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 且之前未传入，则将其存储到 self.fh。

参数：
fhint, list, pd.Index coercible, or ForecastingHorizon, default=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") 为 True，则 X.index 必须包含 fh 的索引引用。

coveragefloat 或唯一浮点数列表，可选 (默认=0.90)

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

返回：
pred_intpd.DataFrame
列具有多级索引：第一级是在 fit 中 y 的变量名，
第二级是计算区间的覆盖率分数。

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

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

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

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

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

对应于列索引中的变量，第二级列索引中的名义覆盖率，以及第三级列索引决定的下限/上限，对应于行索引。上限/下限区间预测值等同于在 alpha = 0.5 - c/2, 0.5 + c/2 (其中 c 在 coverage 中) 处的分位数预测值。

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 且之前未传入，则将其存储到 self.fh。

参数：
fhint, list, pd.Index coercible, or ForecastingHorizon, default=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") 为 True，则 X.index 必须包含 fh 的索引引用。

marginalbool, 可选 (默认=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 且之前未传入，则将其存储到 self.fh。

参数：
fhint, list, pd.Index coercible, or ForecastingHorizon, default=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") 为 True，则 X.index 必须包含 fh 的索引引用。

alphafloat 或唯一浮点数列表，可选 (默认=[0.05, 0.95])

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

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

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

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

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

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

第二级列索引中的分位数概率，以及行索引。

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

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

将针对 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 兼容数据容器格式的时间序列

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

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

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

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

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

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

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

fh 处的预测残差，具有与 fh 相同的索引。y_res 具有与最近传入的 y 相同的类型：Series、Panel、Hierarchical 数据科学类型，相同的格式（参见上文）

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

计算/返回方差预测。

所需状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入 self

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

参数：
fhint, list, pd.Index coercible, or ForecastingHorizon, default=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") 为 True，则 X.index 必须包含 fh 的索引引用。

covbool, 可选 (默认=False)

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

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

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

行索引是 fh，附加的级别等于实例级别，

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

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

对于给定变量和 fh 索引的方差预测是该变量和索引的预测方差，给定观测数据。

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

第二级是 fh。

行索引是 fh，附加的级别等于实例级别，

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

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

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

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

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。

存储在 /home/stored/。

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

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

Xpd.DataFrame 或 2D np.array, 可选 (默认=None)

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

返回：
scorefloat

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

另请参阅

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

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

参数：
config_dictdict

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

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

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, 默认=True

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • “None”: 无额外参数，忽略 backend_params

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

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

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

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

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

    • “shutdown_ray”: bool, 默认=True；False 防止 ray 在并行化后关闭。

      shutdown after parallelization.

    • “logger_name”: str, 默认=”ray”；要使用的记录器名称。

    • “mute_warnings”: bool, 默认=False；如果为 True，则抑制警告

suppressing warnings

remember_databool, 默认=True

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

Notes

改变对象状态，将 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 派生出的整数。这些整数通过链式哈希（chain hashing）的 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, default=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_params=True: 拟合到目前为止所有观测到的数据

  • update_params=False: 仅更新截止点并记住数据

所需状态

要求状态为“已拟合”，即 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), Series 类型 pd.DataFrame 的 list

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

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

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

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

update_paramsbool, 可选 (默认=True)

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

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

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

执行多次 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: 仅更新截止点并记住数据

所需状态

要求状态为“已拟合”，即 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), Series 类型 pd.DataFrame 的 list

  • 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 具有相同的数据科学类型（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 的索引引用。

update_paramsbool, 可选 (默认=True)

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

reset_forecasterbool, 可选 (默认=True)

  • 如果为 True，则不会改变预测器的状态，即更新/预测序列在副本上运行，self 的截止点、模型参数、数据内存不会改变

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

返回：
y_pred将多个分割批次的点预测值制成表格的对象

格式取决于整体预测的 (截止点, 绝对预测范围) 对

  • 如果绝对预测范围点的集合是唯一的：类型是 sktime 兼容数据容器格式的时间序列，输出中会抑制截止点。具有与最近传入的 y 相同的类型：Series, Panel, Hierarchical 数据科学类型，相同的格式（参见上文）

  • 如果绝对预测范围点的集合不唯一：类型是 pandas DataFrame，行索引和列索引都是时间戳。行索引对应于进行预测的截止点，列索引对应于预测的绝对预测范围。如果该 (截止点, 预测范围) 对没有预测值，则条目为 nan。

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

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

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

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

所需状态

要求状态为“已拟合”。

在 self 中访问

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

写入 self

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

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

参数：
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), Series 类型 pd.DataFrame 的 list

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

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

fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

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

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

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

update_paramsbool, 可选 (默认=True)

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

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

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

本页内容