TinyTimeMixer预测器

class TinyTimeMixerForecaster(model_path='ibm/TTM', revision='main', validation_split=0.2, config=None, training_args=None, compute_metrics=None, callbacks=None, broadcasting=False, use_source_package=False, fit_strategy='minimal')

用于多元时间序列零样本预测的 TinyTimeMixer 预测器。

包装了 [1] 中实现的方法，该方法在 [2] 中提出。创建者的教程见 [3]。

TinyTimeMixer (TTM) 是由 IBM 研究院开源的紧凑型时间序列预测预训练模型。TTM 参数少于 100 万，是首个用于时间序列预测的“微型”预训练模型。

拟合策略：完全、最小和零样本

该模型支持三种拟合策略：*零样本* 用于未经训练直接进行预测，*最小* 微调用于轻量级适应新数据，*完全* 微调用于全面的模型训练。选择的策略由模型的 fit_strategy 参数决定

初始化过程:

1. 模型路径：model_path 参数指向一个本地文件夹或 huggingface 仓库，其中包含配置文件和预训练权重。

2. 默认配置：模型从配置文件加载其默认配置。

3. 自定义配置：用户可以在模型初始化期间通过 config 参数提供自定义配置。

4. 配置覆盖：如果提供了自定义配置，它将覆盖默认配置。

5. 预测范围：如果在 fit 期间指定的预测范围（fh）超过默认的 config.prediction_length，则更新配置以反映 max(fh)。

6. 模型架构：最终配置用于构建模型架构。

7. 预训练权重：预训练权重从 model_path 加载，然后将这些权重对齐并加载到模型架构中。

8. 权重对齐：但是，有时预训练权重与模型架构不一致，因为配置已更改，创建了与默认架构大小不同的模型架构。这导致模型架构中的一些权重被随机重新初始化，而不是使用预训练权重。

训练策略:

• 零样本预测：当所有预训练权重与模型架构正确对齐时，会跳过微调部分，模型执行零样本预测。

• 最小微调：当并非所有预训练权重都与模型架构正确对齐，而是有一些权重被重新初始化时，这些重新初始化的权重会在提供的数据上进行微调。

• 完全微调：模型在新数据上进行完全微调，更新所有参数。此方法能最大限度地适应数据集，但需要更多计算资源。

参数：

model_pathstr，默认值=”ibm/TTM”

用于预测的 Huggingface 模型路径。可以是以下之一：

• Huggingface 仓库的名称（例如，“ibm/TTM”）

• 包含 transformers 支持格式的模型文件的本地文件夹路径。在这种情况下，请确保该目录包含所有必要的文件（例如，配置、分词器和模型权重）。

• 如果此参数为 None，则 fit_strategy 应为 full，以允许对从预训练/提供的配置加载的模型进行完全微调，否则会引发 ValueError。

revision: str，默认值=”main”

要使用的模型修订版本

• “main”：用于加载 context_length 为 512 且 prediction_length 为 96 的模型。

• “1024_96_v1”：用于加载 context_length 为 1024 且 prediction_length 为 96 的模型。

当 model_path 为 None 时，此参数变得无关紧要

validation_splitfloat，默认值=0.2

用于验证的数据比例

configdict，默认值={}

用于模型的配置。详情请参见 transformers 文档。

training_argsdict，默认值={}

用于模型的训练参数。详情请参见 transformers.TrainingArguments。注意 output_dir 参数是必需的。

compute_metricslist，默认值=None

训练期间计算的指标列表。详情请参见 transformers.Trainer。

callbackslist，默认值=[]

训练期间使用的回调函数列表。参见 transformers.Trainer

broadcastingbool，默认值=False

如果为 True，多索引数据输入将被广播到单个序列。对于每个单个序列，此预测器的一个副本将尝试在其上进行拟合和预测。广播是自动在内部发生的，从外部 API 的角度看，输入和输出是相同的，predict 只会输出一个多索引结果。

use_source_packagebool，默认值=False

如果为 True，模型和配置将直接从源包 tsfm_public.models.tinytimemixer 加载。如果您想绕过包的本地版本或在需要源包最新更新的环境中工作时，此选项很有用。如果为 False，模型和配置将从 sktime 中维护的包的本地版本加载，因为模型在 pypi 上不可用。要安装源包，请按照此处的说明操作 [4]。

fit_strategystr，默认值=”minimal”

用于拟合（微调）模型的策略。可以是以下之一： - “zero-shot”：直接使用预训练模型。如果在此策略下模型路径为 None，则引发 ValueError。

在此策略下，会引发 ValueError。

• “minimal”：仅微调模型参数的一小部分，以有限的计算资源实现快速适应。如果在此策略下模型路径为 None，则引发 ValueError。

• “full”：微调所有模型参数，这可能会带来更好的性能，但需要更多计算能力和时间。允许模型路径为 None。

属性：

cutoff

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

fh

已传递的预测范围。

is_fitted

是否已调用 fit。

参考文献

[1]

ibm-granite/granite-tsfm

[2]

Ekambaram, V., Jati, A., Dayama, P., Mukherjee, S., Nguyen, N.H., Gifford, W.M., Reddy, C. and Kalagnanam, J., 2024. Tiny Time Mixers (TTMs): Fast Pre-trained Models for Enhanced Zero/Few-Shot Forecasting of Multivariate Time Series. CoRR.

[3]

ibm-granite/granite-tsfm

[4]

ibm-granite/granite-tsfm

示例

>>> from sktime.forecasting.ttm import TinyTimeMixerForecaster
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> forecaster = TinyTimeMixerForecaster() 
>>> # performs zero-shot forecasting, as default config (unchanged) is used
>>> forecaster.fit(y, fh=[1, 2, 3]) 
>>> y_pred = forecaster.predict() 

>>> from sktime.forecasting.ttm import TinyTimeMixerForecaster
>>> from sktime.datasets import load_tecator
>>>
>>> # load multi-index dataset
>>> y = load_tecator(
...     return_type="pd-multiindex",
...     return_X_y=False
... )
>>> y.drop(['class_val'], axis=1, inplace=True)
>>>
>>> # global forecasting on multi-index dataset
>>> forecaster = TinyTimeMixerForecaster(
...     model_path=None,
...     fit_strategy="full",
...     config={
...             "context_length": 8,
...             "prediction_length": 2
...     },
...     training_args={
...         "num_train_epochs": 1,
...         "output_dir": "test_output",
...         "per_device_train_batch_size": 32,
...     },
... ) 
>>>
>>> # model initialized with random weights due to None model_path
>>> # and trained with the full strategy.
>>> forecaster.fit(y, fh=[1, 2, 3]) 
>>> y_pred = forecaster.predict() 

方法

check_is_fitted([method_name])	检查估计器是否已拟合。
clone()	获取具有相同超参数和配置的对象的克隆。
clone_tags(estimator[, tag_names])	从另一个对象克隆标签作为动态覆盖。
create_test_instance([parameter_set])	使用第一个测试参数集构造类的实例。
create_test_instances_and_names([parameter_set])	创建所有测试实例列表及其名称列表。
fit(y[, X, fh])	将预测器拟合到训练数据。
fit_predict(y[, X, fh, X_pred])	在未来范围拟合并预测时间序列。
get_class_tag(tag_name[, tag_value_default])	从类中获取类标签值，具有来自父类的标签级别继承。
get_class_tags()	从类中获取类标签，具有来自父类的标签级别继承。
get_config()	获取对象的配置标志。
get_fitted_params([deep])	获取已拟合参数。
get_param_defaults()	获取对象的参数默认值。
get_param_names([sort])	获取对象的参数名称。
get_params([deep])	获取此对象的参数值字典。
get_tag(tag_name[, tag_value_default, ...])	从实例中获取标签值，具有标签级别继承和覆盖。
get_tags()	从实例中获取标签，具有标签级别继承和覆盖。
get_test_params([parameter_set])	返回估计器的测试参数设置。
is_composite()	检查对象是否由其他 BaseObjects 组成。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化内存容器加载对象。
predict([fh, X, 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, ...])	为对象设置 random_state 伪随机种子参数。
set_tags(**tag_dict)	将实例级别标签覆盖设置为给定值。
update(y[, X, update_params])	更新截止点值，并可选地更新已拟合参数。
update_predict(y[, cv, X, update_params, ...])	在测试集上迭代进行预测和更新模型。
update_predict_single([y, fh, X, update_params])	使用新数据更新模型并进行预测。

classmethod get_test_params(parameter_set='default')

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

参数：

parameter_setstr，默认值=”default”

要返回的测试参数集的名称，用于测试。如果没有为某个值定义特殊参数，将返回“default”集。目前没有为预测器保留的值。

返回：

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

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

check_is_fitted(method_name=None)

检查估计器是否已拟合。

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

如果不是，则抛出 NotFittedError。

参数：

method_namestr，可选

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

抛出：

未拟合错误

如果估计器尚未拟合。

clone()

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

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

等同于构造一个 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)

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

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

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

clone_tags 设置来自另一个对象 estimator 的动态标签覆盖。

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

动态标签设置为 estimator 中标签的值，名称由 tag_names 指定。

tag_names 的默认设置将 estimator 中的所有标签写入 self。

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

参数：

estimator:class:BaseObject 或派生类的实例

tag_namesstr 或 str 列表，默认值 = None

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

返回：

self

self 的引用。

classmethod create_test_instance(parameter_set='default')

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

参数：

parameter_setstr，默认值=”default”

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

返回：

instance具有默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')

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

参数：

parameter_setstr，默认值=”default”

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

返回：

objscls 实例列表

第 i 个实例是 cls(**cls.get_test_params()[i])

namesstr 列表，与 objs 长度相同

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

property cutoff

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

返回：

cutoffpandas 兼容的索引元素，或 None

pandas 兼容的索引元素，如果已设置 cutoff；否则为 None

property fh

已传递的预测范围。

fit(y, X=None, fh=None)

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

状态更改

将状态更改为“fitted”。

写入 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 = 时间序列集合，全局/面板预测。带有 2 级行 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")，则 X.index 必须包含 y.index。

返回：

selfself 的引用。

fit_predict(y, X=None, fh=None, X_pred=None)

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

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

状态更改

将状态更改为“fitted”。

写入 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 = 时间序列集合，全局/面板预测。带有 2 级行 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")，则 X.index 必须包含 y.index。

X_predsktime 兼容格式的时间序列，可选（默认值=None）

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

返回：

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

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

classmethod get_class_tag(tag_name, tag_value_default=None)

从类中获取类标签值，具有来自父类的标签级别继承。

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

get_class_tag 方法是一个类方法，仅考虑类级别标签值和覆盖来检索标签的值。

它从对象中返回名称为 tag_name 的标签值，考虑标签覆盖，按以下降序优先级排序

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

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

按继承顺序。

不考虑实例上的动态标签覆盖，即通过 set_tags 或 clone_tags 在实例上设置的标签覆盖。

要检索可能包含实例覆盖的标签值，请改用 get_tag 方法。

参数：

tag_namestr

标签值的名称。

tag_value_defaultany 类型

如果找不到标签，则为默认/回退值。

返回：

tag_value

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

classmethod get_class_tags()

从类中获取类标签，具有来自父类的标签级别继承。

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

获取对象的配置标志。

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

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

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

Configs 在 clone 或 reset 调用下保留。

返回：

config_dictdict

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

get_fitted_params(deep=True)

获取已拟合参数。

所需状态

要求状态为“fitted”。

参数：

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

获取对象的参数默认值。

返回：

default_dict: dict[str, Any]

键是 cls 中所有在 __init__ 中定义了默认值的参数。值是默认值，与 __init__ 中定义的一致。

classmethod get_param_names(sort=True)

获取对象的参数名称。

参数：

sortbool，默认值=True

是否按字母顺序返回参数名称（True），或按其在类的 __init__ 中出现的顺序返回（False）。

返回：

param_names: list[str]

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

get_params(deep=True)

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

参数：

deepbool，默认值=True

是否返回组件的参数。

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

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

返回：

params键为 str 的 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)

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

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

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

get_tag 方法从实例中检索名为 tag_name 的单个标签的值，考虑到标签覆盖，优先级从高到低依次是：

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

在实例构造时。

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

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

按继承顺序。

参数：

tag_namestr

要检索的标签名称

tag_value_default任意类型，可选；默认=None

如果未找到标签时的默认/回退值

raise_errorbool

当未找到标签时是否引发 ValueError

返回：

tag_valueAny

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

抛出：

ValueError，如果 raise_error 为 True。

如果 tag_name 不在 self.get_tags().keys() 中，则会引发 ValueError。

get_tags()

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

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

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

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

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

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

在实例构造时。

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

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

按继承顺序。

返回：

collected_tagsdict

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

is_composite()

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

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

返回：

composite: bool

一个对象是否具有任何参数，其值是 BaseObject 的子类实例。

property is_fitted

是否已调用 fit。

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

返回：

bool

估计器是否已 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数：

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

返回：

反序列化的 self，其结果位于 path，来自 cls.save(path)

classmethod load_from_serial(serial)

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

参数：

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

返回：

反序列化的 self，其结果是 serial，来自 cls.save(None)

predict(fh=None, X=None, y=None)

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

所需状态

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

在 self 中访问

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

• 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")，则 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)

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

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

所需状态

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

在 self 中访问

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

• 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")，则 X.index 必须包含 fh 索引引用。如果传递了 y（执行全局预测），则 X 必须包含所有历史值和要预测的时间点。

coveragefloat 或唯一浮点值列表，可选 (默认=0.90)

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

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)

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

注意：目前仅针对 Series（非 panel，非 hierarchical）y 实现。

所需状态

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

在 self 中访问

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

• 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")，则 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)

计算/返回分位数预测。

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

所需状态

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

在 self 中访问

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

• 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")，则 X.index 必须包含 fh 索引引用。如果传递了 y（执行全局预测），则 X 必须包含所有历史值和要预测的时间点。

alphafloat 或唯一浮点值列表，可选 (默认=[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)

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

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

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

所需状态

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

在 self 中访问

以“_”结尾的已 fit 模型属性。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")，则 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)

计算/返回方差预测。

所需状态

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

在 self 中访问

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

• 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")，则 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 索引的方差预测是基于观测数据对该变量和索引的预测方差。

给定变量和 fh 索引的方差预测是基于观测数据对该变量和索引的预测方差。

如果 cov=True

列索引是多级索引：第一级是变量名（如上）

第二级是 fh。

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

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

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

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

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

注意

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

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

reset()

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

将 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

类实例重置为干净的 post-init 状态，但保留当前的超参数值。

save(path=None, serialization_format='pickle')

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

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

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

参数：

pathNone 或文件位置 (str 或 Path)

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

• path="estimator"，则将在当前工作目录生成一个名为 estimator.zip 的 zip 文件。

• path="/home/stored/estimator"，则将在 /home/stored/ 中存储一个名为 estimator.zip 的 zip 文件。

存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

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

返回：

如果 path 为 None - 内存中的序列化 self

如果 path 为文件位置 - 指向该文件的 ZipFile

score(y, X=None, fh=None)

使用 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”)，X.index 必须包含 y.index

返回：

scorefloat

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

另请参见

sktime.performance_metrics.forecasting.mean_absolute_percentage_error

set_config(**config_dict)

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

参数：

config_dictdict

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

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

jupyter 内核如何显示 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 将默认为“不执行任何操作”，而不是“重新 fit 所有已见数据”。

返回：

self对 self 的引用。

注意

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

set_params(**params)

设置此对象的参数。

此方法适用于简单的 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')

为对象设置 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)

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

每个 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)

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

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

• update_params=True：拟合所有已观测到的数据

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

所需状态

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

在 self 中访问

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

• 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 = 时间序列集合，全局/面板预测。带有 2 级行 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")，则 X.index 必须包含 y.index。

update_paramsbool, 可选 (默认=True)

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

返回：

self对 self 的引用

update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)

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

执行多个 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：仅更新截止点并记忆数据

所需状态

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

在 self 中访问

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

• 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 = 时间序列集合，全局/面板预测。带有 2 级行 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；默认 = 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。

返回：

y_pred将多个分割批次的点预测制成表格的对象

格式取决于预测的截止点和绝对预测期的配对

• 如果绝对预测点集合是唯一的：类型是 sktime 兼容数据容器格式的时间序列，输出中抑制截止点，类型与最近传递的 y 类型相同：Series, Panel, Hierarchical scitype，格式相同（见上文）

• 如果绝对预测点集合不是唯一的：类型是 pandas DataFrame，行索引和列索引都是时间戳。行索引对应于进行预测的截止点，列索引对应于预测的绝对预测期。条目是在该 (截止点, 预测期) 配对处的点预测值。如果在该配对处没有进行预测，则条目为 nan。

update_predict_single(y=None, fh=None, X=None, update_params=True)

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

此方法适用于一步完成更新和预测。

如果未实现特定于估计器的 update 方法，则默认回退为先 update，然后 predict。

所需状态

要求状态为“fitted”。

在 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 = 时间序列集合，全局/面板预测。带有 2 级行 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")，则 X.index 必须包含 fh 索引引用。

update_paramsbool, 可选 (默认=True)

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

返回：

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

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