StatsForecastAutoCES#

class StatsForecastAutoCES(season_length: int = 1, model: str = 'Z')[source]#

StatsForecast 复杂指数平滑模型。

直接接口到 statsforecast.models.AutoCES，来自 Nixtla 的 statsforecast [1]。

使用信息准则自动选择最佳复杂指数平滑模型。默认为 Akaike 信息准则 (AICc)，同时使用最大似然估计特定模型。状态空间方程可以根据其 $S$ (simple)、$P$ (partial)、$Z$ (optimized) 或 $N$ (omitted) 组件来确定。参数 model 字符串定义 CES 模型的类型：$N$ 表示简单 CES（无季节性），$S$ 表示简单季节性（滞后 CES），$P$ 表示部分季节性（无复杂部分），$F$ 表示完全季节性（带实部和虚部季节性的滞后 CES）。

如果组件选择为 ‘Z’，它作为一个占位符，要求 AutoCES 模型找出最佳参数。

参数:
season_lengthint

每个时间单位的观测数量。例如：每小时数据 24。

modelstr

控制状态空间方程。

属性:
cutoff

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

fh

已传递的预测范围。

is_fitted

是否已调用 fit。

参考文献

方法

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

使用新数据更新模型并进行预测。
classmethod get_test_params(parameter_set='default')[source]#

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

参数:
parameter_setstr, 默认=”default”

要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，将返回 "default" 集。目前预测器没有保留值。

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

用于创建类的测试实例的参数 每个 dict 是构造一个“有趣的”测试实例的参数，即 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 或 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 个元素是测试中 obj 的第 i 个实例的名称。如果实例不止一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

property cutoff[source]#

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

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

pandas 兼容的索引元素，如果 cutoff 已设置；否则为 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), list of 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。

返回:
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), list of 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)[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]#

获取自身的配置标志。

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

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

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

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

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”) 的结果
返回:
反序列化自身，产生 cls.save(path) 在 path 位置的输出
classmethod load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化自身，产生 cls.save(None) 的输出 serial
predict(fh=None, X=None)[source]#

预测未来时间序列。

所需状态

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

在自身中访问

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

  • 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.cutoff, self.is_fitted

写入自身

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

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

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

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

  • 如果 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)

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

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

顺序与输入的 coverage 相同。

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

行索引是 fh，如果 fit 中看到的 y 是 Panel 或 Hierarchical，则具有等于实例级别的附加（上层）级别。

如果拟合过程中使用的 y 是面板数据或分层数据。

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

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

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

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

注意

  • 目前仅适用于 Series (非 Panel, 非 Hierarchical) 的 y。

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

所需状态

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

在自身中访问

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

  • self.cutoff, self.is_fitted

写入自身

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

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

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

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

  • 如果 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.cutoff, self.is_fitted

写入自身

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

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

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

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

  • 如果 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 是 Panel 或 Hierarchical，则具有等于实例级别的附加（上层）级别。

如果拟合过程中使用的 y 是面板数据或分层数据。

条目是分位数预测值，对应于列索引中的变量，

以及第二列索引中的分位数概率，对于行索引。

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

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

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

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

所需状态

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

在自身中访问

以“_”结尾的已拟合模型属性。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.cutoff, self.is_fitted

写入自身

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

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

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

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

  • 如果 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，具有等于实例级别的附加级别，

如果拟合过程中使用的 y 是面板数据或分层数据。

条目是方差预测值，对应于列索引中的变量。给定变量和 fh 索引的方差预测值是该变量和索引在给定观测数据下的预测方差。

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

如果 cov=True
列索引是多级索引：第一级是变量名（同上）

第二级是 fh。

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

如果拟合过程中使用的 y 是面板数据或分层数据。

条目是（协）方差预测值，对应于列索引中的变量，以及

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

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

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"，则会在当前工作目录生成 zip 文件 estimator.zip。

  • path="/home/stored/estimator"，则会将 zip 文件 estimator.zip

存储在 /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, 或 ForecastingHorizon, 默认=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 内核如何显示 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 时减小了序列化大小，但 update 将默认为“什么也不做”而不是“重新拟合所有已见数据”。

返回:
self对 self 的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:
**paramsdict

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_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：仅更新截止点并记住数据

所需状态

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

在自身中访问

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

  • 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), list of Series 类型的 pd.DataFrame

  • 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_paramsbool, 可选 (默认=True)

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

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

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

便捷方法，基于时间分割器 cv 执行多个 update / predict 链式操作，并进行数据回放。

与以下操作相同（如果只有 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.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), list of Series 类型的 pd.DataFrame

  • 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_paramsbool, 可选 (默认=True)

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

reset_forecasterbool, 可选 (默认=True)

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

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

返回:
y_pred用于表格化多个分割批次点预测的对象

格式取决于预测的截止点 (cutoff) 和绝对预测范围 (absolute horizon) 对。

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

  • 如果绝对预测范围点的集合不唯一：类型是 pandas DataFrame，行索引和列索引是时间戳；行索引对应于从中进行预测的截止点；列索引对应于预测的绝对预测范围；条目是在该 (截止点, 预测范围) 对下进行的点预测值；如果未进行预测，则条目为 nan。

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

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

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

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

所需状态

要求状态为“已拟合”。

在自身中访问

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

写入自身

通过附加行更新 self._y 和 self._X 以及 y 和 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), list of 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

预测范围，编码要预测的时间戳。如果已在 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，则仅更新截止点，不更新模型参数（例如，系数）。

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

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