Prophetverse#

class Prophetverse(changepoint_interval: int = 25, changepoint_range: float = 0.8, changepoint_prior_scale: float = 0.001, offset_prior_scale: float = 0.1, feature_transformer=None, capacity_prior_scale: float = 0.2, capacity_prior_loc: float = 1.1, noise_scale: float = 0.05, trend: str = 'linear', 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, exogenous_effects: list | None = None, default_effect=None, scale: float = None, rng_key=None)[source]#

单变量 Prophetverse 预测器 - 在 numpyro 中实现的 Prophet 模型。

来自 felipeangelimvieira 开发的 prophetverse 包的估计器。

与 Facebook Prophet 的区别

  • 逻辑趋势。此处考虑了另一种参数化，容量不作为输入传递，而是从数据中推断。

  • 用户可以将任意 sktime 转换器作为 feature_transformer 传递，例如 FourierFeatures 或 HolidayFeatures。

  • 没有默认的 weekly_seasonality/yearly_seasonality，这由用户通过 feature_transformer 参数设置

  • 使用 changepoint_interval 而非 n_changepoints 来设置变点。

  • 接受每种外生变量都有不同函数来关联其对时间序列的加性效应的配置。例如，可以为一组特征设置不同的先验，或使用 Hill 函数来建模特征的效应。

参数：
changepoint_intervalint, optional, default=25

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

changepoint_rangefloat 或 int, optional, default=0.8

估计趋势变点的历史比例。

  • 如果是 float，必须介于 0 和 1 之间。范围将是训练历史的该比例。

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

changepoint_prior_scalefloat, optional, default=0.001

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

offset_prior_scalefloat, optional, default=0.1

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

feature_transformersktime transformer, BaseTransformer, optional, default=None

用于生成傅里叶项、假日或其他特征的转换器对象。如果为 None，则不使用额外的特征。对于多个特征，传递一个包含转换器的 FeatureUnion 对象。

capacity_prior_scalefloat, optional, default=0.2

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

capacity_prior_locfloat, optional, default=1.1

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

noise_scalefloat, optional, default=0.05

观测噪声的尺度参数。

trendstr, optional, “linear”（默认）或“logistic”之一

要使用的趋势类型。可以是“linear”或“logistic”。

mcmc_samplesint, optional, default=2000

要抽取的 MCMC 样本数量。

mcmc_warmupint, optional, default=200

MCMC 预热步数。也称为 burn-in。

mcmc_chainsint, optional, default=4

并行运行的 MCMC 链数量。

inference_methodstr, optional, “mcmc”或“map”之一, default=”map”

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

optimizer_namestr, optional, default=”Adam”

用于变分推断的 numpyro 优化器名称。

optimizer_kwargsdict, optional, default={}

要传递给 numpyro 优化器的额外关键字参数。

optimizer_stepsint, optional, default=100_000

变分推断要执行的优化步数。

exogenous_effectsList[AbstractEffect], optional, default=None

定义模型中使用的外生效应的 prophetverse AbstractEffect 对象列表。

default_effectAbstractEffectm optional, default=None

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

default_exogenous_priortuple, default=None

外生效应的默认先验分布。

rng_keyjax.random.PRNGKey 或 None (default

随机数生成器密钥。

属性：
cutoff

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

fh

已传递的预测范围。

is_fitted

是否已调用 fit。

示例

>>> from sktime.datasets import load_airline
>>> from sktime.forecasting.prophetverse import Prophetverse
>>> from prophetverse.effects.fourier import LinearFourierSeasonality
>>> from prophetverse.utils.regex import no_input_columns
>>> y = load_airline()
>>> model = Prophetverse(
...     exogenous_effects=[
...         (
...             "seasonality",
...             LinearFourierSeasonality(
...                 sp_list=[12],
...                 fourier_terms_list=[3],
...                 freq="M",
...                 effect_mode="multiplicative",
...             ),
...             no_input_columns,
...         )
...     ],
... )
>>> model.fit(y)
>>> model.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()

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

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

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

score(y[, X, fh])

使用 MAPE（非对称）对预测进行评分，与真实值对照。

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

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

用新数据更新模型并进行预测。
check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数：
method_namestr, optional

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

引发：
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 或 list of str, default = None

要克隆的标签名称。默认值（None）克隆来自 estimator 的所有标签。

返回：
self

对 self 的引用。

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

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

参数：
parameter_setstr, default=”default”

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

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

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

参数：
parameter_setstr, default=”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]#

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

状态变化

状态变为“已拟合”。

写入 self

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

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

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

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

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

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

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

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

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

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

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

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

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

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

状态变化

状态变为“已拟合”。

写入 self

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

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

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

  • 将 fh 存储到 self.fh。

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

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

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

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

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 带 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list of 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 兼容格式的时间序列，可选 (default=None)。

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

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

预测中使用的外生时间序列。如果传递，将在 predict 中使用而不是 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]#

获取 self 的配置标志。

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

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

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

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

返回：
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取拟合参数。

必需的状态

需要状态为“已拟合”。

参数：
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 对象属性收集任何覆盖和新标签。

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

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

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

get_test_params 应该返回一个单独的 dict 或一个 dict 列表。

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

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

参数：
parameter_setstr, default=”default”

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

返回：
paramsdict or list of dict, default = {}

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

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，产生 cls.save(path) 在 path 的输出。
classmethod load_from_serial(serial)[source]#

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

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

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

必需的状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入 self

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

参数：
fhint, list, 可强制转换为 pd.Index，或 ForecastingHorizon, default=None

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

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

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

用于预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型 (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

写入 self

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

参数：
fhint, list, 可强制转换为 pd.Index，或 ForecastingHorizon, default=None

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

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

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

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

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

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

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

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

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

与输入 coverage 的顺序相同。

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

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

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

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

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

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

计算/返回完整的概率预测。

注意

  • 当前仅对 Series（非面板、非分层）y 实现。

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

必需的状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入 self

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

参数：
fhint, list, 可强制转换为 pd.Index，或 ForecastingHorizon, default=None

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

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

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

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

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

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

marginalbool, optional (default=True)

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

返回：
pred_distskpro BaseDistribution

预测分布 如果 marginal=True，将是按时间点的边际分布 如果 marginal=False 并且方法已实现，将是联合分布

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

计算/返回分位数预测。

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

必需的状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入 self

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

参数：
fhint, list, 可强制转换为 pd.Index，或 ForecastingHorizon, default=None

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

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

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

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

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

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

条目是分位数预测，对于列索引中的 var，

在第二个列索引中的分位数概率处，对于行索引。

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

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

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

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

必需的状态

需要状态为“已拟合”。如果已设置 fh，则必须与 y 的索引（pandas 或整数）对应。

在 self 中访问

以“_”结尾的已拟合模型属性。self.cutoff, self._is_fitted

写入 self

无。

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

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

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

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

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

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

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

返回：
y_ressktime 兼容数据容器格式的时间序列

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

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

计算/返回方差预测。

必需的状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入 self

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

参数：
fhint, list, 可强制转换为 pd.Index，或 ForecastingHorizon, default=None

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

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

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

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

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

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

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

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

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

第二级是 fh。

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

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

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

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

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

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，则返回内存中的序列化 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。

存储在 /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, or np.ndarray (1D or 2D)

要评分的时间序列

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

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

Xpd.DataFrame, or 2D np.array, optional (default=None)

用于评分的外生时间序列 如果 self.get_tag(“X-y-must-have-same-index”)，X.index 必须包含 y.index

返回：
scorefloat

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

另请参阅

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

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

参数：
config_dictdict

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

displaystr, “diagram” (default), or “text”

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, default=True

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

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>），也可以使用不带 <component>__ 的字符串 <parameter>。

参数：
**paramsdict

BaseObject 参数，键必须是 <component>__<parameter> 字符串。__ 后缀可以在 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

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

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，并且通常与它不同

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

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

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

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

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

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

当前标签值可以通过 get_tags 或 get_tag 进行检查。

参数：
**tag_dict**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

写入 self

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

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

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

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

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

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

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

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

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

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

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

update_paramsbool, optional (default=True)

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

返回：
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：仅更新截止点和记住数据

必需的状态

需要状态为“已拟合”，即 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 of Series 类型的 pd.DataFrame

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

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

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

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

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

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

update_paramsbool, optional (default=True)

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

reset_forecasterbool, optional (default=True)

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

  • 如果为 False，当运行 update/predict 序列时，将更新 self，如同直接调用 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。

必需的状态

需要状态为“已拟合”。

在 self 中访问

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

写入 self

通过追加行更新 self._y 和 self._X，使用 y 和 X。将 self.cutoff 和 self._cutoff 更新为在 y 中看到的最后一个索引。如果 update_params=True，

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

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

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

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

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

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

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

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

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

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

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

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

update_paramsbool, optional (default=True)

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

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

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