ForecastingOptunaSearchCV#

class ForecastingOptunaSearchCV(forecaster, cv, param_grid, scoring=None, strategy='refit', refit=True, verbose=0, return_n_best_forecasters=1, backend='loky', update_behaviour='full_refit', error_score=nan, n_evals=100, sampler=None)[source]#

执行 Optuna 搜索交叉验证以寻找最佳模型超参数。

实验性：此功能正在开发中，接口可能会发生变化。

在 fit 方法中，此评估器使用应用于 sktime evaluate 基准测试输出的 optuna 基础搜索算法。

param_grid 用于通过 set_params 对传入的 forecaster 的参数进行参数化，从而定义搜索空间。

剩余参数直接传递给 evaluate，以获取评估 schema 中指定的聚合 scoring 指标作为主要优化结果。

参数:
forecastersktime 预测器, BaseForecaster 实例或接口兼容

需要调整的预测器，必须实现 sktime 预测器接口。可以使用 sklearn 回归器，但必须先通过其中一个降维组合器转换为预测器，例如通过 make_reduction

cv交叉验证生成器或可迭代对象

用于生成验证折叠的分割器。例如 ExpandingWindowSplitter()

param_gridoptuna 采样器的字典

字典，键为参数名，值为参数分布列表，从中采样参数值。例如 {“forecaster”: optuna.distributions.CategoricalDistribution( (STLForecaster(), ThetaForecaster()))}

scoringsktime 指标 (BaseMetric), 字符串或可调用对象，可选 (默认值=None)

用于调整预测器的评分指标

  • 可以搜索 sktime 指标对象 (BaseMetric) 的后代

使用 registry.all_estimators 搜索工具，例如通过 all_estimators("metric", as_dataframe=True)

  • 如果可调用，必须具有签名

(y_true: 1D np.ndarray, y_pred: 1D np.ndarray) -> float，假设 np.ndarrays 长度相同，且值越低越好。sktime.performance_metrics.forecasting 中的指标都属于这种形式。

  • 如果为字符串，则使用 registry.resolve_alias 解析为上述之一。

有效字符串是有效的 registry.craft 规范，包括任何 BaseMetric 对象的字符串表示，例如“MeanSquaredError()”；以及引用指标的 registry.ALIAS_DICT 的键。

  • 如果为 None，则默认为 MeanAbsolutePercentageError()

strategy{“refit”, “update”, “no-update_params”}，可选，默认值=”refit”

cv 拟合中的数据摄取策略，内部传递给 evaluate 定义了当窗口扩展时预测器看到新数据时的摄取模式 “refit” = 预测器的新副本拟合到每个训练窗口 “update” = 预测器按照提供的顺序使用训练窗口数据进行更新 “no-update_params” = 拟合到第一个训练窗口，并在没有拟合或更新的情况下重复使用

refitbool，默认值=True

使用在整个数据集上找到的最佳参数重新拟合评估器。

verboseint，默认值=0

控制详细程度：值越高，消息越多。

return_n_best_forecastersint，默认值=1

返回的最佳预测器数量。

backendstr，默认值=”loky”

运行拟合时使用的后端。

update_behaviourstr，默认值=”full_refit”

确定在拟合过程中如何更新预测器。

error_score‘raise’ 或 数值，默认值=np.nan

如果在评估器拟合过程中发生错误，分配给得分的值。

n_evalsint，默认值=100

采样的参数设置数量。n_iter 权衡了运行时与解决方案质量。

samplerOptuna 采样器，可选 (默认值=None)

例如 optuna.samplers.TPESampler(seed=42)

属性:
best_index_int
best_score_: float

最佳模型的得分

best_params_dict

参数网格中最佳参数值

best_forecaster_estimator

使用最佳参数拟合的评估器

cv_results_dict

来自网格搜索交叉验证的结果

n_best_forecasters_: 元组列表（“排名”, <预测器>）

“排名”与 best_forecaster_ 相关

n_best_scores_: float 列表

n_best_forecasters_ 的得分，从最佳到最差排序

示例

>>> from sktime.forecasting.model_selection import (
...     ForecastingOptunaSearchCV,
...     )
>>> from sktime.datasets import load_shampoo_sales
>>> import warnings
>>> warnings.simplefilter(action="ignore", category=FutureWarning)
>>> from sktime.forecasting.base import ForecastingHorizon
>>> from sktime.split import ExpandingWindowSplitter
>>> from sktime.split import temporal_train_test_split
>>> from sklearn.preprocessing import MinMaxScaler, RobustScaler
>>> from sktime.forecasting.compose import TransformedTargetForecaster
>>> from sktime.transformations.series.adapt import TabularToSeriesAdaptor
>>> from sktime.transformations.series.detrend import Deseasonalizer, Detrender
>>> from sktime.forecasting.naive import NaiveForecaster
>>> from sktime.forecasting.theta import ThetaForecaster
>>> from sktime.forecasting.trend import STLForecaster
>>> import optuna
>>> from  optuna.distributions import CategoricalDistribution

>>> y = load_shampoo_sales()
>>> y_train, y_test = temporal_train_test_split(y=y, test_size=6)
>>> fh = ForecastingHorizon(y_test.index, is_relative=False).to_relative(
...         cutoff=y_train.index[-1]
...     )
>>> cv = ExpandingWindowSplitter(fh=fh, initial_window=24, step_length=1)
>>> forecaster = TransformedTargetForecaster(
...     steps=[
...             ("detrender", Detrender()),
...             ("scaler", RobustScaler()),
...             ("minmax2", MinMaxScaler((1, 10))),
...             ("forecaster", NaiveForecaster()),
...         ]
...     )
>>> param_grid = {
...     "scaler__with_scaling": CategoricalDistribution(
...             (True, False)
...         ),
...     "forecaster": CategoricalDistribution(
...             (NaiveForecaster(), ThetaForecaster())
...         ),
...     }
>>> gscv = ForecastingOptunaSearchCV(
...         forecaster=forecaster,
...         param_grid=param_grid,
...         cv=cv,
...         n_evals=10,
...     )
>>> gscv.fit(y)
ForecastingOptunaSearchCV(...)
>>> print(f"{gscv.best_params_=}")

方法

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

检查评估器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:
method_namestr，可选

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

引发:
NotFittedError

如果评估器尚未拟合。

clone()[source]#

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

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

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

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

值上也等同于调用 self.reset，区别在于 clone 返回一个新对象，而不是像 reset 那样改变 self。

引发:
如果克隆不符合规范，由于错误的 __init__，则引发 RuntimeError。
clone_tags(estimator, tag_names=None)[source]#

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

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

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

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

clone_tags 方法应仅在对象的 __init__ 方法中调用，即在构造过程中，或在通过 __init__ 构造后直接调用。

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

tag_names 的默认行为是将 estimator 中的所有标签写入 self。

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

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

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

返回:
self

self 的引用。

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

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

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

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

返回:
instance使用默认参数的类的实例
classmethod create_test_instances_and_names(parameter_set='default')[source]#

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

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

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

返回:
objscls 实例列表

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

namesstr 列表，与 objs 长度相同

第 i 个元素是测试中 obj 的第 i 个实例的名称。命名约定是如果实例多于一个，则为 {cls.__name__}-{i}，否则为 {cls.__name__}

property cutoff[source]#

Cut-off = 预测器的“当前时间”状态。

返回:
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，则将 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对 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 的 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)

用于预测的外生时间序列。如果传入，将在预测中使用而不是 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

已拟合参数字典，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，将返回此对象的参数名称 : 值 的 dict，包括组件（= BaseObject 值的参数）的参数。

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

返回:
params带有 str 值键的 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_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_tagsdict

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

is_composite()[source]#

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

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

返回:
composite: bool

对象是否有任何参数，其值为 BaseObject 的后代实例。

property is_fitted[source]#

是否已调用 fit。

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

返回:
bool

估计器是否已 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回:
反序列化的 self，结果输出到 path，由 cls.save(path) 生成
classmethod load_from_serial(serial)[source]#

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

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

在未来时间序列上进行预测。

所需状态

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

访问 self 中的

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

  • 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")，则 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")，则 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)[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")，则 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

写入 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")，则 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 处计算预测的残差。

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

所需状态

要求状态为“已拟合”。如果已设置 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")，则 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")，则 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 索引的方差预测值是该变量和索引在给定观测数据下的预测方差。

条目为方差预测值，对应于列索引中的变量。给定变量和 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]#

将序列化的 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/ 中。

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

返回:
score浮点数

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 时是仅列出自与默认值不同的参数（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

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)[source]#

设置此对象的参数。

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

参数:
**paramsdict

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

返回:
selfself 的引用（参数设置后）
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

伪随机数生成器，用于控制随机整数的生成。传入 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，通常与它不同

返回:
selfself 的引用
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

  • 将 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，则仅更新截止时间，模型参数（例如系数）不更新。

返回:
selfself 的引用
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；默认 = ExpandingWindowSplitter，initial_window=1 且默认值为：y/X 中的单个数据点逐个添加并预测，initial_window = 1，step_length = 1 且 fh = 1。

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

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

update_paramsbool, 可选 (默认=True)

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

reset_forecasterbool, 可选 (默认=True)

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

  • 如果为 False，则在运行更新/预测序列时会更新 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]#

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

此方法有助于在一个步骤中进行更新和预测。

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

所需状态

需要状态为“已拟合”。

访问 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 的 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，格式相同（见上文）

本页内容