StatsForecastAutoETS#

class StatsForecastAutoETS(season_length: int = 1, model: str = 'ZZZ', damped: bool | None =None, phi: float | None =None)[source]#

StatsForecast 自动指数平滑模型。

直接接口到 statsforecast.models.AutoETS，来自 Nixtla 的 statsforecast [1]。 statsforecast 的实现是 Hyndman 的 forecast::ets [2] 的镜像。

自动选择最佳的 ETS (误差、趋势、季节性) 模型，使用信息准则。默认是 Akaike 信息准则 (AICc)，而特定模型使用最大似然估计。状态空间方程可以基于它们的 $M$ 乘法、 $A$ 加法、 $Z$ 优化或 $N$ 忽略分量来确定。 model 字符串参数定义了 ETS 方程：E 在 [$M, A, Z$] 中，T 在 [$N, A, M, Z$] 中，S 在 [$N, A, M, Z$] 中。

例如，当 model=’ANN’ (加法误差、无趋势、无季节性) 时，ETS 将只探索简单的指数平滑。

如果分量选择为 ‘Z’，它充当占位符，表示让 AutoETS 模型找出最佳参数。

参数：
season_lengthint

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

modelstr

控制状态空间方程。

dampedbool

一个“衰减”趋势的参数。

phifloat, 可选 (默认=None)

趋势衰减的平滑参数。仅在 damped=True 时使用。

属性：
cutoff

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

fh

已传递的预测范围。

is_fitted

是否已调用 fit。

另请参阅

AutoETS

参考文献

方法

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 列表, 默认 = {}

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数：
method_namestr, 可选

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

引发：
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

克隆是一个不同的对象，没有共享引用，处于后初始化状态。

此函数等同于使用 self 的参数构造一个新的 type(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 的对象都有一个标签字典。

标签可用于存储关于对象的元数据，或控制对象的行为。

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

应仅在对象的 __init__ 方法中、构造期间或通过 __init__ 直接构造后调用 clone_tags 方法。

动态标签设置为 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 个元素是测试中 objs 中第 i 个实例的名称。如果实例多于一个，命名约定为 {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，则将 fh 存储到 self.fh。

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

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

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

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

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

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

有关数据格式的更多详细信息，请参阅 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 = 时间序列集合，全局/面板预测。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，由 Series 类型 pd.DataFrame 组成的 list

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

有关数据格式的更多详细信息，请参阅 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)

用于预测的外生时间序列。如果传递，将在 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 的对象都有一个标签字典。

标签可用于存储关于对象的元数据，或控制对象的行为。

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

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

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

  • 如果 deep=True，还包含组件参数的键/值对 组件参数的索引格式为 [组件名称]__[参数名称] 组件名称 的所有参数都显示为 参数名称 及其值

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

classmethod get_param_defaults()[source]#

获取对象的参数默认值。

返回：
default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数：
sortbool, 默认=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

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

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

  • 如果 deep=True，还包含组件参数的键/值对 组件参数的索引格式为 [组件名称]__[参数名称] 组件名称 的所有参数都显示为 参数名称 及其值

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

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

从实例获取标签值，带有标签级别继承和覆盖。

每个兼容 scikit-base 的对象都有一个标签字典。

标签可用于存储关于对象的元数据，或控制对象的行为。

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

  1. get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，考虑标签覆盖，优先级从高到低依次为

通过 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 的对象都有一个标签字典。

标签可用于存储关于对象的元数据，或控制对象的行为。

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

值是对应的标签值，覆盖优先级从高到低依次为

  1. get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，考虑标签覆盖，优先级从高到低依次为

通过 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) 的结果
返回：
反序列化自身，结果输出到 path，是 cls.save(path) 的输出。
classmethod load_from_serial(serial)[source]#

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

参数：
serialcls.save(None) 输出的第一个元素
返回：
反序列化自身，结果输出 serial，是 cls.save(None) 的输出。
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 具有相同的 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.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 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为真，则 X.index 必须包含 fh 索引引用。

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

预测区间名义覆盖率

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

顺序与输入 coverage 相同。

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

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

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

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

对于列索引中的 var，在第二列索引中的名义覆盖率下，根据第三列索引是 lower/upper，对应于行索引。区间上限/下限预测等同于在 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.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 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为真，则 X.index 必须包含 fh 索引引用。

marginalbool, 可选 (default=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 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为真，则 X.index 必须包含 fh 索引引用。

alphafloat 或 包含唯一值的 float 列表, 可选 (default=[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])) 进行计算

所需状态

需要状态为“fitted”。如果设置了 fh，则必须对应于 y 的索引（pandas 或整数）

访问自身属性

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

写入自身

无。

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

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

如果为 None，则使用到目前为止已见的 y（self._y），特别是

  • 如果在之前仅调用了一次 fit，则会产生样本内残差

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

Xsktime 兼容格式的时间序列, 可选 (default=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 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为真，则 X.index 必须包含 fh 索引引用。

covbool, 可选 (default=False)

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

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

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

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

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

条目是方差预测，其中变量在列索引中。

给定变量和 fh 索引的方差预测是对该变量和索引在给定观测数据下的预测方差。

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

第二级是 fh。

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

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

条目是（协）方差预测，其中变量在列索引中，

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

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

reset()[source]#

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

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

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

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

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

  • 配置属性，配置将保留不变。也就是说，reset 前后 get_config 的结果相等。

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

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

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

返回：
self

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

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

将序列化的自身保存到字节类对象或到 (.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 文件。

存储在 /home/stored/。

serialization_format: str, default = “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, 可选 (default=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” (default), 或 “text”

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, default=True

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

warningsstr, “on” (default), 或 “off”

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

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

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

backend:parallelstr, 可选, default=”None”

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

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

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

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

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

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

backend:parallel:paramsdict, 可选, default={} (不传递参数)

作为配置传递给并行化后端的附加参数。有效的键取决于 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, default=True; False 防止 ray 在并行化后关闭。

      并行化后关闭。

    • “logger_name”：str, default=”ray”; 要使用的日志记录器的名称。

    • “mute_warnings”：bool, default=False; 如果为 True，则抑制警告

remember_databool, default=True

是否在 fit 中存储 self._X 和 self._y，并在 update 中更新。如果为 True，则存储并更新 self._X 和 self._y。如果为 False，则不存储和更新 self._X 和 self._y。这在使用 save 时减少了序列化大小，但 update 将默认为“不执行任何操作”，而不是“重新拟合到所有已见数据”。

返回：
selfself 的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

此方法适用于简单的 skbase 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象（即包含其他对象的对象）访问组件 <component> 中的 <parameter>。如果引用明确（例如，没有两个组件参数具有相同的名称 <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 将它们设置为通过 sample_dependent_seed 从 random_state 派生的整数。这些整数通过链式哈希抽样，并保证种子随机生成器之间的伪随机独立性。

取决于 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, default=None

伪随机数生成器，用于控制随机整数的生成。传递 int 可在多次函数调用中获得可复现的输出。

deepbool, 默认=True

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

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

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

self_policystr, {“copy”, “keep”, “new”} 之一, default=”copy”

  • “copy” : self.random_state 设置为输入的 random_state

  • “keep” : self.random_state 保持不变

  • “new” : self.random_state 设置为一个新的随机状态，

源自输入的 random_state，通常与输入不同

返回：
self对 self 的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

当前标签值可以通过 get_tags 或 get_tag 进行检查。

参数：
**tag_dictdict

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

返回：
Self

对 self 的引用。

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

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

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

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

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

所需状态

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

访问自身属性

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

  • self.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 = 时间序列集合，全局/面板预测。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，由 Series 类型 pd.DataFrame 组成的 list

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

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

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

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

update_paramsbool, 可选 (default=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.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 = 时间序列集合，全局/面板预测。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，由 Series 类型 pd.DataFrame 组成的 list

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

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

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

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

Xsktime 兼容格式的时间序列, 可选 (default=None)

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

update_paramsbool, 可选 (default=True)

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

reset_forecasterbool, 可选 (default=True)

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

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

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

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

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

  • 如果绝对 horizon 点的集合不唯一：类型是 pandas DataFrame，行和列索引都是时间戳，行索引对应于从中进行预测的 cutoffs，列索引对应于进行预测的绝对 horizons

如果在该 (cutoff, horizon) 对上没有进行预测，则条目为 nan

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

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

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

所需状态

要求状态为“已拟合”。

访问自身属性

已拟合模型的属性以“_”结尾。指向已见数据的指针，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 = 时间序列集合，全局/面板预测。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，由 Series 类型 pd.DataFrame 组成的 list

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

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

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

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

Xsktime 兼容格式的时间序列, 可选 (default=None)

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

update_paramsbool, 可选 (default=True)

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

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

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