LTSFDLinearForecaster#

class LTSFDLinearForecaster(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)[source]#

LTSF-DLinear 预测器。

Zeng 等人 [1] 实现的长短期特征 (LTSF) 分解线性预测器,又称 LTSF-DLinear。

核心逻辑直接复制自 cure-lab 的 LTSF-Linear 实现 [Rca25a19f0626-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 Loss Function, default=torch.nn.MSELoss

用于训练的损失函数

criterion_kwargsdict, default=None

传递给 criterion 的关键字参数

optimizertorch.optim.Optimizer, 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 对时间序列预测有效吗?Proceedings of the AAAI conference on artificial intelligence 2023 (Vol. 37, No. 9, pp. 11121-11128). .. [Rca25a19f0626-2] cure-lab/LTSF-Linear

示例

>>> from sktime.forecasting.ltsf import LTSFDLinearForecaster 
>>> from sktime.datasets import load_airline
>>> model = LTSFDLinearForecaster(10, 3) 
>>> y = load_airline()
>>> model.fit(y, fh=[1,2,3]) 
LTSFDLinearForecaster(pred_len=3, seq_len=10)
>>> y_pred = model.predict() 
>>> y_pred 
1961-01    436.494476
1961-02    433.659851
1961-03    479.309631
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()

获取 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])

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

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

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

参数:
parameter_setstr, default=”default”

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

返回值:
paramsdict or list of dict
build_pytorch_pred_dataloader(y, fh)[source]#

构建用于预测的 PyTorch DataLoader。

build_pytorch_train_dataloader(y)[source]#

构建用于训练的 PyTorch DataLoader。

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是,则引发 NotFittedError

参数:
method_namestr, optional

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

抛出:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

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

等效于使用 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_tagsget_tag 进行检查。

参数:
estimatorBaseObject 或派生类的实例
tag_namesstr or list of str, default = None

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

返回值:
self

self 的引用。

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

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

参数:
parameter_setstr, default=”default”

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

返回值:
instanceinstance of the class with default parameters
classmethod create_test_instances_and_names(parameter_set='default')[source]#

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

参数:
parameter_setstr, default=”default”

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

返回值:
objslist of instances of cls

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

nameslist of str, same length as objs

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

property cutoff[source]#

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

返回值:
cutoffpandas compatible index element, or None

如果设置了截止点,则为 pandas 兼容索引元素;否则为 None。

property fh[source]#

传递的预测范围。

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

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

状态变化

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

写入 self

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

  • self.is_fitted 标志设置为 True

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

  • 如果传入了 fh,则将其存储到 self.fh

参数:
y时间序列,采用 sktime 兼容的数据容器格式。

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

sktime 中的单个数据格式称为 mtype 规范,每个 mtype 都实现一个抽象 scitype

  • Series scitype = 单个时间序列,普通预测。pd.DataFramepd.Seriesnp.ndarray(1维或2维)。

  • Panel scitype = 时间序列集合,全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (实例, 时间),3D np.ndarray (实例, 变量, 时间),Series 类型 pd.DataFramelist

  • Hierarchical scitype = 分层集合,用于分层预测。pd.DataFrame 具有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)。

关于数据格式的更多详细信息,请参见 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 兼容格式,可选(默认为 None)。

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

返回值:
selfReference to 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) 相同。

状态变化

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

写入 self

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

  • self.is_fitted 标志设置为 True

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

  • fh 存储到 self.fh

参数:
y时间序列,采用 sktime 兼容数据容器格式

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

sktime 中的单个数据格式称为 mtype 规范,每个 mtype 都实现一个抽象 scitype

  • Series scitype = 单个时间序列,普通预测。pd.DataFramepd.Seriesnp.ndarray(1维或2维)。

  • Panel scitype = 时间序列集合,全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (实例, 时间),3D np.ndarray (实例, 变量, 时间),Series 类型 pd.DataFramelist

  • Hierarchical scitype = 分层集合,用于分层预测。pd.DataFrame 具有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)。

关于数据格式的更多详细信息,请参见 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) 将其强制转换。

X外生时间序列,采用 sktime 兼容格式,可选(默认为 None)。

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

X_predsktime 兼容格式的时间序列,可选(默认为 None)

用于预测的外生时间序列。如果传入,将在预测中使用而不是 X。应与 fity 具有相同的 scitype(SeriesPanelHierarchical)。如果 self.get_tag("X-y-must-have-same-index"),则 X.index 必须包含 fh 索引引用。

返回值:
y_pred时间序列,采用 sktime 兼容数据容器格式

fh 处的点预测,具有与 fh 相同的索引。y_pred 与最近传入的 y 具有相同的类型:SeriesPanelHierarchical scitype,相同的格式(见上文)。

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

从类中获取类标签值,继承父类的标签级别。

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

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

它返回对象中名为 tag_name 的标签的值,考虑到标签覆盖,优先级降序如下:

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

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

按继承顺序。

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

要检索可能包含实例覆盖的标签值,请改用 get_tag 方法。

参数:
tag_namestr

标签值的名称。

tag_value_defaultany type

如果找不到标签,则为默认/回退值。

返回值:
tag_value

selftag_name 标签的值。如果找不到,返回 tag_value_default

classmethod get_class_tags()[source]#

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

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

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

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

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

值是对应的标签值,覆盖顺序优先级降序如下:

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

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

按继承顺序。

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

要检索可能包含实例覆盖的标签,请改用 get_tags 方法。

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

要包含来自动态标签的覆盖,请使用 get_tags

collected_tagsdict

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

get_config()[source]#

获取 self 的配置标志。

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

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

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

配置在 clonereset 调用下得以保留。

返回值:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取拟合参数。

所需状态

要求状态为“已拟合”。

参数:
deepbool, default=True

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

  • 如果为 True,将返回此对象的参数名 : 值字典,包括可拟合组件的已拟合参数(即 BaseEstimator 类型参数)。

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

返回值:
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()[source]#

获取对象的默认参数。

返回值:
default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数:
sortbool, default=True

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

返回值:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deepbool, default=True

是否返回组件的参数。

  • 如果为 True,将返回此对象的参数名 : 值 dict,包括组件的参数(即 BaseObject 类型参数)。

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

返回值:
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)[source]#

从实例获取标签值,包括标签级别的继承和覆盖。

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

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

get_tag 方法从实例中检索名称为 tag_name 的单个标签的值,考虑到标签覆盖,优先级降序如下:

  1. 通过实例上的 set_tagsclone_tags 设置的标签,

在实例构造时。

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

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

按继承顺序。

参数:
tag_namestr

要检索的标签名称。

tag_value_defaultany type, optional; default=None

如果找不到标签,则为默认/回退值。

raise_errorbool

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

返回值:
tag_valueAny

selftag_name 标签的值。如果找不到,并且 raise_error 为 True,则抛出错误,否则返回 tag_value_default

抛出:
ValueError,如果 raise_errorTrue

如果 tag_name 不在 self.get_tags().keys() 中,则会抛出 ValueError

get_tags()[source]#

从实例获取标签,包括标签级别的继承和覆盖。

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

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

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

值是对应的标签值,覆盖顺序优先级降序如下:

  1. 通过实例上的 set_tagsclone_tags 设置的标签,

在实例构造时。

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

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

按继承顺序。

返回值:
collected_tagsdict

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

get_y_true(y)[source]#

获取用于验证的 y_true 值。

is_composite()[source]#

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

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

返回值:
composite: bool

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

property is_fitted[source]#

fit 是否已被调用。

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

返回值:
bool

估计器是否已 fit

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialresult of ZipFile(path).open(“object)
返回值:
path 处产生输出的自解序列化对象,是 cls.save(path) 的结果。
classmethod load_from_serial(serial)[source]#

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

参数:
serial1st element of output of cls.save(None)
返回值:
产生输出 serial 的自解序列化对象,是 cls.save(None) 的结果。
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) 将其强制转换。

X外生时间序列,采用 sktime 兼容格式,可选(默认为 None)

用于预测的外生时间序列。应与 fity 具有相同的 scitype(SeriesPanelHierarchical)。如果 self.get_tag("X-y-must-have-same-index"),则 X.index 必须包含 fh 索引引用。

返回值:
y_pred时间序列,采用 sktime 兼容数据容器格式

fh 处的点预测,具有与 fh 相同的索引。y_pred 与最近传入的 y 具有相同的类型:SeriesPanelHierarchical 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 类型,则在内部(通过 _check_fh)将其强制转换为 ForecastingHorizon

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

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

X外生时间序列,采用 sktime 兼容格式,可选(默认为 None)

用于预测的外生时间序列。应与 fity 具有相同的 scitype(SeriesPanelHierarchical)。如果 self.get_tag("X-y-must-have-same-index"),则 X.index 必须包含 fh 索引引用。

coverage浮点数或唯一浮点数列表,可选(默认为 0.90)

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

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

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

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

行索引是 fh,附加(上层)级别等于实例级别,

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

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

对于列索引中的变量,在第二列索引中的名义覆盖率下,取决于第三列索引是 lower/upper,对应于行索引。区间上限/下限预测等效于在覆盖率 c 下,alpha = 0.5 - c/2, 0.5 + c/2 处的分位数预测。

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

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

注意

  • 目前仅为 Series (非面板、非分层) 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 类型,则在内部(通过 _check_fh)将其强制转换为 ForecastingHorizon

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

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

X外生时间序列,采用 sktime 兼容格式,可选(默认为 None)

用于预测的外生时间序列。应与 fity 具有相同的 scitype(SeriesPanelHierarchical)。如果 self.get_tag("X-y-must-have-same-index"),则 X.index 必须包含 fh 索引引用。

marginalbool, optional (default=True)

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

返回值:
pred_distskpro BaseDistribution

如果 marginal=True,则为预测分布,将是按时间点的边际分布;如果 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 类型,则在内部(通过 _check_fh)将其强制转换为 ForecastingHorizon

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

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

X外生时间序列,采用 sktime 兼容格式,可选(默认为 None)

用于预测的外生时间序列。应与 fity 具有相同的 scitype(SeriesPanelHierarchical)。如果 self.get_tag("X-y-must-have-same-index"),则 X.index 必须包含 fh 索引引用。

alpha浮点数或唯一浮点数列表,可选(默认为 [0.05, 0.95])

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

返回值:
quantilespd.DataFrame
列具有多级索引:第一级是 fit 中 y 的变量名,

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

行索引是 fh,附加(上层)级别等于实例级别,

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

条目是分位数预测,对于列索引中的 var,

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

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

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

残差将针对 y.index 处的预测进行计算。

如果 fh 必须在 fit 中传入,则必须与 y.index 一致。如果 y 是一个 np.ndarray,并且在 fit 中没有传入 fh,则残差将在 fh 为 range(len(y.shape[0])) 时计算。

所需状态

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

在 self 中访问

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

写入 self

无。

参数:
y时间序列,采用 sktime 兼容数据容器格式

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

如果为 None,则使用目前已看到的 y (self._y),特别是

  • 如果之前只有一次 fit 调用,则产生样本内残差。

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

X外生时间序列,sktime 兼容格式,可选(默认为 None)

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

返回值:
y_res时间序列,采用 sktime 兼容数据容器格式

fh` 处的预测残差,具有与 ``fh 相同的索引。y_res 与最近传入的 y 具有相同的类型:SeriesPanelHierarchical scitype,相同的格式(见上文)。

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 类型,则在内部(通过 _check_fh)将其强制转换为 ForecastingHorizon

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

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

X外生时间序列,采用 sktime 兼容格式,可选(默认为 None)

用于预测的外生时间序列。应与 fity 具有相同的 scitype(SeriesPanelHierarchical)。如果 self.get_tag("X-y-must-have-same-index"),则 X.index 必须包含 fh 索引引用。

covbool, optional (default=False)

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

返回值:
pred_varpd.DataFrame, format dependent on cov variable
如果 cov=False
列名与 fit/update 中传入的 y 的列名完全相同。

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

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

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

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

在给定观测数据的情况下,该变量和索引的方差。

如果 cov=True
列索引是多级索引:第一级是变量名(如上所示)

第二级是 fh。

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

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

条目是(协)方差预测,对于列索引中的 var,以及

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

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

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]#

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

行为:如果 path 为 None,则返回内存中的序列化 self;如果 path 是文件位置,则将 self 作为 zip 文件存储在该位置。

保存的文件是 zip 文件,包含以下内容:_metadata - 包含 self 的类,即 type(self);_obj - 序列化的 self。此类使用默认序列化方式 (pickle)。

参数:
pathNone or file location (str or 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”。请注意,非默认格式可能需要安装其他软依赖项。

返回值:
if path is None - in-memory serialized self
if path is file location - ZipFile with reference to the file
score(y, X=None, fh=None)[source]#

使用 MAPE(非对称)根据真实值对预测进行评分。

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

用于评分的时间序列。

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

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

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

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

返回值:
scorefloat

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

set_config(**config_dict)[source]#

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

参数:
config_dictdict

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

displaystr, “diagram” (default), or “text”

jupyter 内核如何显示 self 的实例。

  • “diagram” = html 方框图表示。

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

print_changed_onlybool, default=True

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

warningsstr, “on” (default), or “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={} (no parameters passed)

作为配置传递给并行化后端的附加参数。有效键取决于 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”:布尔值,默认为 True;False 阻止 ray

      并行化后关闭。

    • “logger_name”:字符串,默认为“ray”;要使用的日志记录器名称。

    • “mute_warnings”:布尔值,默认为 False;如果为 True,则抑制警告。

remember_databool, default=True

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

返回值:
selfreference to self.

注意

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

set_params(**params)[source]#

设置此对象的参数。

此方法适用于简单的 skbase 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象(即包含其他对象的对象),以访问组件 <component> 中的 <parameter>。如果这使得引用没有歧义,例如,没有两个组件参数具有相同的名称 <parameter>,也可以使用不带 <component>__ 的字符串 <parameter>

参数:
**paramsdict

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

返回值:
selfreference to self (after parameters have been set)
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

设置 self 的 random_state 伪随机种子参数。

通过 self.get_params 查找名为 random_state 的参数,并通过 set_params 将它们设置为通过 sample_dependent_seedrandom_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 instance or None, default=None

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

deepbool, default=True

是否设置 skbase 对象值参数的随机状态,即组件估计器。

  • 如果为 False,则仅设置 selfrandom_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 派生,并且通常与它不同。

返回值:
selfreference to self
set_tags(**tag_dict)[source]#

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

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

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

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

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

当前标签值可以通过 get_tagsget_tag 进行检查。

参数:
**tag_dictdict

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

返回值:
Self

对 self 的引用。

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

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

如果没有实现特定于估计器的 update 方法,则默认回退如下:

  • update_params=True:对所有已观测数据进行拟合。

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

所需状态

要求状态为“已拟合”,即 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.DataFramepd.Seriesnp.ndarray(1维或2维)。

  • Panel scitype = 时间序列集合,全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (实例, 时间),3D np.ndarray (实例, 变量, 时间),Series 类型 pd.DataFramelist

  • Hierarchical scitype = 分层集合,用于分层预测。pd.DataFrame 具有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)。

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

X外生时间序列,采用 sktime 兼容格式,可选(默认为 None)。

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

update_params布尔值,可选 (默认值=True)

是否应更新模型参数。如果为 False,则仅更新截断点 (cutoff),不更新模型参数(例如,系数)。

返回值:
selfreference to 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 方法,则默认回退如下:

  • 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,则不更新状态。

参数:
y时间序列,采用 sktime 兼容的数据容器格式。

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

sktime 中的单个数据格式称为 mtype 规范,每个 mtype 都实现一个抽象 scitype

  • Series scitype = 单个时间序列,普通预测。pd.DataFramepd.Seriesnp.ndarray(1维或2维)。

  • Panel scitype = 时间序列集合,全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (实例, 时间),3D np.ndarray (实例, 变量, 时间),Series 类型 pd.DataFramelist

  • Hierarchical scitype = 分层集合,用于分层预测。pd.DataFrame 具有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)。

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

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

例如,SlidingWindowSplitterExpandingWindowSplitter;默认值 = ExpandingWindowSplitter,其 initial_window=1 和默认参数 = y/X 中的单个数据点被逐个添加并预测,initial_window = 1step_length = 1fh = 1

X外生时间序列,sktime 兼容格式,可选(默认为 None)

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

update_params布尔值,可选 (默认值=True)

是否应更新模型参数。如果为 False,则仅更新截断点 (cutoff),不更新模型参数(例如,系数)。

reset_forecaster布尔值,可选 (默认值=True)
  • 如果为 True,则不会改变预测器的状态,即使用副本运行更新/预测序列,且 self 的截断点 (cutoff)、模型参数、数据内存不会改变

  • 如果为 False,则在运行更新/预测序列时会更新 self,就像直接调用 update/predict 一样

返回值:
y_pred一个对象,用于汇总来自多个拆分批次的点预测

格式取决于预测器整体的 (截断点, 绝对预测期) 对

  • 如果绝对预测期点的集合是唯一的:类型是 sktime 兼容数据容器格式的时间序列,输出中会抑制截断点,与最近传递的 y 具有相同的类型:Series, Panel, Hierarchical scitype,相同的格式(参见上文)

  • 如果绝对预测期点的集合不唯一:类型是一个 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

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

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

参数:
y时间序列,采用 sktime 兼容的数据容器格式。

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

sktime 中的单个数据格式称为 mtype 规范,每个 mtype 都实现一个抽象 scitype

  • Series scitype = 单个时间序列,普通预测。pd.DataFramepd.Seriesnp.ndarray(1维或2维)。

  • Panel scitype = 时间序列集合,全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (实例, 时间),3D np.ndarray (实例, 变量, 时间),Series 类型 pd.DataFramelist

  • Hierarchical scitype = 分层集合,用于分层预测。pd.DataFrame 具有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)。

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

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

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

X外生时间序列,sktime 兼容格式,可选(默认为 None)

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

update_params布尔值,可选 (默认值=True)

是否应更新模型参数。如果为 False,则仅更新截断点 (cutoff),不更新模型参数(例如,系数)。

返回值:
y_pred时间序列,采用 sktime 兼容数据容器格式

fh 处的点预测,具有与 fh 相同的索引。y_pred 与最近传入的 y 具有相同的类型:SeriesPanelHierarchical scitype,相同的格式(见上文)。