BaseForecaster#

class BaseForecaster[source]#

基础预测器模板类。

基础预测器指定了所有预测器必须实现的方法和方法签名。

这些方法的具体实现被推迟到具体的预测器中。

属性:

cutoff: 截止点 = 预测器的“当前时间”状态。
fh: 已传入的预测范围。
is_fitted: 是否已调用 fit。

方法

`check_is_fitted`([method_name])	检查 estimator 是否已拟合。
`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])	返回 skbase 对象的测试参数设置。
`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])	使用新数据更新模型并进行预测。

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

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

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

写入 self

设置以“_”结尾的拟合模型属性，拟合属性可通过 get_fitted_params 查看。

将 self.is_fitted 标志设置为 True。

将 self.cutoff 设置为 y 中看到的最后一个索引。

如果传入了 fh，则将 fh 存储到 self.fh。

参数:

y符合 sktime 数据容器格式的时间序列。

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

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 coercible, or ForecastingHorizon, default=None

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

X符合 sktime 格式的时间序列，可选（默认=None）。

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

返回:

self对 self 的引用。

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 coercible, or ForecastingHorizon, default=None

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

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

X符合 sktime 格式的时间序列，可选（默认=None）

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

返回:

y_pred符合 sktime 数据容器格式的时间序列: 在 fh 处的点预测，与 fh 具有相同的索引。y_pred 与最近传入的 y 具有相同的类型：Series、Panel、Hierarchical scitype，格式相同（见上文）

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。

参数:

y符合 sktime 数据容器格式的时间序列

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

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 coercible, or ForecastingHorizon (非可选)

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

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

X符合 sktime 格式的时间序列，可选（默认=None）。

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

X_pred符合 sktime 格式的时间序列，可选（默认=None）

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

返回:

y_pred符合 sktime 数据容器格式的时间序列: 在 fh 处的点预测，与 fh 具有相同的索引。y_pred 与最近传入的 y 具有相同的类型：Series、Panel、Hierarchical scitype，格式相同（见上文）

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 coercible, or ForecastingHorizon, default=None

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

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

如果 fh 是 int 或 int 的数组状对象，则解释为相对范围，并强制转换为相对 ForecastingHorizon(fh, is_relative=True)。
如果 fh 是 pd.Index 类型，则解释为绝对范围，并强制转换为绝对 ForecastingHorizon(fh, is_relative=False)。

X符合 sktime 格式的时间序列，可选（默认=None）

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

alpha浮点数或包含唯一值的浮点数列表，可选（默认=[0.05, 0.95]）

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

返回:

quantilespd.DataFrame

列具有多级索引：第一级是 fit 中 y 的变量名，: 第二级是传递给函数的 alpha 值。
行索引是 fh，附加（上级）级别等于实例级别，: 来自 fit 中看到的 y，如果 fit 中看到的 y 是 Panel 或 Hierarchical。
条目是分位数预测，对于列索引中的 var，: 在第二个列索引中的分位数概率处，对于行索引。

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 coercible, or ForecastingHorizon, default=None

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

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

如果 fh 是 int 或 int 的数组状对象，则解释为相对范围，并强制转换为相对 ForecastingHorizon(fh, is_relative=True)。
如果 fh 是 pd.Index 类型，则解释为绝对范围，并强制转换为绝对 ForecastingHorizon(fh, is_relative=False)。

X符合 sktime 格式的时间序列，可选（默认=None）

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

coverage浮点数或包含唯一值的浮点数列表，可选（默认=0.90）

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

返回:

pred_intpd.DataFrame

列具有多级索引：第一级是 fit 中 y 的变量名，

计算区间的第二级覆盖率分数。: 顺序与输入 coverage 中的相同。

第三级是字符串“lower”或“upper”，表示区间下限/上限。

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

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

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

对于列索引中的 var，在第二个列索引中的名义覆盖率处，根据第三个列索引判断是下限/上限，对于行索引。区间上下限预测等同于在 alpha = 0.5 - c/2, 0.5 + c/2 （c 在 coverage 中）处的分位数预测。

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 coercible, or ForecastingHorizon, default=None

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

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

如果 fh 是 int 或 int 的数组状对象，则解释为相对范围，并强制转换为相对 ForecastingHorizon(fh, is_relative=True)。
如果 fh 是 pd.Index 类型，则解释为绝对范围，并强制转换为绝对 ForecastingHorizon(fh, is_relative=False)。

X符合 sktime 格式的时间序列，可选（默认=None）

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

cov布尔值，可选（默认=False）

如果为 True，计算协方差矩阵预测。如果为 False，计算边际方差预测。

返回:

pred_varpd.DataFrame，格式取决于 cov 变量

如果 cov=False

列名与 fit/update 中传入的 y 完全相同。: 对于无名称格式，列索引将是 RangeIndex。
行索引是 fh，附加级别等于实例级别，: 来自 fit 中看到的 y，如果 fit 中看到的 y 是 Panel 或 Hierarchical。

条目是方差预测，对于列索引中的 var。给定变量和 fh 索引的方差预测是预测的

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

如果 cov=True

列索引是多级索引：第一级是变量名（如上所示）: 第二级是 fh。
行索引是 fh，附加级别等于实例级别，: 来自 fit 中看到的 y，如果 fit 中看到的 y 是 Panel 或 Hierarchical。
条目是（协）方差预测，对于列索引中的 var，以及: 行和列中时间索引之间的协方差。

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

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 coercible, or ForecastingHorizon, default=None

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

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

如果 fh 是 int 或 int 的数组状对象，则解释为相对范围，并强制转换为相对 ForecastingHorizon(fh, is_relative=True)。
如果 fh 是 pd.Index 类型，则解释为绝对范围，并强制转换为绝对 ForecastingHorizon(fh, is_relative=False)。

X符合 sktime 格式的时间序列，可选（默认=None）

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

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

返回的分布是否按时间索引边际化

返回:

pred_distskpro BaseDistribution: 预测分布；如果 marginal=True，则将是按时间点的边际分布；如果 marginal=False 且方法已实现，则将是联合分布。

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

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

如果没有实现 estimator 特定的更新方法，默认的回退如下：

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

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

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

访问 self 中的

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

self.cutoff, self.is_fitted

写入 self

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

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

参数:

y符合 sktime 数据容器格式的时间序列。

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

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

X符合 sktime 格式的时间序列，可选（默认=None）。

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

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

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

返回:

self对 self 的引用

update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#

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

用于执行多个 update / predict 调用链的简写，基于时间分割器 cv 进行数据回放。

与以下操作相同（如果只有 y、cv 是非默认值）

self.update(y=cv.split_series(y)[0][0])
记住 self.predict()（稍后在单个批次中返回）
self.update(y=cv.split_series(y)[1][0])
记住 self.predict()（稍后在单个批次中返回）
etc
return all remembered predictions

如果没有实现 estimator 特定的更新方法，默认的回退如下：

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，则不更新状态。

参数:

y符合 sktime 数据容器格式的时间序列。

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

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；默认 = ExpandingWindowSplitter，其 initial_window=1 且默认值 = y/X 中的单个数据点逐个添加和预测，initial_window = 1，step_length = 1，fh = 1

X符合 sktime 格式的时间序列，可选（默认=None）

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

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

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

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

如果为 True，则不会更改预测器的状态，即 update/predict 序列将使用副本运行，并且 self 的截止点、模型参数、数据内存不会改变
如果为 False，则在 update/predict 序列运行时将更新 self，就像直接调用 update/predict 一样

返回:

y_pred汇总多个分割批次的点预测的对象

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

如果 absolute horizon 点的集合是唯一的：类型是符合 sktime 数据容器格式的时间序列，输出中省略了截止点，与最近传入的 y 具有相同的类型：Series、Panel、Hierarchical scitype，格式相同（见上文）
如果 absolute horizon 点的集合不唯一：类型是 pandas DataFrame，行索引和列索引都是时间戳；行索引对应于预测所用的截止点；列索引对应于预测的 absolute horizon；条目是从行索引预测的列索引的点预测值；如果该 (cutoff, horizon) 对没有预测，则条目为 nan

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

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

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

如果没有实现 estimator 特定的更新方法，默认的回退是先 update，然后 predict。

所需状态: 要求状态为“已拟合”。
访问 self 中的: 以“_”结尾的拟合模型属性。指向已见数据的指针：self._y 和 self._X，self.cutoff，self._is_fitted 如果 update_params=True，则为以“_”结尾的模型属性。
写入 self: 通过追加行来使用 y 和 X 更新 self._y 和 self._X。将 self.cutoff 和 self._cutoff 更新为 y 中看到的最后一个索引。如果 update_params=True，

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

参数:

y符合 sktime 数据容器格式的时间序列。

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

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 coercible, or ForecastingHorizon, default=None

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

X符合 sktime 格式的时间序列，可选（默认=None）

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

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

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

返回:

y_pred符合 sktime 数据容器格式的时间序列: 在 fh 处的点预测，与 fh 具有相同的索引。y_pred 与最近传入的 y 具有相同的类型：Series、Panel、Hierarchical scitype，格式相同（见上文）

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

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

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

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

所需状态: 要求状态为“已拟合”。如果已设置 fh，则必须与 y 的索引（pandas 或整数）对应
访问 self 中的: 以“_”结尾的拟合模型属性。self.cutoff，self._is_fitted
写入 self: 无。

参数:

y符合 sktime 数据容器格式的时间序列

具有真实观测值的时间序列，用于计算残差。必须与 predict 的预期返回类型、维度和索引相同。

如果为 None，则使用目前为止看到的 y (self._y)，特别是

如果前面只有一次 fit 调用，则生成样本内残差
如果 fit 需要 fh，则它必须指向 fit 中 y 的索引

X符合 sktime 格式的时间序列，可选（默认=None）

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

返回:

y_res符合 sktime 数据容器格式的时间序列: 在 fh 处的预测残差，与 ``fh 具有相同的索引。y_res 与最近传入的 y 具有相同的类型：Series、Panel、Hierarchical scitype，格式相同（见上文）

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

使用 MAPE（非对称）根据真实值对预测进行评分。

参数:

ypd.Series, pd.DataFrame, or np.ndarray (1D or 2D): 要评分的时间序列
fhint, list, pd.Index coercible, or ForecastingHorizon, default=None: 编码要预测的时间戳的预测范围。
Xpd.DataFrame, or 2D np.array, optional (default=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

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

property cutoff[source]#

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

返回:

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

property fh[source]#: 已传入的预测范围。

check_is_fitted(method_name=None)[source]#

检查 estimator 是否已拟合。

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

如果不存在，则引发 NotFittedError。

参数:

method_name字符串，可选: 调用此函数的方法的名称。如果提供，错误消息将包含此信息。

引发:

NotFittedError: 如果 estimator 尚未拟合。

clone()[source]#

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

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

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

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

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

引发:

如果克隆不符合规范，由于错误的 __init__，则会引发 RuntimeError。

clone_tags(estimator, tag_names=None)[source]#

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

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

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

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

clone_tags 方法只能在对象的 __init__ 方法中，在构造期间，或通过 __init__ 构造后直接调用。

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

tag_names 的默认值将 estimator 中的所有标签写入 self。

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

参数:

estimator:class:BaseObject 或派生类的实例
tag_names字符串或字符串列表，默认 = None: 要克隆的标签名称。默认值（None）克隆 estimator 中的所有标签。

返回:

self: 对 self 的引用。

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

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

参数:

parameter_set字符串，默认=”default”: 要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，将返回“default”集。

返回:

instance具有默认参数的类实例

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

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

参数:

parameter_set字符串，默认=”default”: 要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，将返回“default”集。

返回:

objscls 实例列表: 第 i 个实例是 cls(**cls.get_test_params()[i])
names字符串列表，长度与 objs 相同: 第 i 个元素是测试中第 i 个 obj 实例的名称。命名约定是：如果有多个实例，则为 {cls.__name__}-{i}，否则为 {cls.__name__}

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

从类中获取类标签值，具有父类的标签级别继承。

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

get_class_tag 方法是一个类方法，它仅考虑类级别的标签值和覆盖项来检索标签的值。

它返回对象中名为 tag_name 的标签值，并按以下优先级降序考虑标签覆盖项：

设置在类的 _tags 属性中的标签。
设置在父类 _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 属性的键。

值是对应的标签值，覆盖项按以下优先级降序：

设置在类的 _tags 属性中的标签。
设置在父类 _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 对象属性的任何覆盖项和新标签。

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

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

参数:

deep布尔值，默认=True

是否返回组件的参数。

如果 True，将返回此对象的参数名称：值字典，包括组件的参数（= BaseObject 值参数）。
如果 False，将返回此对象的参数名称：值字典，但不包括组件的参数。

返回:

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 的单个标签的值，并按以下优先级降序考虑标签覆盖项：

在实例上通过 set_tags 或 clone_tags 设置的标签，

在实例构造时。

设置在类的 _tags 属性中的标签。
设置在父类 _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 设置的标签。

值是对应的标签值，覆盖项按以下优先级降序：

在实例上通过 set_tags 或 clone_tags 设置的标签，

在实例构造时。

设置在类的 _tags 属性中的标签。
设置在父类 _tags 属性中的标签，

按继承顺序。

返回:

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

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

返回 skbase 对象的测试参数设置。

get_test_params 是一个统一的接口点，用于存储测试目的的参数设置。此函数也用于 create_test_instance 和 create_test_instances_and_names 中构建测试实例。

get_test_params 应该返回单个 dict，或一个 dict 列表。

每个 dict 都是用于测试的参数配置，可用于构建一个“有趣的”测试实例。对于 get_test_params 返回的所有字典 params，调用 cls(**params) 都应该是有效的。

get_test_params 不必返回固定的字典列表，它也可以返回动态或随机的参数设置。

参数:

parameter_set字符串，默认=”default”: 要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，将返回“default”集。

返回:

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

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) 的结果

返回:

在 path 处反序列化 self，其结果与 cls.save(path) 的输出相同。

classmethod load_from_serial(serial)[source]#

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

参数:

serialcls.save(None) 输出的第一个元素

返回:

反序列化 self，其结果与 cls.save(None) 的输出 serial 相同。

reset()[source]#

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

使 self 恢复到构造函数调用后直接的状态，具有相同的超参数。通过 set_config 设置的配置值也会被保留。

reset 调用会删除任何对象属性，除了：

超参数 = __init__ 的参数，写入到 self，例如 self.paramname，其中 paramname 是 __init__ 的一个参数。
包含双下划线字符串（即 "__"）的对象属性。例如，名为 "__myattr" 的属性会被保留。
配置属性，配置会无变化地保留。也就是说，在 reset 前后 get_config 的结果是相等的。

类和对象方法，以及类属性也不受影响。

等同于 clone，不同之处在于 reset 修改 self 而不是返回新对象。

在调用 self.reset() 后，self 在值和状态上都等同于通过构造函数调用 ``type(self)(**self.get_params(deep=False))`` 获取的对象。

返回:

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

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

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

行为：如果 path 为 None，返回一个内存中的序列化 self；如果 path 是文件位置，则将 self 存储在该位置为一个 zip 文件。

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

参数:

pathNone 或文件位置 (str 或 Path)

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

path=”estimator”，则将在当前工作目录创建一个 zip 文件 estimator.zip。
path=”/home/stored/estimator”，则将在 /home/stored/ 存储一个 zip 文件 estimator.zip。

存储在 /home/stored/ 中。

serialization_format: str, 默认 = “pickle”

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

返回:

如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - ZipFile，并带有对文件的引用。

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

是否在 fit 中存储 self._X 和 self._y，并在 update 中更新。如果为 True，则存储并更新 self._X 和 self._y。如果为 False，则不存储和更新 self._X 和 self._y。这在使用 save 时减小了序列化大小，但 update 将默认为“不执行任何操作”而不是“使用所有已看到的数据重新拟合”。

返回:

self对 self 的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:

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

返回:

self对 self 的引用（参数设置后）

set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

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

通过 self.get_params 查找名为 random_state 的参数，并使用 set_params 将它们设置为从 random_state 派生的整数。这些整数通过 sample_dependent_seed 的链式哈希采样，保证了伪随机生成器的种子随机独立性。

根据 self_policy 应用于 self 中的 random_state 参数，以及仅当 deep=True 时，也应用于剩余组件对象。

注意：即使 self 没有 random_state 参数，或者没有任何组件具有 random_state 参数，也会调用 set_params。因此，set_random_state 将重置任何 scikit-base 对象，即使是那些没有 random_state 参数的对象。

参数:

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

伪随机数生成器，用于控制随机整数的生成。传递 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对 self 的引用

set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:

**tag_dictdict: 标签名称：标签值对的字典。

返回:

Self: 对 self 的引用。