CINNForecaster#

class CINNForecaster(n_coupling_layers=10, hidden_dim_size=32, sample_dim=24, batch_size=64, encoded_cond_size=64, lr=0.0005, weight_decay=1e-05, sp_list=None, fourier_terms_list=None, window_size=720, num_epochs=50, verbose=False, f_statistic=None, init_param_f_statistic=None, deterministic=False, lag_feature='mean', patience=5, delta=0.0001, val_split=0.2)[source]#

条件可逆神经网络 (cINN) 预测器。

该预测器使用 cINN 对时间序列进行预测。cINN 学习时间序列与正态分布潜在空间之间的双射映射。然后对潜在空间进行采样并转换回时间序列空间。cINN 以时间序列的统计和基于傅里叶项的特征以及所提供的外生特征为条件。KIT-IAI 团队在 BigDEAL 挑战中应用了该预测器，并在 [1]_ 中进行了描述。

参数:
n_coupling_layersint, 可选 (默认值=15)

cINN 中的耦合层数。

hidden_dim_sizeint, 可选 (默认值=64)

子网络中的隐藏单元数。

sample_dimint, 可选 (默认值=24)

cINN 创建的样本的维度

batch_sizeint, 可选 (默认值=64)

训练的批次大小。

encoded_cond_sizeint, 可选 (默认值=64)

编码条件的维度。

lrfloat, 可选 (默认值=5e-4)

Adam 优化器的学习率。

weight_decayfloat, 可选 (默认值=1e-5)

Adam 优化器的权重衰减。

sp_listint 列表, 可选 (默认值=[24])

用于傅里叶特征的季节周期列表。

fourier_terms_listint 列表, 可选 (默认值=[1, 1])

用于傅里叶特征的傅里叶项数列表。

window_sizeint, 可选 (默认值=24*30)

使用 WindowSummarizer 计算滚动统计信息的窗口大小。

lag_feature: str, 可选 (默认值=”mean”)

WindowSummarizer 应计算的滚动统计信息。

num_epochsint, 可选 (默认值=50)

训练 cINN 的 epoch 数。

verbosebool, 可选 (默认值=False)

是否打印训练进度。

f_statisticfunction, 可选 (默认值=default_sine)

用于预测滚动统计信息的函数。

init_param_f_statisticfloat 列表, 可选 (默认值=[1, 0, 0, 10, 1, 1])

f_statistic 函数的初始参数。

deterministicbool, 可选 (默认值=False)

是使用确定性 cINN 还是随机 cINN。注意，确定性应仅用于测试。

patienceint, 可选 (默认值=5)

停止训练前的等待 epoch 数。

deltafloat, 可选 (默认值=0.0001)

验证损失被视为改进的最小变化。

val_splitfloat, 可选 (默认值=0.2)

用于验证的数据比例。

属性:
cutoff

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

fh

传递的预测视野。

is_fitted

是否已调用 fit。

参考文献

..[1] Heidrich, B., Hertel, M., Neumann, O., Hagenmeyer, V., & Mikut, R.

(2023). Using conditional Invertible Neural Networks to Perform Mid- Term Peak Load Forecasting. IET Smart Grid, Under Review

示例

>>> from sktime.forecasting.conditional_invertible_neural_network import (
...     CINNForecaster,
... )
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> model = CINNForecaster(window_size=100) 
>>> model.fit(y) 
CINNForecaster(...)
>>> y_pred = model.predict(fh=[1,2,3])

方法

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

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

load_from_path(path)

从文件位置加载对象。

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

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

参数:
parameter_setstr, 默认值=”default”

要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，则返回 “default” 集。当前预测器没有保留值。

返回:
paramsdict 或 dict 列表, 默认值 = {}

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

save(path=None, serialization_format='pickle')[source]#

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

行为：如果 path 为 None，则返回内存中的序列化自身；如果 path 是文件，则将 zip 文件及其名称存储在该位置。zip 文件的内容是：_metadata - 包含自身的类，即 type(self)。_obj - 序列化自身。此类使用默认序列化 (pickle)。keras/ - 模型、优化器和状态存储在此目录中。history - 序列化历史对象。

参数:
pathNone 或文件位置 (str 或 Path)

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

path=”estimator” 则将在当前工作目录创建 zip 文件 estimator.zip。path=”/home/stored/estimator” 则将在 /home/stored/ 中存储 zip 文件 estimator.zip。

serialization_format: str, 默认值 = “pickle”

用于序列化的模块。可用选项在 sktime.base._base.SERIALIZATION_FORMATS 下。注意，非默认格式可能需要安装其他软依赖项。

返回:
如果 path 为 None - 内存中的序列化自身
如果 path 为文件位置 - 引用文件的 ZipFile
classmethod load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化自身，产生 serial 输出，来自 cls.save(None)
classmethod load_from_path(path)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回:
反序列化自身，产生 path 处的输出，来自 cls.save(path)
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。is_fitted 属性应在调用对象的 fit 方法时设置为 True。

如果不是，则抛出 NotFittedError。

参数:
method_namestr, 可选

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

抛出:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

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

等同于构造一个 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 查看当前标签值。

参数:
estimator:class:BaseObject 或派生类的实例
tag_namesstr 或 str 列表, 默认值 = None

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

返回:
self

对 self 的引用。

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

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

参数:
parameter_setstr, 默认值=”default”

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

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

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

参数:
parameter_setstr, 默认值=”default”

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

返回:
objscls 实例列表

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

namesstr 列表, 与 objs 长度相同

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

property cutoff[source]#

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

返回:
cutoffpandas 兼容索引元素, 或 None

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

property fh[source]#

传递的预测视野。

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

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

状态变化

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

写入自身

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

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

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

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

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

要拟合预测器的时间序列。

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

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

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

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

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

fhint, list, pd.Index 可强制转换, 或 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")，则 X.index 必须包含 y.index。

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

状态变化

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

写入自身

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

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

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

  • 将 fh 存储到 self.fh。

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

要拟合预测器的时间序列。

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

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

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

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

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

fhint, list, pd.Index 可强制转换, 或 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")，则 X.index 必须包含 y.index。

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

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

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

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

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

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

每个 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()[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, 默认值=True

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

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

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

返回:
fitted_params键为 str 的 dict

拟合参数字典，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, 默认值=True

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

返回:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deepbool, 默认值=True

是否返回组件的参数。

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

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

返回:
params键为 str 的 dict

参数字典，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_tags 或 clone_tags 设置的标签，

在实例构造时。

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

  2. 在父类的 _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()[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 对象属性的任何覆盖和新标签。

get_y_true(y)[source]#

获取用于验证的 y_true 值。

is_composite()[source]#

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

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

返回:
composite: bool

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

property is_fitted[source]#

是否已调用 fit。

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

返回:
布尔值

估计器是否已经 fit 过。

predict(fh=None, X=None)[source]#

在未来视野上预测时间序列。

所需状态

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

访问 self 中的内容

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

  • self.cutoff, self.is_fitted

写入自身

如果传递了 fh 且之前未传递过，则将 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 的科学类型 (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

写入自身

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

coverage浮点数或包含唯一浮点数值的列表，可选 (默认值为 0.90)

预测区间的名义覆盖水平

返回:
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

写入自身

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

marginal布尔值，可选 (默认值为 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

写入自身

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

alpha浮点数或包含唯一浮点数值的列表，可选 (默认值为 [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，则将在 fh 为 range(len(y.shape[0])) 时计算残差。

所需状态

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

访问 self 中的内容

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

写入自身

无。

参数:
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

写入自身

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

cov布尔值，可选 (默认值为 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

类的实例被重置到初始状态，但保留当前的超参数值。

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

使用 MAPE（非对称）评估预测与地面真相的对比。

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

用于评分的时间序列

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

编码要预测的时间戳的预测视野。

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

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

返回:
score浮点数

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

另请参阅

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

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

参数:
config_dictdict

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

display字符串，“diagram” (默认)，或 “text”

jupyter kernel 如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_only布尔值，默认值为 True

打印 self 时是否只列出与默认值不同的 self 参数（False），或列出所有参数名称和值（False）。不嵌套，即只影响 self，不影响组件估计器。

warnings字符串，“on” (默认)，或 “off”

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

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

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

backend:parallel字符串，可选，默认值为“None”

进行广播/向量化时用于并行处理的后端，可选值之一为

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

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

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

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

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

backend:parallel:params字典，可选，默认值为 {} (未传递参数)

作为配置传递给并行化后端的附加参数。有效键取决于 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_data布尔值，默认值为 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>。如果引用是明确的（例如，没有两个组件参数具有相同的名称 <parameter>），也可以使用不带 <component>__ 前缀的字符串 <parameter>。

参数:
**params字典

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

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

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

通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 派生的整数。这些整数通过 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 实例或 None，默认值为 None

伪随机数生成器，用于控制随机整数的生成。传入 int 可使跨多个函数调用的输出具有可重现性。

deepbool, 默认值=True

是否在值类型为 skbase 对象的参数中设置随机状态，即组件估计器。

  • 如果为 False，则仅设置 self 的 random_state 参数（如果存在）。

  • 如果为 True，也将设置组件对象中的 random_state 参数。

self_policy字符串，可选值为 {“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_dict字典

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

返回:
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.cutoff 更新为在 y 中看到的最新索引。

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

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

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

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

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

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

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

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

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

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

update_params布尔值，可选 (默认值为 True)

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

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

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

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

等同于以下操作（如果只有 y 和 cv 不是默认值时）

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

  2. 记住 self.predict() 的结果（稍后在单个批次中返回）

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

  4. 记住 self.predict() 的结果（稍后在单个批次中返回）

  5. 等等

  6. 返回所有记住的预测结果

如果未实现估计器特定的 update 方法，默认回退行为如下

  • update_params=True：对目前已见的所有数据进行拟合

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

所需状态

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

访问 self 中的内容

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

  • self.cutoff, self.is_fitted

写入 self（除非 reset_forecaster=True）

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

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

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

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

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

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

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

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

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

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

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

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

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

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

update_params布尔值，可选 (默认值为 True)

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

reset_forecaster布尔值，可选 (默认值为 True)

  • 如果为 True，将不会改变预测器的状态，即 update/predict 序列是在一个副本上运行的，并且 self 的截止点、模型参数、数据内存不会改变

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

返回:
y_pred用于以表格形式呈现多个分割批次的点预测结果的对象

格式取决于整体预测的（截止点，绝对预测范围）对

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

  • 如果绝对预测范围点的集合不是唯一的：类型是一个 pandas DataFrame，行索引和列索引都是时间戳，行索引对应于从中进行预测的截止点，列索引对应于被预测的绝对预测范围，条目是从行索引预测的列索引的点预测值，如果在该（截止点，预测范围）对处未进行预测，则条目为 nan

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

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

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

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

所需状态

要求状态为“已拟合”。

访问 self 中的内容

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

写入自身

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

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

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

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

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

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

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

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

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

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

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

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

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

update_params布尔值，可选 (默认值为 True)

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

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

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