FallbackForecaster#

class FallbackForecaster(forecasters, verbose=False, nan_predict_policy='ignore')[source]#

按顺序尝试预测模型列表的预测器。

尝试按给定顺序 fit 提供的预测器。如果某个预测器在 fit 或 predict 期间失败，则会继续尝试下一个。此类在单个预测模型的可靠性可能存在疑问，且需要回退机制的场景中很有用。

参数:

forecasters预测器列表，或

sktime 预测器的元组列表 (str, estimator) 按顺序尝试的预测器。这些是“蓝图”转换器或预测器，调用 fit 时预测器状态不会改变

verbosebool，默认值为 False

如果为 True，则在预测器 fit 或 predict 失败时引发警告。

nan_predict_policy: str，默认值为’ignore’

确定在预测中发现 NaN 值时采取的操作。可用选项：

“ignore”
“raise”
“warn”

当设置为“raise”时，此策略会将 NaN 预测视为错误，促使 FallbackForecaster 顺序尝试队列中的下一个预测器。此过程持续到获得无 NaN 的预测，或所有预测器都已尝试完毕，此时操作失败。相反，“warn”选项会发出警告提示预测中存在 NaN，但不改变预测顺序。默认的“ignore”模式不采取任何行动，允许预测过程不受中断地继续，无论预测中是否存在 NaN，都不会发出警告或错误。

属性:

forecasters_(str, estimator) 元组列表: 按顺序尝试的预测器。成功 fit 的预测器存储在此列表中。
first_nonfailing_forecaster_index_int: 预测器列表中第一个非失败预测器的索引。
current_forecaster_sktime 预测器: 指向第一个成功 fit 的预测器与 forecasters_[first_nonfailing_forecaster_index_][1] 相同
current_name_str: 当前预测器的名称与 forecasters_[first_nonfailing_forecaster_index_][0] 相同
exceptions_raised_dict: 预测器在 fit 或 predict 期间引发的异常字典 key 是预测器列表中预测器的 int 索引 value 是包含键“failed_at_step”，“exception”，“forecaster_name”的字典 failed_at_step 是 “fit” 或 “predict” exception 是预测器引发的异常 forecaster_name 是预测器的名称

示例

>>> from sktime.forecasting.naive import NaiveForecaster
>>> from sktime.forecasting.compose import FallbackForecaster
>>> from sktime.forecasting.compose import EnsembleForecaster
>>> from sktime.forecasting.trend import PolynomialTrendForecaster
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> # first fit polyomial trend, if fails make naive forecast
>>> forecasters = [
...     ("poly", PolynomialTrendForecaster()),
...     ("naive", NaiveForecaster())
... ]
>>> forecaster = FallbackForecaster(forecasters=forecasters)
>>> forecaster.fit(y=y, fh=[1, 2, 3])
FallbackForecaster(...)
>>> y_pred = forecaster.predict()

方法

`check_is_fitted`([method_name])	检查估计器是否已 fit。
`clone`()	获取具有相同超参数和配置的对象的克隆。
`clone_tags`(estimator[, tag_names])	从另一个对象克隆标签作为动态覆盖。
`create_test_instance`([parameter_set])	使用第一个测试参数集构造类的实例。
`create_test_instances_and_names`([parameter_set])	创建所有测试实例列表及其名称列表。
`fit`(y[, X, fh])	将预测器 fit 到训练数据。
`fit_predict`(y[, X, fh, X_pred])	fit 并预测未来预测期的时间序列。
`get_class_tag`(tag_name[, tag_value_default])	从类获取类标签值，具有来自父类的标签级别继承。
`get_class_tags`()	从类获取类标签，具有来自父类的标签级别继承。
`get_config`()	获取 self 的配置标志。
`get_fitted_params`([deep])	获取已 fit 的参数。
`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])	更新截止值，并可选地更新已 fit 的参数。
`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]#

检查估计器是否已 fit。

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

如果不是，则引发 NotFittedError。

参数:

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

引发:

NotFittedError: 如果估计器尚未 fit。

clone()[source]#

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

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

等同于构造一个 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 个元素是 obj 在测试中的第 i 个实例的名称。命名约定是如果实例多于一个，则为 {cls.__name__}-{i}，否则为 {cls.__name__}

property cutoff[source]#

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

返回:

cutoffpandas 兼容的索引元素，或 None: 如果截止点已设置，则是 pandas 兼容的索引元素；否则为 None

property fh[source]#: 已传递的预测期。

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

将预测器 fit 到训练数据。

状态改变: 将状态更改为“fitted”。

写入 self

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

将 self.is_fitted 标志设置为 True。

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

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

参数:

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

要 fit 预测器的时间序列。

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 列表
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)。

用于 fit 模型的外生时间序列。应与 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)[source]#

fit 并预测未来预测期的时间序列。

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

状态改变: 将状态更改为“fitted”。

写入 self

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

将 self.is_fitted 标志设置为 True。

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

将 fh 存储到 self.fh 中。

参数:

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

要 fit 预测器的时间序列。

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 列表
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)。

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

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

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

返回:

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

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

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

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

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

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

在类的 _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 对象属性收集任何覆盖和新标签。

get_fitted_params(deep=True)[source]#

获取已 fit 的参数。

所需状态: 要求状态为“fitted”。

参数:

deepbool，默认值为 True

是否返回组件的已 fit 参数。

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

返回:

fitted_params键为 str 类型的 dict

已 fit 参数字典，参数名 : 参数值键值对包括：

始终：此对象的所有已 fit 参数，如通过 get_param_names 获取的值是此对象该键的已 fit 参数值
如果 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，将返回此估计器和其中作为估计器的子对象的参数。

返回:

paramsstring 到任意类型的映射: 参数名称映射到其值。

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

值是相应的标签值，覆盖顺序按以下优先级从高到低排列：

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

在实例构造时。

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

返回:

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

classmethod load_from_serial(serial)[source]#

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

参数:

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

返回:

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

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

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

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

访问 self 中的

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

self.cutoff, self.is_fitted

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

参数:

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

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

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

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

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

返回:

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

predict_interval(fh=None, X=None, coverage=0.9)[source]#

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

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

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

访问 self 中的

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

self.cutoff, self.is_fitted

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

参数:

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

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

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

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

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

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

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

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

返回:

pred_intpd.DataFrame

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

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

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

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

来自 fit 中见过的 y，如果 fit 中见过的 y 是 Panel 或 Hierarchical 类型。

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

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

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

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

注意

目前仅针对 Series（非 Panel，非 Hierarchical）的 y 实现。
返回的分布对象需要安装 skpro。

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

访问 self 中的

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

self.cutoff, self.is_fitted

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

参数:

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

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

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

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

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

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

marginal布尔类型，可选 (默认=True)

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

返回:

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

predict_quantiles(fh=None, X=None, alpha=None)[source]#

计算/返回分位数预测。

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

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

访问 self 中的

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

self.cutoff, self.is_fitted

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

参数:

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

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

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

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

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

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

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

一个或多个概率，用于计算分位数预测。

返回:

quantilespd.DataFrame

列具有多重索引：第一级是来自 fit 中的 y 的变量名，: 第二级是传递给函数的 alpha 值。
行索引是 fh，带有等于实例级别的额外（上层）级别，: 来自 fit 中见过的 y，如果 fit 中见过的 y 是 Panel 或 Hierarchical 类型。
条目是分位数预测值，对应列索引中的变量，: 对应第二级列索引中的分位数概率，对于行索引。

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

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

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

如果必须在 fit 中传递 fh，则必须与 y.index 一致。如果 y 是一个 np.ndarray，并且在 fit 中没有传递 fh，则残差将根据 range(len(y.shape[0])) 的 fh 计算。

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

参数:

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

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

如果为 None，则使用迄今为止见过的 y (self._y)，特别是

如果之前仅调用了一次 fit，则产生样本内残差。
如果 fit 需要 fh，则它必须指向 fit 中 y 的索引。

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

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

返回:

y_ressktime 兼容数据容器格式的时间序列: 在 fh 处的预测残差，索引与 fh 相同。y_res 的类型与最近传递的 y 的类型相同：Series、Panel、Hierarchical 科学类型，格式相同（见上文）。

predict_var(fh=None, X=None, cov=False)[source]#

计算/返回方差预测。

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

访问 self 中的

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

self.cutoff, self.is_fitted

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

参数:

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

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

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

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

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

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

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

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

返回:

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

如果 cov=False

列名与在 fit/update 中传递的 y 完全相同。: 对于无名称格式，列索引将是 RangeIndex。
行索引是 fh，带有等于实例级别的额外级别，: 来自 fit 中见过的 y，如果 fit 中见过的 y 是 Panel 或 Hierarchical 类型。

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

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

如果 cov=True

列索引是一个多重索引：第 1 级是变量名（如上所述）: 第 2 级是 fh。
行索引是 fh，带有等于实例级别的额外级别，: 来自 fit 中见过的 y，如果 fit 中见过的 y 是 Panel 或 Hierarchical 类型。
条目是（协）方差预测值，对应列索引中的变量，以及: 行和列中的时间索引之间的协方差。

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

reset()[source]#

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

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

调用 reset 会删除所有对象属性，除了

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

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

等同于 clone，不同之处在于 reset 会改变 self 的状态而不是返回一个新对象。

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

返回:

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

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

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

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

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

参数:

pathNone 或文件位置 (str 或 Path)

如果为 None，对象被保存到内存对象中；如果是文件位置，对象被保存到该文件位置。如果

path="estimator"，则将在当前工作目录 (cwd) 创建一个 zip 文件 estimator.zip。
path="/home/stored/estimator"，则 zip 文件 estimator.zip 将被

存储在 /home/stored/ 中。

serialization_format: str 类型，默认 = “pickle”

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

返回:

如果 path 为 None - 内存中的序列化对象。
如果 path 是文件位置 - 包含文件引用的 ZipFile。

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

使用 MAPE（非对称）评估预测与真实值的得分。

参数:

ypd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D): 用于评分的时间序列
fhint, list, pd.Index 可强制转换类型，或 ForecastingHorizon，默认值为 None: 编码预测时间戳的预测期。
Xpd.DataFrame, 或二维 np.array，可选 (默认=None): 用于评分的外生时间序列。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 y.index。

返回:

scorefloat: self.predict(fh, X) 相对于 y_test 的 MAPE 损失。

另请参阅

sktime.performance_metrics.forecasting.mean_absolute_percentage_error

set_config(**config_dict)[source]#

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

参数:

config_dictdict

配置名 : 配置值对的字典。下面列出了有效的配置、值及其含义。

displaystr 类型，“diagram”（默认），或“text”

jupyter kernel 如何显示对象实例

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

print_changed_only布尔类型，默认=True

打印对象时，是仅列出与默认值不同的参数（True），还是列出所有参数名称和值（False）。不嵌套，即仅影响对象本身，而不影响组件估计器。

warningsstr 类型，“on”（默认），或“off”

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

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

backend:parallelstr 类型，可选，默认=”None”

用于广播/向量化时的并行化后端，选项包括：

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

backend:parallel:paramsdict 类型，可选，默认={}（未传递参数）

作为配置传递给并行化后端的额外参数。有效的键取决于 backend:parallel 的值。

“None”：无额外参数，backend_params 被忽略
“loky”、“multiprocessing”和“threading”：默认的 joblib 后端。可以在此处传递适用于 joblib.Parallel 的任何有效键，例如 n_jobs，但 backend 除外，它由 backend 参数直接控制。如果未传递 n_jobs，它将默认为 -1，其他参数将使用 joblib 的默认值。
“joblib”：自定义和第三方 joblib 后端，例如 spark。可以在此处传递适用于 joblib.Parallel 的任何有效键，例如 n_jobs，在这种情况下，backend 必须作为 backend_params 的一个键传递。如果未传递 n_jobs，它将默认为 -1，其他参数将使用 joblib 的默认值。
“dask”：可以传递适用于 dask.compute 的任何有效键，例如 scheduler
“ray”：可以传递以下键
- “ray_remote_args”：适用于 ray.init 的有效键字典
- “shutdown_ray”：布尔类型，默认=True；False 可阻止 ray
  在并行化后关闭。
- “logger_name”：str 类型，默认=”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 将默认为“不做任何事”而不是“重新拟合所有已见数据”。

返回:

self对自身的引用。

注意

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

set_params(**kwargs)[source]#

设置估计器的参数。

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

返回:

self返回对象的一个实例。

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

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

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

适用于 self 中的 random_state 参数（取决于 self_policy）以及剩余的组件对象（当且仅当 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对自身的引用

set_tags(**tag_dict)[source]#

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

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

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

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

set_tags 方法应仅在对象的 __init__ 方法中、构造期间或通过 __init__ 构造后立即调用。

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

参数:

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

返回:

返回: 对自身的引用。

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

更新截止值，并可选地更新已 fit 的参数。

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

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

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

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

访问 self 中的

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

self.cutoff, self.is_fitted

写入 self

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

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

参数:

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

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

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

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

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

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

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

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

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

返回:

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() 的结果（稍后在单个批次中返回）
等等
返回所有记住的预测值

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

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

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

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

访问 self 中的

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

self.cutoff, self.is_fitted

写入对象自身（除非 reset_forecaster=True）

更新 self.cutoff 到 y 中看到的最新索引。
如果 update_params=True，更新以“_”结尾的已拟合模型属性。

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

参数:

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

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

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

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

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

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

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

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

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

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

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

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

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

返回:

y_pred列表化来自多个分割批次的点预测的对象

格式取决于整体预测的 (截止点, 绝对预测范围) 对。

如果绝对预测范围点的集合是唯一的：类型是 sktime 兼容数据容器格式的时间序列，输出中会抑制截止点，类型与最近传递的 y 相同：Series、Panel、Hierarchical 科学类型，格式相同（见上文）。
如果绝对预测范围点的集合不唯一：类型是一个 pandas DataFrame，行和列索引是时间戳，行索引对应于从中进行预测的截止点，列索引对应于被预测的绝对预测范围，条目是根据行索引预测的列索引的点预测值；如果在该 (截止点, 预测范围) 对处没有预测，则条目为 nan。

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

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

此方法用于在一个步骤中更新和进行预测，非常有用。

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

所需状态: 要求状态为“fitted”。
访问 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，

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

参数:

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 列表
Hierarchical scitype = 分层集合，用于分层预测。具有 3 个或更多级别行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

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

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

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

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

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

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

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

返回:

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