ForecastingSkoptSearchCV#

类 ForecastingSkoptSearchCV(forecaster, cv: BaseSplitter, param_distributions: dict | list[dict], n_iter: int = 10, n_points: int | None = 1, random_state: int | None = None, scoring: list[BaseMetric] | None = None, optimizer_kwargs: dict | None =None, strategy: str | None = 'refit', refit: bool = True, verbose: int = 0, return_n_best_forecasters: int = 1, backend: str ='loky', update_behaviour: str ='full_refit', error_score=nan, tune_by_instance=False, tune_by_variable=False, backend_params=None, n_jobs='deprecated')[来源]#

对预测器进行超参数的贝叶斯搜索。

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

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

要调优的预测器，必须实现 sktime 预测器接口。可以使用 sklearn 回归器，但必须先通过一种还原组合器将其转换为预测器，例如通过 make_reduction

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

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

param_distributionsdict 或 dict/tuple 列表。详情见下文。

1. 如果是 dict，则是一个字典，表示给定估计器参数的搜索空间。键是参数名称（字符串），值遵循以下格式。一个用于存储分类参数的列表，以及一个用于整数和实数参数的元组，格式为 (int/float, int/float, "prior")，例如 (1e-6, 1e-1, "log-uniform")。 2. 如果是 dict 列表，每个字典对应一个参数空间，遵循上面情况 1 中描述的相同结构。搜索将对每个参数空间按顺序执行，样本数量设置为 n_iter。 3. 如果是 tuple 列表，tuple 必须包含 (dict, int)，其中 int 表示该搜索空间的 n_iter。dict 必须遵循情况 1 中相同的结构。如果您想对每个参数空间执行不同迭代次数的搜索，这会很有用。

n_iterint，默认值=10

采样的参数设置数量。n_iter 在运行时和解决方案质量之间进行权衡。如果您想并行尝试更多参数设置，请考虑增加 n_points。

n_pointsint，默认值=1

并行采样的参数设置数量。如果这与 n_iter 不一致，最后一次迭代将采样较少的点

scoringsktime 指标 (BaseMetric)，str 或可调用对象，可选（默认值=None）

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

  • 可以使用 registry.all_estimators 搜索工具搜索 sktime 指标对象 (BaseMetric) 的后代，例如通过 all_estimators("metric", as_dataframe=True)

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

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

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

  • 如果是 str，使用 registry.resolve_alias 解析为上述之一。有效字符串是有效的 registry.craft 规范，包括任何 BaseMetric 对象的字符串表示，例如 “MeanSquaredError()”；以及引用指标的 registry.ALIAS_DICT 的键。

  • 如果为 None，默认使用 MeanAbsolutePercentageError()

optimizer_kwargs: dict，可选

传递给 Optimizer 的参数，用于控制贝叶斯搜索的行为。例如，{'base_estimator': 'RF'} 将使用随机森林代理，而不是默认的高斯过程。更多信息请参阅 skopt.Optimizer 文档。

random_stateint, RandomState 实例或 None，默认值=None

用于从可能值列表中进行随机均匀采样的伪随机数生成器状态，而不是 scipy.stats 分布。传入一个 int 可使多次函数调用产生可复现的输出。

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

拟合 cv 时的数据摄取策略，内部传递给 evaluate，定义了预测器在窗口扩展时看到新数据时的摄取模式：“refit” = 预测器的新副本在每个训练窗口上重新拟合。“update” = 预测器根据提供的序列用训练窗口数据进行更新。“no-update_params” = 拟合到第一个训练窗口，无需拟合或更新即可重复使用

update_behaviour: str，可选，默认值 = “full_refit”

更新时预测器的行为，可以是 {“full_refit”, “inner_only”, “no_update”} 之一。“full_refit” = 在所有已见数据上重新拟合调优参数和内部估计器。“inner_only” = 不重新调优参数，只更新内部估计器。“no_update” = 不更新调优参数也不更新内部估计器

refitbool，可选（默认值=True）

True = 在 fit 中使用最佳参数在整个数据上重新拟合预测器。 False = 不进行重新拟合。该预测器不能用于预测。这用于调优超参数，然后将估计器用作参数估计器，例如通过 get_fitted_params 或 PluginParamsForecaster。

verboseint，可选（默认值=0）
error_score“raise” 或 数字，默认值=np.nan

如果在估计器拟合中发生异常时分配给分数的值。如果设置为“raise”，则抛出异常。如果给定了数值，则抛出 FitFailedWarning。

return_n_best_forecasters: int，默认值=1

如果需要返回 n 个最佳预测器，可以设置此值，n 个最佳预测器将分配给 n_best_forecasters_。将 return_n_best_forecasters 设置为 -1 以返回所有预测器。

backend{“dask”, “loky”, “multiprocessing”, “threading”}，默认值为 “loky”。

如果指定且 strategy 设置为 “refit”，则并行执行 evaluate。

  • “None”：按顺序执行循环，简单的列表推导

  • “loky”, “multiprocessing” 和 “threading”：使用 joblib.Parallel 循环

  • “joblib”：自定义和第三方 joblib 后端，例如 spark

  • “dask”：使用 dask，需要环境中安装 dask 包

  • “ray”：使用 ray，需要环境中安装 ray 包

建议：使用“dask”或“loky”进行并行评估。“threading”由于 GIL 和“dask”和“loky”的序列化后端（cloudpickle）可能不会看到速度提升，而 cloudpickle 通常比“multiprocessing”中使用的标准 pickle 库更健壮。

tune_by_instancebool，可选（默认值=False）

在将面板数据或分层数据传递给调优估计器的情况下，是否按每个时间序列实例分别调优参数。仅当传递的时间序列是面板数据或分层数据时才适用。如果为 True，预测器的克隆将分别拟合到每个实例，并可在 forecasters_ 属性的字段中获取。效果与对 self 应用 ForecastByLevel 包装器相同。如果为 False，则为所有实例选择相同的最佳参数。

tune_by_variablebool，可选（默认值=False）

在将多元数据传递给调优估计器的情况下，是否按每个时间序列变量分别调优参数。仅当传递的时间序列是严格的多元数据时才适用。如果为 True，预测器的克隆将分别拟合到每个变量，并可在 forecasters_ 属性的字段中获取。效果与对 self 应用 ColumnEnsembleForecaster 包装器相同。如果为 False，则为所有变量选择相同的最佳参数。

backend_paramsdict，可选

作为配置传递给后端的附加参数。直接传递给 utils.parallel.parallelize。有效键取决于 backend 的值

  • “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，则抑制警告

属性:
best_index_int
best_score_: float

最佳模型的得分

best_params_dict

参数网格中的最佳参数值

best_forecaster_估计器

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

cv_results_dict

网格搜索交叉验证的结果

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

“排名”与 best_forecaster_ 相关

n_best_scores_: float 列表

n_best_forecasters_ 的得分，按预测器得分从优到劣排序

forecasters_pd.DataFramee

包含所有拟合预测器及其参数的 DataFrame。仅当 tune_by_instance=True 或 tune_by_variable=True，并且至少其中之一适用时才存在。在这种情况下，其他属性不存在于 self 中，仅存在于 forecasters_ 的字段中。

示例

>>> from sktime.datasets import load_shampoo_sales
>>> from sktime.forecasting.model_selection import ForecastingSkoptSearchCV
>>> from sktime.split import ExpandingWindowSplitter
>>> from sklearn.ensemble import GradientBoostingRegressor
>>> from sktime.forecasting.compose import make_reduction
>>> y = load_shampoo_sales()
>>> fh = [1,2,3,4]
>>> cv = ExpandingWindowSplitter(fh=fh)
>>> forecaster = make_reduction(GradientBoostingRegressor(random_state=10))
>>> param_distributions = {
...     "estimator__learning_rate" : (1e-4, 1e-1, "log-uniform"),
...     "window_length" : (1, 10, "uniform"),
...     "estimator__criterion" : ["friedman_mse", "squared_error"]}
>>> sscv = ForecastingSkoptSearchCV(
...     forecaster=forecaster,
...     param_distributions=param_distributions,
...     cv=cv,
...     n_iter=5,
...     random_state=10)  
>>> sscv.fit(y)  
ForecastingSkoptSearchCV(...)
>>> y_pred = sscv.predict(fh)

方法

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

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict([fh, X])

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

predict_interval([fh, X, coverage])

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

predict_proba([fh, X, marginal])

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

predict_quantiles([fh, X, alpha])

计算/返回分位数预测。

predict_residuals([y, X])

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

predict_var([fh, X, cov])

计算/返回方差预测。

reset()

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

save([path, serialization_format])

将序列化的 self 保存到字节类对象或 (.zip) 文件。

score(y[, X, fh])

使用 MAPE（非对称）对预测结果与真实值进行评分。

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

set_random_state([random_state, deep, ...])

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

set_tags(**tag_dict)

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

update(y[, X, update_params])

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

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

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

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

用新数据更新模型并进行预测。
类方法 get_test_params(parameter_set='default')[来源]#

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

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

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

返回:
paramsdict 或 dict 列表
check_is_fitted(method_name=None)[来源]#

检查估计器是否已拟合。

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

如果不是，则抛出 NotFittedError。

参数:
method_namestr，可选

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

抛出:
NotFittedError

如果估计器尚未拟合。

clone()[来源]#

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

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

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

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

在值上也等效于调用 self.reset，不同之处在于 clone 返回新对象，而不是像 reset 那样修改 self。

抛出:
如果由于错误的 __init__ 导致克隆不符合要求，则抛出 RuntimeError。
clone_tags(estimator, tag_names=None)[来源]#

将其他对象的标签克隆为动态覆盖。

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

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

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

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 的引用。

类方法 create_test_instance(parameter_set='default')[来源]#

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

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

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

返回:
instance具有默认参数的类实例
类方法 create_test_instances_and_names(parameter_set='default')[来源]#

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

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

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

返回:
objscls 实例列表

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

namesstr 列表，长度与 objs 相同

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

属性 cutoff[来源]#

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

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

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

属性 fh[来源]#

已传递的预测期。

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

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

状态变化

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

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

  • Hierarchical scitype = 分层集合，用于分层预测。带有 3 级或更多行 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指向自身的引用。
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 = 时间序列集合，全局/面板预测。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame list

  • Hierarchical scitype = 分层集合，用于分层预测。带有 3 级或更多行 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）

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

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

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

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

在调用 clone 或 reset 后，配置会保留。

返回:
config_dictdict

配置名：配置值对的字典。通过嵌套继承从 _config 类属性收集，然后从 _onfig_dynamic 对象属性中获取任何覆盖和新标签。

get_fitted_params(deep=True)[source]#

获取拟合参数。

所需状态

要求状态为“已拟合”。

参数:
deep布尔值，默认=True

是否返回组件的拟合参数。

  • 如果为 True，将返回此对象的参数名：值字典，包括可拟合组件（= BaseEstimator 值参数）的拟合参数。

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

返回:
fitted_params键为字符串的字典

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

  • 始终：此对象的所有拟合参数，通过 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]#

获取对象的参数名称。

参数:
sort布尔值，默认=True

是否按字母顺序（True）或在类 __init__ 中出现的顺序（False）返回参数名称。

返回:
param_names: list[str]

cls 的参数名称列表。如果 sort=False，则按它们在类 __init__ 中出现的顺序排列。如果 sort=True，则按字母顺序排列。

get_params(deep=True)[source]#

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

参数:
deep布尔值，默认=True

是否返回组件的参数。

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

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

返回:
params键为字符串的字典

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

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

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

  • 如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

get_tag(tag_name, tag_value_default=None, raise_error=True)[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_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)” 的结果
返回:
反序列化的 self，结果输出到 path，来自 cls.save(path)
classmethod load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第1个元素
返回:
反序列化的 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 类型。

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

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

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

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

注意

  • 目前仅针对 Series（非 panel，非 hierarchical）y 实现。

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

所需状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入 self

如果 fh 已传入且之前未传入，则将 fh 存储到 self.fh。

参数:
fhint, list, pd.Index 可强制类型转换，或 ForecastingHorizon，默认值=None

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

如果 fh 不为 None 且不是 ForecastingHorizon 类型，则在内部强制转换为 ForecastingHorizon（通过 _check_fh）。

  • 如果 fh 是 int 或类似 int 的数组，则解释为相对预测范围，并强制转换为相对 ForecastingHorizon(fh, is_relative=True)。

  • 如果 fh 是 pd.Index 类型，则解释为绝对预测范围，并强制转换为绝对 ForecastingHorizon(fh, is_relative=False)。

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

用于预测的外生时间序列。应与 fit 中的 y 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为真，则 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") 为真，则 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 索引引用。

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 会删除任何对象属性，除了

  • 超参数 = 写入 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，则返回内存中的序列化对象；如果 path 是文件位置，则将对象存储在该位置作为 zip 文件

保存的文件是 zip 文件，包含以下内容：_metadata - 包含对象的类，即 type(self)；_obj - 序列化的对象。此类使用默认序列化（pickle）。

参数:
pathNone 或文件位置 (str 或 Path)

如果为 None，则将对象保存到内存中的对象中；如果为文件位置，则将对象保存到该文件位置。如果

  • path="estimator"，则会在当前工作目录创建 zip 文件 estimator.zip。

  • path="/home/stored/estimator"，则会在

/home/stored/ 中存储 zip 文件 estimator.zip。

serialization_format: str, 默认 = “pickle”

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

返回:
如果 path 为 None - 内存中的序列化对象
如果 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”) 为 True，则 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 内核如何显示对象实例

  • “diagram” = html 框图表示

  • “text” = 字符串打印输出

print_changed_onlybool, 默认=True

打印对象时是否只列出与默认值不同的参数 (False)，或列出所有参数名称和值 (False)。不进行嵌套，即只影响对象本身，不影响组件估计器。

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对象的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:
**paramsdict

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

返回:
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

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

deep布尔值，默认=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对象的引用
set_tags(**tag_dict)[source]#

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

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

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

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

应该仅在对象的 __init__ 方法中（构造期间）或紧接在通过 __init__ 构造后调用 set_tags 方法。

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

参数:
**tag_dictdict

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

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

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

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

Xsktime 兼容格式的时间序列，可选（默认值=None）。

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

update_paramsbool, 可选 (默认=True)

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

返回:
self对象的引用
update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#

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

快捷方式，用于执行基于时间分割器 cv 的多个 update / predict 执行链，并进行数据回放。

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

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

有关数据格式的更多详细信息，请参阅关于 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_paramsbool, 可选 (默认=True)

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

reset_forecasterbool, 可选 (默认=True)

  • 如果为 True，则不会改变预测器的状态，即使用一个副本运行 update/predict 序列，并且对象的 cutoff、模型参数、数据内存不改变

  • 如果为 False，则在运行 update/predict 序列时会像直接调用 update/predict 一样更新对象

返回:
y_pred对象，用于汇总来自多个分割批次的点预测

格式取决于预测总体的对 (cutoff, absolute horizon)

  • 如果 absolute horizon 点的集合是唯一的：类型是 sktime 兼容数据容器格式的时间序列，输出中省略 cutoff，与最近传递的 y 具有相同的类型：Series, Panel, Hierarchical scitype，相同的格式（见上文）

  • 如果 absolute horizon 点的集合不是唯一的：类型是 pandas DataFrame，行和列索引是时间戳，行索引对应于从中预测的 cutoff，列索引对应于预测的 absolute horizon。条目是根据行索引预测列索引的点预测。如果在该 (cutoff, horizon) 对处没有进行预测，则条目为 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

通过附加行更新 self._y 和 self._X，使用 y 和 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 = 时间序列集合，全局/面板预测。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame list

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

update_paramsbool, 可选 (默认=True)

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

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

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

本页内容