ThetaForecaster#

class ThetaForecaster(initial_level=None, deseasonalize=True, sp=1)[源代码]#

用于预测的 Theta 方法。

[1]中定义的 theta 方法等同于带有漂移的简单指数平滑（SES）（如[2]中所示）。

使用A&N中概述的测试对时间序列进行季节性测试。如果被认为是季节性的，则使用经典的乘法分解对时间序列进行季节性调整，然后应用 theta 方法。再对得到的预测值进行季节性还原。

在 SES 导致常数预测的情况下，theta 预测器将退回到预测 SES 常数加上从训练数据中提取的线性趋势。

预测区间使用底层状态空间模型计算。

参数:
initial_levelfloat, 可选

简单指数平滑的 alpha 值，如果设置了该值，则使用该值，否则从数据中估计。

deseasonalizebool, 可选 (default=True)

如果为 True，则数据进行季节性调整。

spint, 可选 (default=1)

构成季节性周期的观测次数，用于乘法季节性调整器，如果在训练数据中检测到季节性，则使用该值。如果提供了季节性调整器转换器，则忽略。默认值为 1（无季节性）。

属性:
initial_level_float

SES 拟合的估计 alpha 值。

drift_float

拟合模型的估计漂移。

se_float

预测的标准误差。用于计算预测区间。

另请参阅

StatsForecastAutoTheta

参考文献

[1]

Assimakopoulos, V. and Nikolopoulos, K. The theta model: a decomposition approach to forecasting. International Journal of Forecasting 16, 521-530, 2000. https://www.sciencedirect.com/science/article/pii/S0169207000000662

[2]

`Hyndman, Rob J., and Billah, Baki. Unmasking the Theta method. International J. Forecasting, 19, 287-290, 2003. https://www.sciencedirect.com/science/article/pii/S0169207001001431

示例

>>> from sktime.datasets import load_airline
>>> from sktime.forecasting.theta import ThetaForecaster
>>> y = load_airline()
>>> forecaster = ThetaForecaster(sp=12)  
>>> forecaster.fit(y)  
ThetaForecaster(...)
>>> y_pred = forecaster.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()

获取 self 的配置标志。

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

将对象重置为干净的 post-init 状态。

save([path, serialization_format])

将序列化的 self 保存到 bytes-like 对象或 (.zip) 文件。

score(y[, X, fh])

使用 MAPE（非对称）对预测结果进行评分。

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

set_random_state([random_state, deep, ...])

为 self 设置 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')[源代码]#

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

参数:
parameter_setstr , default = “default”

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

返回:
params :dict 或 dict 列表 , default = {}

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

check_is_fitted(method_name=None)[源代码]#

检查估计器是否已拟合。

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

如果不是，则引发NotFittedError。

参数:
method_namestr, 可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[源代码]#

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

克隆是不同的对象，没有共享引用，处于 post-init 状态。此函数等同于返回sklearn.clone的self。

等同于使用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)[源代码]#

从另一个对象克隆标签作为动态覆盖。

每个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 列表, default = None

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

返回:
self

对self的引用。

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

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

参数:
parameter_setstr, default=”default”

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

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

创建所有测试实例的列表以及它们的名称列表。

参数:
parameter_setstr, default=”default”

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

返回:
objscls 实例列表

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

namesstr 列表, 与 objs 长度相同

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

property cutoff[源代码]#

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

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

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

property fh[源代码]#

已传递的预测期。

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

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

状态改变

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

写入 self

  • 设置以“_”结尾的拟合模型属性，拟合属性可通过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, or np.ndarray (1D or 2D)

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

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

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

fhint, list, pd.Index 可强制转换, 或 ForecastingHorizon, default=None

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

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

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

返回:
self对 self 的引用。
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)相同。

状态改变

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

写入 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, or np.ndarray (1D or 2D)

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list of Series typed 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 兼容格式的时间序列, 可选 (default=None).

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

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

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

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

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

classmethod get_class_tag(tag_name, tag_value_default=None)[源代码]#

从类中获取类标签值，带有来自父类的标签级别继承。

每个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类属性收集，然后是_onfig_dynamic对象属性中的任何覆盖和新标签。不被set_tags或clone_tags设置的动态标签覆盖。

get_config()[源代码]#

获取 self 的配置标志。

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

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

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

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

返回:
config_dictdict

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

get_fitted_params(deep=True)[源代码]#

获取拟合参数。

所需状态

要求状态为“已拟合”。

参数:
deepbool, default=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()[源代码]#

获取对象的参数默认值。

返回:
default_dict: dict[str, Any]

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

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

获取对象的参数名称。

参数:
sortbool, default=True

是按字母顺序排序返回参数名称 (True)，还是按它们在类__init__中出现的顺序返回 (False)。

返回:
param_names: list[str]

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

get_params(deep=True)[源代码]#

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

参数:
deepbool, default=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, tag_value_default=None, raise_error=True)[源代码]#

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

通过实例上的set_tags或clone_tags设置的标签，

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

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

按照继承顺序。

参数:
tag_namestr

在实例构建时。

要检索的标签名称

tag_value_default任意类型, 可选; 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后代实例。

property is_fitted[源代码]#

是否已调用fit。

返回:
检查对象的_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)[源代码]#

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

  • 访问 self 中的属性

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

写入 self

self.cutoff, self.is_fitted

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

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

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

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

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

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

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

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

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

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

所需状态

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

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

  • 访问 self 中的属性

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

写入 self

self.cutoff, self.is_fitted

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

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

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

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

  • 如果fh是int或 array-like of int，则解释为相对预测期，并强制转换为相对的ForecastingHorizon(fh, is_relative=True)。

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

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

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

coveragefloat 或 float 的唯一值列表, 可选 (default=0.90)

返回:
预测区间名义覆盖率
pred_intpd.DataFrame
列具有多级索引：第一级是 fit 中 y 的变量名，

第二级是计算区间的覆盖率。顺序与输入coverage中的顺序相同。

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

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

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

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

对于列索引中的 var，在第二级列索引中的名义覆盖率下，根据第三级列索引为下限/上限，对应行索引。下限/上限预测值等同于 alpha = 0.5 - c/2, 0.5 + c/2 （对于 coverage 中的 c）时的分位数预测值。

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

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

注意

  • 目前仅针对 Series（非面板、非层次结构）y 实现。

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

所需状态

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

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

  • 访问 self 中的属性

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

写入 self

self.cutoff, self.is_fitted

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

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

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

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

  • 如果fh是int或 array-like of int，则解释为相对预测期，并强制转换为相对的ForecastingHorizon(fh, is_relative=True)。

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

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

marginal布尔型，可选（默认=True）

返回的分布是否按时间索引进行边际化

返回:
pred_distskpro BaseDistribution

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

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

计算/返回分位数预测。

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

所需状态

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

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

  • 访问 self 中的属性

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

写入 self

self.cutoff, self.is_fitted

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

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

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

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

  • 如果fh是int或 array-like of int，则解释为相对预测期，并强制转换为相对的ForecastingHorizon(fh, is_relative=True)。

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

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

alpha浮点型或包含唯一浮点值的列表，可选（默认=[0.05, 0.95]）

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

返回:
quantilespd.DataFrame
pred_intpd.DataFrame

第二层是传递给函数的 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 处计算残差。

所需状态

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

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

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

写入 self

无。

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

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

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

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

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

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

用于更新和预测的外生时间序列。其 scitype (Series, Panel, 或 Hierarchical) 应与 fit 中的 y 相同。如果 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)[source]#

计算/返回方差预测。

所需状态

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

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

  • 访问 self 中的属性

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

写入 self

self.cutoff, self.is_fitted

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

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

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

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

  • 如果fh是int或 array-like of int，则解释为相对预测期，并强制转换为相对的ForecastingHorizon(fh, is_relative=True)。

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

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

cov布尔型，可选（默认=False）

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

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

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

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

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

条目是方差预测，对应于列索引中的变量。

对于给定变量和 fh 索引的方差预测是一个预测的

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

第二级是 fh。

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

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

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

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

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

reset()[source]#

将对象重置为干净的 post-init 状态。

结果是将 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]#

将序列化的 self 保存到 bytes-like 对象或 (.zip) 文件。

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

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

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

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

  • path=”estimator”，则会在当前工作目录 (cwd) 创建一个 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, default=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 kernel 如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_only布尔型，默认=True

打印 self 时，是仅列出与默认值不同的自身参数 (True)，还是列出所有参数名称和值 (False)。不嵌套，即只影响自身，不影响组件估计器。

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

是否在 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 对象以及组合对象。对于组合对象（即包含其他对象的对象），可以使用参数键字符串 __ 来访问组件 中的 。如果引用明确（例如，没有两个组件参数具有相同的名称 ），也可以使用不带 __ 的字符串 。

参数:
**params字典

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

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

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

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

根据 self_policy，应用于 self 中的 random_state 参数，并且仅当 deep=True 时应用于剩余的组件对象。

注意：即使 self 没有 random_state 参数，或者没有任何组件有 random_state 参数，也会调用 set_params。因此，set_random_state 将重置任何 scikit-base 对象，即使是那些没有 random_state 参数的对象。

参数:
random_state整数，RandomState 实例或 None，默认=None

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

deepbool, default=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，并且通常与它不同

返回:
selfself 的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:
**tag_dict字典

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

返回:
Self

self 的引用。

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

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

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

  • update_params=True：对到目前为止所有观察到的数据进行拟合

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

所需状态

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

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

  • 访问 self 中的属性

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

写入 self

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

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

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

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

sktime中的独立数据格式称为mtype规范，每个 mtype 都实现一个抽象的scitype。

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

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

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

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

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

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

update_params布尔型，可选（默认=True）

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

返回:
selfself 的引用
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) 并记住数据

所需状态

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

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

  • 访问 self 中的属性

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

写入 self（除非 reset_forecaster=True）

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

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

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

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

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

sktime中的独立数据格式称为mtype规范，每个 mtype 都实现一个抽象的scitype。

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

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list of Series typed 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）

用于更新和预测的外生时间序列。其 scitype (Series, Panel 或 Hierarchical) 应与 fit 中的 y 相同。如果 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，其行索引和列索引是时间戳。行索引对应于用于预测的截止点，列索引对应于被预测的绝对预测范围。条目是根据行索引预测的列索引的点预测值。如果在该（截止点, 预测范围）对处没有预测，则条目为 nan。

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

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

此方法适用于单步进行更新和预测。

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

所需状态

要求状态为“已拟合”。

要求状态为“已拟合”，即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 兼容数据容器格式的时间序列。

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

sktime中的独立数据格式称为mtype规范，每个 mtype 都实现一个抽象的scitype。

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

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

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

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

fhint, list, pd.Index 可强制转换, 或 ForecastingHorizon, default=None

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

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

用于更新和预测的外生时间序列。其 scitype (Series, Panel 或 Hierarchical) 应与 fit 中的 y 相同。如果 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，相同的格式（见上文）。