EnsembleForecaster#

class EnsembleForecaster(forecasters, n_jobs=None, aggfunc='mean', weights=None)[source]#

预测器集成。

概述：输入一个长度为 n 的序列，EnsembleForecaster 会对 forecasters 中传递的每个估计器执行拟合和预测。然后，它按行对预测数据帧应用 aggfunc 聚合函数，并返回最终预测结果 - 一个序列。

参数:
forecasters估计器列表、(str, 估计器) 或 (str, 估计器, count) 元组

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

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

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

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

n_jobsint 或 None，可选，默认为 None

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

aggfuncstr, {‘mean’, ‘median’, ‘min’, ‘max’}，默认为 ‘mean’

用于聚合单个预测器预测结果的函数。

weights浮点数列表

在聚合中应用的权重。

属性:
cutoff

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

fh

传递的预测范围。

is_fitted

是否已调用 fit。

另请参阅

AutoEnsembleForecaster

示例

>>> from sktime.forecasting.compose import EnsembleForecaster
>>> from sktime.forecasting.naive import NaiveForecaster
>>> from sktime.forecasting.trend import PolynomialTrendForecaster
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> forecasters = [
...     ("trend", PolynomialTrendForecaster()),
...     ("naive", NaiveForecaster()),
... ]
>>> forecaster = EnsembleForecaster(forecasters=forecasters, weights=[4, 10])
>>> forecaster.fit(y=y, fh=[1,2,3])
EnsembleForecaster(...)
>>> y_pred = forecaster.predict()

方法

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

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

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

设置估计器的参数。

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

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

克隆是一个没有共享引用、处于初始化后状态的不同对象。此函数等效于返回 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_namesstr 或 str 列表，默认为 None

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

返回:
self

对 self 的引用。

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

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

参数:
parameter_setstr，默认为“default”

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

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

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

参数:
parameter_setstr，默认为“default”

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

返回:
objscls 实例列表

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

namesstr 列表，与 objs 长度相同

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

property cutoff[source]#

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

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

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

property fh[source]#

传递的预测范围。

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

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

状态变化

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

写入 self

  • 设置以“_”结尾的已拟合模型属性，已拟合属性可通过 get_fitted_params 进行检查。

  • 将 self.is_fitted 标志设置为 True。

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

  • 如果传递了 fh，则将其存储到 self.fh。

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

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

sktime 中的个体数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

  • Series scitype = 个体时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 类型 Series 的 pd.DataFrame

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

有关数据格式的更多详细信息，请参阅 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") 为 True，则 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 (instance, time), 3D np.ndarray (instance, variable, time), list 类型 Series 的 pd.DataFrame

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

有关数据格式的更多详细信息，请参阅 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") 为 True，则 X.index 必须包含 y.index。

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

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

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

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

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

从类中获取类标签值，并从父类继承标签级别。

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

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

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

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

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

按继承顺序排列。

不考虑通过 set_tags 或 clone_tags 在实例上设置的动态标签覆盖。

要检索可能包含实例覆盖的标签值，请改用 get_tag 方法。

参数:
tag_namestr

标签值的名称。

tag_value_default任意类型

如果未找到标签，则为默认/回退值。

返回:
tag_value

self 中 tag_name 标签的值。如果未找到，则返回 tag_value_default。

classmethod get_class_tags()[source]#

从类中获取类标签，并从父类继承标签级别。

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

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

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

它返回一个字典，其中的键是类或其任何父类中设置的 _tags 属性的任何键。

值是相应的标签值，覆盖按以下优先级降序排列：

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

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

按继承顺序排列。

实例可以根据超参数覆盖这些标签。

要检索可能包含实例覆盖的标签，请改用 get_tags 方法。

不考虑通过 set_tags 或 clone_tags 在实例上设置的动态标签覆盖。

要包含来自动态标签的覆盖，请使用 get_tags。

collected_tagsdict

标签名称：标签值对的字典。通过嵌套继承从 _tags 类属性收集。不被通过 set_tags 或 clone_tags 设置的动态标签覆盖。

get_config()[source]#

获取 self 的配置标志。

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

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

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

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

返回:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态

要求状态为“已拟合”。

参数:
deepbool，默认为 True

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

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

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

返回:
fitted_params带有 str 类型键的 dict

已拟合参数字典，参数名：参数值键值对包括：

  • 始终：此对象的所有已拟合参数，通过 get_param_names 获取，值是此对象该键的已拟合参数值

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

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

classmethod get_param_defaults()[source]#

获取对象的参数默认值。

返回:
default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数:
sortbool，默认为 True

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

返回:
param_names: list[str]

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

get_params(deep=True)[source]#

获取估计器的参数。

参数:
deepboolean，可选

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

返回:
params字符串到任意类型的映射

参数名称映射到其值。

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_valueAny

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

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

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

返回:
composite: bool，表示 self 是否包含一个参数是 BaseObject
property is_fitted[source]#

是否已调用 fit。

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

返回:
bool

估计器是否已经过 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

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

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化的 self，产生 cls.save(None) 的输出 serial
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 兼容格式的时间序列，可选 (default=None)

用于预测的外生时间序列。应与 fit 中 y 的 scitype (Series, Panel, or 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 兼容格式的时间序列，可选 (default=None)

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

coveragefloat 或唯一浮点值列表，可选 (默认=0.90)

预测区间的标称覆盖率

返回:
pred_intpd.DataFrame
列具有多级索引：第一级是 fit 中 y 的变量名，
第二级是计算区间的覆盖率分数。

与输入 coverage 中的顺序相同。

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

行索引是 fh，如果 fit 中看到的 y 是 Panel 或 Hierarchical，则附加（上层）级别等于实例级别。

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

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

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

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 兼容格式的时间序列，可选 (default=None)

用于预测的外生时间序列。应与 fit 中 y 的 scitype (Series, Panel, or 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 兼容格式的时间序列，可选 (default=None)

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

alphafloat 或唯一浮点值列表，可选 (默认=[0.05, 0.95])

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

返回:
quantilespd.DataFrame
列具有多级索引：第一级是 fit 中 y 的变量名，

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

行索引是 fh，如果 fit 中看到的 y 是 Panel 或 Hierarchical，则附加（上层）级别等于实例级别。

来自 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, or 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 兼容格式的时间序列，可选 (default=None)

用于预测的外生时间序列。应与 fit 中 y 的 scitype (Series, Panel, or 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 索引的方差预测，是给定观测数据的该变量和索引的预测方差。

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

如果 cov=True
列索引是多级索引：第一级是变量名（如上）

第二级是 fh。

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

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

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

行和列中的时间索引之间的协方差。

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

reset()[source]#

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

将 self 设置为构造函数调用后立即的状态，具有相同的超参数。通过 set_config 设置的配置值也保留。

A 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

类实例已重置为干净的 post-init 状态，但保留当前超参数值。

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。

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。

返回:
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 kernel 如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, 默认=True

打印 self 时是仅列出与默认值不同的 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(**kwargs)[source]#

设置估计器的参数。

有效的参数键可以使用 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 可在多次函数调用中获得可重复输出。

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 派生，通常与它不同

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

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

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

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

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

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

所需状态

要求状态为“已拟合”，即 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 (instance, time), 3D np.ndarray (instance, variable, time), list 类型 Series 的 pd.DataFrame

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

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

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

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

update_paramsbool, 可选 (默认=True)

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

返回:
self指向 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_params=True：拟合到迄今为止所有观测到的数据

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

所需状态

要求状态为“已拟合”，即 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 (instance, time), 3D np.ndarray (instance, variable, time), list 类型 Series 的 pd.DataFrame

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

有关数据格式的更多详细信息，请参阅 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, or Hierarchical) 相同。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 fh 索引引用。

update_paramsbool, 可选 (默认=True)

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

reset_forecasterbool, 可选 (默认=True)

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

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

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

格式取决于整体预测的 (cutoff, 绝对预测区间) 对

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

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

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

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

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

fhint、list、pd.Index 可强制转换类型，或 ForecastingHorizon，默认为 None

预测时间戳的预测区间。如果在 fit 中已传入，则不应再次传入。如果在 fit 中未传入，则必须传入，不是可选的。

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

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

update_paramsbool, 可选 (默认=True)

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

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

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