LTSFTransformerForecaster

class LTSFTransformerForecaster(seq_len, context_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, position_encoding=True, temporal_encoding=True, temporal_encoding_type='linear', d_model=512, n_heads=8, d_ff=2048, e_layers=3, d_layers=2, factor=5, dropout=0.1, activation='relu', freq='h')

LTSF-Transformer 预测器。

由 Zeng 等人实现的长期短期特征 (LTSF) Transformer 预测器，也称为 LTSF-Transformer [1]_。

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

参数:

seq_len整型

输入序列的长度。最好是 pred_len 的两倍。

pred_len整型

预测序列的长度。

context_len整型，可选（默认值=2）

标签序列的长度。最好与 pred_len 相同。

num_epochs整型，可选（默认值=16）

训练轮数。

batch_size整型，可选（默认值=8）

批次大小。

in_channels整型，可选（默认值=1）

输入通道数。

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

是否对每个时间序列使用单独的模型。

criterion字符串或可调用对象，可选

要使用的损失函数。

criterion_kwargs字典，可选

损失函数的额外关键字参数。

optimizer字符串或可调用对象，可选

要使用的优化器。

optimizer_kwargs字典，可选

优化器的额外关键字参数。

lr浮点型，可选（默认值=0.001）

学习率。

custom_dataset_traintorch.utils.data.Dataset，可选

用于训练的自定义数据集。

custom_dataset_predtorch.utils.data.Dataset，可选

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

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

是否使用位置编码。位置编码通过为输入序列中的每个元素添加唯一的位置信息，帮助模型理解元素的顺序。

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

是否使用时间编码。仅适用于 DatetimeIndex 和 PeriodIndex，否则禁用。

temporal_encoding_type字符串，可选（默认值=“linear”）

要使用的时间编码类型，仅在 temporal_encoding 为 True 时相关。 - “linear”：使用线性层编码时间数据。 - “embed”：使用带有可学习权重的嵌入层。 - “fixed-embed”：使用带有固定正弦-余弦值作为权重的嵌入层。

d_model整型，可选（默认值=512）

模型的维度。

n_heads整型，可选（默认值=8）

注意力头的数量。

d_ff整型，可选（默认值=2048）

前馈网络模型的维度。

e_layers整型，可选（默认值=3）

编码器层数。

d_layers整型，可选（默认值=2）

解码器层数。

factor整型，可选（默认值=5）

注意力机制的因子。

dropout浮点型，可选（默认值=0.1）

Dropout 比率。

activation字符串，可选（默认值=“relu”）

要使用的激活函数。默认为 relu，否则为 gelu。

freq字符串，可选（默认值=“h”）

输入数据的频率，仅在 temporal_encoding 为 True 时相关。

属性:

cutoff

Cut-off = 预测器的“当前时间”状态。

fh

传入的预测范围。

is_fitted

是否已调用 fit。

示例

>>> from sktime.forecasting.ltsf import LTSFTransformerForecaster 
>>> from sktime.datasets import load_airline
>>>
>>> y = load_airline()
>>>
>>> model = LTSFTransformerForecaster(10, 5, 5) 
>>> model.fit(y, fh=[1, 2, 3, 4, 5]) 
LTSFTransformerForecaster(context_len=5, pred_len=5, seq_len=10)
>>> pred = model.predict() 

方法

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()	获取 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])	返回估计器的测试参数设置。
get_y_true(y)	获取用于验证的 y_true 值。
is_composite()	检查对象是否由其他 BaseObject 组成。
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])	将序列化的 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])	使用新数据更新模型并进行预测。

build_pytorch_train_dataloader(y)

构建用于训练的 PyTorch DataLoader。

build_pytorch_pred_dataloader(y, fh)

构建用于预测的 PyTorch DataLoader。

classmethod get_test_params(parameter_set='default')

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

参数:

parameter_setstr, default=”default”

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

Returns:

paramsdict or list of dict

check_is_fitted(method_name=None)

检查估计器是否已拟合。

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

如果不是，则引发NotFittedError。

参数:

method_namestr, optional

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

Raises:

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。

Raises:

如果克隆不符合要求（由于__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或list of str, default = None

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

Returns:

self

对self的引用。

classmethod create_test_instance(parameter_set='default')

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

参数:

parameter_setstr, default=”default”

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

Returns:

instance具有默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')

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

参数:

parameter_setstr, default=”default”

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

Returns:

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

Cut-off = 预测器的“当前时间”状态。

Returns:

cutoffpandas compatible index element, or None

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

property fh

传入的预测范围。

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

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

状态变化

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

写入self

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

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

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

• 如果传递了fh，则将其存储到self.fh中。

参数:

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

用于拟合预测器的时间序列。

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

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

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

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

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

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

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

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

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

Returns:

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

状态变化

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

写入self

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

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

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

• 将fh存储到self.fh。

参数:

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

用于拟合预测器的时间序列。

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

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

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

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

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

fhint, list, pd.Index coercible, or ForecastingHorizon (非可选)

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

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

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

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

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

用于预测的外生时间序列。如果传递，将用于预测而不是 X。应与 fit 中的 y 具有相同的科学类型 (Series, Panel, or Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。

Returns:

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

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

Returns:

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调用中保留。

Returns:

config_dictdict

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

get_fitted_params(deep=True)

获取已拟合参数。

所需状态

要求状态为“fitted”（已拟合）。

参数:

deepbool, default=True

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

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

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

Returns:

fitted_paramsdict with str-valued keys

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

• 始终：此对象的所有拟合参数，通过get_param_names值是此对象该键的拟合参数值

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

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

classmethod get_param_defaults()

获取对象的参数默认值。

Returns:

default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)

获取对象的参数名称。

参数:

sortbool, default=True

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

Returns:

param_names: list[str]

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

get_params(deep=True)

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

参数:

deepbool, default=True

是否返回组件的参数。

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

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

Returns:

paramsdict with str-valued keys

参数字典，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_defaultany type, optional; default=None

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

raise_errorbool

找不到标签时是否引发ValueError

Returns:

tag_valueAny

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

Raises:

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中设置的标签，

按照继承顺序。

Returns:

collected_tagsdict

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

get_y_true(y)

获取用于验证的 y_true 值。

is_composite()

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

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

Returns:

composite: bool

对象是否具有任何其值为BaseObject派生实例的参数。

property is_fitted

是否已调用 fit。

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

Returns:

bool

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

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

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

Returns:

通过cls.save(path)在path处输出的反序列化自身

classmethod load_from_serial(serial)

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

参数:

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

Returns:

通过cls.save(None)输出的serial反序列化自身

predict(fh=None, X=None)

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

所需状态

要求状态为“fitted”（已拟合），即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兼容格式的时间序列，可选 (default=None)

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

Returns:

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

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

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

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

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

所需状态

要求状态为“fitted”（已拟合），即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兼容格式的时间序列，可选 (default=None)

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

coveragefloat or list of float of unique values, optional (default=0.90)

预测区间(s) 的标称覆盖率

Returns:

pred_intpd.DataFrame

列具有多级索引：第一级是拟合时 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才能返回分布对象。

所需状态

要求状态为“fitted”（已拟合），即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兼容格式的时间序列，可选 (default=None)

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

marginalbool, optional (default=True)

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

Returns:

pred_distskpro BaseDistribution

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

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

计算/返回分位数预测。

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

所需状态

要求状态为“fitted”（已拟合），即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兼容格式的时间序列，可选 (default=None)

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

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

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

Returns:

quantilespd.DataFrame

列具有多级索引：第一级是拟合时 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，则将在fh为range(len(y.shape[0]))处计算残差

所需状态

要求状态为“fitted”（已拟合）。如果已设置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 具有相同的科学类型 (Series, Panel, or Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用和 y.index。

Returns:

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

在fh` 上的预测残差，具有与 ``fh 相同的索引。y_res 具有与最近传递的 y 相同的类型：Series, Panel, Hierarchical scitype，相同格式 (见上文)

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

计算/返回方差预测。

所需状态

要求状态为“fitted”（已拟合），即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兼容格式的时间序列，可选 (default=None)

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

covbool, optional (default=False)

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

Returns:

pred_varpd.DataFrame, format dependent on cov variable

如果 cov=False

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

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

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

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

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

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

如果 cov=True

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

第二级是 fh。

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

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

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

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

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

reset()

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

结果是将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))``后获得的对象。

Returns:

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” 则将创建一个 zip 文件estimator.zip并将其

存储在/home/stored/中。

serialization_format: str, default = “pickle”

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

Returns:

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

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

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

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

参数:

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

要评分的时间序列

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

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

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

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

Returns:

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 内核如何显示 self 的实例

• “diagram” = HTML 框图表示

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

print_changed_onlybool, default=True

打印 self 时是否只列出与默认值不同的参数 (True)，还是列出所有参数名称和值 (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”；要使用的日志记录器的名称。

  • “mute_warnings”：bool, default=False；如果为True，则抑制警告

remember_databool, default=True

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

Returns:

self对自身的引用。

Notes

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

set_params(**params)

设置此对象的参数。

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

参数:

**paramsdict

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

Returns:

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 中的 random_state 参数，取决于 self_policy，以及剩余组件对象（当且仅当 deep=True 时）。

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

参数:

random_stateint, RandomState instance or 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派生，通常与之不同

Returns:

self对自身的引用

set_tags(**tag_dict)

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

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

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

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

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

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

参数:

**tag_dictdict

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

Returns:

Self

对自身的引用。

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

更新截止值，并且（可选）更新已拟合的参数。

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

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

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

所需状态

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

访问 self 中的属性

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

• self.cutoff, self.is_fitted

写入self

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

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

参数:

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

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

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

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

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

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

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

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

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

update_params布尔型，可选（默认为 True）

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

Returns:

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：仅更新截止点并记住数据

所需状态

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

访问 self 中的属性

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

• self.cutoff, self.is_fitted

写入到 self（除非 reset_forecaster=True）

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

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

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

参数:

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

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

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

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

• Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list of Series 类型 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 且默认为 initial_window = 1、step_length = 1 和 fh = 1，这意味着将 y/ X 中的单个数据点逐一添加并进行预测

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

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

update_params布尔型，可选（默认为 True）

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

reset_forecaster布尔型，可选（默认为 True）

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

• 如果为 False，当运行更新/预测序列时，将更新 `self`，如同直接调用了 update/predict 一样

Returns:

y_pred一个对象，汇总了来自多个分割批次的点预测结果

格式取决于总体预测的截止点和绝对预测期对

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

• 如果绝对预测期点的集合不唯一：类型是 pandas DataFrame，行索引和列索引都是时间戳，行索引对应于进行预测的截止点，列索引对应于预测的绝对预测期，条目是基于行索引预测的列索引的对应点预测结果，如果在该（截止点，预测期）对没有进行预测，则条目为 nan

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

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

此方法适用于在单个步骤中进行更新和预测。

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

所需状态

要求状态为“fitted”（已拟合）。

访问 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，

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

参数:

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

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

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

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

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

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

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

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

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

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

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

update_params布尔型，可选（默认为 True）

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

Returns:

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

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