ARCH

class ARCH(mean='Constant', lags=0, vol='GARCH', p=1, o=0, q=1, power=2.0, dist='Normal', hold_back=None, rescale=False, update_freq=0, disp=False, starting_values=None, cov_type='robust', show_warning=False, first_obs=None, last_obs=None, tol=None, options=None, backcast=None, params=None, start=None, align='origin', method='simulation', simulations=10, rng=None, random_state=None, reindex=False)

直接封装了 Python arch 包中的 ARCH 模型。

ARCH 模型是一类流行的波动率模型，它使用收益或残差的观测值作为波动冲击，来预测高频时间序列数据中的波动率。

一个完整的 ARCH 模型分为三个组件：

一个均值模型，例如，常数均值或 ARX；一个波动过程，例如，GARCH 或 EGARCH 过程；以及标准化残差的分布。

参数:

meanstr，可选

均值模型的名称。当前支持的选项有：‘Constant’、‘Zero’、‘LS’、‘AR’、‘ARX’、‘HAR’ 和 ‘HARX’。

lagsint 或 list (int)，可选

标量整数值表示滞后长度，或整数列表指定滞后位置。

volstr，可选

波动率模型的名称。当前支持的选项有：‘GARCH’（默认）、‘ARCH’、‘EGARCH’、‘FIARCH’ 和 ‘HARCH’。

pint，可选

对称创新项的滞后阶数。

oint，可选

非对称创新项的滞后阶数。

qint，可选

滞后波动率或等价物的滞后阶数。

powerfloat，可选

用于 GARCH 及相关模型的幂次。

distint，可选

误差分布的名称。当前支持的选项有：

• 正态分布：‘normal’、‘gaussian’（默认）

• Student’s t 分布：‘t’、‘studentst’

• 偏斜 Student’s t 分布：‘skewstudent’、‘skewt’

• 广义误差分布：‘ged’、‘generalized error”

hold_backint

估计模型参数时，从样本开始排除的观测值数量。用于比较不同滞后长度的模型时，在共同样本上进行估计。

rescalebool

标志，指示是否在数据尺度可能导致估计模型参数时出现收敛问题的情况下自动重新缩放数据。如果为 False，则模型在未转换的数据上进行估计。如果为 True，则 y 被重新缩放，并在估计结果中报告新的尺度。

update_freqint，可选

迭代更新的频率。每 update_freq 次迭代生成一次输出。设置为 0 可禁用迭代输出。

disp{bool, “off”, “final”}

‘final’ 表示打印优化结果，‘off’ 表示不显示任何内容。如果使用布尔值，False 对应 “off”，True 对应 “final”。

starting_valuesnp.ndarray，可选

要使用的起始值数组。如果未提供，则由模型组件构建起始值。

cov_typestr，可选

参数协方差的估计方法。支持的选项有 ‘robust’（不假定信息矩阵等式成立）和 ‘classic’（假定信息矩阵等式成立）。在 ARCH 文献中，‘robust’ 对应 Bollerslev-Wooldridge 协方差估计器。

show_warningbool，可选

标志，指示是否应显示收敛警告。

first_obs{int, str, datetime, Timestamp}

估计模型时使用的第一个观测值。

last_obs{int, str, datetime, Timestamp}

估计模型时使用的最后一个观测值。

tolfloat，可选

终止容忍度。

optionsdict，可选

传递给 scipy.optimize.minimize 的选项。有效条目包括 ‘ftol’、‘eps’、‘disp’ 和 ‘maxiter’。

backcast{float, np.ndarray}，可选

用作回溯值的值。应衡量 \sigma^2_0，因为在计算方差递推之前，模型特定的非线性变换会应用于该值。

params{np.ndarray, Series}

预测所需的参数。必须与拟合模型计算出的参数形状相同。

start{int, datetime, Timestamp, str}，可选

一个整数、datetime 或 str，指示生成预测的第一个观测值。Datetime 只能与具有 datetime 索引的 pandas 输入一起使用。字符串必须可转换为日期时间，例如 ‘1945-01-01’。

alignstr，可选

‘origin’ 或 ‘target’。设置为 ‘origin’ 时，预测的第 t 行包含 t+1, t+2, …, t+h 的预测。设置为 ‘target’ 时，第 t 行包含时间 t-1 的 1 步预测，时间 t-2 的 2 步预测，…，以及时间 t-h 的 h 步预测。‘target’ 简化了计算预测误差，因为实现值和 h 步预测是对齐的。

method{‘analytic’, ‘simulation’, ‘bootstrap’}

生成预测时使用的方法。默认是 analytic。该方法只影响方差预测的生成。并非所有波动率模型都支持所有方法。特别是，不像 EGARCH 或 TARCH 那样以平方形式演变的波动率模型不支持 horizon > 1 的 ‘analytic’ 方法。

simulationsint

使用 simulation 或 bootstrap 计算预测时运行的模拟次数。

rngcallable，可选

在基于模拟的预测中使用的自定义随机数生成器。必须使用 rng(size) 语法生成随机样本，其中 size 是 2 元素元组 (simulations, horizon)。

random_stateRandomState，可选

方法为 ‘bootstrap’ 时使用的 NumPy RandomState 实例。

reindexbool，可选

是否重新索引预测，使其维度与被预测序列相同。在 4.18 之前这是默认行为。从 4.19 开始，这成为可选。如果未提供，将发出警告，告知默认行为将在 2021 年 9 月之后发生更改。

属性:

cutoff

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

fh

传递的预测范围。

is_fitted

fit 方法是否已被调用。

另请参见

StatsForecastARCH

StatsForecastGARCH

参考资料

[1]

arch 包的 GitHub 仓库（软依赖）。 bashtage/arch

[2]

arch 包的文档（软依赖）。使用 ARCH 及其变体预测波动率。 https://arch.readthedocs.io/en/stable/univariate/introduction.html

示例

>>> from sktime.datasets import load_airline  
>>> from sktime.forecasting.arch import ARCH  
>>> y = load_airline()  
>>> forecaster = ARCH()  
>>> forecaster.fit(y)  
ARCH(...)
>>> y_pred = forecaster.predict(fh=1)  

方法

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()	返回评估器的测试参数设置。
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])	将序列化的 self 保存到字节类对象或 (.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)	将实例级别标签覆盖设置为给定值。
summary()	拟合模型的摘要。
update(y[, X, update_params])	更新截止值，并（可选地）更新拟合参数。
update_predict(y[, cv, X, update_params, ...])	在测试集上迭代地进行预测并更新模型。
update_predict_single([y, fh, X, update_params])	使用新数据更新模型并进行预测。

classmethod get_test_params()

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

返回:

paramsdict 或 dict 列表

summary()

拟合模型的摘要。

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 设置动态标签覆盖。

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

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

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

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

参数:

estimator:class:BaseObject 或派生类的实例

tag_namesstr 或 str 列表，默认 = None

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

返回:

self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')

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

参数:

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 个元素是测试中第 i 个 obj 实例的名称。如果有多于一个实例，命名约定是 {cls.__name__}-{i}，否则是 {cls.__name__}。

property cutoff

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

返回:

cutoff与 pandas 兼容的索引元素，或 None

如果已设置 cutoff，则是与 pandas 兼容的索引元素；否则为 None。

property fh

传递的预测范围。

fit(y, X=None, fh=None)

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

状态变更

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

写入 self

• 设置以“_”结尾的拟合模型属性，拟合属性可通过 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 = 时间序列集合，全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，list 类型的 Series 类型 pd.DataFrame。

• Hierarchical scitype = 分层集合，用于分层预测。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") 为 True，则 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。

参数:

y以与 sktime 兼容的数据容器格式表示的时间序列

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

sktime 中的独立数据格式是所谓的 mtype 规范，每种 mtype 实现了一种抽象 scitype。

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

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

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）

用于预测的外生时间序列。如果传递，将代替 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 的标签值，考虑标签覆盖，优先级从高到低如下：

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 类属性收集。不会被通过 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，默认=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)

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

参数:

deepbool，默认=True

是否返回组件的参数。

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

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

返回:

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)

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

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

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

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

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

在实例构建时。

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

3. 在父类的 _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 设置的标签。

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

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

在实例构建时。

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

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

按继承顺序。

返回:

collected_tagsdict

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

is_composite()

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

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

返回:

compositebool

对象是否具有任何参数，其值是 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.cutoff, self.is_fitted

写入 self

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

参数:

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

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

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

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

用于预测的外部时间序列。应与 fit 中的 y 具有相同的科学类型（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)

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

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

所需状态

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

在 self 中访问

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

• self.cutoff, self.is_fitted

写入 self

如果 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)。

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

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

coverage浮点数或包含唯一浮点数的列表，可选 (默认=0.90)

预测区间的名义覆盖度

返回:

pred_intpd.DataFrame

列具有多级索引：第一级是 fit 中 y 的变量名，

第二级是计算区间的覆盖率。

顺序与输入 coverage 中的一致。

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

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

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

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

对于列索引中的变量，在第二列索引的名义覆盖率下，下限/上限取决于第三列索引，对应于行索引。上限/下限区间预测等同于在 alpha = 0.5 - c/2, 0.5 + c/2 （c 在 coverage 中）处的分位数预测。

predict_proba(fh=None, X=None, marginal=True)

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

注意

• 目前仅对 Series (非 Panel, 非 Hierarchical) 类型的 y 实现。

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

所需状态

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

在 self 中访问

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

• self.cutoff, self.is_fitted

写入 self

如果 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)。

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

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

marginal布尔值，可选 (默认=True)

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

返回:

pred_distskpro BaseDistribution

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

predict_quantiles(fh=None, X=None, alpha=None)

计算/返回分位数预测。

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

所需状态

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

在 self 中访问

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

• self.cutoff, self.is_fitted

写入 self

如果 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)。

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

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

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

一个概率值或概率值列表，用于计算分位数预测。

返回:

quantilespd.DataFrame

列具有多级索引：第一级是 fit 中 y 的变量名，

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

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

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

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

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

predict_residuals(y=None, X=None)

返回时间序列预测的残差。

将为 y.index 处的预测计算残差。

如果在 fit 中必须传递 fh，则其必须与 y.index 一致。如果 y 是 np.ndarray 且在 fit 中未传递 fh，则残差将在 fh 为 range(len(y.shape[0])) 处计算。

所需状态

要求状态为“已拟合”。如果已设置 fh，则其必须与 y 的索引相对应 (pandas 或整数)

在 self 中访问

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

写入 self

无。

参数:

y以与 sktime 兼容的数据容器格式表示的时间序列

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

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

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

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

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

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

返回:

y_ressktime 兼容数据容器格式的时间序列

fh 处的预测残差，与 fh 具有相同的索引。y_res 与最近一次传递的 y 具有相同的类型：Series、Panel、Hierarchical 科学类型，格式相同（见上文）

predict_var(fh=None, X=None, cov=False)

计算/返回方差预测。

所需状态

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

在 self 中访问

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

• self.cutoff, self.is_fitted

写入 self

如果 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)。

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

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

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

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

将 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')

将序列化的 self 保存到字节类对象或 (.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, default = “pickle”

用于序列化的模块。可用选项有“pickle”和“cloudpickle”。请注意，非默认格式可能需要安装其他软依赖项。

返回:

如果 path 为 None - 内存中的序列化 self

如果 path 是文件位置 - 指向文件的 ZipFile 对象

score(y, X=None, fh=None)

使用 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

返回:

score浮点数

self.predict(fh, X) 相对于 y_test 的 MAPE (平均绝对百分比误差) 损失。

另请参见

sktime.performance_metrics.forecasting.mean_absolute_percentage_error

set_config(**config_dict)

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

参数:

config_dictdict

配置名 : 配置值 对的字典。有效的配置项、值及其含义如下所示

display字符串，“diagram”（默认），或“text”

jupyter 内核显示 self 实例的方式

• “diagram” = HTML 框图表示

• “text” = 字符串输出

print_changed_only布尔值，默认=True

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

warnings字符串，“on”（默认），或“off”

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

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

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

backend:parallel字符串，可选，默认=“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”：字符串，默认=“ray”；要使用的日志记录器名称。

  • “mute_warnings”：布尔值，默认=False；如果为 True，则抑制警告

remember_data布尔值，默认=True

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

返回:

selfself 的引用。

注意

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

set_params(**params)

设置此对象的参数。

该方法适用于简单的 skbase 对象以及复合对象。对于复合对象（即包含其他对象的对象），可以使用参数键字符串 <component>__<parameter> 来访问组件 <component> 中的 <parameter>。如果引用清晰明确（例如，没有两个组件的参数名称相同），也可以使用不带 <component>__ 的字符串 <parameter>。

参数:

**params字典

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

返回:

selfself 的引用（设置参数后）

set_random_state(random_state=None, deep=True, self_policy='copy')

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

通过 self.get_params 查找名为 random_state 的参数，并使用从 random_state 派生的整数通过 set_params 设置它们。这些整数通过 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，默认=True

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

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

• 如果为 True，也将设置组件对象中的 random_state 参数。

self_policy字符串，以下选项之一 {“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)

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

每个与 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)

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

如果未实现特定于评估器的 update 方法，默认回退行为如下：

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

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

所需状态

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

在 self 中访问

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

• self.cutoff, self.is_fitted

写入 self

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

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

参数:

y以与 sktime 兼容的数据容器格式表示的时间序列。

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

sktime 中的独立数据格式是所谓的 mtype 规范，每种 mtype 实现了一种抽象 scitype。

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

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

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

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

X以外生时间序列，以与 sktime 兼容的格式表示，可选（默认=None）。

用于更新模型拟合的外部时间序列。应与 y 具有相同的科学类型（Series、Panel 或 Hierarchical）。如果 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)

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

用于执行一系列多次 update / predict 操作的简写，数据回放基于时间分割器 cv。

与以下操作相同（如果只有 y、cv 是非默认值）

1. self.update(y=cv.split_series(y)[0][0])

2. 记住 self.predict() 的结果（稍后在单个批次中返回）

3. self.update(y=cv.split_series(y)[1][0])

4. 记住 self.predict() 的结果（稍后在单个批次中返回）

5. 等等

6. 返回所有记住的预测结果

如果未实现特定于评估器的 update 方法，默认回退行为如下：

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

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

所需状态

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

在 self 中访问

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

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

用于更新和预测的外部时间序列。应与 fit 中的 y 具有相同的科学类型（Series、Panel 或 Hierarchical）。如果 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将来自多个分割批次的点预测制成表格的对象

格式取决于（cutoff，绝对范围）预测对的总体情况

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

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

update_predict_single(y=None, fh=None, X=None, update_params=True)

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

此方法适用于一步完成更新和预测。

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

所需状态

要求状态为“已拟合”。

在 self 中访问

以“_”结尾的已拟合模型属性。指向已见数据的指针，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，

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

参数:

y以与 sktime 兼容的数据容器格式表示的时间序列。

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

sktime 中的独立数据格式是所谓的 mtype 规范，每种 mtype 实现了一种抽象 scitype。

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

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

• Hierarchical scitype = 分层集合，用于分层预测。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 具有相同的科学类型（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。

update_params布尔值，可选 (默认=True)

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

返回:

y_pred以与 sktime 兼容的数据容器格式表示的时间序列

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