ReconcilerForecaster#

class ReconcilerForecaster(forecaster, method='mint_shrink', return_totals=True)[source]#

分层调和预测器。

应用调和方法，使时间序列层次结构中的预测总和适当一致。

首先使用任何预测器为层次结构中的每个成员单独生成基本预测。然后对基本预测进行调和，使其总和适当一致。这个调和步骤通常可以提高层次结构中预测的准确性。

更多信息请参考 [1]。

参数:
forecaster估计器

用于生成基本预测的估计器，然后对这些预测进行调和

method{“mint_cov”, “mint_shrink”, “ols”, “wls_var”, “wls_str”, “bu”, “td_fcst”}，默认值=”mint_shrink”

应用于预测的调和方法，基于

  • "mint_cov" - 样本协方差

  • "mint_shrink" - 带有收缩的协方差

  • "ols" - 普通最小二乘

  • "wls_var" - 加权最小二乘（方差）

  • "wls_str" - 加权最小二乘（结构）

  • "bu" - 自下而上

  • "td_fcst" - 基于预测比例的自上而下

return_totals布尔值

预测 (predict) 和类似预测的方法返回的预测结果是否应包含层次结构中的总值，这些总值存储在 __total 索引级别。

  • 如果为 True，预测数据帧将在 __total 级别包含总值

  • 如果为 False，返回的预测数据帧不包含 __total 级别

属性:
截止点

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

fh

传递的预测范围。

is_fitted

fit 是否已被调用。

另请参阅

Aggregator
Reconciler

参考文献

示例

>>> from sktime.forecasting.naive import NaiveForecaster
>>> from sktime.forecasting.reconcile import ReconcilerForecaster
>>> from sktime.transformations.hierarchical.aggregate import Aggregator
>>> from sktime.utils._testing.hierarchical import _bottom_hier_datagen
>>> agg = Aggregator()
>>> y = _bottom_hier_datagen(
...     no_bottom_nodes=3,
...     no_levels=1,
...     random_seed=123,
...     length=7,
... )
>>> y = agg.fit_transform(y)
>>> forecaster = NaiveForecaster(strategy="drift")
>>> reconciler = ReconcilerForecaster(forecaster, method="mint_shrink")
>>> reconciler.fit(y)
ReconcilerForecaster(...)
>>> prds_recon = reconciler.predict(fh=[1])

方法

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

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

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

将序列化后的对象保存到字节类对象或到 (.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()[source]#

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

返回:
paramsdict，默认值 = {}

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

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 或 list of 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])

nameslist of str，长度与 objs 相同

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

property cutoff[source]#

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

返回:
cutoffpandas 兼容的索引元素，或 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 具有两级行 MultiIndex (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，list 类型的 Series pd.DataFrame

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

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

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

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

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

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

返回:
self对 self 的引用。
fit_predict(y, X=None, fh=None, X_pred=None)[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 具有两级行 MultiIndex (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，list 类型的 Series pd.DataFrame

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

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

fhint, list, pd.Index 可强制转换类型，或 ForecastingHorizon （非可选）

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

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

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

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

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

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

获取已拟合的参数。

所需状态

要求状态为“已拟合”。

参数:
deep布尔值，默认值=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]#

获取对象的参数名称。

参数:
sort布尔值，默认值=True

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

返回:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deep布尔值，默认值=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_error布尔值

未找到标签时是否引发 ValueError

返回:
tag_value任意类型

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 对象属性的任何覆盖和新标签。

is_composite()[source]#

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

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

返回:
composite: bool

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

property is_fitted[source]#

fit 是否已被调用。

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

返回:
布尔值

估计器是否已 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) 输出的第一个元素
返回:
反序列化的 self，结果输出 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 可强制转换类型，或 ForecastingHorizon，默认值=None

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

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

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

用于预测的外生时间序列。应与 fit 中的 y 具有相同的 scitype (Series, Panel 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index")，则 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 且之前未传递过，则将其存储到 self.fh 中。

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

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

如果 fh 不是 None 且不是 ForecastingHorizon 类型，则内部会强制转换为 ForecastingHorizon (通过 _check_fh)。

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

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

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

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

coveragefloat 或 list of float 唯一值列表，可选（默认值=0.90）

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

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

顺序与输入 coverage 相同。

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

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

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

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

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

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

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

注意

  • 目前仅为 Series（非面板，非分层）y 实现。

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

所需状态

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

访问 self 中的内容

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

  • self.cutoff, self.is_fitted

写入 self

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

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

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

如果 fh 不是 None 且不是 ForecastingHorizon 类型，则内部会强制转换为 ForecastingHorizon (通过 _check_fh)。

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

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

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

用于预测的外生时间序列。应与 fit 中的 y 具有相同的 scitype (Series, Panel 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index")，则 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

写入 self

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

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

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

如果 fh 不是 None 且不是 ForecastingHorizon 类型，则内部会强制转换为 ForecastingHorizon (通过 _check_fh)。

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

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

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

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

alphafloat 或 list of 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 的索引

X以 sktime 兼容格式表示的时间序列，可选 (默认为 None)

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

返回:
y_res以 sktime 兼容数据容器格式表示的时间序列

在 fh`, with same index as ``fh 上的预测残差，索引与 fh 相同。y_res 与最近传入的 y 类型相同：Series、Panel、Hierarchical 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 可强制转换类型，或 ForecastingHorizon，默认值=None

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

如果 fh 不是 None 且不是 ForecastingHorizon 类型，则内部会强制转换为 ForecastingHorizon (通过 _check_fh)。

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

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

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

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

cov布尔值，可选 (默认为 False)

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

返回:
pred_varpd.DataFrame，格式取决于 cov 变量
如果 cov=False
列名与在 fit/update 中传入的 y 的列名完全相同。

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

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

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

条目是方差预测，对应于列索引中的变量 (var)。给定变量和 fh 索引的方差预测是预测的

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

如果 cov=True
列索引是一个多级索引 (multiindex)：第一级是变量名 (如上所述)

第二级是 fh。

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

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

条目是 (协)方差预测，对应于列索引中的变量 (var)，并且

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

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

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

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

行为：如果 path 为 None，则返回内存中的序列化 self；如果 path 是文件位置，则将 self 以 zip 文件形式存储在该位置

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

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

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

  • path="estimator"，则将在当前工作目录 (cwd) 生成一个名为 estimator.zip 的 zip 文件。

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

/home/stored/ 中存储一个 estimator.zip 的 zip 文件。

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 可强制转换类型，或 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

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

displaystr，"diagram" (默认)，或 "text"

jupyter 内核如何显示 self 的实例

  • "diagram" = html 框图表示

  • "text" = 字符串打印输出

print_changed_only布尔值，默认为 True

打印 self 时是只列出与默认值不同的 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: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"：str，默认为 “ray”；要使用的日志记录器名称。

    • "mute_warnings"：布尔值，默认为 False；如果为 True，则抑制警告

remember_data布尔值，默认为 True

self._X 和 self._y 是否在 fit 中存储并在 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>。

参数:
**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 以确保在多次函数调用中获得可复现的输出。

deep布尔值，默认值=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 兼容对象都有一个标签字典，用于存储对象的元数据。

标签 (Tags) 是特定于实例 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: 仅更新截止点 (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 具有两级行 MultiIndex (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，list 类型的 Series pd.DataFrame

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

有关数据格式的更多详细信息，请参阅 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，则仅更新截止点 (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 具有两级行 MultiIndex (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，list 类型的 Series pd.DataFrame

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

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

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

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

X以 sktime 兼容格式表示的时间序列，可选 (默认为 None)

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

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

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

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

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

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

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

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

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

  • 如果绝对预测期点集合不是唯一的：类型是一个 pandas DataFrame，行索引和列索引是时间戳，行索引对应于预测的截止点 (cutoffs)，列索引对应于预测的绝对预测期 (absolute horizons)，条目是从行索引预测的列索引的点预测值，如果在该 (截止点, 预测期) 对没有做出预测，则条目为 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 具有两级行 MultiIndex (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，list 类型的 Series pd.DataFrame

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

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

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

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

X以 sktime 兼容格式表示的时间序列，可选 (默认为 None)

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

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

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

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

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