HierarchicalProphet#

class HierarchicalProphet(trend='linear', changepoint_interval: int = 25, changepoint_range: float | int = 0.8, changepoint_prior_scale: float = 0.001, offset_prior_scale: float = 0.1, capacity_prior_scale: float = 0.2, capacity_prior_loc: float = 1.1, feature_transformer=None, exogenous_effects: list | None = None, default_effect=None, shared_features: list[str] = None, mcmc_samples: int = 2000, mcmc_warmup: int = 200, mcmc_chains: int = 4, inference_method: str = 'map', optimizer_name: str = 'Adam', optimizer_kwargs: dict[str, Any] | None = None, optimizer_steps: int = 100000, noise_scale: float = 0.05, correlation_matrix_concentration: float = 1.0, rng_key=None)[source]#

一个基于 Meta Prophet 的贝叶斯分层时间序列预测模型。

该方法一次性预测层次结构中所有底层序列，使用 MultivariateNormal 作为似然函数，并使用 LKJ 先验来处理相关矩阵。

如果您想在多个序列之间拟合共享系数，此预测器会特别有用。在这种情况下，shared_features 参数应是一个特征名称列表，这些特征应具有该行为。

参数:
trendUnion[str, BaseEffect]，可选，默认为 “linear”

要使用的趋势类型。也可以是自定义效应对象。

changepoint_intervalint，可选，默认为 25

在历史数据中采样的潜在变点数量。

changepoint_rangeUnion[float, int]，可选，默认为 0.8

用于估计趋势变点的历史数据比例。

  • 如果为 float 类型，必须在 0 到 1 之间（包含）。范围将是训练历史的该比例。

  • 如果为 int 类型，可以是正数或负数。绝对值必须小于训练点的数量。范围将是该点数。负整数表示从历史末尾开始计数的点数，正整数表示从历史开头开始计数的点数。

changepoint_prior_scalefloat，可选，默认为 0.001

控制自动变点选择灵活性的正则化参数。

offset_prior_scalefloat，可选，默认为 0.1

偏移量先验分布的尺度参数。偏移量是分段趋势方程中的常数项。

capacity_prior_scalefloat，可选，默认为 0.2

容量先验分布的尺度参数。

capacity_prior_locfloat，可选，默认为 1.1

容量先验分布的位置参数。

feature_transformerBaseTransformer 或 None，可选，默认为 None

用于预处理外生特征的转换器。

exogenous_effectsAbstractEffect 列表 或 None，可选，默认为 None

定义模型中使用的外生效应的列表。

default_effectAbstractEffect 或 None，可选，默认为 None

当未为变量指定效应时使用的默认效应。

shared_featureslist，可选，默认为 []

在层次结构中所有序列之间共享的特征列表。

mcmc_samplesint，可选，默认为 2000

要抽取的 MCMC 样本数量。

mcmc_warmupint，可选，默认为 200

MCMC 的热身步数。

mcmc_chainsint，可选，默认为 4

MCMC 链的数量。

inference_methodstr，可选，默认为 ‘map’

要使用的推断方法。“map” 或 “mcmc”。

optimizer_namestr，可选，默认为 ‘Adam’

要使用的优化器名称。

optimizer_kwargsdict 或 None，可选，默认为 {‘step_size’: 1e-4}

优化器的附加关键字参数。

optimizer_stepsint，可选，默认为 100_000

优化步数。

noise_scalefloat，可选，默认为 0.05

噪声的尺度参数。

correlation_matrix_concentrationfloat，可选，默认为 1.0

相关矩阵的集中度参数。

rng_keyjax.random.PRNGKey 或 None，可选，默认为 None

随机数生成器密钥。

属性:
cutoff

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

fh

传递的预测期。

is_fitted

是否已调用 fit。

示例

>>> from sktime.forecasting.naive import NaiveForecaster
>>> from sktime.transformations.hierarchical.aggregate import Aggregator
>>> from sktime.utils._testing.hierarchical import _bottom_hier_datagen
>>> from sktime.forecasting.prophetverse import HierarchicalProphet
>>> agg = Aggregator()
>>> y = _bottom_hier_datagen(
...     no_bottom_nodes=3,
...     no_levels=1,
...     random_seed=123,
...     length=7,
... )
>>> y = agg.fit_transform(y)
>>> forecaster = HierarchicalProphet()
>>> forecaster.fit(y)
>>> forecaster.predict(fh=[1])

方法

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

返回 skbase 对象的测试参数设置。

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

使用新数据更新模型并进行预测。
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 查看。

参数:
estimatorBaseObject 或派生类的实例
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]#

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

状态改变

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

写入自身

  • 设置以“_”结尾的拟合模型属性，拟合属性可通过 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 (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，Series 类型的 pd.DataFrame list。

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

有关数据格式的更多详细信息，请参阅 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自身引用。
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 (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，Series 类型的 pd.DataFrame list。

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

有关数据格式的更多详细信息，请参阅 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）

用于预测的外生时间序列。如果传递，将用于 predict 而不是 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 的键值对，通常用作控制行为的瞬时标志。

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 的字典

拟合参数的字典，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，默认为 True

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

返回:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deepbool，默认为 True

是否返回组件的参数。

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

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

返回:
params键为 str 的字典

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

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

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

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

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

在实例构造时。

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

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

按继承顺序排列。

返回:
collected_tags字典

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

类方法 get_test_params(parameter_set='default')[source]#

返回 skbase 对象的测试参数设置。

get_test_params 是一个统一接口点，用于存储用于测试目的的参数设置。此函数也用于 create_test_instance 和 create_test_instances_and_names 来构造测试实例。

get_test_params 应返回单个 dict，或一个 list 的 dict。

每个 dict 都是用于测试的参数配置，可用于构造一个“有趣的”测试实例。对于 get_test_params 返回中的所有字典 params，调用 cls(**params) 应该是有效的。

get_test_params 不必返回固定的字典列表，它也可以返回动态或随机的参数设置。

参数:
parameter_setstr，默认为 “default”

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

返回:
params字典或字典列表，默认 = {}

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

is_composite()[source]#

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

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

返回:
复合对象：布尔值

对象是否有任何参数的值是 BaseObject 的派生实例。

属性 is_fitted[source]#

是否已调用 fit。

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

返回:
布尔值

估计器是否已 fit。

类方法 load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object”) 的结果
返回:
反序列化 self，其输出位于 path，由 cls.save(path) 生成
类方法 load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第1个元素
返回:
反序列化 self，其输出为 serial，由 cls.save(None) 生成
predict(fh=None, X=None)[source]#

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

所需状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入自身

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

参数:
fhint, list, 可强制转换为 pd.Index，或 ForecastingHorizon，默认为 None

预测 horizons，它编码了要预测的时间戳。如果已在 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") 为 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 是可迭代的，则将计算多个区间。

所需状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入自身

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

参数:
fhint, list, 可强制转换为 pd.Index，或 ForecastingHorizon，默认为 None

预测 horizons，它编码了要预测的时间戳。如果已在 fit 中传递过，则不应再次传递。如果未在 fit 中传递过，则必须传递，不是可选的

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

  • 如果 fh 是 int 或 int 数组类型，则解释为相对 horizons，并强制转换为相对 ForecastingHorizon(fh, is_relative=True)。

  • 如果 fh 是 pd.Index 类型，则解释为绝对 horizons，并强制转换为绝对 ForecastingHorizon(fh, is_relative=False)。

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

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

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

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

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

顺序与输入 coverage 相同。

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

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

来自 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 (非 Panel, 非 Hierarchical) y 实现。

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

所需状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入自身

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

参数:
fhint, list, 可强制转换为 pd.Index，或 ForecastingHorizon，默认为 None

预测 horizons，它编码了要预测的时间戳。如果已在 fit 中传递过，则不应再次传递。如果未在 fit 中传递过，则必须传递，不是可选的

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

  • 如果 fh 是 int 或 int 数组类型，则解释为相对 horizons，并强制转换为相对 ForecastingHorizon(fh, is_relative=True)。

  • 如果 fh 是 pd.Index 类型，则解释为绝对 horizons，并强制转换为绝对 ForecastingHorizon(fh, is_relative=False)。

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

用于预测的外生时间序列。应与 fit 中 y 的 scitype (Series, Panel, 或 Hierarchical) 相同。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 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

写入自身

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

参数:
fhint, list, 可强制转换为 pd.Index，或 ForecastingHorizon，默认为 None

预测 horizons，它编码了要预测的时间戳。如果已在 fit 中传递过，则不应再次传递。如果未在 fit 中传递过，则必须传递，不是可选的

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

  • 如果 fh 是 int 或 int 数组类型，则解释为相对 horizons，并强制转换为相对 ForecastingHorizon(fh, is_relative=True)。

  • 如果 fh 是 pd.Index 类型，则解释为绝对 horizons，并强制转换为绝对 ForecastingHorizon(fh, is_relative=False)。

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

用于预测的外生时间序列。应与 fit 中 y 的 scitype (Series, Panel, 或 Hierarchical) 相同。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 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

写入自身

无。

参数:
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 scitype，格式相同 (见上文)

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

计算/返回方差预测。

所需状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入自身

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

参数:
fhint, list, 可强制转换为 pd.Index，或 ForecastingHorizon，默认为 None

预测 horizons，它编码了要预测的时间戳。如果已在 fit 中传递过，则不应再次传递。如果未在 fit 中传递过，则必须传递，不是可选的

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

  • 如果 fh 是 int 或 int 数组类型，则解释为相对 horizons，并强制转换为相对 ForecastingHorizon(fh, is_relative=True)。

  • 如果 fh 是 pd.Index 类型，则解释为绝对 horizons，并强制转换为绝对 ForecastingHorizon(fh, is_relative=False)。

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

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

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

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

返回:
pred_varpd.DataFrame，格式取决于 cov 变量
如果 cov=False
列名与 fit/update 中传递的 y 完全相同。

对于无名格式，列索引将是 RangeIndex。

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

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

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

条目是方差预测，对于列索引中的变量。给定变量和 fh 索引的方差预测是对该变量和索引的预测方差，给定观测数据。

如果 cov=True
列索引是多级索引：第一级是变量名称 (如上)

第二级是 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]#

将序列化的自身保存到字节类对象或到 (.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/。

序列化格式：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”) 为 True，则 X.index 必须包含 y.index

返回:
score浮点数

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

另请参阅

sktime.performance_metrics.forecasting.mean_absolute_percentage_error
set_config(**config_dict)[source]#

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

参数:
config_dictdict

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

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

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_only布尔值，默认=True

打印 self 时是仅列出与默认值不同的 self 参数 (True)，还是列出所有参数名称和值 (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

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

返回:
self对 self 的引用。

注释

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:
**params字典

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

返回:
self对 self 的引用 (参数设置后)
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 从链式哈希中采样，并保证 seeded 随机生成器的伪随机独立性。

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

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

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

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

deepbool，默认为 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 派生，并且通常与它不同

返回:
self对 self 的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:
**tag_dict字典

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

返回:
Self

对 self 的引用。

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

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

如果未实现估计器特定的 update 方法，则默认备用行为如下：

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

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

所需状态

要求状态为“已拟合”，即 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 (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，Series 类型的 pd.DataFrame list。

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

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

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

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

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

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

返回:
self对 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 方法，则默认备用行为如下：

  • 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 (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，Series 类型的 pd.DataFrame list。

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

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

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

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

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

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

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

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

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

  • 如果绝对 horizon 点的集合是唯一的：类型是 sktime 兼容数据容器格式的时间序列，输出中省略 cutoff，类型与最近传递的 y 相同：Series, Panel, Hierarchical scitype，格式相同 (见上文)

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

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

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

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

如果未实现估计器特定的 update 方法，则默认备用行为是先 update，然后 predict。

所需状态

要求状态为“已拟合”。

在 self 中访问

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

写入自身

通过追加行，使用 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 = 时间序列集合，全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，Series 类型的 pd.DataFrame list。

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

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

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

预测 horizons，它编码了要预测的时间戳。如果已在 fit 中传递过，则不应再次传递。如果未在 fit 中传递过，则必须传递，不是可选的

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

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

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

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

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

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