ConformalIntervals#

class ConformalIntervals(forecaster, method='empirical', initial_window=None, sample_frac=None, verbose=False, n_jobs=None)[source]#

经验预测区间和共形预测区间。

实现了基于绝对残差的经验预测区间和共形预测区间。经验预测区间基于滑动窗口经验分位数。共形预测区间按照 [1] 中的描述实现。

所有区间都封装了任意预测器，即为给定的点预测预测器（第一个参数）添加了概率预测能力。

method=”conformal_bonferroni” 是 [1] 中描述的方法，

其中使用了任意预测器而不是 RNN。

method=”conformal” 是 [1] 中的方法，但没有 Bonferroni 校正。

即，进行单独预测，这导致 H=1（在所有预测范围）。

method=”empirical” 使用训练集上相对有符号残差的分位数，即 [1] 符号中的 y_t+h^(i) - y-hat_t+h^(i)，遍历 i，在分位数 0.5-0.5*coverage（下限）和 0.5+0.5*coverage（上限）处，作为预测范围 h 处点预测的偏移量

即 y_t+h^(i) - y-hat_t+h^(i)，遍历 i，采用 [1] 中的记法，分别在分位数 0.5-0.5*coverage (下限) 和 0.5+0.5*coverage (上限) 处，作为预测范围 h 处点预测的偏移量

method=”empirical_residual” 使用训练集上绝对残差的经验分位数，即 epsilon-h（在 [1] 符号中）的分位数，在分位数点 (1-coverage)/2 分位数处，作为点预测的偏移量

在训练集上，即 epsilon-h 的分位数 ([1] 中记法)，在分位数点 (1-coverage)/2 处，作为点预测的偏移量

参数：
forecaster估计器

添加概率预测的估计器

methodstr, 可选, 默认=”empirical”

“empirical”：预测区间边界是来自训练集的经验分位数 “empirical_residual”：上限/下限是加减 (1-coverage)/2 分位数

在预测范围内的绝对残差，即 epsilon-h

“conformal_bonferroni”：Bonferroni，如 Stankeviciute 等人所述

注意：这不提供频率派预测区间，而是共形预测区间

“conformal”：如 Stankeviciute 等人所述，但 H=1，

即，在预测范围内的索引数量下没有 Bonferroni 校正

initial_windowfloat, int 或 None, 可选 (默认=max(10, 0.1*len(y)))

定义初始训练窗口的大小 如果是 float，应在 0.0 和 1.0 之间，表示数据集用于训练分割初始窗口的比例。 如果是 int，表示初始窗口中训练样本的相对数量。 如果是 None，该值设置为 0.1*len(y) 和 10 中的较大者。

sample_fracfloat, 可选, 默认=None

范围 (0,1) 中的值，对应于用于计算残差矩阵值的 y 索引的比例（用于加速计算）

verbosebool, 可选, 默认=False

是否在出现数据点过少的窗口时打印警告

n_jobsint 或 None, 可选, 默认=1

fit 过程中并行运行的作业数量。-1 表示使用所有处理器。

属性：
cutoff

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

fh

传入的预测范围。

is_fitted

是否已调用 fit。

参考文献

[1] (1,2,3,4,5)

Kamile Stankeviciute, Ahmed M Alaa and Mihaela van der Schaar. Conformal Time Series Forecasting. NeurIPS 2021.

示例

>>> from sktime.datasets import load_airline  
>>> from sktime.forecasting.conformal import ConformalIntervals  
>>> from sktime.forecasting.naive import NaiveForecaster  
>>> y = load_airline()  
>>> forecaster = NaiveForecaster(strategy="drift")  
>>> conformal_forecaster = ConformalIntervals(forecaster)  
>>> conformal_forecaster.fit(y, fh=[1, 2, 3])  
ConformalIntervals(...)
>>> pred_int = conformal_forecaster.predict_interval()

推荐将 ConformalIntervals 与 ForecastingGridSearch 一起使用的方法是 1. 首先运行网格搜索，2. 然后对调优后的参数使用 ConformalIntervals 否则，嵌套滑动窗口将导致较高的计算要求

>>> from sktime.datasets import load_airline
>>> from sktime.forecasting.conformal import ConformalIntervals
>>> from sktime.forecasting.naive import NaiveForecaster
>>> from sktime.forecasting.model_selection import ForecastingGridSearchCV
>>> from sktime.split import ExpandingWindowSplitter
>>> from sktime.param_est.plugin import PluginParamsForecaster
>>> # part 1 = grid search
>>> cv = ExpandingWindowSplitter(fh=[1, 2, 3])  
>>> forecaster = NaiveForecaster()  
>>> param_grid = {"strategy" : ["last", "mean", "drift"]}  
>>> gscv = ForecastingGridSearchCV(
...     forecaster=forecaster,
...     param_grid=param_grid,
...     cv=cv,
... )  
>>> # part 2 = plug in results of grid search into conformal intervals estimator
>>> conformal_with_fallback = ConformalIntervals(NaiveForecaster())
>>> gscv_with_conformal = PluginParamsForecaster(
...     gscv,
...     conformal_with_fallback,
...     params={"forecaster": "best_forecaster"},
... )  
>>> y = load_airline()  
>>> gscv_with_conformal.fit(y, fh=[1, 2, 3])  
PluginParamsForecaster(...)
>>> y_pred_quantiles = gscv_with_conformal.predict_quantiles()

方法

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

检查对象是否由其他 BaseObject 组成。

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 列表
check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数：
method_namestr, 可选

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

引发：
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

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

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

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

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

引发：
如果克隆不符合要求，由于 __init__ 错误，将引发 RuntimeError。
clone_tags(estimator, tag_names=None)[source]#

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

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

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

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

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

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

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

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

参数：
estimator:class:BaseObject 或派生类的实例
tag_namesstr 或 str 列表, 默认 = None

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

返回：
self

self 的引用。

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

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

参数：
parameter_setstr, 默认=”default”

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

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

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

参数：
parameter_setstr, 默认=”default”

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

返回：
objscls 实例列表

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

namesstr 列表, 长度与 objs 相同

第 i 个元素是测试中第 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，则将其存储到 self.fh。

参数：
y采用 sktime 兼容数据容器格式的时间序列。

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

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

  • Series 科学类型 = 个体时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel 科学类型 = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 类型的 pd.DataFrame，其元素为 Series 类型

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

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

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

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

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。

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

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

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

  • Series 科学类型 = 个体时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel 科学类型 = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 类型的 pd.DataFrame，其元素为 Series 类型

  • Hierarchical 科学类型 = 分层集合，用于分层预测。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) 强制转换。

X采用 sktime 兼容格式的时间序列, 可选 (默认=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 科学类型，格式相同（见上文）

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

从类中获取类标签值，并从父类继承标签级别。

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

get_class_tag 方法是一个类方法，仅考虑类级别标签值和覆盖来检索标签的值。

它从对象中返回名称为 tag_name 的标签的值，并考虑以下降序优先级的标签覆盖

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

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

按照继承顺序。

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

要检索可能包含实例覆盖的标签值，请改用 get_tag 方法。

参数：
tag_namestr

标签值的名称。

tag_value_default任意类型

如果找不到标签，则为默认/备用值。

返回：
tag_value

self 中 tag_name 标签的值。如果未找到，则返回 tag_value_default。

classmethod get_class_tags()[source]#

从类中获取类标签，并从父类继承标签级别。

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

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

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

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

值是对应的标签值，按照以下降序优先级进行覆盖

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

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

按照继承顺序。

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

要检索可能包含实例覆盖的标签值，请改用 get_tags 方法。

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

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

collected_tagsdict

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

get_config()[source]#

获取自身的配置标志。

配置是 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，还包含组件参数的键/值对。组件的参数索引为 [componentname]__[paramname]，componentname 的所有参数都显示为 paramname 及其值

  • 如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

classmethod get_param_defaults()[source]#

获取对象的默认参数。

返回：
default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数：
sortbool, 默认=True

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

返回：
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数：
deepbool, 默认=True

是否返回组件的参数。

  • 如果为 True，将返回此对象的参数名称 : 值 dict，包括组件（= BaseObject 类型参数）的参数。

  • 如果为 False，将返回此对象的参数名称 : 值 dict，但不包括组件的参数。

返回：
params键为 str 的 dict

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

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

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

  • 如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

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

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

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

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

get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，并考虑以下降序优先级的标签覆盖

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

在实例构造时。

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

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

按照继承顺序。

参数：
tag_namestr

要检索的标签名称

tag_value_default任意类型, 可选; 默认=None

如果找不到标签，则为默认/备用值

raise_errorbool

找不到标签时是否引发 ValueError

返回：
tag_valueAny

self 中 tag_name 标签的值。如果未找到，则在 raise_error 为 True 时引发错误，否则返回 tag_value_default。

引发：
ValueError，如果 raise_error 为 True。

如果 tag_name 不在 self.get_tags().keys() 中，则引发 ValueError。

get_tags()[source]#

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

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

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

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

值是对应的标签值，按照以下降序优先级进行覆盖

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

在实例构造时。

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

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

按照继承顺序。

返回：
collected_tagsdict

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

is_composite()[source]#

检查对象是否由其他 BaseObject 组成。

复合对象是包含其他对象作为参数的对象。在实例上调用，因为这可能因实例而异。

返回：
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]#

在未来预测范围预测时间序列。

所需状态

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

在自身中访问

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

  • self.cutoff, self.is_fitted

写入自身

如果传入了 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)

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

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

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

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

所需状态

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

在自身中访问

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

  • self.cutoff, self.is_fitted

写入自身

如果传入了 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)

用于预测的外生时间序列。应与 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，在第二列索引中的名义覆盖率处，下限/上限取决于第三列索引，对应行索引。上限/下限区间端点预测等同于在 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 且之前未传入过，则将其存储到 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)

用于预测的外生时间序列。应与 fit 中的 y 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为真，则 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

编码要预测的时间戳的预测范围。如果在 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)

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

alphafloat 或唯一浮点数列表, 可选 (默认为 [0.05, 0.95])

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

返回：
quantilespd.DataFrame
列具有多级索引：第一级是 fit 中 y 的变量名，

第二层是传递给函数的 alpha 值。

行索引是 fh，附加的 (上限) 层等于实例层，

来自 fit 中见过的 y，如果 fit 中见过的 y 是 Panel 或 Hierarchical。

条目是分位数预测，对于列索引中的 var，

在第二列索引中的分位数概率处，对应行索引。

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

写入自身

无。

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

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

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

  • 如果之前有一次 fit 调用，则生成样本内残差

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

Xsktime 兼容格式的时间序列, 可选 (默认为 None)

用于更新和预测的外生时间序列。应与 fit 中 y 具有相同的 scitype (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 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

编码要预测的时间戳的预测范围。如果在 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)

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

covbool, 可选 (默认为 False)

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

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

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

行索引是 fh，附加的层等于实例层，

来自 fit 中见过的 y，如果 fit 中见过的 y 是 Panel 或 Hierarchical。

条目是方差预测，对于列索引中的 var。给定变量和 fh 索引的方差预测是

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

如果 cov=True
列索引是一个多索引：第一层是变量名 (同上)

第二层是 fh。

行索引是 fh，附加的层等于实例层，

来自 fit 中见过的 y，如果 fit 中见过的 y 是 Panel 或 Hierarchical。

条目是 (协) 方差预测，对于列索引中的 var，以及

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

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

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) 生成一个 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

编码要预测的时间戳的预测范围。

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 派生的整数。这些整数是通过 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：仅更新截止点并记住数据

所需状态

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

在自身中访问

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

  • self.cutoff, self.is_fitted

写入自身

  • 将 self.cutoff 更新到在 y 中见到的最新索引。

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

参数：
y采用 sktime 兼容数据容器格式的时间序列。

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

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

  • Series 科学类型 = 个体时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel 科学类型 = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 类型的 pd.DataFrame，其元素为 Series 类型

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

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

X采用 sktime 兼容格式的时间序列, 可选 (默认=None)。

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

update_paramsbool, 可选 (默认为 True)

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

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

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

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

所需状态

要求状态为“已拟合”，即 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 科学类型 = 个体时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel 科学类型 = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 类型的 pd.DataFrame，其元素为 Series 类型

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

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

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

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

Xsktime 兼容格式的时间序列, 可选 (默认为 None)

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

update_paramsbool, 可选 (默认为 True)

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

reset_forecasterbool, 可选 (默认为 True)

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

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

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

格式取决于总体预测的对 (截止点, 绝对预测范围)

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

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

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

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

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

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

所需状态

要求状态为“已拟合”。

在自身中访问

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

写入自身

通过附加行，使用 y 和 X 更新 self._y 和 self._X。将 self.cutoff 和 self._cutoff 更新为 y 中见到的最后一个索引。如果 update_params=True，

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

参数：
y采用 sktime 兼容数据容器格式的时间序列。

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

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

  • Series 科学类型 = 个体时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel 科学类型 = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 类型的 pd.DataFrame，其元素为 Series 类型

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

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

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

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

Xsktime 兼容格式的时间序列, 可选 (默认为 None)

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

update_paramsbool, 可选 (默认为 True)

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

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

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