StackingForecaster#

class StackingForecaster(forecasters, regressor=None, random_state=None, n_jobs=None)[source]#

StackingForecaster。

堆叠两个或更多 Forecaster，并使用元模型（回归器）从给定 forecaster 的预测中推断出最终预测。

参数:

forecasterslist of (str, estimator) tuples: 应用于输入序列的估计器。
regressor: sklearn-like regressor，可选，默认为 None。: 回归器用作元模型，并使用集成 forecaster 的预测作为外生数据，使用 y 作为内生数据进行训练。数据的长度取决于给定的 fh。如果为 None，则使用 GradientBoostingRegressor(max_depth=5)。回归器也可以是 sklearn.Pipeline()。
random_stateint, RandomState instance or None, default=None: 用于设置默认回归器的 random_state。
n_jobsint or None, optional (default=None): 用于并行运行 fit 的作业数。None 表示 1，除非在 joblib.parallel_backend 上下文中。-1 表示使用所有处理器。

属性:

regressor_sklearn-like regressor: 已拟合的元模型（回归器）

示例

>>> from sktime.forecasting.compose import StackingForecaster
>>> 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 = StackingForecaster(forecasters=forecasters)
>>> forecaster.fit(y=y, fh=[1,2,3])
StackingForecaster(...)
>>> 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])	将 forecaster 拟合到训练数据。
`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”: 返回的测试参数集的名称，用于测试。如果没有为某个值定义特殊参数，将返回 "default" 集。

返回:

paramsdict or list of dict

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:

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

引发:

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 的对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。

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

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

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

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

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

estimatorAn instance of :class:BaseObject or derived class

参数:

tag_namesstr or list of str, default = None
要克隆的标签名称。默认值 (None) 克隆来自 estimator 的所有标签。: self

返回:

self 的引用。: classmethod create_test_instance(parameter_set='default')[source]#

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

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

参数:

parameter_setstr, default=”default”: instanceinstance of the class with default parameters

返回:

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

objslist of instances of cls

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

参数:

parameter_setstr, default=”default”: instanceinstance of the class with default parameters

返回:

第 i 个实例是 cls(**cls.get_test_params()[i]): nameslist of str, same length as objs
第 i 个元素是测试中 obj 的第 i 个实例的名称。命名约定为 {cls.__name__}-{i}（如果实例多于一个），否则为 {cls.__name__}。: property cutoff[source]#

截止时间 = forecaster 的“当前时间”状态。

cutoffpandas compatible index element, or None

返回:

如果已设置截止时间，则为 pandas 兼容的索引元素；否则为 None: property fh[source]#

已传递的预测范围。: fit(y, X=None, fh=None)[source]#

状态改变

将 forecaster 拟合到训练数据。

将状态更改为“已拟合”。: 写入 self

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

将 self.is_fitted 标志设置为 True。

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

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

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

参数:

要拟合 forecaster 的时间序列。

用于拟合预测器的时序数据。

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

Series scitype = 个体时序，普通预测。pd.DataFrame，pd.Series，或 np.ndarray (1D 或 2D)
Panel scitype = 时序集合，全局/面板预测。行具有两级 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，由 Series 类型 pd.DataFrame 组成的 list
Hierarchical scitype = 分层集合，用于分层预测。行具有三级或更多级 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

fhint, list, pd.Index coercible, or ForecastingHorizon, default=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。

selfReference to 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) 相同。

在未来预测范围拟合和预测时间序列。

将 fh 存储到 self.fh。

将状态更改为“已拟合”。: 写入 self

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

将 self.is_fitted 标志设置为 True。

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

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

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

参数:

fhint, list, pd.Index coercible, or ForecastingHorizon (非可选)

用于拟合预测器的时序数据。

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

Series scitype = 个体时序，普通预测。pd.DataFrame，pd.Series，或 np.ndarray (1D 或 2D)
Panel scitype = 时序集合，全局/面板预测。行具有两级 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，由 Series 类型 pd.DataFrame 组成的 list
Hierarchical scitype = 分层集合，用于分层预测。行具有三级或更多级 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

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

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

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

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

selfReference to self.

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

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

返回:

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 的标签值，考虑到标签覆盖项，优先级从高到低如下所示

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

按继承顺序。

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

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

参数:

tag_name字符串: 标签值的名称。
tag_value_default任何类型: 如果未找到标签，则使用的默认/备用值。

返回:

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

classmethod get_class_tags()[source]#

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

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

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

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

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

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

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

按继承顺序。

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

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

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

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

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

get_config()[source]#

获取 self 的配置标志。

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

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

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

配置在 clone 或 reset 调用期间保留。

返回:

config_dict字典: 配置名称 : 配置值对的字典。通过嵌套继承从 _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，将返回此预测器和包含的子对象（预测器）的参数。

返回:

params字符串到任何类型的映射: 参数名称映射到其值。

get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

从实例获取标签值，具有标签级别继承和覆盖。

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

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

get_tag 方法从实例中检索名称为 tag_name 的单个标签值，考虑到标签覆盖项，优先级从高到低如下所示

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

在实例构造时。

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

按继承顺序。

参数:

tag_name字符串: 要检索的标签名称
tag_value_default任何类型，可选；默认=None: 如果未找到标签，则使用的默认/备用值
raise_error布尔值: 如果未找到标签，是否引发 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 的对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。

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

get_tags 方法返回一个标签字典，其中的键是类或其任何父类中设置的任何 _tags 属性的键，或通过 set_tags 或 clone_tags 设置的标签。

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

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

在实例构造时。

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

按继承顺序。

返回:

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

is_composite()[source]#

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

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

返回:

composite: 布尔值，表示 self 是否包含一个 BaseObject 类型的参数。

property is_fitted[source]#

fit 是否已被调用。

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

返回:

布尔值: 预测器是否已拟合。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:

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

返回:

反序列化的 self，其结果存储在 path，由 cls.save(path) 生成。

classmethod load_from_serial(serial)[source]#

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

参数:

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

返回:

反序列化的 self，其结果是输出 serial，由 cls.save(None) 生成。

predict(fh=None, X=None)[source]#

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

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

在 self 中访问

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

self.cutoff，self.is_fitted

设置以“_”结尾的已拟合模型属性，已拟合属性可通过 get_fitted_params 查看。: 如果传入 fh 且之前未传入，则将 fh 存储到 self.fh。

参数:

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

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

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

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

设置以“_”结尾的已拟合模型属性，已拟合属性可通过 get_fitted_params 查看。: 如果传入 fh 且之前未传入，则将 fh 存储到 self.fh。

参数:

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

预测期，编码要预测的时间戳。如果在 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)

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

返回:

pred_intpd.DataFrame

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

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

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

行索引是 fh，带有与 fit 中 y 具有的实例级别相同的附加（上层）级别，

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

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

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

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

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

注意

目前仅为 Series (非面板，非分层) y 实现。
返回的分布对象需要安装 skpro。

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

在 self 中访问

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

self.cutoff，self.is_fitted

设置以“_”结尾的已拟合模型属性，已拟合属性可通过 get_fitted_params 查看。: 如果传入 fh 且之前未传入，则将 fh 存储到 self.fh。

参数:

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

预测期，编码要预测的时间戳。如果在 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

设置以“_”结尾的已拟合模型属性，已拟合属性可通过 get_fitted_params 查看。: 如果传入 fh 且之前未传入，则将 fh 存储到 self.fh。

参数:

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

预测期，编码要预测的时间戳。如果在 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，则残差将在 fh 为 range(len(y.shape[0])) 时计算。

所需状态: 需要状态为“已拟合”。如果已设置 fh，则必须对应于 y 的索引（pandas 或整数）。
在 self 中访问: 以“_”结尾的已拟合模型属性。self.cutoff, self._is_fitted
设置以“_”结尾的已拟合模型属性，已拟合属性可通过 get_fitted_params 查看。: 无。

参数:

fhint, list, pd.Index coercible, or ForecastingHorizon (非可选)

用于计算残差的真实观测值时序数据。必须与 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

设置以“_”结尾的已拟合模型属性，已拟合属性可通过 get_fitted_params 查看。: 如果传入 fh 且之前未传入，则将 fh 存储到 self.fh。

参数:

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

预测期，编码要预测的时间戳。如果在 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 是 Panel 或 Hierarchical 类型。

来自 fit 中看到的 y。条目是方差预测值，对于列索引中的变量。给定变量和 fh 索引的方差预测值是该变量和索引在给定观测数据下的预测方差。

用于列索引中的变量。给定变量和 fh 索引的方差预测值是该变量和索引在给定观测数据下的预测方差。

如果 cov=True

列索引是多级索引：第一级是变量名（如上）: 第二级是 fh。
行索引是 fh，带有与实例级别相同的附加级别，: 如果 fit 中看到的 y 是 Panel 或 Hierarchical 类型。
条目是（协）方差预测值，用于列索引中的变量，以及: 行和列中的时间索引之间的协方差。

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

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 的引用。: 实例重置到干净的 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。

存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

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

返回:

如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 引用文件的 ZipFile

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

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

参数:

ypd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D): 用于评分的时序数据
编码要预测的时间戳的预测范围。如果 self.get_tag("requires-fh-in-fit") 为 True，则必须在 fit 中传入，非可选。: 如果 fh 不是 None 且不是 ForecastingHorizon 类型，则通过调用 _check_fh 强制转换为 ForecastingHorizon。特别是，如果 fh 是 pd.Index 类型，则通过 ForecastingHorizon(fh, is_relative=False) 强制转换。
Xpd.DataFrame, 或 2D np.array, 可选 (默认=None): 用于评分的外生时序数据；如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 y.index。

返回:

score浮点数: self.predict(fh, X) 相对于 y_test 的 MAPE 损失。

另请参阅

sktime.performance_metrics.forecasting.mean_absolute_percentage_error

set_config(**config_dict)[source]#

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

参数:

config_dict字典

配置名称 : 配置值对的字典。有效的配置、值及其含义如下所示

display字符串，“diagram” (默认)，或 “text”

jupyter 内核显示 self 实例的方式

“diagram” = html 方框图表示
“text” = 字符串打印输出

print_changed_only布尔值，默认=True

打印 self 时是否只列出与默认值不同的 self 参数 (False)，还是列出所有参数名称和值 (False)。不嵌套，即仅影响 self 而不影响组件预测器。

warnings字符串，“on” (默认)，或 “off”

是否引发警告，仅影响来自 sktime 的警告

“on” = 将引发来自 sktime 的警告
“off” = 将不引发来自 sktime 的警告

backend:parallel字符串，可选，默认=“None”

广播/向量化时用于并行化的后端，以下之一

“None”: 顺序执行循环，简单的列表推导
“loky”、“multiprocessing”和“threading”: 使用 joblib.Parallel
“joblib”: 自定义和第三方 joblib 后端，例如 spark
“dask”: 使用 dask，需要环境中安装 dask 包
“ray”: 使用 ray，需要环境中安装 ray 包

backend:parallel:params字典，可选，默认={}（未传递参数）

作为配置传递给并行化后端的附加参数。有效键取决于 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”: 字符串，默认=“ray”；要使用的日志记录器名称。
- “mute_warnings”: 布尔值，默认=False；如果为 True，则抑制警告。

remember_data布尔值，默认=True

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

返回:

selfself 的引用。

注意

更改对象状态，将 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 instance or None, default=None

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

deep布尔值，默认=True

是否在 skbase 值参数（即组件预测器）中设置随机状态。

如果为 False，则仅设置 self 的 random_state 参数（如果存在）。
如果为 True，也将设置组件对象中的 random_state 参数。

self_policy字符串，{"copy", "keep", "new"} 之一，默认="copy"

“copy” : self.random_state 设置为输入的 random_state
“keep” : 保持 self.random_state 不变
“new” : self.random_state 设置为新的随机状态，

派生自输入的 random_state，并且通常与它不同

返回:

selfself 的引用

set_tags(**tag_dict)[source]#

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

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

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

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

set_tags 方法应仅在对象的构造期间或通过 __init__ 直接在构造后，于对象的 __init__ 方法中调用。

estimatorAn instance of :class:BaseObject or derived class

参数:

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

返回:

Self: 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

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

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

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

参数:

要拟合 forecaster 的时间序列。

用于更新预测器的时序数据。

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

Series scitype = 个体时序，普通预测。pd.DataFrame，pd.Series，或 np.ndarray (1D 或 2D)
Panel scitype = 时序集合，全局/面板预测。行具有两级 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，由 Series 类型 pd.DataFrame 组成的 list
Hierarchical scitype = 分层集合，用于分层预测。行具有三级或更多级 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

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

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

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

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

返回:

selfself 的引用

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() (稍后以单批次返回)
等等
返回所有记住的预测

如果未实现特定于预测器的 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，则不更新状态。

参数:

要拟合 forecaster 的时间序列。

用于更新预测器的时序数据。

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

Series scitype = 个体时序，普通预测。pd.DataFrame，pd.Series，或 np.ndarray (1D 或 2D)
Panel scitype = 时序集合，全局/面板预测。行具有两级 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，由 Series 类型 pd.DataFrame 组成的 list
Hierarchical scitype = 分层集合，用于分层预测。行具有三级或更多级 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

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

例如，SlidingWindowSplitter 或 ExpandingWindowSplitter；默认 = ExpandingWindowSplitter，其中 initial_window=1 且默认值 = y/X 中的单个数据点被逐个添加和预测，initial_window = 1, step_length = 1 且 fh = 1。

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

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

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

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

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

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

返回:

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

格式取决于整体预测的（截止点，绝对预测期）对

如果绝对预测期点集合是唯一的：类型为 sktime 兼容数据容器格式的时序数据，输出中省略截止点，其类型与最近一次传入的 y 相同：Series, Panel, Hierarchical scitype，格式相同（参见上文）。
如果绝对预测期点集合不唯一：类型为 pandas DataFrame，行和列索引为时间戳。行索引对应于从中进行预测的截止点，列索引对应于从中进行预测的绝对预测期。如果在该（截止点，预测期）对处没有进行预测，则条目为 nan。

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

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

此方法可用于一步完成更新和预测。

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

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

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

参数:

要拟合 forecaster 的时间序列。

用于更新预测器的时序数据。

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

Series scitype = 个体时序，普通预测。pd.DataFrame，pd.Series，或 np.ndarray (1D 或 2D)
Panel scitype = 时序集合，全局/面板预测。行具有两级 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，由 Series 类型 pd.DataFrame 组成的 list
Hierarchical scitype = 分层集合，用于分层预测。行具有三级或更多级 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

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

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

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

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

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

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

返回:

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