PytorchForecastingDeepAR#

class PytorchForecastingDeepAR(model_params: dict[str, Any] | None = None, allowed_encoder_known_variable_names: list[str] | None = None, dataset_params: dict[str, Any] | None = None, train_to_dataloader_params: dict[str, Any] | None = None, validation_to_dataloader_params: dict[str, Any] | None = None, trainer_params: dict[str, Any] | None = None, model_path: str | None = None, deterministic: bool = False, random_log_path: bool =False, broadcasting: bool = False)[source]#

pytorch-forecasting 的 DeepAR 模型。

参数:

model_paramsdict[str, Any] (默认=None): 用于初始化 pytorch-forecasting NBeats 模型的参数 [1] 例如：{“cell_type”: “GRU”, “rnn_layers”: 3}
dataset_paramsdict[str, Any] (默认=None): 用于从 pandas.DataFrame 初始化 TimeSeriesDataSet 的参数 [2] max_prediction_length 将根据 fh 覆盖，time_idx, target, group_ids, time_varying_known_reals, time_varying_unknown_reals 将从数据推断，因此您无需传递它们
train_to_dataloader_paramsdict[str, Any] (默认=None): 用于传递给 TimeSeriesDataSet.to_dataloader() 的参数默认为 {“train”: True}
validation_to_dataloader_paramsdict[str, Any] (默认=None): 用于传递给 TimeSeriesDataSet.to_dataloader() 的参数默认为 {“train”: False}
model_path: string (默认=None): 尝试加载现有模型而不进行拟合。仍然需要调用 fit 函数，但不会执行实际的拟合。
deterministic: bool (默认=False): 在预测前设置种子，以便对于相同的输入，它将给出相同的输出。
random_log_path: bool (默认=False): 使用随机根目录进行日志记录。此参数用于 Github actions 中的 CI 测试，不适用于最终用户。

属性:

algorithm_class

导入底层的 pytorch-forecasting 算法类。

algorithm_parameters

获取 DeepAR 类的关键字参数。

dict: 底层算法类的关键字参数

cutoff

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

fh

传递的预测范围。

is_fitted

是否已调用 fit。

参考

[1]

https://pytorch-forecasting.readthedocs.io/en/stable/api/pytorch_forecasting.models.nbeats.NBeats.html

[2]

https://pytorch-forecasting.readthedocs.io/en/stable/api/pytorch_forecasting.data.timeseries.TimeSeriesDataSet.html

示例

>>> # import packages
>>> from sktime.forecasting.base import ForecastingHorizon
>>> from sktime.forecasting.pytorchforecasting import PytorchForecastingDeepAR
>>> from sktime.utils._testing.hierarchical import _make_hierarchical
>>> from sklearn.model_selection import train_test_split
>>> # generate random data
>>> data = _make_hierarchical(
...     hierarchy_levels=(5, 200), max_timepoints=50, min_timepoints=50, n_columns=3
... )
>>> # define forecast horizon
>>> max_prediction_length = 5
>>> fh = ForecastingHorizon(range(1, max_prediction_length + 1), is_relative=True)
>>> # split X, y data for train and test
>>> x = data[["c0", "c1"]]
>>> y = data["c2"].to_frame()
>>> X_train, X_test, y_train, y_test = train_test_split(
...     x, y, test_size=0.2, train_size=0.8, shuffle=False
... )
>>> len_levels = len(y_test.index.names)
>>> y_test = y_test.groupby(level=list(range(len_levels - 1))).apply(
...     lambda x: x.droplevel(list(range(len_levels - 1))).iloc[:-max_prediction_length]
... )
>>> # define the model
>>> model = PytorchForecastingDeepAR(
...     trainer_params={
...         "max_epochs": 5,  # for quick test
...         "limit_train_batches": 10,  # for quick test
...     },
... )
>>> # fit and predict
>>> model.fit(y=y_train, X=X_train, fh=fh) # doctest skip
PytorchForecastingDeepAR(trainer_params={'limit_train_batches': 10,
                                        'max_epochs': 5})
>>> y_pred = model.predict(fh, X=X_test, y=y_test)
>>> print(y_test)
                            c2
h0   h1     time
h0_0 h1_180 2000-01-01  5.006716
            2000-01-02  5.197903
            2000-01-03  4.477552
            2000-01-04  4.751521
            2000-01-05  3.323994
...                          ...
h0_4 h1_199 2000-02-10  5.590399
            2000-02-11  5.595445
            2000-02-12  4.915307
            2000-02-13  4.726925
            2000-02-14  5.482842

[4500 行 x 1 列] >>> print(y_pred)

c2

h0 h1 time h0_0 h1_180 2000-02-15 4.919366

2000-02-16 4.862666 2000-02-17 5.021425 2000-02-18 4.934844 2000-02-19 4.808967

… … h0_4 h1_199 2000-02-15 5.150748

2000-02-16 5.230827 2000-02-17 5.123736 2000-02-18 5.139505 2000-02-19 5.121511

[500 行 x 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`()	获取 self 的配置标志。
`get_fitted_params`([deep])	获取已拟合的参数。
`get_param_defaults`()	获取对象的默认参数。
`get_param_names`([sort])	获取对象的参数名称。
`get_params`([deep])	获取此对象的参数值字典。
`get_tag`(tag_name[, tag_value_default, ...])	从实例获取标签值，具有标签级别继承和覆盖。
`get_tags`()	从实例获取标签，具有标签级别继承和覆盖。
`get_test_params`([parameter_set])	返回评估器的测试参数设置。
`is_composite`()	检查对象是否由其他 BaseObjects 组成。
`load_from_path`(serial)	从文件位置加载对象。
`load_from_serial`(serial)	从序列化内存容器加载对象。
`predict`([fh, X, y])	在未来范围预测时间序列。
`predict_interval`([fh, X, coverage, y])	计算/返回预测区间预测。
`predict_proba`([fh, X, marginal, y])	计算/返回完全概率预测。
`predict_quantiles`([fh, X, alpha, y])	计算/返回分位数预测。
`predict_residuals`([y, X])	返回时间序列预测的残差。
`predict_var`([fh, X, cov, y])	计算/返回方差预测。
`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])	使用新数据更新模型并进行预测。

property algorithm_class[source]#: 导入底层的 pytorch-forecasting 算法类。

property algorithm_parameters: dict[source]#

获取 DeepAR 类的关键字参数。

返回:

dict: 底层算法类的关键字参数

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

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

参数:

parameter_setstr, 默认=”default”: 要返回的测试参数集的名称，用于测试。如果未为值定义特殊参数，将返回 "default" 集。目前预测器没有保留值。

返回:

paramsdict 或 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 的默认值 (None) 将 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]#

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

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

写入 self

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

将 self.is_fitted 标志设置为 True。

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

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

参数:

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

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

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

Series scitype = 个体时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。具有两级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame 列表。
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)。

用于拟合模型的外生时间序列。应与 y 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 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 = 时间序列集合，全局/面板预测。具有两级行 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)。

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

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

用于预测的外生时间序列。如果传递，将在预测中使用，而不是 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 的标签值，考虑标签覆盖，优先级降序排列如下：

在类的 _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]#

获取已拟合的参数。

所需状态: 要求状态为“已拟合”。

参数:

deepbool, 默认=True

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

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

返回:

fitted_params键为 str 的 dict

已拟合参数字典，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键为字符串的 dict

参数字典，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 的单个标签的值，同时考虑标签覆盖，优先级顺序如下（由高到低）

通过实例上的 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。

引发:

如果 raise_error 为 True，则引发 ValueError。: 如果 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]#

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

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

返回:

composite: bool: 对象是否具有任何参数，其值是 BaseObject 的后代实例。

property is_fitted[source]#

是否已调用 fit。

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

返回:

bool: 估计器是否已 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:

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

返回:

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

classmethod load_from_serial(serial)[source]#

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

参数:

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

返回:

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

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

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

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

在 self 中访问

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

self.cutoff, self.is_fitted

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

参数:

fhint, list, pd.Index 可强制转换，或 ForecastingHorizon, 默认=None: 编码预测时间戳的预测范围。如果在 fit 中已经传入过，则不应再传入。如果在 fit 中未传入，则必须传入，非可选。
Xsktime 兼容格式的时间序列，可选 (默认值=None): 在预测中使用的外生时间序列。应与 fit 中的 y 具有相同的 scitype (Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。如果未传入 y (不执行全局预测)，则 X 应仅包含待预测的时间点。如果传入了 y (执行全局预测)，则 X 必须包含所有历史值和待预测的时间点。
ysktime 兼容格式的时间序列，可选 (默认值=None): 待预测时间序列的历史值。如果不是 None，则将执行全局预测。仅传入历史值，而非待预测的时间点。

返回:

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

注意

如果 y 不是 None，将执行全局预测。在全局预测模式下，X 应包含所有历史值和待预测的时间点，而 y 应仅包含历史值，而非待预测的时间点。

如果 y 是 None，将执行非全局预测。在非全局预测模式下，X 应仅包含待预测的时间点，而 y 应仅包含历史值，而非待预测的时间点。

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

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

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

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

在 self 中访问

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

self.cutoff, self.is_fitted

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

参数:

fhint, list, np.array 或 ForecastingHorizon，可选 (默认值=None): 编码预测时间戳的预测范围。如果在 fit 中已经传入过，则不应再传入。如果在 fit 中未传入，则必须传入，非可选。
Xsktime 兼容格式的时间序列，可选 (默认值=None): 用于预测的外生时间序列。应与 fit 中的 y 具有相同的 scitype (Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。如果传入了 y (执行全局预测)，则 X 必须包含所有历史值和待预测的时间点。
coveragefloat 或包含唯一 float 值的列表，可选 (默认值=0.90): 预测区间(们)的名义覆盖率
ysktime 兼容格式的时间序列，可选 (默认值=None): 待预测时间序列的历史值。如果不是 None，则将执行全局预测。仅传入历史值，而非待预测的时间点。

返回:

pred_intpd.DataFrame

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

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

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

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

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

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

对于列索引中的 var，在第二级列索引指定的名义覆盖率下，根据第三级列索引确定是下限/上限，对应于行索引。上限/下限区间预测等同于在 alpha = 0.5 - c/2, 0.5 + c/2 (其中 c 在 coverage 中) 处的分位数预测。

注意

如果 y 不是 None，将执行全局预测。在全局预测模式下，X 应包含所有历史值和待预测的时间点，而 y 应仅包含历史值，而非待预测的时间点。

如果 y 是 None，将执行非全局预测。在非全局预测模式下，X 应仅包含待预测的时间点，而 y 应仅包含历史值，而非待预测的时间点。

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

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

注意：目前仅针对 Series (非 Panel，非 Hierarchical) y 实现。

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

在 self 中访问

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

self.cutoff, self.is_fitted

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

参数:

fhint, list, np.array 或 ForecastingHorizon，可选 (默认值=None): 编码预测时间戳的预测范围。如果在 fit 中已经传入过，则不应再传入。如果在 fit 中未传入，则必须传入，非可选。
Xsktime 兼容格式的时间序列，可选 (默认值=None): 用于预测的外生时间序列。应与 fit 中的 y 具有相同的 scitype (Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。如果传入了 y (执行全局预测)，则 X 必须包含所有历史值和待预测的时间点。
marginalbool，可选 (默认值=True): 返回的分布是否是按时间索引的边际分布
ysktime 兼容格式的时间序列，可选 (默认值=None): 待预测时间序列的历史值。如果不是 None，则将执行全局预测。仅传入历史值，而非待预测的时间点。

返回:

pred_distsktime BaseDistribution: 预测分布。如果 marginal=True，则为按时间点的边际分布；如果 marginal=False 且方法已实现，则为联合分布。

注意

如果 y 不是 None，将执行全局预测。在全局预测模式下，X 应包含所有历史值和待预测的时间点，而 y 应仅包含历史值，而非待预测的时间点。

如果 y 是 None，将执行非全局预测。在非全局预测模式下，X 应仅包含待预测的时间点，而 y 应仅包含历史值，而非待预测的时间点。

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

计算/返回分位数预测。

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

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

在 self 中访问

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

self.cutoff, self.is_fitted

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

参数:

fhint, list, np.array 或 ForecastingHorizon，可选 (默认值=None): 编码预测时间戳的预测范围。如果在 fit 中已经传入过，则不应再传入。如果在 fit 中未传入，则必须传入，非可选。
Xsktime 兼容格式的时间序列，可选 (默认值=None): 用于预测的外生时间序列。应与 fit 中的 y 具有相同的 scitype (Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。如果传入了 y (执行全局预测)，则 X 必须包含所有历史值和待预测的时间点。
alphafloat 或包含唯一 float 值的列表，可选 (默认值=[0.05, 0.95]): 计算分位数预测的概率或概率列表。
ysktime 兼容格式的时间序列，可选 (默认值=None): 待预测时间序列的历史值。如果不是 None，则将执行全局预测。仅传入历史值，而非待预测的时间点。

返回:

quantilespd.DataFrame

列具有多级索引：第一级是在 fit 中 y 的变量名，: 第二级是传递给函数的 alpha 值。
行索引是 fh，附加的（上层）级别等于实例级别，: 来自 fit 中看到的 y，如果 fit 中看到的 y 是 Panel 或 Hierarchical 类型。
条目是分位数预测，对于列索引中的 var，: 在第二级列索引指定的分位数概率处，对应于行索引。

注意

如果 y 不是 None，将执行全局预测。在全局预测模式下，X 应包含所有历史值和待预测的时间点，而 y 应仅包含历史值，而非待预测的时间点。

如果 y 是 None，将执行非全局预测。在非全局预测模式下，X 应仅包含待预测的时间点，而 y 应仅包含历史值，而非待预测的时间点。

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
写入 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 scitype，相同格式（参见上文）

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

计算/返回方差预测。

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

在 self 中访问

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

self.cutoff, self.is_fitted

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

参数:

fhint, list, np.array 或 ForecastingHorizon，可选 (默认值=None): 编码预测时间戳的预测范围。如果在 fit 中已经传入过，则不应再传入。如果在 fit 中未传入，则必须传入，非可选。
Xsktime 兼容格式的时间序列，可选 (默认值=None): 用于预测的外生时间序列。应与 fit 中的 y 具有相同的 scitype (Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。
covbool，可选 (默认值=False): 如果为 True，计算协方差矩阵预测。如果为 False，计算边际方差预测。
ysktime 兼容格式的时间序列，可选 (默认值=None): 待预测时间序列的历史值。如果不是 None，则将执行全局预测。仅传入历史值，而非待预测的时间点。

返回:

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

如果 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，以及: 行和列中时间索引之间的协方差。

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

注意

如果 y 不是 None，将执行全局预测。在全局预测模式下，X 应包含所有历史值和待预测的时间点，而 y 应仅包含历史值，而非待预测的时间点。

如果 y 是 None，将执行非全局预测。在非全局预测模式下，X 应仅包含待预测的时间点，而 y 应仅包含历史值，而非待预测的时间点。

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 或文件位置 (str 或 Path)

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

path=”estimator”，则会在当前工作目录创建 zip 文件 estimator.zip。
path=”/home/stored/estimator”，则会在 /home/stored/ 中创建 zip 文件 estimator.zip。

存储在 /home/stored/ 中。

serialization_format: 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。

返回:

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 如何显示 self 的实例

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

print_changed_onlybool, 默认值=True

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

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”: bool, 默认值=True; False 防止 ray 在并行处理后
  关闭。
- “logger_name”: str, 默认值=”ray”; 要使用的日志记录器名称。
- “mute_warnings”: bool, 默认值=False; 如果为 True，则抑制警告

remember_databool, 默认值=True

是否在 fit 中存储 self._X 和 self._y，并在 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 实例或 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对 self 的引用

set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:

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

返回:

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 = 时间序列集合，全局/面板预测。具有两级行 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 具有相同的 scitype (Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 y.index。

update_paramsbool, 可选 (默认值=True)

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

返回:

self对 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: 仅更新截止点并记住数据

所需状态: 要求状态为“已拟合”，即 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 = 时间序列集合，全局/面板预测。具有两级行 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 具有相同的 scitype (Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。

update_paramsbool, 可选 (默认值=True)

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

reset_forecasterbool, 可选 (默认值=True)

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

返回:

y_pred用于以表格形式呈现来自多个分割批次的点预测的对象

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

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

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

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

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

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

所需状态: 要求状态为“已拟合”。
在 self 中访问: 以 “_” 结尾的已拟合模型属性。指向已见数据的指针，self._y 和 self.X。self.cutoff, self._is_fitted。如果 update_params=True，则更新以 “_” 结尾的模型属性。
写入 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 = 时间序列集合，全局/面板预测。具有两级行 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 具有相同的 scitype (Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。

update_paramsbool, 可选 (默认值=True)

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

返回:

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