StatsModelsARIMA#

class StatsModelsARIMA(order: tuple[int, int, int] = (0, 0, 0), seasonal_order: tuple[int, int, int, int] = (0, 0, 0, 0), trend: str | Iterable | None = None, enforce_stationarity: bool = True, enforce_invertibility: bool = True, concentrate_scale: bool = False, trend_offset: int = 1, dates: ndarray | None = None, freq: str | None = None, missing: str | None = None, validate_specification: bool = True, start_params: ndarray | None = None, transformed: bool = True, includes_fixed: bool = False, method: str | None = None, method_kwargs: dict | None = None, gls: bool = False, gls_kwargs: dict | None = None, cov_type: str = 'opg', cov_kwds: dict | None = None, return_params: bool = False, low_memory: bool = False)[source]#

(S)ARIMA(X) 预测器，来自 statsmodels 的 tsa.arima 模块。

直接接口 statsmodels.tsa.arima.model.ARIMA。

用户应注意，statsmodels 包含 (S)ARIMA(X) 的两个独立实现，即 ARIMA 和 SARIMAX 类，位于不同的模块中：tsa.arima.model.ARIMA 和 tsa.statespace.SARIMAX。

这些是同一基础模型 (S)ARIMA(X) 的实现，但具有不同的拟合策略、拟合参数和略有不同的行为。用户应参阅 statsmodels 文档了解更多详细信息：https://statsmodels.cn/dev/examples/notebooks/generated/statespace_sarimax_faq.html

参数：
ordertuple，可选

(p,d,q) 模型阶数，分别对应自回归、差分和移动平均分量。d 始终是整数，而 p 和 q 可以是整数或整数列表。

seasonal_ordertuple，可选

(P,D,Q,s) 模型季节性分量的阶数，分别对应 AR 参数、差分、MA 参数和周期性。默认值为 (0, 0, 0, 0)。D 和 s 始终是整数，而 P 和 Q 可以是整数或正整数列表。

trendstr{‘n’,’c’,’t’,’ct’} 或 iterable，可选

控制确定性趋势的参数。可以指定为字符串，其中‘c’表示常数项，‘t’表示时间的线性趋势，‘ct’同时包含两者。也可以指定为定义多项式的 iterable，例如 numpy.poly1d，其中 [1,1,0,1] 表示 \(a + bt + ct^3\)。对于没有积分的模型，默认值为‘c’；对于有积分的模型，没有趋势。请注意，所有趋势项都作为外生回归量包含在模型中，这与 SARIMAX 模型中包含趋势的方式不同。有关趋势项处理的精确定义，请参阅注意事项部分。

enforce_stationaritybool，可选

是否要求自回归参数对应于平稳过程。

enforce_invertibilitybool，可选

是否要求移动平均参数对应于可逆过程。

concentrate_scalebool，可选

是否将尺度（误差项的方差）从似然函数中分离出来。这将参数数量减少一个。仅在考虑数值最大似然估计时适用。

trend_offsetint，可选

时间趋势值开始的偏移量。默认值为 1，因此如果 trend='t'，趋势等于 1, 2, …, nobs。通常仅在通过扩展先前数据集创建模型时设置。

datesdatetime 类型的 array_like，可选

如果 endog 或 exog 未提供索引，则可以提供 datetime 对象的 array-like 对象。

freqstr，可选

如果 endog 或 exog 未提供索引，则可以在此处指定时间序列的频率，作为 Pandas offset 或 offset 字符串。

missingstr

可用选项为‘none’、‘drop’和‘raise’。如果为‘none’，则不进行 nan 检查。如果为‘drop’，则丢弃任何包含 nans 的观测值。如果为‘raise’，则引发错误。默认值为‘none’。

start_paramsarray_like，可选

对数似然最大化解的初始猜测。如果为 None，则默认值由 Model.start_params 提供。

transformedbool，可选

start_params 是否已转换。默认值为 True。

includes_fixedbool，可选

如果参数之前已使用 fix_params 方法固定，则此参数描述 start_params 是否除自由参数外还包含固定参数。默认值为 False。

methodstr，可选

用于估计模型参数的方法。有效选项包括‘statespace’、‘innovations_mle’、‘hannan_rissanen’、‘burg’、‘innovations’和‘yule_walker’。并非所有选项都适用于每种规格（例如，‘yule_walker’只能用于 AR(p) 模型）。

method_kwargsdict，可选

要传递给参数估计器拟合函数（由 method 参数描述）的参数。

glsbool，可选

是否使用广义最小二乘法（GLS）估计回归效应。如果 method='statespace'，默认值为 False，否则为 True。

gls_kwargsdict，可选

要传递给 GLS 估计拟合方法的参数。仅在使用了 GLS 估计时适用（详见 gls 参数）。

cov_typestr，可选

cov_type 关键字控制计算参数估计协方差矩阵的方法。可以是以下之一：

  • ‘opg’ 表示梯度外积估计器

  • ‘oim’ 表示观测信息矩阵估计器，使用 Harvey (1989) 的方法计算

  • ‘approx’ 表示观测信息矩阵估计器，使用 Hessian 矩阵的数值近似计算。

  • ‘robust’ 表示一个近似的（拟最大似然）协方差矩阵，即使存在一些错误指定也可能有效。中间计算使用‘oim’方法。

  • ‘robust_approx’ 与‘robust’相同，不同之处在于中间计算使用‘approx’方法。

  • ‘none’ 表示不计算协方差矩阵。

默认值为‘opg’，除非使用内存节省以避免计算每个观测值的对数似然值，此时默认值为‘oim’。

cov_kwdsdict 或 None，可选

影响协方差矩阵计算的参数字典。

opg, oim, approx, robust, robust_approx

  • ‘approx_complex_step’ : bool，可选 - 如果为 True，则使用复步法计算数值近似。如果为 False，则使用有限差分法计算数值近似。默认值为 True。

  • ‘approx_centered’ : bool，可选 - 如果为 True，则使用有限差分法计算的数值近似使用中心近似。默认值为 False。

return_paramsbool，可选

是否仅返回最大化参数的数组。默认值为 False。

low_memorybool，可选

如果设置为 True，则应用技术大幅减少内存使用。如果使用，结果对象的一些功能将不可用（包括平滑结果和样本内预测），但样本外预测是可能的。默认值为 False。

属性：
cutoff

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

fh

传递的预测范围。

is_fitted

fit 是否已被调用。

另请参见

ARIMA
SARIMAX
AutoARIMA
StatsForecastAutoARIMA

示例

>>> from sktime.datasets import load_airline
>>> from sktime.forecasting.arima import StatsModelsARIMA
>>> y = load_airline()
>>> forecaster = StatsModelsARIMA(order=(0, 0, 12))  
>>> forecaster.fit(y)  
>>> y_pred = forecaster.predict(fh=[1,2,3])

方法

check_is_fitted([method_name])

检查估计器是否已拟合。

clone()

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

clone_tags(estimator[, tag_names])

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

create_test_instance([parameter_set])

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

create_test_instances_and_names([parameter_set])

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

fit(y[, X, fh])

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

fit_predict(y[, X, fh, X_pred])

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

get_class_tag(tag_name[, tag_value_default])

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

get_class_tags()

从类获取类标签，带有父类的标签级继承。

get_config()

获取自身的配置标志。

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)

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

summary()

获取拟合预测器的摘要。

update(y[, X, update_params])

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

update_predict(y[, cv, X, update_params, ...])

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

update_predict_single([y, fh, X, update_params])

用新数据更新模型并进行预测。
summary()[source]#

获取拟合预测器的摘要。

这与 statsmodels 中的实现相同

https://statsmodels.cn/dev/examples/notebooks/generated/statespace_structural_harvey_jaeger.html

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

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

参数：
parameter_setstr，默认值=”default”

要返回的测试参数集的名称，用于测试。如果未为值定义特殊参数，将返回 "default" 集。预测器当前没有保留值。

返回：
paramsdict 列表，默认值 = []

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。is_fitted 属性应在调用对象的 fit 方法时设置为 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 或 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 个元素是 objs 在测试中的第 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，则将 fh 存储到 self.fh。

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

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

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

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

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex（实例，时间），3D np.ndarray（实例，变量，时间），Series 类型 pd.DataFrame 的 list

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex（层级_1，...，层级_n，时间）

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

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

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

Xsktime 兼容格式的时间序列，可选（默认值=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 scitype = 单个时间序列，普通预测。pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex（实例，时间），3D np.ndarray（实例，变量，时间），Series 类型 pd.DataFrame 的 list

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex（层级_1，...，层级_n，时间）

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

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

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

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

Xsktime 兼容格式的时间序列，可选（默认值=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 scitype，格式相同（见上文）

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

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

  • 始终：此对象的所有拟合参数，如同通过 get_param_names；值是此对象该键的拟合参数值

  • 如果 deep=True，也包含组件参数的键/值对；组件参数的索引格式为 [组件名称]__[参数名称]；组件名称 的所有参数都以 参数名称 及其值的形式出现

  • 如果 deep=True，也包含任意级别的组件递归，例如 [组件名称]__[子组件名称]__[参数名称] 等

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，将返回此对象的参数名:值字典，但不包括组件的参数。

返回：
paramsstr 类型键的 dict

参数字典，paramname : paramvalue 键值对包括

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

  • 如果 deep=True，也包含组件参数的键/值对；组件参数的索引格式为 [组件名称]__[参数名称]；组件名称 的所有参数都以 参数名称 及其值的形式出现

  • 如果 deep=True，也包含任意级别的组件递归，例如 [组件名称]__[子组件名称]__[参数名称] 等

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”) 的结果
返回：
反序列化自身，结果存储在 path，由 cls.save(path) 生成
classmethod load_from_serial(serial)[source]#

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

参数：
serialcls.save(None) 输出的第一个元素
返回：
反序列化自身，结果为 serial，由 cls.save(None) 生成
predict(fh=None, X=None)[source]#

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

所需状态

需要状态为“已拟合”，即 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）

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

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

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

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

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

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

所需状态

需要状态为“已拟合”，即 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）

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

coveragefloat 或 float 唯一值的列表，可选（默认=0.90）

预测区间(s)的名义覆盖率

返回：
pred_intpd.DataFrame
列具有多重索引：第一层是 fit 中 y 的变量名，
第二层是计算区间的覆盖率分数。

顺序与输入 coverage 中的顺序相同。

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

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

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

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

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

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

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

注意

  • 目前仅针对 Series (非面板，非分层) y 实现。

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

所需状态

需要状态为“已拟合”，即 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）

用于预测的外部时间序列。应与 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 中的属性

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

  • 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）

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

alphafloat 或 float 唯一值的列表，可选（默认=[0.05, 0.95]）

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

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

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

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

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

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

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

predict_residuals(y=None, X=None)[source]#

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

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

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

所需状态

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

访问 self 中的属性

以 "_" 结尾的已拟合模型属性。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")，则 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 中的属性

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

  • 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）

用于预测的外部时间序列。应与 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。

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

给定观测数据时，那个变量和索引的方差。

如果 cov=True
列索引是多重索引：第一层是变量名（如上文所述）

第二层是 fh。

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

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

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

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

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

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"，则将在当前工作目录创建 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")，则 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>。如果引用明确（例如，没有两个组件参数具有名称 <parameter>），也可以使用字符串 <parameter>，无需 <component>__ 前缀。

参数：
**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 将它们设置为通过 sample_dependent_seed 从 random_state 派生的整数。这些整数通过链式哈希采样，并保证随机生成器的伪随机独立性。

取决于 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_params=True：拟合所有已观测到的数据

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

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入自身

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

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

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

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

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

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

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex（实例，时间），3D np.ndarray（实例，变量，时间），Series 类型 pd.DataFrame 的 list

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex（层级_1，...，层级_n，时间）

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

Xsktime 兼容格式的时间序列，可选（默认值=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 不是默认值）：

  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_params=True：拟合所有已观测到的数据

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

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入 self（除非 reset_forecaster=True）

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

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

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

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

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

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

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

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex（实例，时间），3D np.ndarray（实例，变量，时间），Series 类型 pd.DataFrame 的 list

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex（层级_1，...，层级_n，时间）

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

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

例如，SlidingWindowSplitter 或 ExpandingWindowSplitter；默认 = 初始窗口为 1 且默认为 ExpandingWindowSplitter = 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")，则 X.index 必须包含 fh 索引引用。

update_paramsbool，可选（默认=True）

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

reset_forecasterbool，可选（默认=True）

  • 如果为 True，则不会改变预测器的状态，即使用副本运行更新/预测序列，self 的截止点、模型参数、数据记忆不会改变

  • 如果为 False，则在运行更新/预测序列时将更新 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 中的属性

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

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

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

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

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

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

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex（实例，时间），3D np.ndarray（实例，变量，时间），Series 类型 pd.DataFrame 的 list

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex（层级_1，...，层级_n，时间）

有关数据格式的更多详细信息，请参阅 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")，则 X.index 必须包含 fh 索引引用。

update_paramsbool，可选（默认=True）

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

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

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