PytorchForecastingTFT#

class PytorchForecastingTFT(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, random_log_path: bool = False, broadcasting: bool = False)[source]#

pytorch-forecasting 的时间融合变换器模型。

参数:

model_paramsdict[str, Any] (默认=None): 用于初始化 pytorch-forecasting TFT 模型 [1] 的参数，例如：{“lstm_layers”: 3, “hidden_continuous_size”: 10}
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: 字符串 (默认=None): 尝试加载现有模型而不进行拟合。仍然需要调用拟合函数，但不会执行实际的拟合。
random_log_path: 布尔值 (默认=False): 对日志记录使用随机根目录。此参数用于 Github action 中的 CI 测试，不面向最终用户。

属性:

algorithm_class

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

algorithm_parameters

获取 TFT 类的关键字参数。

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

cutoff

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

fh

已传递的预测范围。

is_fitted

fit 是否已被调用。

参考文献

[1]

https://pytorch-forecasting.readthedocs.io/en/stable/api/pytorch_forecasting.models.temporal_fusion_transformer.TemporalFusionTransformer.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 PytorchForecastingTFT
>>> 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 = PytorchForecastingTFT(
...     trainer_params={
...         "max_epochs": 5,  # for quick test
...         "limit_train_batches": 2,  # for quick test
...     },
... )
>>> # fit and predict
>>> model.fit(y=y_train, X=X_train, fh=fh) # doctest skip
PytorchForecastingTFT(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.261697
            2000-01-02  5.614349
            2000-01-03  6.619191
            2000-01-04  5.159320
            2000-01-05  7.590924
...                          ...
h0_4 h1_199 2000-02-10  6.591850
            2000-02-11  5.619114
            2000-02-12  5.105312
            2000-02-13  5.185010
            2000-02-14  4.534434

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

c2

h0 h1 time h0_0 h1_180 2000-02-15 5.310687

2000-02-16 5.162195 2000-02-17 5.157579 2000-02-18 5.360476 2000-02-19 5.308441

… … h0_4 h1_199 2000-02-15 5.232810

2000-02-16 5.282471 2000-02-17 5.254453 2000-02-18 5.181715 2000-02-19 5.188011

[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`()	获取自身的配置标志。
`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`()	检查对象是否由其他 BaseObject 组成。
`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])	将序列化的自身保存到字节类对象或 (.zip) 文件。
`score`(y[, X, fh])	使用 MAPE (非对称) 评估预测与真实值的得分。
`set_config`(**config_dict)	将配置标志设置为给定值。
`set_params`(**params)	设置此对象的参数。
`set_random_state`([random_state, deep, ...])	为自身设置 pseudo-random seed 参数 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 算法类。

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

获取 TFT 类的关键字参数。

property algorithm_parameters: dict[source]#

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

返回:

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

参数:

获取 TFT 类的关键字参数。: classmethod get_test_params(parameter_set='default')[source]#

property algorithm_parameters: dict[source]#

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

paramsdict 或 list of dict, 默认 = {}

检查评估器是否已拟合。

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

check_is_fitted(method_name=None)[source]#

参数:

检查 _is_fitted 属性是否存在且为 True。在调用对象的 fit 方法时，is_fitted 属性应设置为 True。: 如果不是，则引发 NotFittedError。

method_namestr, 可选

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

引发:

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

如果评估器尚未拟合。

clone()[source]#

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

等效于构造 type(self) 的新实例，参数与 self 相同，即 type(self)(**self.get_params(deep=False))。

method_namestr, 可选

如果 self 上设置了配置，克隆对象也将拥有与原始对象相同的配置，等效于调用 cloned_self.set_config(**self.get_config())。

值上等效于调用 self.reset，但 clone 返回一个新对象，而不是像 reset 那样修改 self。

将标签从另一个对象克隆为动态覆盖。

如果由于错误的 __init__ 导致克隆不符合要求，则引发 RuntimeError。

clone_tags(estimator, tag_names=None)[source]#

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

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, 默认 = None

property algorithm_parameters: dict[source]#

要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。: self

self 的引用。

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

参数:

获取 TFT 类的关键字参数。: classmethod create_test_instance(parameter_set='default')[source]#

property algorithm_parameters: dict[source]#

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

instance具有默认参数的类实例

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

参数:

获取 TFT 类的关键字参数。: classmethod create_test_instance(parameter_set='default')[source]#

property algorithm_parameters: dict[source]#

classmethod create_test_instances_and_names(parameter_set='default')[source]#: objscls 实例列表
第 i 个实例是 cls(**cls.get_test_params()[i]): namesstr 列表，长度与 objs 相同

第 i 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个，则命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

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

property algorithm_parameters: dict[source]#

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，则将 fh 存储到 self.fh。

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

要拟合预测器的时间序列。

sktime 中的单个数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。
Series scitype = 单个时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，或 Series 类型的 pd.DataFrame 的 list

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

property algorithm_parameters: dict[source]#

用于拟合模型的外生时间序列。应与 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=None, fh=None)[source]#: 状态改变

状态更改为“已拟合”。

写入自身

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

将 self.is_fitted 标志设置为 True。

与 fit(y, X, fh).predict(X_pred) 相同。如果未传入 X_pred，则与 fit(y, fh, X).predict(X) 相同。

参数:

将 fh 存储到 self.fh。

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

要拟合预测器的时间序列。

sktime 中的单个数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。
Series scitype = 单个时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，或 Series 类型的 pd.DataFrame 的 list

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

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

fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon (不可选)

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

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

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

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

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

property algorithm_parameters: dict[source]#

用于预测的外生时间序列。如果传入，将在预测中使用而不是 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任意类型

property algorithm_parameters: dict[source]#

如果找不到标签，则使用的默认/备用值。: tag_value

self 中 tag_name 标签的值。如果找不到，则返回 tag_value_default。

从类中获取类标签，并继承父类的标签级别。

如果由于错误的 __init__ 导致克隆不符合要求，则引发 RuntimeError。

clone_tags(estimator, tag_names=None)[source]#

classmethod get_class_tags()[source]#

get_class_tags 方法是一个类方法，它在仅考虑类级别标签值和覆盖的情况下检索标签的值。

它返回一个字典，其中键是类或其任何父类中设置的任何 _tags 属性的键。

它返回名称为 tag_name 的标签值，考虑了标签覆盖，优先级从高到低如下：
在类的 _tags 属性中设置的标签。

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

值是对应的标签值，覆盖优先级从高到低如下：

实例可以根据超参数覆盖这些标签。

按照继承顺序。

要获取可能包含实例覆盖的标签，请使用 get_tags 方法。

要包含动态标签的覆盖，请使用 get_tags。: collected_tagsdict

标签名称 : 标签值对的字典。通过嵌套继承从 _tags 类属性收集。不受通过 set_tags 或 clone_tags 设置的动态标签的覆盖。

获取自身的配置标志。

get_config()[source]#

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

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

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

property algorithm_parameters: dict[source]#

配置在 clone 或 reset 调用中保留。: config_dictdict

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

获取拟合参数。

get_fitted_params(deep=True)[source]#: 所需状态

参数:

要求状态为“已拟合”。

deepbool, 默认=True

如果为 True，将返回一个此对象的参数名 : 值的字典，包括可拟合组件 (= BaseEstimator 类型参数) 的拟合参数。
如果为 False，将返回一个此对象的参数名 : 值的字典，但不包括组件的拟合参数。

property algorithm_parameters: dict[source]#

fitted_params类型为 str 的键组成的字典

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

始终：此对象的所有拟合参数，通过 get_param_names 获取，值为此对象对应键的拟合参数值。
如果 deep=True，还包含组件参数的键值对。组件的参数索引为 [componentname]__[paramname]，componentname 的所有参数显示为 paramname 及其对应值。
如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等。

classmethod get_param_defaults()[source]#

获取对象的参数默认值。

property algorithm_parameters: dict[source]#

default_dict: dict[str, Any]: 键是 cls 中在 __init__ 中定义了默认值的所有参数。值是默认值，如同在 __init__ 中定义的那样。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数:

sortbool, 默认=True: 是否按字母顺序返回参数名称 (True)，还是按它们在类 __init__ 中出现的顺序返回 (False)。

property algorithm_parameters: dict[source]#

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

get_params(deep=True)[source]#

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

参数:

要求状态为“已拟合”。

是否返回组件的参数。

如果为 True，将返回一个此对象的参数名 : 值的 dict，包括组件 (= BaseObject 类型参数) 的参数。
如果为 False，将返回一个此对象的参数名 : 值的 dict，但不包括组件的参数。

property algorithm_parameters: dict[source]#

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

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

如果由于错误的 __init__ 导致克隆不符合要求，则引发 RuntimeError。

clone_tags(estimator, tag_names=None)[source]#

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

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

在实例构造时设置的标签。

它返回名称为 tag_name 的标签值，考虑了标签覆盖，优先级从高到低如下：
在类的 _tags 属性中设置的标签。

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

参数:

要获取可能包含实例覆盖的标签值，请使用 get_tag 方法。: 要检索的标签名称
tag_value_default任意类型, 可选; 默认=None: 如果未找到标签，则使用的默认/备用值
raise_errorbool: 当未找到标签时是否引发 ValueError

property algorithm_parameters: dict[source]#

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

method_namestr, 可选

ValueError, 如果 raise_error 为 True。: 如果 tag_name 不在 self.get_tags().keys() 中，则引发 ValueError。

get_tags()[source]#

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

如果由于错误的 __init__ 导致克隆不符合要求，则引发 RuntimeError。

clone_tags(estimator, tag_names=None)[source]#

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

它返回一个字典，其中键是类或其任何父类中设置的任何 _tags 属性的键。

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

在实例构造时设置的标签。

它返回名称为 tag_name 的标签值，考虑了标签覆盖，优先级从高到低如下：
在类的 _tags 属性中设置的标签。

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

property algorithm_parameters: dict[source]#

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

is_composite()[source]#

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

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

property algorithm_parameters: dict[source]#

composite: bool: 对象是否包含任何参数，其值是 BaseObject 的派生实例。

property is_fitted[source]#

fit 是否已被调用。

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

property algorithm_parameters: dict[source]#

bool: 估计器是否已拟合。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:

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

property algorithm_parameters: dict[source]#

反序列化 self，其结果是 cls.save(path) 在 path 处的输出。

classmethod load_from_serial(serial)[source]#

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

参数:

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

property algorithm_parameters: dict[source]#

反序列化 self，其结果是 cls.save(None) 的输出 serial。

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

预测未来范围内的时序数据。

get_fitted_params(deep=True)[source]#: 要求状态为“已拟合”，即 self.is_fitted=True。

访问 self 中的属性

以 "_" 结尾的拟合模型属性。

self.cutoff, self.is_fitted

状态更改为“已拟合”。: 如果传递了 fh 且之前未传递过，则将 fh 存储到 self.fh。

参数:

有关数据格式的更多详细信息，请参见 mtype 术语表。有关用法，请参见预测教程 examples/01_forecasting.ipynb: 编码要预测的时间戳的预测范围。如果在 fit 中已传递，则不应再次传递。如果在 fit 中未传递，则必须传递，非可选。
Xsktime 兼容格式的时间序列, 可选 (默认=None): 用于预测的外部时间序列。应与 fit 中 y 的 scitype (是 Series, Panel, 还是 Hierarchical) 相同。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 fh 索引参考。如果未传递 y (未执行全局预测)，则 X 应仅包含要预测的时间点。如果传递了 y (执行全局预测)，则 X 必须包含所有历史值和要预测的时间点。
ysktime 兼容格式的时间序列, 可选 (默认=None): 应预测的时间序列的历史值。如果不是 None，将执行全局预测。仅传递历史值，而不是要预测的时间点。

property algorithm_parameters: dict[source]#

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

注释

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

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

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

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

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

get_fitted_params(deep=True)[source]#: 要求状态为“已拟合”，即 self.is_fitted=True。

访问 self 中的属性

以 "_" 结尾的拟合模型属性。

self.cutoff, self.is_fitted

状态更改为“已拟合”。: 如果传递了 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")，则 X.index 必须包含 fh 索引参考。如果传递了 y (执行全局预测)，则 X 必须包含所有历史值和要预测的时间点。
coveragefloat 或唯一值的 float 列表, 可选 (默认=0.90): 预测区间标称覆盖率
ysktime 兼容格式的时间序列, 可选 (默认=None): 应预测的时间序列的历史值。如果不是 None，将执行全局预测。仅传递历史值，而不是要预测的时间点。

property algorithm_parameters: dict[source]#

pred_intpd.DataFrame

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

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

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

行索引是 fh，具有与实例级别相等的额外 (上层) 级别，

如果 fit 中看到的 y 是 Panel 或 Hierarchical，则从 fit 中看到的 y 获取。

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

对于列索引中的变量，第二列索引中的标称覆盖率，取决于第三列索引的 lower/upper，对于行索引。上限/下限区间预测等价于 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 (非面板、非分层) y 实现。

get_fitted_params(deep=True)[source]#: 要求状态为“已拟合”，即 self.is_fitted=True。

访问 self 中的属性

以 "_" 结尾的拟合模型属性。

self.cutoff, self.is_fitted

状态更改为“已拟合”。: 如果传递了 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")，则 X.index 必须包含 fh 索引参考。如果传递了 y (执行全局预测)，则 X 必须包含所有历史值和要预测的时间点。
marginalbool, 可选 (默认=True): 返回的分布是否按时间索引是边缘分布
ysktime 兼容格式的时间序列, 可选 (默认=None): 应预测的时间序列的历史值。如果不是 None，将执行全局预测。仅传递历史值，而不是要预测的时间点。

property algorithm_parameters: dict[source]#

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 是可迭代的，将计算多个分位数。

get_fitted_params(deep=True)[source]#: 要求状态为“已拟合”，即 self.is_fitted=True。

访问 self 中的属性

以 "_" 结尾的拟合模型属性。

self.cutoff, self.is_fitted

状态更改为“已拟合”。: 如果传递了 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")，则 X.index 必须包含 fh 索引参考。如果传递了 y (执行全局预测)，则 X 必须包含所有历史值和要预测的时间点。
alphafloat 或唯一值的 float 列表, 可选 (默认=[0.05, 0.95]): 计算分位数预测的概率或概率列表。
ysktime 兼容格式的时间序列, 可选 (默认=None): 应预测的时间序列的历史值。如果不是 None，将执行全局预测。仅传递历史值，而不是要预测的时间点。

property algorithm_parameters: dict[source]#

quantilespd.DataFrame

列具有多重索引：第一层是 fit 中 y 的变量名，: 第二层是传递给函数的 alpha 值。
行索引是 fh，具有与实例级别相等的额外 (上层) 级别，: 如果 fit 中看到的 y 是 Panel 或 Hierarchical，则从 fit 中看到的 y 获取。
条目是分位数预测，对于列索引中的变量，: 对于行索引，在第二列索引中的分位数概率处。

注释

如果 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，则残差将在 range(len(y.shape[0])) 的 fh 处计算。

get_fitted_params(deep=True)[source]#: 要求状态为“已拟合”。如果已设置 fh，则必须与 y 的索引 (pandas 或 integer) 对应。
访问 self 中的属性: 以 "_" 结尾的拟合模型属性。self.cutoff, self._is_fitted
状态更改为“已拟合”。: 无。

参数:

将 fh 存储到 self.fh。

带有真实观测值的时间序列，用于计算残差。必须具有与 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")，则 X.index 必须同时包含 fh 索引参考和 y.index。

property algorithm_parameters: dict[source]#

y_ressktime 兼容数据容器格式的时间序列: fh 处的预测残差，与 fh 具有相同的索引。y_res 与最近传递的 y 具有相同的类型：Series, Panel, Hierarchical scitype，相同的格式 (见上文)。

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

计算/返回方差预测。

get_fitted_params(deep=True)[source]#: 要求状态为“已拟合”，即 self.is_fitted=True。

访问 self 中的属性

以 "_" 结尾的拟合模型属性。

self.cutoff, self.is_fitted

状态更改为“已拟合”。: 如果传递了 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")，则 X.index 必须包含 fh 索引参考。
covbool, 可选 (默认=False): 如果为 True，则计算协方差矩阵预测。如果为 False，则计算边缘方差预测。
ysktime 兼容格式的时间序列, 可选 (默认=None): 应预测的时间序列的历史值。如果不是 None，将执行全局预测。仅传递历史值，而不是要预测的时间点。

property algorithm_parameters: dict[source]#

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

如果 cov=False

列名与 fit/update 中传递的 y 的列名完全相同。: 对于无名格式，列索引将是 RangeIndex。
行索引是 fh，具有与实例级别相等的额外级别，: 如果 fit 中看到的 y 是 Panel 或 Hierarchical，则从 fit 中看到的 y 获取。

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

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

如果 cov=True

列索引是多重索引：第一层是变量名 (如上所述): 第二层是 fh。
行索引是 fh，具有与实例级别相等的额外级别，: 如果 fit 中看到的 y 是 Panel 或 Hierarchical，则从 fit 中看到的 y 获取。
条目是 (协)方差预测，对于列索引中的变量，以及: 行和列中时间索引之间的协方差。

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

注释

如果 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))`` 后获得的对象相同。

property algorithm_parameters: dict[source]#

要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。: 类的实例重置为干净的初始化后状态，但保留当前的超参数值。

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”，则 zip 文件 estimator.zip 将

存储在 /home/stored/ 中。

serialization_format: str, 默认 = “pickle”

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

property algorithm_parameters: dict[source]#

如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 引用该文件的 ZipFile

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

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

参数:

ypd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D): 用于评分的时间序列
有关数据格式的更多详细信息，请参见 mtype 术语表。有关用法，请参见预测教程 examples/01_forecasting.ipynb: fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon (不可选)
Xpd.DataFrame, 或 2D np.array, 可选 (默认=None): 用于评分的外部时间序列。如果 self.get_tag(“X-y-must-have-same-index”)，则 X.index 必须包含 y.index。

property algorithm_parameters: dict[source]#

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

另请参阅

sktime.performance_metrics.forecasting.mean_absolute_percentage_error

set_config(**config_dict)[source]#

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

参数:

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

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

displaystr, “diagram” (默认), 或 “text”

jupyter 内核如何显示 self 的实例

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

print_changed_onlybool, 默认=True

打印 self 时是仅列出与默认值不同的 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_data布尔型, 默认值=True

remember_databool, 默认=True

property algorithm_parameters: dict[source]#

在 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>。不带 <component>__ 的字符串 <parameter> 也可以使用，如果这样引用是明确的，例如，组件参数中没有两个参数同名为 <parameter>。: **paramsdict

property algorithm_parameters: dict[source]#

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

self对 self 的引用 (设置参数后)

为自身设置 pseudo-random seed 参数 random_state。

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

通过 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 值可确保在多次函数调用中输出可重现。

要求状态为“已拟合”。

是否在 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 派生，并且通常与其不同。

property algorithm_parameters: dict[source]#

self对 self 的引用

set_tags(**tag_dict)[source]#

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

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

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

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

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

tag_names 的默认值是将 estimator 中的所有标签写入 self。

参数:

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

property algorithm_parameters: dict[source]#

Self: 对 self 的引用。

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

更新截止值，并可选择更新拟合参数。

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

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

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

get_fitted_params(deep=True)[source]#: 要求状态为“已拟合”，即 self.is_fitted=True。

访问 self 中的属性

以 "_" 结尾的拟合模型属性。

self.cutoff, self.is_fitted

状态更改为“已拟合”。

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

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

参数:

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

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

要拟合预测器的时间序列。

sktime 中的单个数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。
Series scitype = 单个时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，或 Series 类型的 pd.DataFrame 的 list

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

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

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

update_paramsbool, 可选 (默认=True)

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

property algorithm_parameters: dict[source]#

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

get_fitted_params(deep=True)[source]#: 要求状态为“已拟合”，即 self.is_fitted=True。

访问 self 中的属性

以 "_" 结尾的拟合模型属性。

self.cutoff, self.is_fitted

写入 self (除非 reset_forecaster=True)

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

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

参数:

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

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

要拟合预测器的时间序列。

sktime 中的单个数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。
Series scitype = 单个时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，或 Series 类型的 pd.DataFrame 的 list

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

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

例如，SlidingWindowSplitter 或 ExpandingWindowSplitter；默认 = ExpandingWindowSplitter，initial_window=1 和默认值 = 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")，则 X.index 必须包含 fh 索引参考。

update_paramsbool, 可选 (默认=True)

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

reset_forecasterbool, 可选 (默认=True)

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

property algorithm_parameters: dict[source]#

y_pred汇集多个分割批次点预测的对象

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

如果绝对范围点集合是唯一的：类型是 sktime 兼容数据容器格式的时间序列，输出中省略截止点，与最近传递的 y 具有相同的类型：Series, Panel, Hierarchical scitype，相同的格式 (见上文)。
如果绝对范围点集合不是唯一的：类型是 pandas DataFrame，行和列索引都是时间戳。行索引对应于从中预测的截止点，列索引对应于预测的绝对范围。如果未在该 (截止点, 范围) 对处进行预测，则条目为 nan。

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

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

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

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

get_fitted_params(deep=True)[source]#: 所需状态
访问 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，

更新以 "_" 结尾的拟合模型属性。

参数:

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

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

要拟合预测器的时间序列。

sktime 中的单个数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。
Series scitype = 单个时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，或 Series 类型的 pd.DataFrame 的 list

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

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

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

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

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

update_paramsbool, 可选 (默认=True)

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

property algorithm_parameters: dict[source]#

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