StatsForecastAutoARIMA#

class StatsForecastAutoARIMA(start_p: int = 2, d: int | None = None, start_q: int = 2, max_p: int = 5, max_d: int = 2, max_q: int = 5, start_P: int = 1, D: int | None = None, start_Q: int = 1, max_P: int = 2, max_D: int = 1, max_Q: int = 2, max_order: int = 5, sp: int = 1, seasonal: bool = True, stationary: bool = False, information_criterion: str = 'aicc', test: str = 'kpss', seasonal_test: str = 'seas', stepwise: bool = True, n_jobs: int = 2, trend: bool = True, method: str | None = None, offset_test_args: str | None = None, seasonal_test_args: dict | None = None, trace: bool = False, n_fits: int = 94, with_intercept: bool = True, approximation: bool | None = None, truncate: bool | None = None, blambda: float | None = None, biasadj: bool = False, parallel: bool = False)[source]#

StatsForecast AutoARIMA 估计器。

Nixtla 的 statsforecast.models.AutoARIMA 的直接接口。

这个估计器直接接口了 Nixtla 的 statsforecast [2] 中的 AutoARIMA。 statsforecast 的实现灵感来自于 Hyndman 的 forecast::auto.arima [1]。

根据 AIC、AICc 或 BIC 值返回最佳 ARIMA 模型。该函数在提供的阶数约束范围内搜索可能的模型。

参数:
start_p: int (默认 2)

逐步过程 (stepwise procedure) 中 p 的起始值。

d: int 可选 (默认 None)

一阶差分的阶数。如果缺失，将根据 test 选择一个值。

start_q: int (默认 2)

逐步过程 (stepwise procedure) 中 q 的起始值。

max_p: int (默认 5)

p 的最大值。

max_d: int (默认 2)

非季节性差分的最大数量

max_q: int (默认 5)

q 的最大值。

start_P: int (默认 1)

逐步过程 (stepwise procedure) 中 P 的起始值。

D: int 可选 (默认 None)

季节性差分的阶数。如果缺失，将根据 season_test 选择一个值。

start_Q: int (默认 1)

逐步过程 (stepwise procedure) 中 Q 的起始值。

max_P: int (默认 2)

P 的最大值。

max_D: int (默认 1)

季节性差分的最大数量

max_Q: int (默认 2)

Q 的最大值。

max_order: int (默认 5)

如果模型选择不是逐步进行的，则 p+q+P+Q 的最大值。

sp: int (默认 1)

每单位时间的观测次数。例如，对于每小时数据为 24。

seasonal: bool (默认 True)

如果为 False，则将搜索限制为非季节性模型。

stationary: bool (默认 False)

如果为 True，则将搜索限制为平稳模型。

information_criterion: str (默认 ‘aicc’)

用于模型选择的信息准则。可以从以下字符串中选择： - ‘aicc’ 表示修正的 Akaike 信息准则。 - ‘aic’ 表示 Akaike 信息准则。 - ‘bic’ 表示贝叶斯信息准则。

test: str (默认 ‘kpss’)

要使用的单位根检验类型。详情请参见 ndiffs。仅允许使用 Kwiatkowski-Phillip-Schmidt-Shin 检验的 ‘kpss’。

seasonal_test: str (默认 ‘seas’)

这决定了用于选择季节性差分数量的方法。默认方法 (‘seas’) 是使用从 STL 分解计算出的季节强度度量。其他可能性包括季节单位根检验。仅允许使用 ‘seas’。

stepwise: bool (默认 True)

如果为 True，将进行逐步选择（更快）。否则，它将搜索所有模型。非逐步选择可能非常慢，特别是对于季节性模型。

n_jobs: int (默认 2)

如果 parallel = True 且 stepwise = False，允许用户指定要使用的并行进程数量。如果为 None，则自动检测逻辑核心数量并使用所有可用核心。

trend: bool (默认 True)

如果为 True，则考虑包含漂移项的模型。

method: str 可选 (默认 None)

拟合方法：最大似然估计或最小化条件平方和。默认（除非存在缺失值）是使用条件平方和寻找初始值，然后使用最大似然估计。可以缩写。可以从以下字符串中选择

  • ‘CSS-ML’ 表示使用条件平方和寻找初始值，然后进行最大似然估计。

  • ‘ML’ 表示最大似然估计。

  • ‘CSS’ 表示条件平方和。

offset_test_args: dict 可选 (默认 None)

传递给单位根检验的附加参数。

seasonal_test_args: dict 可选 (默认 None)

传递给季节单位根检验的附加参数。详情请参见 nsdiffs。

trace: bool (默认 False)

如果为 True，将报告考虑的 ARIMA 模型列表。

n_fits: int (默认 94)

逐步搜索中考虑的最大模型数量。

with_intercept: bool (默认 True)

如果为 True，则考虑均值非零的模型。

approximation: bool 可选 (默认 None)

如果为 True，则通过条件平方和进行估计，并对用于模型选择的信息准则进行近似。最终模型仍使用最大似然估计计算。对于长时间序列或高季节周期，应使用近似法以避免过长的计算时间。

truncate: bool 可选 (默认 None)

一个整数值，指示在模型选择中使用多少观测值。当 truncate 不为 None 且 approximation=True 时，序列的最后 truncate 个值用于选择模型。如果 truncate=None 或 approximation=False，则使用所有观测值。

blambda: float 可选 (默认 None)

Box-Cox 变换参数。如果 lambda=”auto”，则使用 BoxCox.lambda 自动选择变换。如果为 None，则忽略变换。否则，在估计模型之前对数据进行变换。

biasadj: bool (默认 False)

对 Box-Cox 变换使用调整后的反变换均值。如果使用变换后的数据生成预测和拟合值，常规的反变换将导致中位数预测。如果 biasadj 为 True，将进行调整以生成均值预测和拟合值。

parallel: bool (默认 False)

如果为 True 且 stepwise = False，则并行执行模型搜索。这在多核机器上可以显著提高速度。

属性:
cutoff

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

fh

已传递的预测范围。

is_fitted

是否已调用 fit 方法。

参考文献

示例

>>> from sktime.datasets import load_airline
>>> from sktime.forecasting.statsforecast import StatsForecastAutoARIMA
>>> y = load_airline()
>>> forecaster = StatsForecastAutoARIMA(  
...     sp=12, d=0, max_p=2, max_q=2
... )
>>> forecaster.fit(y)  
StatsForecastAutoARIMA(...)
>>> 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()

获取 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([parameter_set])

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

is_composite()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict([fh, X])

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

predict_interval([fh, X, coverage])

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

predict_proba([fh, X, marginal])

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

predict_quantiles([fh, X, alpha])

计算/返回分位数预测。

predict_residuals([y, X])

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

predict_var([fh, X, cov])

计算/返回方差预测。

reset()

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

save([path, serialization_format])

将序列化的 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)

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

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 列表, 默认 = {}

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。在调用对象的 fit 方法时，is_fitted 属性应设置为 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 个元素是测试中 obj 的第 i 个实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

property cutoff[source]#

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

返回值:
cutoffpandas 兼容的索引元素，或 None

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

property fh[source]#

已传递的预测范围。

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

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

状态变更

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

写入 self

  • 设置以“_”结尾的拟合模型属性，拟合属性可通过 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 列表。

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

返回值:
self对 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) 相同。

状态变更

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

写入 self

  • 设置以“_”结尾的拟合模型属性，拟合属性可通过 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 列表。

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

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

用于预测的外生时间序列。如果传递，将在 predict 中使用，而不是 X。应与 fit 中的 y 具有相同的 scitype (Series, Panel 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 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 的配置标志。

配置是 self 的键值对，通常用作控制行为的瞬时标志。

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

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

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

返回值:
config_dictdict

配置名：配置值对的字典。通过嵌套继承从 _config 类属性收集，然后从 _config_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`，将返回此对象的参数名称: 值字典，但不包括组件的参数。

返回值:
params带有字符串键的字典

参数字典，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_error布尔值

未找到标签时是否引发 `ValueError`

返回值:
tag_value任意类型

`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_tags字典

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

is_composite()[source]#

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

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

返回值:
composite: 布尔值

对象是否包含任何其值为 `BaseObject` 后代实例的参数。

property is_fitted[source]#

是否已调用 fit 方法。

检查对象的 `_is_fitted` 属性，该属性在对象构造期间应初始化为 `False`，并在调用对象的 `fit` 方法时设置为 True。

返回值:
布尔值

评估器是否已经过`fit`。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open("object") 的结果
返回值:
反序列化后的 self，结果输出到 `path`，是 `cls.save(path)` 的输出。
classmethod load_from_serial(serial)[source]#

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

参数:
serial`cls.save(None)` 输出的第一个元素
返回值:
反序列化后的 self，结果输出 `serial`，是 `cls.save(None)` 的输出。
predict(fh=None, X=None)[source]#

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

所需状态

要求状态为“已拟合”，即 `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`具有相同的scitype（`Series`、`Panel`或`Hierarchical`）。如果`self.get_tag("X-y-must-have-same-index")`为True，则`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`

写入 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`具有相同的scitype（`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类型。

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

对于列索引中的变量，在第二列索引中的名义覆盖率下，根据第三列索引（下限/上限），针对行索引进行预测。上下限区间预测等价于对于覆盖率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`

写入 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`具有相同的scitype（`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)[source]#

计算/返回分位数预测。

如果 `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`具有相同的scitype（`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)[source]#

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

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

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

所需状态

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

访问 self 中的属性

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

写入 self

无。

参数:
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 中的属性

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

  • `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`具有相同的scitype（`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()[source]#

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

结果是将`self`设置为构造函数调用后的状态，具有相同的超参数。通过`set_config`设置的配置值也会被保留。

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

  • 超参数 = `__init__`的参数写入到`self`，例如`self.paramname`，其中`paramname`是`__init__`的一个参数

  • 包含双下划线的对象属性，即字符串“__”。例如，名为“__myattr”的属性会被保留。

  • 配置属性，配置保持不变。也就是说，`reset`前后的`get_config`结果是相同的。

类方法、对象方法和类属性也不受影响。

等同于`clone`，但`reset`会修改`self`本身而不是返回新对象。

在调用`self.reset()`后，`self`的值和状态与调用构造函数``type(self)(**self.get_params(deep=False))``后获得的对象相等。

返回值:
self

类的实例被重置为干净的初始化后状态，但保留当前的超参数值。

save(path=None, serialization_format='pickle')[source]#

将序列化的 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”，则会在`/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 (1维或2维)

要评分的时间序列

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

预测范围，编码了要进行预测的时间戳。

Xpd.DataFrame, 或 2维 np.array，可选（默认=None）

用于评分的外生时间序列。如果self.get_tag(“X-y-must-have-same-index”)为True，X.index必须包含y.index

返回值:
得分浮点数

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_only布尔值，默认=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: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”：str，默认=”ray”；要使用的日志记录器名称。

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

remember_data布尔值，默认=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对象以及复合对象。参数键字符串`__`可用于复合对象（即包含其他对象的对象），以访问组件``中的``。如果引用是明确的，也可以使用不带`__`的字符串``，例如，没有两个组件参数同名为``。

参数:
params字典

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

返回值:
self指向self的引用（参数设置后）
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

设置 self 的 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

用于控制随机整数生成的伪随机数生成器。传递整数以在多次函数调用中获得可复现的输出。

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_dict**字典

标签名称: 标签值对的字典。

返回值:
Self

指向self的引用。

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

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

如果没有实现特定于评估器的update方法，则默认回退如下

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

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

所需状态

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

访问 self 中的属性

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

  • `self.cutoff`, `self.is_fitted`

写入 self

  • 将`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 列表。

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

update_params布尔值，可选（默认=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 中的属性

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

  • `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 列表。

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame，行索引为 3 级或更多 MultiIndex (层级_1, ..., 层级_n, 时间)。

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

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

例如，`SlidingWindowSplitter`或`ExpandingWindowSplitter`；默认=具有`initial_window=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")`为True，则`X.index`必须包含`fh`索引引用。

update_params布尔值，可选（默认=True）

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

reset_forecaster布尔值，可选（默认=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 中的属性

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

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

参数:
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 列表。

  • 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")`为True，则`X.index`必须包含`fh`索引引用。

update_params布尔值，可选（默认=True）

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

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

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