StatsForecastARCH#

class StatsForecastARCH(p=1)[source]#

StatsForecast ARCH 估计器。

直接接口到 statsforecast.models.ARCH。

这实现了自回归条件异方差 (ARCH) 模型。

构造一个 ARCH(p) 模型。

参数:
p: int (默认值 1)

AR 参数 - 自回归滞后项数。

属性:
cutoff

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

fh

传入的预测范围。

is_fitted

是否已调用 fit。

示例

>>> from sktime.datasets import load_airline
>>> from sktime.forecasting.arch import StatsForecastARCH
>>> y = load_airline()
>>> forecaster = StatsForecastARCH(p=2)
>>> forecaster.fit(y)
StatsForecastARCH(...)
>>> y_pred = forecaster.predict(fh=[1,2,3])

方法

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

检查对象是否由其他 BaseObjects 组成。

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict([fh, X])

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

predict_interval([fh, X, coverage])

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

predict_proba([fh, X, marginal])

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

predict_quantiles([fh, X, alpha])

计算/返回分位数预测结果。

predict_residuals([y, X])

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

predict_var([fh, X, cov])

计算/返回方差预测结果。

reset()

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

save([path, serialization_format])

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

score(y[, X, fh])

使用 MAPE（非对称）对预测结果进行评分。

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

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')[source]#

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

参数:
parameter_setstr, 默认值=”default”

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

返回:
paramsdict 或 dict 列表，默认值 = {}

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:
method_namestr, 可选

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

引发:
NotFittedError

如果估计器尚未拟合。

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 个元素是测试中第 i 个对象实例的名称。如果实例不止一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

property cutoff[source]#

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

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

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

property fh[source]#

传入的预测范围。

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

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

状态变化

状态变为“已拟合”。

写入自身

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

状态变化

状态变为“已拟合”。

写入自身

  • 设置以“_”结尾的已拟合模型属性，可通过 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")，则 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 的标签值，按以下降序优先顺序考虑标签覆盖：

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

获取自身的配置标志。

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

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

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

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

返回:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取已拟合的参数。

所需状态

需要状态为“fitted”。

参数:
deepbool, default=True

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

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

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

返回:
fitted_paramsdict with str-valued keys

拟合参数的字典， 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]#

获取对象的参数名称。

参数:
sortbool, default=True

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

返回:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deepbool, default=True

是否返回组件的参数。

  • 如果为 True，将为此对象返回一个参数名称 : 值 的 dict，包括组件（= BaseObject 值参数）的参数。

  • 如果为 False，将为此对象返回一个参数名称 : 值 的 dict，但不包括组件的参数。

返回:
paramsdict with str-valued keys

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

  • 始终：此对象的所有参数，如同通过 get_param_names 获取的值是此对象该键对应的参数值，值始终与构造时传递的值相同。

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

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

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

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

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

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

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

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

实例构造时设置的标签。

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

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

按继承顺序。

参数:
tag_namestr

要检索的标签名称

tag_value_defaultany type, optional; default=None

如果未找到标签时的默认/备用值

raise_errorbool

未找到标签时是否引发 ValueError

返回:
tag_valueAny

self 中 tag_name 标签的值。如果未找到，并且 raise_error 为 True，则引发错误；否则返回 tag_value_default。

引发:
如果 raise_error 为 True，则引发 ValueError。

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

检查对象是否由其他 BaseObjects 组成。

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

返回:
composite: bool

对象的任何参数值是否是 BaseObject 的后代实例。

property is_fitted[source]#

是否已调用 fit。

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

返回:
bool

估计器是否已经过 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialresult of ZipFile(path).open(“object)
返回:
反序列化后的 self，结果输出到 path，即 cls.save(path) 的输出。
classmethod load_from_serial(serial)[source]#

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

参数:
serial1st element of output of cls.save(None)
返回:
反序列化后的 self，结果输出 serial，即 cls.save(None) 的输出。
predict(fh=None, X=None)[source]#

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

所需状态

需要状态为“fitted”，即 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) 将其强制转换。

Xtime series in sktime compatible format, optional (default=None)

预测中使用的外生时间序列。应与 fit 中 y 的科学类型（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，格式相同（见上文）

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

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

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

所需状态

需要状态为“fitted”，即 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，它将在内部被强制转换为 ForecastingHorizon (通过 _check_fh)。

  • 如果 fh 是 int 或类似 int 数组的对象，它被解释为相对时间范围，并被强制转换为相对的 ForecastingHorizon(fh, is_relative=True)。

  • 如果 fh 的类型是 pd.Index，它被解释为绝对时间范围，并被强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

Xtime series in sktime compatible format, optional (default=None)

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

coveragefloat or list of float of unique values, optional (default=0.90)

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

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

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

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

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

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

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

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

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

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

注意

  • 当前仅针对 Series 类型（非面板、非层次）的 y 实现。

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

所需状态

需要状态为“fitted”，即 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，它将在内部被强制转换为 ForecastingHorizon (通过 _check_fh)。

  • 如果 fh 是 int 或类似 int 数组的对象，它被解释为相对时间范围，并被强制转换为相对的 ForecastingHorizon(fh, is_relative=True)。

  • 如果 fh 的类型是 pd.Index，它被解释为绝对时间范围，并被强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

Xtime series in sktime compatible format, optional (default=None)

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

marginalbool, optional (default=True)

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

返回:
pred_distskpro BaseDistribution

如果 marginal=True，则是预测分布；如果 marginal=False 并且方法支持，则将是联合分布。

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

计算/返回分位数预测结果。

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

所需状态

需要状态为“fitted”，即 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，它将在内部被强制转换为 ForecastingHorizon (通过 _check_fh)。

  • 如果 fh 是 int 或类似 int 数组的对象，它被解释为相对时间范围，并被强制转换为相对的 ForecastingHorizon(fh, is_relative=True)。

  • 如果 fh 的类型是 pd.Index，它被解释为绝对时间范围，并被强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

Xtime series in sktime compatible format, optional (default=None)

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

alphafloat or list of float of unique values, optional (default=[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

写入自身

无。

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

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

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

  • 如果前面仅有一个 fit 调用，则产生样本内残差。

  • 如果 fit 需要 fh，则它必须指向 fit 中 y 的索引。

Xtime series in sktime compatible format, optional (default=None)

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

返回:
y_restime series in sktime compatible data container format

fh 处的预测残差，与 fh 具有相同的索引。y_res 与最近传递的 y 具有相同的类型：Series, Panel, Hierarchical 科学类型，相同的格式（见上文）。

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

计算/返回方差预测结果。

所需状态

需要状态为“fitted”，即 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，它将在内部被强制转换为 ForecastingHorizon (通过 _check_fh)。

  • 如果 fh 是 int 或类似 int 数组的对象，它被解释为相对时间范围，并被强制转换为相对的 ForecastingHorizon(fh, is_relative=True)。

  • 如果 fh 的类型是 pd.Index，它被解释为绝对时间范围，并被强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

Xtime series in sktime compatible format, optional (default=None)

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

covbool, optional (default=False)

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

返回:
pred_varpd.DataFrame, format dependent on cov variable
如果 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 设置的配置值也会保留。

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

  • 超参数 = __init__ 的参数并写入 self，例如 self.paramname，其中 paramname 是 __init__ 的一个参数。

  • 包含双下划线的对象属性，即字符串“__”。例如，名为“__myattr”的属性会被保留。

  • 配置属性，配置会保持不变。也就是说，在 reset 之前和之后 get_config 的结果是相同的。

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

等同于 clone，区别在于 reset 会修改 self 而不是返回一个新对象。

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

返回:
self

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

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

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

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

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

参数:
pathNone or file location (str or Path)

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

  • path="estimator"，则将在当前工作目录创建一个 zip 文件 estimator.zip。

  • path="/home/stored/estimator"，则将在

/home/stored/ 中存储一个 zip 文件 estimator.zip。

serialization_format: str, default = “pickle”

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

返回:
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 引用该文件的 ZipFile 对象
score(y, X=None, fh=None)[source]#

使用 MAPE（非对称）对预测结果进行评分。

参数:
ypd.Series, pd.DataFrame, or np.ndarray (1D or 2D)

要评分的时间序列

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

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

Xpd.DataFrame, or 2D np.array, optional (default=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” (default), or “text”

jupyter 内核如何显示 self 实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, default=True

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

warningsstr, “on” (default), or “off”

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

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

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

backend:parallelstr, optional, default=”None”

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

  • “None”：顺序执行循环，简单的列表推导式

  • “loky”, “multiprocessing” 和 “threading”：使用 joblib.Parallel

  • “joblib”：自定义和第三方 joblib 后端，例如 spark

  • “dask”：使用 dask，需要在环境中安装 dask 包

  • “ray”：使用 ray，需要在环境中安装 ray 包

backend:parallel:paramsdict, optional, default={} (no parameters passed)

作为配置传递给并行化后端的附加参数。有效键取决于 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, default=True

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

返回:
selfreference to self.

注释

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:
**paramsdict

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

返回:
selfreference to self (after parameters have been set)
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

为自身设置 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

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

deepbool, default=True

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

  • 如果为 False，则仅设置 self 的 random_state 参数（如果存在）。

  • 如果为 True，则也会设置组件对象中的 random_state 参数。

self_policystr, one of {“copy”, “keep”, “new”}, default=”copy”

  • “copy”：self.random_state 设置为输入的 random_state

  • “keep”：self.random_state 保持不变

  • “new”：self.random_state 设置为一个新的随机状态，

从输入的 random_state 派生而来，通常与它不同。

返回:
selfreference to self
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:
**tag_dictdict

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

返回:
返回值

对 self 的引用。

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

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

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

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

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

所需状态

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

访问 self 中的内容

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

  • self.cutoff, self.is_fitted

写入自身

  • 将 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, 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 y.index。

update_paramsbool, optional (default=True)

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

返回:
selfreference to self
update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#

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

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

等同于以下操作（如果只有 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：仅更新截止点并记住数据

所需状态

需要状态为“fitted”，即 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

cvtemporal cross-validation generator inheriting from BaseSplitter, optional

继承自 BaseSplitter 的时间交叉验证生成器，可选；例如 SlidingWindowSplitter 或 ExpandingWindowSplitter；默认值为 ExpandingWindowSplitter，其 initial_window=1 且默认值表示 y/X 中的单个数据点逐个添加和预测，initial_window = 1，step_length = 1 和 fh = 1。

Xtime series in sktime compatible format, optional (default=None)

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

update_paramsbool, optional (default=True)

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

reset_forecasterbool, optional (default=True)

  • 是否重置预测器。如果为 True，则不更改预测器的状态，即更新/预测序列使用副本运行，并且 self 的截止点、模型参数、数据内存不更改。

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

返回:
y_predobject that tabulates point forecasts from multiple split batches

汇集来自多个分割批次点预测的对象。格式取决于总体预测的（截止点，绝对时间范围）对。

  • 如果绝对时间范围点的集合是唯一的：类型是 sktime 兼容数据容器格式的时间序列，输出中省略了截止点，与最近传递的 y 具有相同的类型：Series, Panel, Hierarchical 科学类型，相同的格式（见上文）。

  • 如果绝对时间范围点的集合不是唯一的：类型是 pandas DataFrame，行和列索引是时间戳。行索引对应于预测所用的截止点，列索引对应于预测的绝对时间范围。如果在该（截止点，时间范围）对下没有预测，则条目为 nan。

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

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

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

如果没有实现特定于估计器的更新方法，默认回退行为是先更新，然后预测。

所需状态

需要状态为“fitted”。

访问 self 中的内容

以“_”结尾的拟合模型属性。指向已见数据的指针，self._y 和 self.X。self.cutoff, self._is_fitted。如果 update_params=True，则更新以“_”结尾的模型属性。

写入自身

通过附加行更新 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 中传递，则必须传递，不可选。

Xtime series in sktime compatible format, optional (default=None)

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

update_paramsbool, optional (default=True)

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

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

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