OnlineEnsembleForecaster

class OnlineEnsembleForecaster(forecasters, ensemble_algorithm=None, n_jobs=None)

预测器的在线更新集成。

参数：

ensemble_algorithm集成算法

forecasters评估器列表，(str, 评估器)，或 (str, 评估器, count) 元组

应用于输入序列的评估器。

• (str, 评估器) 元组：字符串是评估器的名称。

• 没有字符串的评估器将根据类名分配唯一的名称

• (str, 评估器, count) 元组：评估器将复制 count 次。

n_jobsint 或 None，可选（默认值：None）

fit 时并行运行的任务数。None 表示 1，除非在 joblib.parallel_backend 上下文中使用。-1 表示使用所有处理器。

属性：

cutoff

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

fh

已传递的预测范围。

is_fitted

是否已调用 fit 方法。

方法

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()	获取自身的配置标志。
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()	检查对象是否是复合对象。
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])	将序列化的对象保存到类似字节的对象或到 (.zip) 文件。
score(y[, X, fh])	使用 MAPE（非对称）根据真实值对预测进行评分。
set_config(**config_dict)	将配置标志设置为给定值。
set_params(**kwargs)	设置评估器的参数。
set_random_state([random_state, deep, ...])	为自身设置 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')

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

参数：

parameter_setstr，默认值=”default”

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

返回：

paramsdict 或 list of 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 的引用。

classmethod create_test_instance(parameter_set='default')#

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

参数：

parameter_setstr，默认值=”default”

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

返回：

instance使用默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')#

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

参数：

parameter_setstr，默认值=”default”

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

返回：

objscls 实例列表

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

namesstr 列表，长度与 objs 相同

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

property cutoff#

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

返回：

cutoffpandas 兼容的索引元素，或 None

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

property fh#

已传递的预测范围。

fit(y, X=None, fh=None)#

使用训练数据拟合预测器。

状态变化

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

写入自身

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

返回：

selfself 的引用。

fit_predict(y, X=None, fh=None, X_pred=None)#

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

与 fit(y, X, fh).predict(X_pred) 相同。如果未传递 X_pred，则与 fit(y, fh, X).predict(X) 相同。

状态变化

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

写入自身

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

用于预测的外生时间序列。如果传递，将在 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)#

从类中获取类标签值，继承自父类。

每个 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()#

从类中获取类标签，继承自父类。

每个 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()#

获取自身的配置标志。

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

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

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

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

返回：

config_dictdict

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

get_fitted_params(deep=True)#

获取已拟合的参数。

所需状态

要求状态为“已拟合”。

参数：

deepbool，默认值=True

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

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

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

返回：

fitted_params键为 str 类型的 dict

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

• 总是：此对象的所有已拟合参数，如通过 get_param_names 获得的，值是该键对应的此对象的已拟合参数值

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

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

classmethod get_param_defaults()#

获取对象的默认参数。

返回：

default_dict: dict[str, Any]

键是 cls 中所有在 __init__ 中定义了默认值的参数。值是默认值，如在 __init__ 中定义的。

classmethod get_param_names(sort=True)#

获取对象的参数名称。

参数：

sortbool，默认值=True

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

返回：

param_names: list[str]

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

get_params(deep=True)#

获取评估器的参数。

参数：

deepboolean，可选

如果为 True，将返回此评估器和包含的作为评估器的子对象的参数。

返回：

paramsstring 到任意类型的映射

参数名称映射到其值。

get_tag(tag_name, tag_value_default=None, raise_error=True)#

从实例中获取标签值，考虑标签级别继承和覆盖。

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

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

get_tag 方法从实例中检索名称为 tag_name 的单个标签值，考虑标签覆盖，优先级降序如下

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

在实例构建时。

2. 在类的 _tags 属性中设置的标签。

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

按继承顺序。

参数：

tag_namestr

要检索的标签名称

tag_value_default任意类型，可选；默认值=None

如果未找到标签，则使用的默认/备用值

raise_errorbool

未找到标签时是否引发 ValueError

返回：

tag_valueAny

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 设置的标签，

在实例构建时。

2. 在类的 _tags 属性中设置的标签。

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

按继承顺序。

返回：

collected_tagsdict

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

is_composite()#

检查对象是否是复合对象。

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

返回：

composite: bool，self 是否包含一个 BaseObject 类型的参数

property is_fitted#

是否已调用 fit 方法。

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

返回：

bool

评估器是否已 fit。

classmethod load_from_path(serial)#

从文件位置加载对象。

参数：

serialZipFile(path).open(“object) 的结果

返回：

cls.save(path) 在 path 处生成输出的反序列化 self

classmethod load_from_serial(serial)#

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

参数：

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

返回：

cls.save(None) 生成输出 serial 的反序列化 self

predict(fh=None, X=None)#

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

所需状态

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

访问 self 中的

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

• self.cutoff，self.is_fitted

写入自身

如果传递了 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)#

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

如果 coverage 是可迭代的，将计算多个区间。

所需状态

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

访问 self 中的

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

• self.cutoff，self.is_fitted

写入自身

如果传递了 fh 且之前未传递过，则将 fh 存储到 self.fh。

参数：

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

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

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

• 如果 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` 索引引用。

coveragefloat 或包含唯一值的 float 列表，可选（默认值=0.90）

预测区间的名义覆盖范围

返回：

pred_intpd.DataFrame

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

第二级是计算区间的覆盖率。

顺序与输入 coverage 中的顺序相同。

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

行索引是 fh，额外的（上层）级别等于实例级别，

从 fit 中看到的 y，如果 fit 中看到的 y 是 Panel 或 Hierarchical 类型。

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

对于列索引中的 var，在第二个列索引中的标称覆盖率下，下限/上限取决于第三个列索引，对应于行索引。对于覆盖率 c，上限/下限区间预测值等同于 alpha = 0.5 - c/2, 0.5 + c/2 时的分位数预测值。

predict_proba(fh=None, X=None, marginal=True)

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

注意

• 目前仅适用于 Series（非 Panel，非 Hierarchical）类型的 y。

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

所需状态

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

访问 self 中的

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

• self.cutoff，self.is_fitted

写入自身

如果传递了 fh 且之前未传递过，则将 fh 存储到 self.fh。

参数：

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

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

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

• 如果 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)

如果 alpha 是可迭代的，将计算多个分位数。

计算/返回分位数预测。

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

所需状态

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

访问 self 中的

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

• self.cutoff，self.is_fitted

写入自身

如果传递了 fh 且之前未传递过，则将 fh 存储到 self.fh。

参数：

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

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

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

• 如果 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` 索引引用。

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

quantilespd.DataFrame

返回：

第二层是传递给函数的 alpha 值。

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

条目是分位数预测值，对于列索引中的 var，

行索引是 fh，额外的（上层）级别等于实例级别，

从 fit 中看到的 y，如果 fit 中看到的 y 是 Panel 或 Hierarchical 类型。

在第二个列索引中的分位数概率下，对应于行索引。

predict_residuals(y=None, X=None)

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

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

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

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

所需状态

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

访问 self 中的

无。

写入自身

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

参数：

ysktime 兼容数据容器格式的时间序列

如果为 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)

cov布尔值，可选 (默认值=False)

计算/返回方差预测。

所需状态

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

访问 self 中的

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

• self.cutoff，self.is_fitted

写入自身

如果传递了 fh 且之前未传递过，则将 fh 存储到 self.fh。

参数：

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

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

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

• 如果 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` 索引引用。

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

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

返回：

如果 cov=False

列名与在 fit/update 中传入的 y 的列名完全相同。

对于无名称的格式，列索引将是一个 RangeIndex。

行索引是 fh，额外级别等于实例级别，

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

从 fit 中看到的 y，如果 fit 中看到的 y 是 Panel 或 Hierarchical 类型。

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

如果 cov=True

列索引是一个多重索引：第一级是变量名（如上所示）

第二级是 fh。

条目是（协）方差预测值，对于列索引中的 var，以及

条目是方差预测值，对于列索引中的 var。给定变量和 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')

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

将序列化的对象保存到类似字节的对象或到 (.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”，则将在 /home/stored/ 中创建一个 zip 文件 estimator.zip。

• 存储在 /home/stored/ 中。

serialization_format: str，默认值 = “pickle”

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

如果 path 为 None - 内存中的序列化 self

返回：

如果 path 是文件路径 - 引用该文件的 ZipFile

score(y, X=None, fh=None)

ypd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D)

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

参数：

要评分的时间序列

Xpd.DataFrame, 或 2D np.array，可选 (默认值=None)

fhint, list, pd.Index 可强制转换类型, 或 ForecastingHorizon，默认值=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

displaystr, “diagram” (默认值), 或 “text”

jupyter kernel 如何显示 self 的实例

“diagram” = html 盒图表示

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

• print_changed_only布尔值，默认值=True

打印 self 时是仅列出与默认值不同的 self 参数 (True)，还是列出所有参数名称和值 (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”: 布尔值，默认值=True；False 会阻止 ray 在并行化后

  • 关闭。

    “logger_name”: str，默认值=”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对 self 的引用。

返回：

说明

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

set_params(**kwargs)

有效的参数键可以通过 get_params() 列出。

设置评估器的参数。

self返回 self 的一个实例。

返回：

set_random_state(random_state=None, deep=True, self_policy='copy')

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

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

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

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

random_state整数，RandomState 实例或 None，默认值=None

参数：

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

是否设置 skbase 对象值参数（即组件估计器）中的随机状态。

deepbool，默认值=True

如果为 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)

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

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

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

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

set_tags 方法只能在对象的 __init__ 方法中调用，即在构造过程中，或通过 __init__ 构造后立即调用。

**tag_dict字典

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

参数：

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

self

返回：

对 self 的引用。

update(y, X=None, update_params=True)

如果未实现特定于估计器的 update 方法，默认回退如下

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

update_params=True: 拟合迄今为止所有观测到的数据

• update_params=False: 仅更新 cutoff 并记住数据

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

所需状态

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

访问 self 中的

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

• self.cutoff，self.is_fitted

写入自身

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

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

参数：

ysktime 兼容数据容器格式的时间序列。

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

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）。

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

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

update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)

返回：

set_tags(**tag_dict)

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

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

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

self.update(y=cv.split_series(y)[0][0])

1. 记住 self.predict() (稍后在单个批次中返回)

2. self.update(y=cv.split_series(y)[1][0])

3. 等等

4. self.update(y=cv.split_series(y)[1][0])

5. 返回所有记住的预测值

6. 写入 self（除非 reset_forecaster=True）

update_params=True: 拟合迄今为止所有观测到的数据

• update_params=False: 仅更新 cutoff 并记住数据

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

所需状态

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

访问 self 中的

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

• self.cutoff，self.is_fitted

如果 reset_forecaster=True，则不更新状态。

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

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

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

参数：

ysktime 兼容数据容器格式的时间序列。

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

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

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

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

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

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

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

update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)

如果为 True，将不会改变预测器的状态，即 update/predict 序列使用副本运行，self 的 cutoff、模型参数、数据内存都不会改变

• 如果为 False，则当 update/predict 序列运行时将更新 self，就像直接调用 update/predict 一样

• y_pred汇总来自多个分割批次的点预测值的对象

返回：

格式取决于总体预测的 (cutoff, 绝对预测范围) 对

如果绝对预测范围点的集合是唯一的：类型是 sktime 兼容数据容器格式的时间序列，输出中抑制 cutoff，与最近传入的 y 类型相同：Series, Panel, Hierarchical 科学类型，格式相同（见上文）

• 如果绝对预测范围点的集合不是唯一的：类型是一个 pandas DataFrame，行索引和列索引都是时间戳；行索引对应于从中进行预测的 cutoffs；列索引对应于预测的绝对预测范围；条目是从行索引预测的列索引的点预测值；如果在该 (cutoff, horizon) 对处没有预测，则条目为 nan

• update_predict_single(y=None, fh=None, X=None, update_params=True)

此方法对于一步完成更新和预测非常有用。

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

如果未实现特定于估计器的 update 方法，默认回退是先 update，然后 predict。

以“_”结尾的已拟合模型属性。指向已见数据的指针 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 兼容数据容器格式的时间序列。

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

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 中传递，则必须传递，非可选

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

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

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

update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)

返回：

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

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