LTSFLinearForecaster

class LTSFLinearForecaster(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-Linear 预测器。

长短期特征 (LTSF) 线性预测器的实现，也称为 LTSF-Linear，由 Zeng 等人 [1] 提出。

核心逻辑直接复制自 cure-lab 的 LTSF-Linear 实现 [Rdf9423af0e01-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

传递给损失函数的关键字参数

optimizertorch.optim.Optimizer, default=torch.optim.Adam

训练使用的优化器

optimizer_kwargsdict, default=None

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

lrfloat, default=0.003

模型训练的学习率

属性:

截止点

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

预测范围

传递的预测范围。

是否已拟合

fit 是否已被调用。

参考资料

[1]

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

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

示例

>>> from sktime.forecasting.ltsf import LTSFLinearForecaster 
>>> from sktime.datasets import load_airline
>>> model = LTSFLinearForecaster(10, 3) 
>>> y = load_airline()
>>> model.fit(y, fh=[1,2,3]) 
LTSFLinearForecaster(pred_len=3, seq_len=10)
>>> y_pred = model.predict() 
>>> y_pred 
1961-01    515.456726
1961-02    576.704712
1961-03    559.859680
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_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" 集。

返回::

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。在调用对象的 fit 方法时，is_fitted 属性应设为 True。

如果不是，则引发 NotFittedError。

参数:

method_namestr, 可选

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

引发::

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 或 str 列表，默认值 = None

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

返回::

self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')

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

参数:

parameter_setstr, 默认值=”default”

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

返回::

instance具有默认参数的类的实例

classmethod create_test_instances_and_names(parameter_set='default')

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

参数:

parameter_setstr, 默认值=”default”

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

返回::

objscls 实例列表

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

namesstr 列表，与 objs 长度相同

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

property cutoff

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

返回::

cutoffpandas 兼容的索引元素，或 None

如果 cutoff 已设置，则为 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 = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame 列表

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

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

fhint, 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") 为 True，则 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 = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame 列表

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

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

fhint, 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") 为 True，则 X.index 必须包含 y.index。

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

用于预测的外部时间序列。如果传递，将在预测中而不是 X 中使用。应与 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，格式相同（见上文）

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 的键值对，通常用作控制行为的瞬时标志。

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

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

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

返回::

config_dictdict

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

get_fitted_params(deep=True)

获取拟合参数。

所需状态

要求状态为“已拟合”。

参数:

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

获取对象的默认参数。

返回::

default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)

获取对象的参数名称。

参数:

sortbool, 默认值=True

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

返回::

param_names: list[str]

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

get_params(deep=True)

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

参数:

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)

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

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

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

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

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

在实例构造时。

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

3. 在父类的 _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()

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

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

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

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

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

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

在实例构造时。

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

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

按继承顺序。

返回::

collected_tagsdict

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

get_y_true(y)

获取用于验证的 y_true 值。

is_composite()

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

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

返回::

composite: bool

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

property is_fitted

fit 是否已被调用。

检查对象在构造时应初始化为 False` 并在调用其 :cite:`fit 方法时设为 True 的 _is_fitted` 属性。

返回::

bool

估计器是否已 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

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

返回::

cls.save(path) 的输出，即在 path 处反序列化的 self

classmethod load_from_serial(serial)

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

参数:

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

返回::

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

predict(fh=None, X=None)

预测未来时间序列。

所需状态

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

访问 self 中的内容

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

• self.cutoff、self.is_fitted

写入 self

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

参数:

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

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

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

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

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

返回::

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

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

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

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

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

所需状态

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

访问 self 中的内容

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

• self.cutoff、self.is_fitted

写入 self

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

参数:

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

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

如果 fh 不是 None 且类型不是 ForecastingHorizon，它将在内部被强制转换为 ForecastingHorizon（通过 _check_fh）。

• 如果 fh 是 int 或 int 类型的数组，则将其解释为相对预测范围，并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)。

• 如果 fh 类型为 pd.Index，则将其解释为绝对预测范围，并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

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

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

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

预测区间(s) 的名义覆盖率(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)

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

注意

• 当前仅为 Series (非面板、非分层) y 实现。

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

所需状态

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

访问 self 中的内容

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

• self.cutoff、self.is_fitted

写入 self

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

参数:

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

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

如果 fh 不是 None 且类型不是 ForecastingHorizon，它将在内部被强制转换为 ForecastingHorizon（通过 _check_fh）。

• 如果 fh 是 int 或 int 类型的数组，则将其解释为相对预测范围，并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)。

• 如果 fh 类型为 pd.Index，则将其解释为绝对预测范围，并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

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

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

marginalbool, 可选 (默认值=True)

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

返回::

pred_distskpro BaseDistribution

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

predict_quantiles(fh=None, X=None, alpha=None)

计算/返回分位数预测。

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

所需状态

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

访问 self 中的内容

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

• self.cutoff、self.is_fitted

写入 self

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

参数:

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

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

如果 fh 不是 None 且类型不是 ForecastingHorizon，它将在内部被强制转换为 ForecastingHorizon（通过 _check_fh）。

• 如果 fh 是 int 或 int 类型的数组，则将其解释为相对预测范围，并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)。

• 如果 fh 类型为 pd.Index，则将其解释为绝对预测范围，并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

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

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

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

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

返回::

quantilespd.DataFrame

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

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

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

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

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

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

predict_residuals(y=None, X=None)

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

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

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

所需状态

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

访问 self 中的内容

以“_”结尾的已拟合模型属性。self.cutoff、self._is_fitted

写入 self

无。

参数:

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

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

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

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

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

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

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

返回::

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

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

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

计算/返回方差预测。

所需状态

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

访问 self 中的内容

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

• self.cutoff、self.is_fitted

写入 self

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

参数:

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

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

如果 fh 不是 None 且类型不是 ForecastingHorizon，它将在内部被强制转换为 ForecastingHorizon（通过 _check_fh）。

• 如果 fh 是 int 或 int 类型的数组，则将其解释为相对预测范围，并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)。

• 如果 fh 类型为 pd.Index，则将其解释为绝对预测范围，并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

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

用于预测的外部时间序列。应与 fit 中的 y 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 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 索引的方差预测是预测的

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

如果 cov=True

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

第二级是 fh。

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

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

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

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

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

reset()

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

结果是将 self 设置回构造函数调用后的状态，具有相同的超参数。通过 set_config 设置的配置值也会被保留。

reset 调用删除任何对象属性，除了

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

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

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

类方法、对象方法和类属性也不受影响。

等同于 clone，但 reset 修改 self 而不是返回一个新对象。

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

返回::

self

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

save(path=None, serialization_format='pickle')

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

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

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

参数:

pathNone 或文件位置 (str 或 Path)

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

• path=”estimator” 则将在当前工作目录创建一个名为 estimator.zip 的 zip 文件。

• path=”/home/stored/estimator” 则将创建一个名为 estimator.zip 的 zip 文件并

存储在 /home/stored/ 中。

serialization_format: str, 默认值 = “pickle”

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

返回::

如果 path 为 None - 内存中的序列化 self

如果 path 是文件位置 - 引用该文件的 ZipFile

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

使用 MAPE（非对称）对预测与真实值进行评分。

参数:

ypd.Series, pd.DataFrame, or np.ndarray (1D or 2D)

要评分的时间序列

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

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

Xpd.DataFrame, or 2D np.array, optional (default=None)

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

返回::

scorefloat

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

另请参阅

sktime.performance_metrics.forecasting.mean_absolute_percentage_error

set_config(**config_dict)

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

参数:

config_dictdict

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

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

jupyter 内核如何显示 self 实例

• “diagram” = html 方框图表示

• “text” = 字符串输出

print_changed_onlybool, 默认值=True

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 在

    并行化后关闭。

  • “logger_name”：str，默认值=”ray”；要使用的日志记录器名称。

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

remember_databool, 默认值=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>。如果引用明确无歧义，例如没有两个组件参数的名称都为 <parameter>，则也可以使用不带 <component>__ 的字符串 <parameter>。

参数:

**paramsdict

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

返回::

self对 self 的引用（参数设置后）

set_random_state(random_state=None, deep=True, self_policy='copy')

为自身设置 random_state 伪随机种子参数。

通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 导出的整数。这些整数通过 sample_dependent_seed 从链式哈希中采样，并保证种子随机生成器的伪随机独立性。

根据 self_policy，应用于 self 中的 random_state 参数，并且仅当 deep=True 时应用于剩余组件对象。

注意：即使 self 没有 random_state 参数，或没有任何组件具有 random_state 参数，也会调用 set_params。因此，set_random_state 将重置任何 scikit-base 对象，即使是没有 random_state 参数的对象。

参数:

random_stateint, RandomState 实例或 None, 默认值=None

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

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)

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

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

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

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

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

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

参数:

**tag_dictdict

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

返回::

自身

对自身的引用。

update(y, X=None, update_params=True)

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

如果没有实现特定于估计器的更新方法，则默认回退如下

• 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 = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame 列表

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

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

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

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

update_paramsbool, optional (default=True)

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

返回::

self对 self 的引用

update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)

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

一种快捷方式，用于执行多个 update / predict 执行的链式操作，数据回放基于时间分割器 cv。

与以下操作相同（如果只有 y、cv 不是默认值）

1. self.update(y=cv.split_series(y)[0][0])

2. 记住 self.predict()（稍后一次性返回）

3. self.update(y=cv.split_series(y)[1][0])

4. 记住 self.predict()（稍后一次性返回）

5. 等等

6. 返回所有记住的预测

如果没有实现特定于估计器的更新方法，则默认回退如下

• update_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 = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame 列表

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

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

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

例如，SlidingWindowSplitter 或 ExpandingWindowSplitter；默认 = 初始窗口为 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, optional (default=True)

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

reset_forecasterbool, optional (default=True)

• 如果为 True，将不会改变预测器的状态，即更新/预测序列是使用副本运行的，且 self 的截止点、模型参数、数据记忆不会改变

• 如果为 False，则在运行更新/预测序列时将更新 self，如同直接调用更新/预测一样

返回::

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

格式取决于总体预测的（截止点，绝对 horizon）对

• 如果绝对 horizon 点的集合是唯一的：类型是与 sktime 兼容的数据容器格式的时间序列，输出中省略了截止点，与最近传入的 y 具有相同的类型：Series、Panel、Hierarchical scitype，格式相同（见上文）

• 如果绝对 horizon 点的集合不唯一：类型是 pandas DataFrame，行索引和列索引都是时间戳，行索引对应于从中预测的截止点，列索引对应于预测的绝对 horizon，条目是根据行索引预测的列索引的点预测，如果在该（截止点，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

通过追加行来使用 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 列表

• 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, optional (default=True)

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

返回::

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

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