StatsForecastADIDA#

class StatsForecastADIDA(prediction_intervals: object | None = None)[source]#

StatsForecast ADIDA (聚合-分解间歇需求方法) 模型。

直接接口到 Nixtla 的 statsforecast.models.ADIDA。

此估计器直接接口 statsforecast [1] 中的 ADIDA (由 Nixtla 提供)。

聚合-分解间歇需求方法：使用时间聚合减少零观测的数量。数据聚合后，使用优化的 SES 生成新层级的预测。然后使用相等权重将预测分解回原始层级。

ADIDA 专门处理稀疏或间歇序列，这些序列的非零观测值非常少。它们以难以预测而闻名，因此，专门为其开发了不同的方法。

参数:
prediction_intervalsConformalIntervals，可选

用于计算一致预测区间的信息。

属性:
cutoff

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

fh

传递的预测范围。

is_fitted

是否已调用 fit。

参考资料

示例

>>> from sktime.datasets import load_airline
>>> from sktime.forecasting.statsforecast import StatsForecastADIDA
>>> y = load_airline()
>>> model = StatsForecastADIDA()
>>> fitted_model = model.fit(y) 
>>> y_pred = fitted_model.predict(fh=[1, 2, 3])

方法

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

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

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

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

使用新数据更新模型并进行预测。
check_is_fitted(method_name=None)[源码]#

检查估计器是否已拟合。

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

如果不是，则会引发 NotFittedError。

参数:
method_namestr，可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[源码]#

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

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

等同于构造一个 type(self) 的新实例，使用 self 的参数，即 type(self)(**self.get_params(deep=False))。

如果 self 上设置了配置，则克隆也会具有与原始对象相同的配置，等同于调用 cloned_self.set_config(**self.get_config())。

在值上也等同于调用 self.reset，区别在于 clone 返回一个新对象，而不是像 reset 那样改变 self。

引发:
如果由于错误的 __init__ 导致克隆不合规，则会引发 RuntimeError。
clone_tags(estimator, tag_names=None)[源码]#

将来自另一个对象的标签克隆为动态覆盖。

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

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

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

clone_tags 方法只能在对象构建期间的 __init__ 方法中调用，或直接在 __init__ 后调用。

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

tag_names 的默认值会从 estimator 将所有标签写入到 self。

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

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

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

返回:
self

self 的引用。

classmethod create_test_instance(parameter_set='default')[源码]#

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

参数:
parameter_setstr，默认值为“default”

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

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

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

参数:
parameter_setstr，默认值为“default”

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

返回:
objscls 实例列表

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

namesstr 列表，与 objs 长度相同

第 i 个元素是测试中 objs 的第 i 个实例的名称。如果实例数量超过一个，命名约定是 {cls.__name__}-{i}，否则是 {cls.__name__}

property cutoff[源码]#

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

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

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

property fh[源码]#

传递的预测范围。

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

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

状态变更

将状态更改为“fitted”。

写入 self

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

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

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

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

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

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

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

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

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

  • 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") 为 True，则 X.index 必须包含 y.index。

返回:
selfself 的引用。
fit_predict(y, X=None, fh=None, X_pred=None)[源码]#

拟合并预测未来范围的时间序列。

等同于 fit(y, X, fh).predict(X_pred)。如果未传递 X_pred，则等同于 fit(y, fh, X).predict(X)。

状态变更

将状态更改为“fitted”。

写入 self

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

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

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

  • 将 fh 存储到 self.fh。

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

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

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

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

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

  • 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") 为 True，则 X.index 必须包含 y.index。

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

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

从类中获取类标签值，包含从父类继承的标签层级。

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

从类中获取类标签，包含从父类继承的标签层级。

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

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

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

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

值是对应的标签值，覆盖优先级按以下降序排列

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

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

按继承顺序。

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

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

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

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

collected_tagsdict

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

get_config()[源码]#

获取对象的配置标志。

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

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

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

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

返回:
config_dictdict

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

get_fitted_params(deep=True)[源码]#

获取拟合参数。

所需状态

需要状态为“fitted”。

参数:
deepbool，默认值为 True

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

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

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

返回:
fitted_params键为 str 的字典

拟合参数的字典，paramname : paramvalue 键值对包含

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

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

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

classmethod get_param_defaults()[源码]#

获取对象的参数默认值。

返回:
default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)[源码]#

获取对象的参数名称。

参数:
sortbool，默认值为 True

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

返回:
param_names: list[str]

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

get_params(deep=True)[源码]#

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

参数:
deepbool，默认值为 True

deepbool, default=True

  • 是否返回组件的参数。

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

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

params键为 str 的字典

  • 参数字典，paramname : paramvalue 键值对包含

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

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

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

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

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

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

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

  1. get_tag 方法从实例中检索名称为 tag_name 的单个标签值，并考虑标签覆盖，优先级按以下降序排列

在实例构建时通过 set_tags 或 clone_tags 在实例上设置的标签。

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

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

按继承顺序。

参数:
tag_namestr

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。

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

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

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

get_tags()[源码]#

值是对应的标签值，覆盖优先级按以下降序排列

  1. get_tag 方法从实例中检索名称为 tag_name 的单个标签值，并考虑标签覆盖，优先级按以下降序排列

在实例构建时通过 set_tags 或 clone_tags 在实例上设置的标签。

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

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

按继承顺序。

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

collected_tagsdict

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

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

is_composite()[源码]#

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

composite: bool

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

是否已调用 fit。

property is_fitted[源码]#

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

bool

估计器是否已 fit。

从文件位置加载对象。

参数:
classmethod load_from_path(serial)[源码]#
返回:
serialZipFile(path).open(“object) 的结果
反序列化的 self，结果存储在 path，来自 cls.save(path) 的输出

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

参数:
classmethod load_from_serial(serial)[源码]#
返回:
serialcls.save(None) 输出的第一个元素
反序列化的 self，结果为输出 serial，来自 cls.save(None)

预测未来范围的时间序列。

所需状态

predict(fh=None, X=None)[源码]#

所需状态为“fitted”，即 self.is_fitted=True。

  • 访问 self

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

写入 self

self.cutoff, self.is_fitted

参数:
fhint、list、可强制转换为 pd.Index 的对象，或 ForecastingHorizon，默认值为 None

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

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

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

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

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

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

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

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

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

所需状态

predict(fh=None, X=None)[源码]#

所需状态为“fitted”，即 self.is_fitted=True。

  • 访问 self

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

写入 self

self.cutoff, self.is_fitted

参数:
fhint、list、可强制转换为 pd.Index 的对象，或 ForecastingHorizon，默认值为 None

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

predict_interval(fh=None, X=None, coverage=0.9)[源码]#

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

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

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

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

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

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

返回:
coveragefloat 或 float 的唯一值列表，可选 (默认值为 0.90)
预测区间(s) 的名义覆盖率
pred_intpd.DataFrame

列具有多级索引：第一级是 fit 中 y 的变量名，

第二级是计算区间的覆盖率分数。

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

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

行索引是 fh，具有额外的（上层）级别，等于 fit 中 y 看到的实例级别，

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

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

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

对于 col 索引中的 var，在第二个 col 索引中的名义覆盖率下，下限/上限取决于第三个 col 索引，对于行索引。上限/下限区间的预测等效于在 alpha = 0.5 - c/2, 0.5 + c/2 (对于 coverage 中的 c) 处的分位数预测。

  • predict_proba(fh=None, X=None, marginal=True)[源码]#

  • 注意

所需状态

predict(fh=None, X=None)[源码]#

所需状态为“fitted”，即 self.is_fitted=True。

  • 访问 self

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

写入 self

self.cutoff, self.is_fitted

参数:
fhint、list、可强制转换为 pd.Index 的对象，或 ForecastingHorizon，默认值为 None

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

predict_interval(fh=None, X=None, coverage=0.9)[源码]#

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

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

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

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

目前仅对 Series (非面板，非分层) y 实现。

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

返回:
marginalbool，可选 (默认值为 True)

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

pred_distskpro BaseDistribution

计算/返回分位数预测。

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

所需状态

predict(fh=None, X=None)[源码]#

所需状态为“fitted”，即 self.is_fitted=True。

  • 访问 self

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

写入 self

self.cutoff, self.is_fitted

参数:
fhint、list、可强制转换为 pd.Index 的对象，或 ForecastingHorizon，默认值为 None

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

predict_interval(fh=None, X=None, coverage=0.9)[源码]#

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

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

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

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

predict_quantiles(fh=None, X=None, alpha=None)[源码]#

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

返回:
alphafloat 或 float 的唯一值列表，可选 (默认值为 [0.05, 0.95])
预测区间(s) 的名义覆盖率

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

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

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

quantilespd.DataFrame

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

条目是分位数预测，对于 col 索引中的 var，

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

在第二个 col 索引中的分位数概率下，对于行索引。

predict_residuals(y=None, X=None)[源码]#

所需状态

将在 y.index 处计算预测的残差。

所需状态为“fitted”，即 self.is_fitted=True。

如果 fh 必须在 fit 中传递，则必须与 y.index 一致。如果 y 是一个 np.ndarray，并且在 fit 中未传递 fh，则残差将计算在 range(len(y.shape[0])) 的 fh 处

写入 self

所需状态为“fitted”。如果已设置 fh，则必须与 y 的索引（pandas 或 integer）对应

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

访问 self

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

  • 返回:

  • 无。

ypd.Series, pd.DataFrame, or np.ndarray (1D or 2D), default=None

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

返回:
如果为 None，则使用到目前为止看到的 y (self._y)，特别是

如果在单个 fit 调用后，则产生样本内残差

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

计算/返回方差预测。

所需状态

predict(fh=None, X=None)[源码]#

所需状态为“fitted”，即 self.is_fitted=True。

  • 访问 self

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

写入 self

self.cutoff, self.is_fitted

参数:
fhint、list、可强制转换为 pd.Index 的对象，或 ForecastingHorizon，默认值为 None

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

predict_interval(fh=None, X=None, coverage=0.9)[源码]#

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

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

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

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

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

用于更新和预测的外生时间序列 应与 fit 中 y 具有相同的 scitype (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 scitype，格式相同（见上文）
predict_var(fh=None, X=None, cov=False)[源码]#

covbool，可选 (默认值为 False)

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

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

pred_varpd.DataFrame，格式取决于 cov 变量

如果 cov=False

列名与 fit/update 中传递的 y 的列名完全相同。
对于无名格式，列索引将是 RangeIndex。

行索引是 fh，具有额外的级别，等于 fit 中 y 看到的实例级别，

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

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

条目是方差预测，对于 col 索引中的 var。给定变量和 fh 索引的方差预测是一个预测值

该变量和索引的方差，基于观测数据。

如果 cov=True

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

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

第二级是 fh。

条目是（协）方差预测，对于 col 索引中的 var，以及

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

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

  • reset()[源码]#

结果是将 self 设置为构造函数调用后直接具有的状态，使用相同的超参数。通过 set_config 设置的配置值也保留。

reset 调用会删除任何对象属性，除了

超参数 = __init__ 的参数写入到 self，例如 self.paramname 其中 paramname 是 __init__ 的参数

返回:
self

包含双下划线的对象属性，即字符串“__”。例如，名为“__myattr”的属性会被保留。

配置属性，配置保持不变。即 reset 前后 get_config 的结果相等。

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

类和对象方法以及类属性也不受影响。

等同于 clone，区别在于 reset 会改变 self，而不是返回一个新对象。

参数:
在 self.reset() 调用后，self 在值和状态上等于构造函数调用 type(self)(**self.get_params(deep=False)) 后获得的对象。

类实例重置为干净的后初始化状态，但保留当前的超参数值。

  • save(path=None, serialization_format='pickle')[源码]#

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

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

pathNone 或文件位置 (str 或 Path)

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

返回:
path=”estimator”，则将在当前工作目录创建 zip 文件 estimator.zip。
path=”/home/stored/estimator”，则将在 /home/stored/ 中存储 zip 文件 estimator.zip。
serialization_format: str, default = “pickle”

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

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

返回:

fhint、list、可强制转换为 pd.Index 的对象，或 ForecastingHorizon，默认值为 None

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

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

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

返回:
score(y, X=None, fh=None)[源码]#

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

要评分的时间序列

Xpd.DataFrame, or 2D np.array, optional (default=None)
用于评分的外生时间序列 如果 self.get_tag(“X-y-must-have-same-index”)，X.index 必须包含 y.index

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

参数:
config_dictdict

scorefloat

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

另请参阅

  • sktime.performance_metrics.forecasting.mean_absolute_percentage_error

  • set_config(**config_dict)[源码]#

配置名称：配置值对的字典。有效的配置、值及其含义列在下方

displaystr，“diagram”（默认值）或“text”

jupyter 内核如何显示 self 的实例

“diagram” = html 框图表示

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

  • print_changed_onlybool，默认值为 True

打印 self 时是只列出与默认值不同的 self 参数 (False)，还是列出所有参数名称和值 (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 时减少序列化大小，但更新将默认执行“什么也不做”，而不是“重新拟合所有看到的数据”。

设置此对象的参数。

selfself 的引用。

参数:
说明

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

返回:
set_params(**params)[源码]#
此方法适用于简单的 skbase 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象（即包含其他对象的对象）来访问组件 <component> 中的 <parameter>。如果引用明确（例如，没有两个组件参数具有名称 <parameter>），也可以使用字符串 <parameter>，不带 <component>__。

为对象设置 random_state 伪随机种子参数。

**paramsdict

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

selfself 的引用 (参数已设置后)

参数:
set_random_state(random_state=None, deep=True, self_policy='copy')[源码]#

通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 通过 sample_dependent_seed 派生的整数。这些整数通过链式哈希采样，并保证种子随机生成器的伪随机独立性。

deepbool，默认值为 True

根据 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，默认值为 True

  • 是否在 skbase 对象值参数（即组件估计器）中设置随机状态。

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

如果为 True，则也会在组件对象中设置 random_state 参数。

返回:
self_policystr，{'copy', 'keep', 'new'} 之一，默认值为“copy”
“copy”：self.random_state 设置为输入的 random_state

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

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

“keep”：self.random_state 保持不变

“new”：self.random_state 设置为新的随机状态，

从输入的 random_state 派生，通常与它不同

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

参数:
selfself 的引用

set_tags(**tag_dict)[源码]#

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

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

set_tags 方法只能在对象构建期间的 __init__ 方法中调用，或直接在 __init__ 后调用。

更新截止点值，并可选地更新拟合参数。

**tag_dictdict

  • 标签名称：标签值对的字典。

  • 返回:

所需状态

predict(fh=None, X=None)[源码]#

所需状态为“fitted”，即 self.is_fitted=True。

  • 访问 self

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

写入 self

  • Self

  • self 的引用。

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

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

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

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

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

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

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

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

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

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

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

返回:
self_policystr，{'copy', 'keep', 'new'} 之一，默认值为“copy”
写入 self

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

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

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

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

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

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

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

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

  6. update_paramsbool，可选 (默认值为 True)

**tag_dictdict

  • 标签名称：标签值对的字典。

  • 返回:

所需状态

predict(fh=None, X=None)[源码]#

所需状态为“fitted”，即 self.is_fitted=True。

  • 访问 self

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

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

  • Self

  • self 的引用。

update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[源码]#

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

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

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

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

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

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

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

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

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

ypd.Series, pd.DataFrame, or np.ndarray (1D or 2D), default=None

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

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

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

记住 self.predict() (稍后一次性返回)

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

  • 等等

返回:
返回所有记住的预测结果

写入 self（除非 reset_forecaster=True）

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

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

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

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

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

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

所需状态

需要状态为“fitted”。

所需状态为“fitted”，即 self.is_fitted=True。

拟合模型的属性（以“_”结尾）。指向已见数据的指针：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 兼容数据容器格式的时间序列。

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

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

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

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

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

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

fhint、list、可强制转换为 pd.Index 的对象，或 ForecastingHorizon，默认值为 None

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

ypd.Series, pd.DataFrame, or np.ndarray (1D or 2D), default=None

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

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

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

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

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

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

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

参数:
parameter_setstr，默认值为“default”

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

返回:
params字典或字典列表

用于创建类的测试实例的参数