ColumnEnsembleForecaster#

class ColumnEnsembleForecaster(forecasters)[源码]#

使用独立的预测器对每个时间序列进行预测。

按列应用不同的预测器。

ColumnEnsembleForecaster 接收预测器/索引对，具体语法如下。索引可以是单个 pandas 索引元素、pd.Index、int、str 或它们的列表。如果索引是可迭代对象 (pd.Index, list)，则指代多个列。

在 fit、predict、update 中的行为：对于传入的索引对 f_i, ix_i，将预测器 f_i 应用于列 ix_i。predict 结果会被连接到一个容器中，其列与 fit 中的列相同。

参数：

forecasterssktime 预测器，或元组列表 (str, estimator, int 或 pd.index)

如果是元组，name = str，estimator 是预测器，index 是 int 或 index。如果最后一个元素是 index，它必须是可强制转换为 int, str, 或 pd.Index 的类型；如果最后一个元素是 int x，且不在列中，则解释为第 x 列。所有列都必须存在于一个索引中。

如果是预测器，预测器的克隆将应用于所有列。如果是元组列表，元组中的预测器将应用于具有 int/str 索引的列。

属性：

cutoff: 截止点 = 预测器的“当前时间”状态。
fh: 传入的预测 horizon。
is_fitted: 是否已调用 fit。

示例

>>> import pandas as pd
>>> from sktime.forecasting.compose import ColumnEnsembleForecaster
>>> from sktime.forecasting.naive import NaiveForecaster
>>> from sktime.forecasting.trend import PolynomialTrendForecaster
>>> from sktime.datasets import load_longley

使用整数（列的 iloc 引用）进行索引

>>> y = load_longley()[1][["GNP", "UNEMP"]]
>>> forecasters = [
...     ("trend", PolynomialTrendForecaster(), 0),
...     ("naive", NaiveForecaster(), 1),
... ]
>>> forecaster = ColumnEnsembleForecaster(forecasters=forecasters)
>>> forecaster.fit(y, fh=[1, 2, 3])
ColumnEnsembleForecaster(...)
>>> y_pred = forecaster.predict()

使用字符串进行索引

>>> df = pd.DataFrame({"a": [1, 2, 3], "b": [4, 5, 6]})
>>> fc = ColumnEnsembleForecaster(
...     [("foo", NaiveForecaster(), "a"), ("bar", NaiveForecaster(), "b")]
... )
>>> fc.fit(df, fh=[1, 42])
ColumnEnsembleForecaster(...)
>>> y_pred = fc.predict()

将一个预测器应用于多列，多元

>>> df = pd.DataFrame({"a": [1, 2, 3], "b": [4, 5, 6], "c": [7, 8, 9]})
>>> fc = ColumnEnsembleForecaster(
...    [("ab", NaiveForecaster(), ["a", 1]), ("c", NaiveForecaster(), 2)]
... )
>>> fc.fit(df, fh=[1, 42])
ColumnEnsembleForecaster(...)
>>> y_pred = fc.predict()

方法

`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])	在未来 horizon 上拟合并预测时间序列。
`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`()	检查对象是否是复合对象。
`load_from_path`(serial)	从文件位置加载对象。
`load_from_serial`(serial)	从序列化的内存容器加载对象。
`predict`([fh, X])	在未来 horizon 上预测时间序列。
`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`(**kwargs)	设置评估器的参数。
`set_random_state`([random_state, deep, ...])	为自身设置 random_state 伪随机种子参数。
`set_tags`(**tag_dict)	将实例级标签覆盖设置为给定值。
`update`(y[, X, update_params])	更新 cutoff 值，并可选地更新已拟合参数。
`update_predict`(y[, cv, X, update_params, ...])	在测试集上迭代进行预测和更新模型。
`update_predict_single`([y, fh, X, update_params])	用新数据更新模型并进行预测。

check_is_fitted(method_name=None)[源码]#

检查评估器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数：

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

引发：

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

clone()[源码]#

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

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

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

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

其值也等同于调用 self.reset，不同之处在于 clone 返回一个新对象，而不是像 reset 那样修改 self。

引发：

如果克隆不符合规范，由于错误的 __init__，则引发 RuntimeError。

clone_tags(estimator, tag_names=None)[源码]#

将其他对象的标签作为动态覆盖进行克隆。

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

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

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

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

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

tag_names 的默认值将 estimator 中的所有标签写入 self。

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

参数：

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

返回：

self: 对 self 的引用。

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

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

参数：

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

返回：

instance具有默认参数的类的实例

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

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

参数：

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

返回：

objscls 实例列表: 第 i 个实例是 cls(**cls.get_test_params()[i])
namesstr 列表，与 objs 长度相同: 第 i 个元素是测试中 objs 的第 i 个实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

property cutoff[源码]#

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

返回：

cutoffpandas 兼容的索引元素，或 None: pandas 兼容的索引元素，如果已设置 cutoff；否则为 None

property fh[源码]#: 传入的预测 horizon。

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

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

状态改变: 将状态改变为“已拟合”。

写入自身

设置以“_”结尾的已拟合模型属性，已拟合属性可通过 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 = 时间序列集合，全局/面板预测。带有两级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型 pd.DataFrame 的 list
Hierarchical scitype = 分层集合，用于分层预测。带有三级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

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

fhint, list, 可强制转换为 pd.Index，或 ForecastingHorizon，默认值为 None

编码要预测的时间戳的预测 horizon。如果 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") 为 True，X.index 必须包含 y.index。

返回：

self对自身的引用。

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

在未来 horizon 上拟合并预测时间序列。

与 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 = 时间序列集合，全局/面板预测。带有两级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型 pd.DataFrame 的 list
Hierarchical scitype = 分层集合，用于分层预测。带有三级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

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

fhint, list, 可强制转换为 pd.Index，或 ForecastingHorizon（非可选）

编码要预测的时间戳的预测 horizon。

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

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

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

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

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

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

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

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

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

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

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

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

按照继承顺序。

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

要检索具有潜在实例覆盖的标签，请改用 get_tags 方法。

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

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

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

get_config()[源码]#

获取自身的配置标志。

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

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

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

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

返回：

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

get_fitted_params(deep=True)[源码]#

获取已拟合参数。

所需状态: 要求状态为“已拟合”。

参数：

deepbool，默认值为 True

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

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

返回：

fitted_params带有 str 值键的字典

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

总是：此对象的所有已拟合参数，通过 get_param_names 获取的值是此对象该键的已拟合参数值
如果 deep=True，还包含组件参数的键/值对，组件参数的索引格式为 [componentname]__[paramname]，componentname 的所有参数都以 paramname 形式出现并带其值
如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

classmethod get_param_defaults()[源码]#

获取对象的参数默认值。

返回：

default_dict: dict[str, Any]: 键是 cls 中所有在 __init__ 中定义了默认值的参数。值是默认值，如同在 __init__ 中定义的那样。

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

获取对象的参数名称。

参数：

sortbool，默认值为 True: 是否按字母顺序（True）或按它们在类的 __init__ 中出现的顺序（False）返回参数名称。

返回：

param_names: list[str]: cls 的参数名称列表。如果 sort=False，则按它们在类的 __init__ 中出现的顺序排列。如果 sort=True，则按字母顺序排列。

get_params(deep=True)[源码]#

获取评估器的参数。

参数：

deepboolean，可选: 如果为 True，将返回此评估器及其包含的作为评估器的子对象的参数。

返回：

paramsstring 到 any 的映射: 参数名称映射到其值。

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

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

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

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

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

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

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

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

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

在实例构造时。

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

按照继承顺序。

返回：

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

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

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

参数：

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

返回：

params字典或字典列表，默认值为 {}: 用于创建类测试实例的参数。每个字典都是用于构造一个“有趣的”测试实例的参数，即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个（或唯一一个）字典。

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) 的结果

返回：

反序列化的自身，结果输出在 path，来自 cls.save(path)

classmethod load_from_serial(serial)[源码]#

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

参数：

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

返回：

反序列化的自身，结果输出 serial，来自 cls.save(None)

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

在未来 horizon 上预测时间序列。

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

访问自身属性

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

self.cutoff，self.is_fitted

写入自身: 如果传入了 fh 且之前未传入，则将其存储到 self.fh。

参数：

fhint, list, 可强制转换为 pd.Index，或 ForecastingHorizon，默认值为 None

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

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

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

用于预测的外生时间序列。应与 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，格式相同（见上文）

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

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

If coverage is iterable, multiple intervals will be calculated.

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

访问自身属性

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

self.cutoff，self.is_fitted

写入自身: 如果传入了 fh 且之前未传入，则将其存储到 self.fh。

参数：

fhint, list, 可强制转换为 pd.Index，或 ForecastingHorizon，默认值为 None

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

If fh is not None and not of type ForecastingHorizon, it is coerced to ForecastingHorizon internally (via _check_fh).

if fh is int or array-like of int, it is interpreted as relative horizon, and coerced to a relative ForecastingHorizon(fh, is_relative=True).
if fh is of type pd.Index, it is interpreted as an absolute horizon, and coerced to an absolute ForecastingHorizon(fh, is_relative=False).

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

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

coveragefloat 或唯一值的浮点数列表，可选 (默认=0.90)

预测区间标称覆盖度

返回：

pred_intpd.DataFrame

列具有多重索引：第一层是拟合时来自 y 的变量名，

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

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

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

来自拟合时看到的 y，如果拟合时看到的 y 是 Panel 或 Hierarchical。

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

对于列索引中的变量，在第二列索引中的标称覆盖率下，根据第三列索引确定下限/上限，用于行索引。上限/下限区间预测等同于在 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 且之前未传入，则将其存储到 self.fh。

参数：

fhint, list, 可强制转换为 pd.Index，或 ForecastingHorizon，默认值为 None

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

If fh is not None and not of type ForecastingHorizon, it is coerced to ForecastingHorizon internally (via _check_fh).

if fh is int or array-like of int, it is interpreted as relative horizon, and coerced to a relative ForecastingHorizon(fh, is_relative=True).
if fh is of type pd.Index, it is interpreted as an absolute horizon, and coerced to an absolute ForecastingHorizon(fh, is_relative=False).

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

用于预测的外生时间序列。应与 fit 中 y 具有相同的 scitype（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 且之前未传入，则将其存储到 self.fh。

参数：

fhint, list, 可强制转换为 pd.Index，或 ForecastingHorizon，默认值为 None

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

If fh is not None and not of type ForecastingHorizon, it is coerced to ForecastingHorizon internally (via _check_fh).

if fh is int or array-like of int, it is interpreted as relative horizon, and coerced to a relative ForecastingHorizon(fh, is_relative=True).
if fh is of type pd.Index, it is interpreted as an absolute horizon, and coerced to an absolute ForecastingHorizon(fh, is_relative=False).

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

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

alpha浮点数或唯一值的浮点数列表，可选 (默认=[0.05, 0.95])

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

返回：

quantilespd.DataFrame

列具有多重索引：第一层是拟合时来自 y 的变量名，: 第二层是传递给函数的 alpha 值。
行索引是 fh，具有额外的（上层）级别，等于实例级别，: 来自拟合时看到的 y，如果拟合时看到的 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
写入自身: 无。

参数：

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

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

如果为 None，则使用迄今为止看到的 y (self._y)，特别地

如果之前仅调用了一次 fit，则会产生样本内残差
如果 fit 需要 fh，则它必须指向 fit 中 y 的索引

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

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

返回：

y_res采用 sktime 兼容数据容器格式的时间序列: fh 处的预测残差，与 fh 具有相同的索引。y_res 与最近传递的 y 具有相同的类型：Series, Panel, Hierarchical scitype，相同的格式（见上文）。

predict_var(fh=None, X=None, cov=False)[source]#

计算/返回方差预测。

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

访问自身属性

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

self.cutoff，self.is_fitted

写入自身: 如果传入了 fh 且之前未传入，则将其存储到 self.fh。

参数：

fhint, list, 可强制转换为 pd.Index，或 ForecastingHorizon，默认值为 None

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

If fh is not None and not of type ForecastingHorizon, it is coerced to ForecastingHorizon internally (via _check_fh).

if fh is int or array-like of int, it is interpreted as relative horizon, and coerced to a relative ForecastingHorizon(fh, is_relative=True).
if fh is of type pd.Index, it is interpreted as an absolute horizon, and coerced to an absolute ForecastingHorizon(fh, is_relative=False).

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

用于预测的外生时间序列。应与 fit 中 y 具有相同的 scitype（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，如果拟合时看到的 y 是 Panel 或 Hierarchical。

条目是方差预测，用于列索引中的变量。给定变量和 fh 索引的方差预测是针对该变量和索引、给定观测数据的预测方差。

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

如果 cov=True

列索引是多重索引：第一层是变量名（同上）: 第二层是 fh。
行索引是 fh，具有额外的级别等于实例级别，: 来自拟合时看到的 y，如果拟合时看到的 y 是 Panel 或 Hierarchical。
条目是（协）方差预测，用于列索引中的变量，以及: 行索引和列索引中时间索引之间的协方差。

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

reset()[source]#

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

将 self 设置回构造函数调用后直接所处的状态，具有相同的超参数。使用 set_config 设置的配置值也保留。

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

超参数 = __init__ 的参数写入 self，例如，self.paramname 其中 paramname 是 __init__ 的一个参数
包含双下划线，即字符串“__”的对象属性。例如，名为“__myattr”的属性会被保留。
配置属性，配置保持不变。也就是说，调用 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”，则会在 /home/stored/ 中存储 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: 编码要预测的时间戳的预测 horizon。
Xpd.DataFrame, 或 2D np.array，可选 (默认=None): 用于评分的外生时间序列。如果 self.get_tag("X-y-must-have-same-index")，则 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_dict字典

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

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

jupyter kernel 如何显示 self 的实例

“diagram” = html 框图表示
“text” = 字符串打印输出

print_changed_onlybool，默认=True

打印 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(**kwargs)[source]#

设置评估器的参数。

有效的参数键可以通过 get_params() 列出。

返回：

self返回 self 的实例。

set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

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

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

取决于 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

是否设置 scikit-base 对象值参数（即组件估计器）中的随机状态。

如果为 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]#

更新 cutoff 值，并可选地更新已拟合参数。

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

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

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

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

访问自身属性

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

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 = 时间序列集合，全局/面板预测。带有两级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型 pd.DataFrame 的 list
Hierarchical scitype = 分层集合，用于分层预测。带有三级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

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

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

用于更新模型拟合的外生时间序列。应与 y 具有相同的 scitype（Series, Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index")，则 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_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，不更新状态。

参数：

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

用于更新预测器的时序数据。

sktime 中的个体数据格式被称为 mtype 规范，每种 mtype 都实现了一个抽象的 scitype。

Series scitype = 个体时间序列，普通预测。pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）
Panel scitype = 时间序列集合，全局/面板预测。带有两级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型 pd.DataFrame 的 list
Hierarchical scitype = 分层集合，用于分层预测。带有三级或更多级行 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)

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

update_paramsbool，可选 (默认=True)

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

reset_forecasterbool，可选 (默认=True)

如果为 True，则不会改变预测器的状态，即 update/predict 序列使用副本运行，并且 self 的截止点、模型参数、数据内存不会改变
如果为 False，则在运行 update/predict 序列时会像直接调用 update/predict 一样更新 self

返回：

y_pred汇总来自多个分割批次的点预测的对象

格式取决于总体预测的（截止点，绝对预测期）对

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

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

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

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

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

所需状态: 要求状态为“已拟合”。
访问自身属性: 以“_”结尾的拟合模型属性。指向已见数据的指针，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 = 时间序列集合，全局/面板预测。带有两级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型 pd.DataFrame 的 list
Hierarchical scitype = 分层集合，用于分层预测。带有三级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

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

fhint, list, 可强制转换为 pd.Index，或 ForecastingHorizon，默认值为 None

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

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

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

update_paramsbool，可选 (默认=True)

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

返回：

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