STLForecaster#

class STLForecaster(sp=2, seasonal=7, trend=None, low_pass=None, seasonal_deg=1, trend_deg=1, low_pass_deg=1, robust=False, seasonal_jump=1, trend_jump=1, low_pass_jump=1, inner_iter=None, outer_iter=None, forecaster_trend=None, forecaster_seasonal=None, forecaster_resid=None)[source]#

基于 statsmodels.tsa.seasonal.STL 实现的 STLForecaster。

STLForecaster 应用以下算法，也参见 [1]。

在 fit 方法中

  1. 使用 statsmodels 的 STL [2] 将给定的时间序列 y 分解为三个分量：趋势 (trend)、季节项 (season) 和 残差 (residuals)。

2. 将 forecaster_trend 的克隆拟合到 趋势 (trend) 分量，将 forecaster_seasonal 的克隆拟合到 季节项 (season) 分量，

并将 forecaster_resid 的克隆拟合到 残差 (residuals) 分量，使用来自 fit 的 y、X、fh。预测器以克隆形式拟合，存储在属性 forecaster_trend_、forecaster_seasonal_、forecaster_resid_ 中。

在 predict 方法中，预测如下

  1. 使用来自 predict 的 X、fh，从 forecaster_trend_ 中获得 y_pred_trend 预测结果，从 forecaster_seasonal_ 中获得 y_pred_seasonal 预测结果，从 forecaster_resid_ 中获得 y_pred_residual 预测结果。

2. 将 y_pred 重组为 y_pred = y_pred_trend + y_pred_seasonal + y_pred_residual 3. 返回 y_pred

update 会完全重新拟合，即对目前为止所有见过的数据执行 fit 操作。

参数:
spint，可选，默认为 2。传递给 statsmodels STL。

传递给 statsmodels STL 的季节周期长度。（forecaster_seasonal 和 forecaster_resid 为 None 的情况）。默认的 forecaster_trend 不接收 sp 参数，因为趋势与季节性无关。

seasonalint，可选，默认为 7。传递给 statsmodels STL。

季节平滑器的长度。必须是大于等于 3 的奇数，通常应大于等于 7（默认值）。

trend{int, None}，可选，默认为 None。传递给 statsmodels STL。

趋势平滑器的长度。必须是奇数。如果未提供，则根据原始实现中的建议，使用大于 1.5 * 周期 / (1 - 1.5 / 季节项) 的最小奇数。

low_pass{int, None}，可选，默认为 None。传递给 statsmodels STL。

低通滤波器的长度。必须是大于等于 3 的奇数。如果未提供，则使用大于周期的最小奇数。

seasonal_degint，可选，默认为 1。传递给 statsmodels STL。

季节 LOESS 的次数。0 (常数) 或 1 (常数和趋势)。

trend_degint，可选，默认为 1。传递给 statsmodels STL。

趋势 LOESS 的次数。0 (常数) 或 1 (常数和趋势)。

low_pass_degint，可选，默认为 1。传递给 statsmodels STL。

低通 LOESS 的次数。0 (常数) 或 1 (常数和趋势)。

robustbool，可选，默认为 False。传递给 statsmodels STL。

指示是否使用对某些形式的异常值具有鲁棒性的加权版本的标志。

seasonal_jumpint，可选，默认为 1。传递给 statsmodels STL。

确定线性插值步长的正整数。如果大于 1，则每隔 seasonal_jump 个点使用 LOESS 进行拟合，并在拟合点之间进行线性插值。值越大，估计时间越短。

trend_jumpint，可选，默认为 1。传递给 statsmodels STL。

确定线性插值步长的正整数。如果大于 1，则每隔 trend_jump 个点使用 LOESS 进行拟合，并在两者之间的值进行线性插值。值越大，估计时间越短。

low_pass_jumpint，可选，默认为 1。传递给 statsmodels STL。

确定线性插值步长的正整数。如果大于 1，则每隔 low_pass_jump 个点使用 LOESS 进行拟合，并在两者之间的值进行线性插值。值越大，估计时间越短。

inner_iter: int 或 None，可选，默认为 None。传递给 ``statsmodels`` ``STL``。

内循环中执行的迭代次数。如果未提供，如果 robust 为 True 则使用 2，否则使用 5。此参数传递给 statsmodels 中的 STL.fit()。

outer_iter: int 或 None，可选，默认为 None。传递给 ``statsmodels`` ``STL``。

外循环中执行的迭代次数。如果未提供，如果 robust 为 True 则使用 15，否则使用 0。此参数传递给 statsmodels 中的 STL.fit()。

forecaster_trendsktime 预测器，可选

拟合到 STL 的 trend_ 分量的预测器，默认为 None。如果为 None，则使用 NaiveForecaster(strategy=”drift”)。

forecaster_seasonalsktime 预测器，可选

拟合到 STL 的 seasonal_ 分量的预测器，默认为 None。如果为 None，则使用 NaiveForecaster(strategy=”last”)。

forecaster_residsktime 预测器，可选

拟合到 STL 的 resid_ 分量的预测器，默认为 None。如果为 None，则使用 NaiveForecaster(strategy=”mean”)。

属性:
trend_pd.Series

趋势分量。

seasonal_pd.Series

季节项分量。

resid_pd.Series

残差分量。

forecaster_trend_sktime 预测器

已拟合的趋势预测器。

forecaster_seasonal_sktime 预测器

已拟合的季节项预测器。

forecaster_resid_sktime 预测器

已拟合的残差预测器。

另请参阅

Deseasonalizer
Detrender

参考资料

[1]

R. B. Cleveland, W. S. Cleveland, J.E. McRae, and I. Terpenning (1990) STL: 基于 LOESS 的季节-趋势分解过程。《官方统计杂志》，6, 3-73。

示例

>>> from sktime.datasets import load_airline
>>> from sktime.forecasting.trend import STLForecaster
>>> y = load_airline()
>>> forecaster = STLForecaster(sp=12)  
>>> forecaster.fit(y)  
STLForecaster(...)
>>> 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)

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

plot_components([title])

绘制观测值、趋势、季节项和残差分量。

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

使用新数据更新模型并进行预测。
plot_components(title=None)[source]#

绘制观测值、趋势、季节项和残差分量。

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

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。在调用对象的 fit 方法时，应将 is_fitted 属性设置为 True。

如果不是，则引发 NotFittedError。

参数:
method_namestr，可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

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

等效于使用 self 的参数构造 type(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 个 obj 实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

property cutoff[source]#

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

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

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

property fh[source]#

传递的预测期。

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

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

状态变化

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

写入 self

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

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

有关数据格式的更多详细信息，请参阅 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对 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 = 时间序列集合，全局/面板预测。带有两级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame 列表

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

有关数据格式的更多详细信息，请参阅 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 的配置标志。

配置是 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键为字符串的字典

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

  • always: 此对象的所有参数，通过 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 设置的标签，

在实例构造时设置的标签。

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

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

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

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

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

返回值:
composite: 布尔值

对象是否有任何参数，其值是 BaseObject 的派生实例。

property is_fitted[源代码]#

是否已调用 fit 方法。

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

返回值:
布尔值

估计器是否已 `fit`。

classmethod load_from_path(serial)[源代码]#

从文件位置加载对象。

参数:
serialZipFile(path).open("object") 的结果
返回值:
反序列化自身，产生 cls.save(path) 在 path 处的输出
classmethod load_from_serial(serial)[源代码]#

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

参数:
serial`cls.save(None)` 输出的第一个元素
返回值:
反序列化自身，产生 cls.save(None) 的输出 serial
predict(fh=None, X=None)[源代码]#

在未来预测期预测时间序列。

所需状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入 self

如果传入了 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_predsktime 兼容数据容器格式的时间序列

在 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 且之前未传入过，则将其存储到 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)

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

返回值:
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 (非面板、非层级) y 实现。

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

所需状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入 self

如果传入了 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 且之前未传入过，则将其存储到 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 处的预测值计算残差。

如果 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 具有相同的 科学类型（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 且之前未传入过，则将其存储到 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，返回内存中的序列化对象；如果 path 是文件位置，则将对象作为 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”，则 zip 文件 estimator.zip 将被

存储在 /home/stored/ 中。

serialization_format: str，默认值 = “pickle”

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

返回值:
如果 path 为 None - 内存中的序列化对象
如果 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 kernel 如何显示 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 将默认为“不做任何操作”，而不是“重新拟合所有已见数据”。

返回值:
self自身引用。

注意

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

set_params(**params)[源代码]#

设置此对象的参数。

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

参数:
**params字典

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

返回值:
self自身引用（设置参数后）
set_random_state(random_state=None, deep=True, self_policy='copy')[源代码]#

为 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_policy字符串，{"copy", "keep", "new"} 之一，默认值="copy"

  • “copy” : self.random_state 设置为输入的 random_state

  • “keep” : self.random_state 保持原样

  • “new” : self.random_state 设置为一个新的随机状态，

从输入的 random_state 派生，并且通常与它不同

返回值:
self自身引用
set_tags(**tag_dict)[源代码]#

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

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

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。它们可用于元数据检查或控制对象的行为。

set_tags 将动态标签覆盖设置为 tag_dict 中指定的值，其中键是标签名，字典值是要设置的标签值。

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

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

参数:
**tag_dict字典

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

返回值:
自身

自身引用。

update(y, X=None, update_params=True)[源代码]#

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

如果未实现估计器特定的 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 = 时间序列集合，全局/面板预测。带有两级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame 列表

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

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

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

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

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

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

返回值:
self自身引用
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：仅更新截止点并记住数据

所需状态

需要状态为“已拟合”，即 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 = 时间序列集合，全局/面板预测。带有两级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame 列表

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

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

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

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

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

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

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

update_predict_single(y=None, fh=None, X=None, update_params=True)[源代码]#

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

此方法用于在单个步骤中更新并进行预测，非常有用。

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

所需状态

要求状态为“已拟合”。

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

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

有关数据格式的更多详细信息，请参阅 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，则仅更新截止点，模型参数（例如，系数）不更新。

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

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