按级别预测#

class ForecastByLevel(forecaster, groupby='local')[source]#

按实例或面板进行预测。

用于按实例或按面板应用 forecaster 的多个副本。

如果 groupby="global"，行为与 forecaster 相同。如果 groupby="local"，则为每个时间序列实例拟合 forecaster 的一个克隆。如果 groupby="panel"，则为每个面板（第一个非时间级别）拟合 forecaster 的一个克隆。如果级别数小于或等于 2，当只有一个级别（单个时间序列）时，“global” 和 “panel” 的结果相同，并且这三个设置都一致。

如果拟合了多个克隆，可以通过 forecasters_ 属性访问拟合的预测器，否则通过 forecaster_ 属性访问。

参数：

forecastersktime 预测器，在 ForecastByLevel 中使用: 一个“蓝图”预测器，调用 fit 时其状态不会改变。
groupbystr，可选，["local", "global", "panel"] 之一，默认为 "local": 用于对数据进行分组以拟合 forecaster 克隆的级别。“local” = 单元/实例级别，每个最低层级有一个缩减模型。“global” = 顶层，在忽略层级的汇集数据上，整体有一个缩减模型。“panel” = 第二最低层级，每个面板级别 (-2) 有一个缩减模型。如果级别数小于或等于 2，当只有一个级别（单个时间序列）时，“global” 和 “panel” 的结果相同，并且这三个设置都一致。

属性：

forecaster_sktime 预测器，仅当 groupby 为 “global” 时存在: 用于拟合和预测的 forecaster 克隆
forecasters_sktime 预测器的 pd.DataFrame，否则存在: 条目是用于拟合和预测的 forecaster 克隆

示例

>>> from sktime.forecasting.naive import NaiveForecaster
>>> from sktime.forecasting.compose import ForecastByLevel
>>> from sktime.utils._testing.hierarchical import _make_hierarchical
>>> y = _make_hierarchical()
>>> f = ForecastByLevel(NaiveForecaster(), groupby="local")
>>> f.fit(y)
ForecastByLevel(...)
>>> fitted_forecasters = f.forecasters_
>>> fitted_forecasters_alt = f.get_fitted_params()["forecasters"]

方法

`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 或 list of dict

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError 异常。

参数：

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

抛出异常：

NotFittedError: 如果估计器尚未拟合。

clone()[source]#

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

克隆是一个没有共享引用、处于初始化后状态的不同对象。此函数等同于返回 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)[source]#

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

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

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

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

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

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

tag_names 的默认设置会将 estimator 中的所有标签写入 self。

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

参数：

estimator:class:BaseObject 或派生类的实例
tag_namesstr 或 list of str，默认为 None: 要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回值：

self: 对 self 的引用。

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

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

参数：

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

返回值：

instance具有默认参数的类实例

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

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

参数：

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

返回值：

objscls 实例列表: 第 i 个实例是 cls(**cls.get_test_params()[i])
nameslist of str，与 objs 长度相同: 第 i 个元素是测试中第 i 个 obj 实例的名称。如果实例不止一个，命名约定为 {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。

参数：

y符合 sktime 数据容器格式的时间序列。

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

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 中传递，非可选。

X符合 sktime 格式的时间序列，可选（默认为 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。

参数：

y符合 sktime 数据容器格式的时间序列

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

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) 强制转换。

X符合 sktime 格式的时间序列，可选（默认为 None）。

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

X_pred符合 sktime 格式的时间序列，可选（默认为 None）

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

返回值：

y_pred符合 sktime 数据容器格式的时间序列: 在 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 的标签值，考虑标签覆盖，优先级从高到低如下：

类中 _tags 属性设置的标签。
父类中 _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 属性的任何键。

值是相应的标签值，覆盖优先级从高到低如下：

类中 _tags 属性设置的标签。
父类中 _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 类型的字典

已拟合参数字典，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，将返回此对象的参数名称 : 值字典，包括组件（= BaseObject 类型参数）的参数。
如果为 False，将返回此对象的参数名称 : 值字典，但不包括组件的参数。

返回值：

params键为 str 类型的字典

参数字典，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 的单个标签值，考虑标签覆盖，优先级从高到低如下：

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

在实例构造时。

类中 _tags 属性设置的标签。
父类中 _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 设置的标签。

值是相应的标签值，覆盖优先级从高到低如下：

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

在实例构造时。

类中 _tags 属性设置的标签。
父类中 _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") 的结果

返回值：

反序列化后的 self，其结果位于 path，来自 cls.save(path) 的输出

classmethod load_from_serial(serial)[source]#

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

参数：

serialcls.save(None) 输出的第一个元素

返回值：

反序列化后的 self，其结果是 serial，来自 cls.save(None)

predict(fh=None, X=None)[source]#

在未来预测期预测时间序列。

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

访问 self 中的属性

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

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) 强制转换。

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

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

返回值：

y_pred符合 sktime 数据容器格式的时间序列: 在 fh 处的点预测，与 fh 具有相同的索引。y_pred 与最近传递的 y 具有相同的类型：Series、Panel、Hierarchical scitype，相同格式（见上文）。

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

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

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

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

访问 self 中的属性

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

self.cutoff, self.is_fitted

写入对象本身: 如果传递了 fh 并且之前未曾传递，则将 fh 存储到 self.fh。

参数：

fhint、list、pd.Index 可强制转换类型，或 ForecastingHorizon，默认为 None

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

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

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

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

预测中使用的外生时间序列。其 scitype (Series, Panel 或 Hierarchical) 应与 fit 中的 y 相同。如果 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，则额外包含等于实例级别的 (上层) 级别。

来自在 fit 中观测到的 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。

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

访问 self 中的属性

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

self.cutoff, self.is_fitted

写入对象本身: 如果传递了 fh 并且之前未曾传递，则将 fh 存储到 self.fh。

参数：

fhint、list、pd.Index 可强制转换类型，或 ForecastingHorizon，默认为 None

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

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

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

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

预测中使用的外生时间序列。其 scitype (Series, Panel 或 Hierarchical) 应与 fit 中的 y 相同。如果 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 是可迭代对象，则将计算多个分位数。

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

访问 self 中的属性

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

self.cutoff, self.is_fitted

写入对象本身: 如果传递了 fh 并且之前未曾传递，则将 fh 存储到 self.fh。

参数：

fhint、list、pd.Index 可强制转换类型，或 ForecastingHorizon，默认为 None

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

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

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

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

预测中使用的外生时间序列。其 scitype (Series, Panel 或 Hierarchical) 应与 fit 中的 y 相同。如果 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，则额外包含等于实例级别的 (上层) 级别。: 来自在 fit 中观测到的 y，如果其为面板或层级数据。
条目是分位数预测值，对应于列索引中的变量，: 以及第二列索引中的分位数概率，针对行索引中的时间点。

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 或 integer) 的索引对应。
访问 self 中的属性: 以“_”结尾的已拟合模型属性。self.cutoff, self._is_fitted
写入对象本身: 无。

参数：

y符合 sktime 数据容器格式的时间序列

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

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

如果前面只有一次 fit 调用，则生成样本内残差
如果 fit 需要 fh，则它必须指向 fit 中 y 的索引

X符合 sktime 兼容格式的时间序列，可选 (默认为 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]#

计算/返回方差预测。

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

访问 self 中的属性

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

self.cutoff, self.is_fitted

写入对象本身: 如果传递了 fh 并且之前未曾传递，则将 fh 存储到 self.fh。

参数：

fhint、list、pd.Index 可强制转换类型，或 ForecastingHorizon，默认为 None

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

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

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

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

预测中使用的外生时间序列。其 scitype (Series, Panel 或 Hierarchical) 应与 fit 中的 y 相同。如果 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，额外包含等于实例级别的级别，: 来自在 fit 中观测到的 y，如果其为面板或层级数据。

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

给定观测数据下，针对该变量和索引的方差。

如果 cov=True

列索引是多级索引：第一级是变量名 (如上): 第二级是 fh。
行索引是 fh，额外包含等于实例级别的级别，: 来自在 fit 中观测到的 y，如果其为面板或层级数据。
条目是 (协) 方差预测值，对应于列索引中的变量，以及: 行索引和列索引中的时间索引之间的协方差。

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

reset()[source]#

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

将 self 设置为其在构造函数调用之后直接拥有的状态，并保留相同的超参数。通过 set_config 设置的配置值也会保留。

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

超参数 = __init__ 的参数，写入到 self，例如，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>。如果不带 <component>__ 前缀的字符串 <parameter> 也能明确引用，则也可使用，例如，如果组件中没有两个参数同名 <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 派生的整数。这些整数通过链式哈希 (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_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: 仅更新截止点并记录数据

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

访问 self 中的属性

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

self.cutoff, self.is_fitted

写入对象本身

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

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

参数：

y符合 sktime 数据容器格式的时间序列。

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

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。

X符合 sktime 格式的时间序列，可选（默认为 None）。

用于更新模型拟合的外生时间序列。其 scitype (Series, Panel 或 Hierarchical) 应与 y 相同。如果 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]#

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

用于执行多个 update / predict 序列调用的简写方法，数据回放基于时间分割器 cv。

与以下操作相同 (如果只有 y, cv 不是默认值)

self.update(y=cv.split_series(y)[0][0])
记录 self.predict() (稍后一次性返回)
self.update(y=cv.split_series(y)[1][0])
记录 self.predict() (稍后一次性返回)
等等
返回所有记录的预测值

如果没有实现特定于估计器的 update 方法，默认的后备行为如下：

update_params=True: 对迄今为止所有观测到的数据进行拟合

update_params=False: 仅更新截止点并记录数据

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

访问 self 中的属性

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

self.cutoff, self.is_fitted

写入 self (除非 reset_forecaster=True)

将 self.cutoff 更新为 y 中看到的最新索引。
如果 update_params=True，则更新以“_”结尾的已拟合模型属性。

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

参数：

y符合 sktime 数据容器格式的时间序列。

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

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

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

用于更新和预测的外生时间序列。其 scitype (Series, Panel 或 Hierarchical) 应与 fit 中的 y 相同。如果 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汇集多个分割批次点预测的对象

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

如果绝对预测期点的集合是唯一的：类型是 sktime 兼容数据容器格式的时间序列，输出中省略截止点，与最近传递的 y 类型相同：Series, Panel, Hierarchical scitype，格式相同 (见上文)
如果绝对预测期点的集合不唯一：类型是 pandas DataFrame，行索引和列索引都是时间戳，行索引对应于预测所依据的截止点，列索引对应于预测的绝对预测期，条目是在该 (截止点, 预测期) 对处的点预测值，如果在该对没有预测，则条目为 nan。

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

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

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

如果没有实现特定于估计器的 update 方法，默认的后备行为是先更新，然后预测。

所需状态: 要求状态为“已拟合”。
访问 self 中的属性: 以“_”结尾的已拟合模型属性。已见数据的指针，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，

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

参数：

y符合 sktime 数据容器格式的时间序列。

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

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 中未传递，则必须传递，不是可选参数。

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

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

update_paramsbool, 可选 (默认为 True)

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

返回值：

y_pred符合 sktime 数据容器格式的时间序列: 在 fh 处的点预测，与 fh 具有相同的索引。y_pred 与最近传递的 y 具有相同的类型：Series、Panel、Hierarchical scitype，相同格式（见上文）。