ESRNNForecaster#

class ESRNNForecaster(hidden_size=10, num_layer=5, season1_length=12, season2_length=6, seasonality_type='single', window=10, stride=1, batch_size=32, num_epochs=1000, criterion=None, optimizer='Adam', lr=0.1, optimizer_kwargs=None, criterion_kwargs=None, custom_dataset_train=None, custom_dataset_pred=None)[source]#

指数平滑循环神经网络。

此模型结合了指数平滑 (ES) 和循环神经网络 (LSTM) 用于时间序列预测。ES 用于平衡序列的水平和季节性。此方法在 [1] 中提出。

参数:
hidden_sizeint

隐藏状态中的特征数量

num_layerint

层数

seasonality_typestring

季节性类型，可以是 zero, single 或 double

season1_lengthint

季节性 1 的周期

season2_lengthint

季节性 2 的周期

strideint

滑动窗口的步长

batch_sizeint

训练期间的批大小

num_epochsint

训练期间的 epoch 数量

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 的关键字参数

windowint

输入窗口大小，默认为 5

lrint

训练的学习率

属性:
cutoff

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

fh

已传递的预测范围。

is_fitted

是否已调用 fit 方法。

参考文献

[1]

Smyl, S. 2020.

一种结合指数平滑和循环神经网络的时间序列预测混合方法。 https://www.sciencedirect.com/science/article/pii/S0169207019301153

示例

>>> from sktime.forecasting.es_rnn import ESRNNForecaster 
>>> from sktime.datasets import load_airline
>>> from sktime.transformations.series.boxcox import LogTransformer
>>> y = load_airline()
>>> scaler=LogTransformer()
>>> forecaster=ESRNNForecaster(15,6,12,6,'double',20,1,32,100,'MSE')
>>> y_new=scaler.fit_transform(y)
>>> forecaster.fit(y_new, fh=[1,2,3]) 
>>> y_pred = forecaster.predict() 
>>> y_pred=scaler.inverse_transform(y_pred)

方法

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

将序列化的 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)[source]#

为训练构建 PyTorch DataLoader。

build_pytorch_pred_dataloader(y, fh)[source]#

为预测构建 PyTorch DataLoader。

check_is_fitted(method_name=None)[source]#

检查评估器是否已拟合。

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

如果未设置，则引发 NotFittedError。

参数:
method_namestr, optional

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

引发:
NotFittedError

如果评估器尚未拟合。

clone()[source]#

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

克隆是一个没有共享引用、处于初始化后状态的独立对象。此函数等同于返回 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)[source]#

将其他对象的标签克隆为动态覆盖。

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

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

clone_tags 方法只能在对象的 __init__ 方法中调用，即在构造期间或通过 __init__ 直接构造之后。

动态标签被设置为 estimator 中标签的值，名称由 tag_names 指定。

tag_names 的默认设置是将 estimator 中的所有标签写入 self。

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

参数:
estimatorAn instance of :class:BaseObject or derived class
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 个元素是测试中 obj 的第 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。

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

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

个体数据格式在 sktime 中称为 mtype 规范，每种 mtype 实现一个抽象的 scitype。

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

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

  • 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 中传递，不可选。

Xsktime 兼容格式的时间序列，可选（默认为 None）。

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

返回:
selfself 的引用。
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。

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

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

个体数据格式在 sktime 中称为 mtype 规范，每种 mtype 实现一个抽象的 scitype。

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

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

  • 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) 被强制转换。

Xsktime 兼容格式的时间序列，可选（默认为 None）。

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

X_predsktime 兼容格式的时间序列，可选（默认为 None）

用于预测的外生时间序列。如果传递，将在 predict 中使用，而不是 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)[source]#

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

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

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

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

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

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

按继承顺序。

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

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

参数:
tag_namestr

标签值的名称。

tag_value_defaultany type

如果未找到标签，则为默认/备用值。

返回:
tag_value

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

classmethod get_class_tags()[source]#

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

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

获取自身的配置标志。

配置是 self 的键值对，通常用作控制行为的瞬态标志。

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

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

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

返回:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态

要求状态为“已拟合”。

参数:
deepbool, default=True

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

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

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

返回:
fitted_paramsdict with str-valued keys

已拟合参数字典，参数名 : 参数值 的键值对包括

  • 总是：此对象的所有已拟合参数，通过 get_param_names 获取，值是该键对应的已拟合参数值，属于此对象

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

  • 如果 deep=True，还包含任意级别的组件递归，例如 [组件名称]__[子组件名称]__[参数名称] 等

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

参数字典，参数名 : 参数值 的键值对包括

  • 总是：此对象的所有参数，通过 get_param_names 获取，值是该键对应的参数值，属于此对象，值始终与构造时传递的值相同

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

  • 如果 deep=True，还包含任意级别的组件递归，例如 [组件名称]__[子组件名称]__[参数名称] 等

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

从实例中获取标签值，并包含标签级别继承和覆盖。

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

从实例中获取标签，并包含标签级别继承和覆盖。

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

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

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

值是相应的标签值，覆盖按优先级降序排列如下：

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

在实例构造时。

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

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

按继承顺序。

返回:
collected_tagsdict

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

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

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

参数:
parameter_setstr, default=”default”

要返回的测试参数集的名称，用于测试。如果未为特定值定义特殊参数，将返回 "default" 集。分类器的保留值

“results_comparison” - 用于某些分类器的身份测试，应包含与“TSC bakeoff”相当的参数设置

返回:
paramsdict or list of dict, default = {}

用于创建类测试实例的参数。每个字典是用于构建“有趣”测试实例的参数，即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个（或唯一的）字典。

get_y_true(y)[source]#

获取用于验证的 y_true 值。

is_composite()[source]#

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

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

返回:
composite: bool

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

property is_fitted[source]#

是否已调用 fit 方法。

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

返回:
bool

预测器是否已 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回:
反序列化 self，结果输出到 path，来自 cls.save(path)
classmethod load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第 1 个元素
返回:
反序列化 self，结果输出 serial，来自 cls.save(None)
predict(fh=None, X=None)[source]#

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

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入 self

如果传递了 fh 且之前未传递过，则将 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 具有相同的科学类型 (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 且之前未传递过，则将 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 具有相同的科学类型 (Series, Panel 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。

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

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

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

与输入 coverage 的顺序相同。

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

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

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

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

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

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 且之前未传递过，则将 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 具有相同的科学类型 (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)[source]#

计算/返回分位数预测。

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

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入 self

如果传递了 fh 且之前未传递过，则将 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 具有相同的科学类型 (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)[source]#

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

将计算在 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 具有相同的科学类型 (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 且之前未传递过，则将 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 具有相同的科学类型 (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()[source]#

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

将 self 重置到构造函数调用后的状态，并保持相同的超参数。通过 set_config 设置的配置值也会保留。

一个 reset 调用删除所有对象属性，除了

  • 超参数 = 写入 self 的 __init__ 参数，例如 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 或文件位置 (str 或 Path)

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

  • path=”estimator”，则将在当前工作目录 (cwd) 创建一个 zip 文件 estimator.zip。

  • path=”/home/stored/estimator”，则将在

存储在 /home/stored/。

serialization_format: str，默认 = “pickle”

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

返回:
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 引用该文件的 ZipFile 对象
score(y, X=None, fh=None)[source]#

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

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

用于评分的时间序列

fhint, list, pd.Index 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 kernel 如何显示 self 的实例

  • “diagram” = html 框图表示

  • “text” = 字符串输出

print_changed_onlybool，默认=True

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

warningsstr，“on”（默认）或“off”

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

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

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

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

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

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

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

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

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

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

backend:parallel:paramsdict，可选，默认={}（不传递参数）

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

  • “None”：无附加参数，忽略 backend_params

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

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

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

  • “ray”：可传递以下键

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

    • “shutdown_ray”：bool，默认=True；False 防止 ray 在

      并行化后关闭。

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

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

remember_databool，默认=True

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

设置此对象的参数。

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

参数:
**paramsdict

BaseObject 参数，键必须是 <component>__<parameter> 字符串。如果仅使用 <parameter> 在 get_params 键中是唯一的，则可以使用将其用作完整键的别名。

返回:
self对 self 的引用（设置参数后）
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

为 self 设置 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, 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 方法，则默认回退如下

  • update_params=True：拟合到目前为止所有已观测数据

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

所需状态

要求状态为“已拟合”，即 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 (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，list，包含 Series 类型的 pd.DataFrame

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

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

Xsktime 兼容格式的时间序列，可选（默认为 None）。

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

update_paramsbool，可选 (默认=True)

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

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

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

执行多个 update / predict 的链式调用的简写，数据回放基于时间序列分割器 cv。

与以下代码相同（如果仅 y, cv 为非默认值）

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

所需状态

要求状态为“已拟合”，即 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 (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，list，包含 Series 类型的 pd.DataFrame

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

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

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

例如 SlidingWindowSplitter 或 ExpandingWindowSplitter；默认 = initial_window=1 的 ExpandingWindowSplitter，默认情况下 y/X 中的单个数据点被逐一添加和预测，initial_window = 1，step_length = 1 且 fh = 1

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

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

update_paramsbool，可选 (默认=True)

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

reset_forecasterbool，可选 (默认=True)

  • 如果为 True，则不会改变预测器的状态，即使用副本运行 update/predict 序列，self 的 cutoff、模型参数、数据内存不会改变

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

返回:
y_pred汇总来自多个分割批次的点预测结果的对象

格式取决于预测总体上的 (cutoff, absolute horizon) 对

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

  • 如果绝对预测期点集合不是唯一的：类型是 pandas DataFrame，行和列索引是时间戳，行索引对应于预测的 cutoff，列索引对应于预测的绝对预测期，条目是根据行索引预测的列索引的点预测值，如果在该 (cutoff, horizon) 对没有预测，则条目为 nan

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

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

此方法有助于一步完成更新和预测。

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

所需状态

要求状态为“已拟合”。

访问 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 (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，list，包含 Series 类型的 pd.DataFrame

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

有关数据格式的更多详细信息，请参阅 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，则仅更新 cutoff，模型参数（例如系数）不更新。

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

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