TimeLLMForecaster

class TimeLLMForecaster(task_name='long_term_forecast', pred_len=24, seq_len=96, llm_model='GPT2', llm_layers=3, llm_dim=768, patch_len=16, stride=8, d_model=128, d_ff=128, n_heads=4, dropout=0.1, device: str | None = None, prompt_domain=False)

Time-LLM 的接口。

Time-LLM 是一个重编程框架，用于将大型语言模型 (LLMs) 重新用于通用时间序列预测，同时保持骨干语言模型不变。该方法已在 [2] 中提出，官方代码见 [1]。

参数:

task_namestr，默认值=’long_term_forecast’

要执行的任务 - 可以是 [‘long_term_forecast’, ‘short_term_forecast’] 之一。

pred_lenint，默认值=24

预测范围 - 要预测的时间步数。

seq_lenint，默认值=96

输入序列的长度。

llm_modelstr，默认值=’GPT2’

要使用的 LLM 模型 - 可以是 [‘GPT2’, ‘LLAMA’, ‘BERT’] 之一。

llm_layersint，默认值=3

从 LLM 中使用的 Transformer 层数。

patch_lenint，默认值=16

用于 Patch Embedding 的 Patch 长度。

strideint，默认值=8

Patch 之间的步长。

d_modelint，默认值=128

模型维度。

d_ffint，默认值=128

前馈层维度。

n_headsint，默认值=4

注意力头数。

dropoutfloat，默认值=0.1

Dropout 比率。

devicestr，如果可用则默认=’cuda’，否则为’cpu’

运行模型的设备。

属性:

cutoff

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

fh

传入的预测范围。

is_fitted

是否已调用 fit。

参考

[1]

KimMeen/Time-LLM

[2]

Ming Jin, Shiyu Wang, Lintao Ma, Zhixuan Chu, James Y. Zhang,

Xiaoming Shi, Pin-Yu Chen, Yuxuan Liang, Yuan-Fang Li, Shirui Pan, Qingsong Wen. Time-LLM: 通过重编程大型语言模型进行时间序列预测（Time Series Forecasting by Reprogramming Large Language Models）。https://arxiv.org/abs/2310.01728。

示例

>>> from sktime.forecasting.time_llm import TimeLLMForecaster
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> forecaster = TimeLLMForecaster(
...     pred_len=36,
...     seq_len=96,
...     llm_model='GPT2'
... )
>>> forecaster.fit(y, fh=[1])
TimeLLMForecaster(pred_len=1)
>>> y_pred = forecaster.predict(fh=[1])

方法

check_is_fitted([method_name])	检查估计器是否已拟合。
clone()	获取具有相同超参数和配置的对象的克隆。
clone_tags(estimator[, tag_names])	从另一个对象克隆标签作为动态覆盖。
create_test_instance([parameter_set])	使用第一个测试参数集构造类的实例。
create_test_instances_and_names([parameter_set])	创建所有测试实例的列表及其名称列表。
fit(y[, X, fh])	将预测器拟合到训练数据。
fit_predict(y[, X, fh, X_pred])	拟合并预测未来时间序列。
get_class_tag(tag_name[, tag_value_default])	从类获取类标签值，带有来自父类的标签级别继承。
get_class_tags()	从类获取类标签，带有来自父类的标签级别继承。
get_config()	获取 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()	检查对象是否由其他 BaseObject 组成。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化内存容器加载对象。
predict([fh, X])	预测未来时间序列。
predict_interval([fh, X, coverage])	计算/返回预测区间预测值。
predict_proba([fh, X, marginal])	计算/返回完全概率预测值。
predict_quantiles([fh, X, alpha])	计算/返回分位数预测值。
predict_residuals([y, X])	返回时间序列预测的残差。
predict_var([fh, X, cov])	计算/返回方差预测值。
reset()	将对象重置为干净的后初始化状态。
save([path, serialization_format])	将序列化的 self 保存到字节类对象或 (.zip) 文件。
score(y[, X, fh])	使用 MAPE（非对称）评估预测相对于真实值的分数。
set_config(**config_dict)	将配置标志设置为给定值。
set_params(**params)	设置此对象的参数。
set_random_state([random_state, deep, ...])	为 self 设置 random_state 伪随机种子参数。
set_tags(**tag_dict)	将实例级别标签覆盖设置为给定值。
update(y[, X, update_params])	更新截止点值，并可选地更新已拟合参数。
update_predict(y[, cv, X, update_params, ...])	在测试集上迭代进行预测并更新模型。
update_predict_single([y, fh, X, update_params])	使用新数据更新模型并进行预测。

classmethod get_test_params(parameter_set='default')

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

check_is_fitted(method_name=None)

检查估计器是否已拟合。

检查估计器是否已拟合。is_fitted 属性应在调用对象的 fit 方法时设置为 True。

如果未拟合，则会引发 NotFittedError 错误。

参数:

method_namestr，可选

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

引发:

未拟合错误

如果估计器尚未拟合。

clone()

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

克隆是另一个没有共享引用、处于后初始化状态的对象。此函数等效于返回 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)

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

每个 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 个元素是测试中第 i 个 obj 实例的名称。如果实例不止一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

property cutoff

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

返回:

cutoffpandas 兼容的索引元素，或 None

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

property fh

传入的预测范围。

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

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

状态更改

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

写入 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 = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame 的 list

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

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

fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

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

Xsktime兼容格式的时间序列, optional (default=None).

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

返回:

self指向自身的引用。

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

状态更改

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

写入 self

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

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

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

• 将fh存储到self.fh。

参数:

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

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

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

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

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

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

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

fhint, list, pd.Index coercible, or ForecastingHorizon (不可选)

表示预测时间戳的预测范围。

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

Xsktime兼容格式的时间序列, optional (default=None).

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

X_predsktime兼容格式的时间序列, optional (default=None)

用于预测的外生时间序列。如果传递，将用于预测而不是X。应与fit中的y具有相同的scitype（Series, Panel, or 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 type

如果未找到标签，则返回的默认/备用值。

返回:

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

获取 self 的配置标志。

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

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

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

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

返回:

config_dictdict

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

get_fitted_params(deep=True)

获取已拟合参数。

所需状态

需要状态为“已拟合”。

参数:

deepbool, default=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, default=True

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

返回:

param_names: list[str]

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

get_params(deep=True)

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

参数:

deepbool, default=True

是否返回组件的参数。

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

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

返回:

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_defaultany type, optional; default=None

如果未找到标签，则返回的默认/备用值

raise_errorbool

未找到标签时是否引发ValueError

返回:

tag_valueAny

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

引发:

ValueError, if raise_error is 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()

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

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

返回:

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)输出的第1个元素

返回:

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

predict(fh=None, X=None)

预测未来时间序列。

所需状态

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

在self中访问

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

• self.cutoff, self.is_fitted

写入 self

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

参数:

fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

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

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

Xsktime兼容格式的时间序列, optional (default=None)

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

返回:

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

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

predict_interval(fh=None, X=None, coverage=0.9)

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

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

所需状态

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

在self中访问

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

• self.cutoff, self.is_fitted

写入 self

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

参数:

fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

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

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

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

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

Xsktime兼容格式的时间序列, optional (default=None)

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

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

预测区间名义覆盖率

返回:

pred_intpd.DataFrame

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

第二级是计算区间的覆盖率分数。

与输入coverage中的顺序相同。

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

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

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

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

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

predict_proba(fh=None, X=None, marginal=True)

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

注意

• 当前仅对Series（非Panel、非Hierarchical）y实现。

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

所需状态

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

在self中访问

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

• self.cutoff, self.is_fitted

写入 self

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

参数:

fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

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

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

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

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

Xsktime兼容格式的时间序列, optional (default=None)

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

marginalbool, optional (default=True)

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

返回:

pred_distskpro BaseDistribution

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

predict_quantiles(fh=None, X=None, alpha=None)

计算/返回分位数预测值。

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

所需状态

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

在self中访问

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

• self.cutoff, self.is_fitted

写入 self

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

参数:

fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

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

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

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

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

Xsktime兼容格式的时间序列, optional (default=None)

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

alphafloat or list of float of unique values, optional (default=[0.05, 0.95])

计算分位数预测的概率或概率列表。

返回:

quantilespd.DataFrame

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

第二级是传递给函数的alpha值。

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

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

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

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

predict_residuals(y=None, X=None)

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

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

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

所需状态

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

在self中访问

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

写入 self

无。

参数:

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

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

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

• 如果前面有一个单独的fit调用，则生成样本内残差

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

Xsktime兼容格式的时间序列, optional (default=None)

用于更新和预测的外生时间序列，应与fit中的y具有相同的scitype（Series, Panel>, or 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)

计算/返回方差预测值。

所需状态

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

在self中访问

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

• self.cutoff, self.is_fitted

写入 self

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

参数:

fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

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

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

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

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

Xsktime兼容格式的时间序列, optional (default=None)

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

covbool, optional (default=False)

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

返回:

pred_varpd.DataFrame, format dependent on cov variable

如果cov=False

列名与fit/update中传递的y的列名完全相同。

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

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

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

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

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

如果cov=True

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

第二级是fh。

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

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

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

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

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

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

类实例被重置到干净的初始化后状态，但保留当前的超参数值。

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

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

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

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

参数:

pathNone or file location (str or Path)

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

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

• path=”/home/stored/estimator”，则会在/home/stored/中创建zip文件estimator.zip。

。

serialization_format: str, default = “pickle”

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

返回:

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

如果path为文件位置 - 引用该文件的ZipFile

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

使用 MAPE（非对称）评估预测相对于真实值的分数。

参数:

ypd.Series, pd.DataFrame, or np.ndarray (1D or 2D)

要评分的时间序列

fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

表示预测时间戳的预测范围。

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

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

返回:

scorefloat

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

另见

sktime.performance_metrics.forecasting.mean_absolute_percentage_error

set_config(**config_dict)

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

参数:

config_dictdict

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

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

jupyter内核如何显示self的实例

• “diagram” = html框图表示

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

print_changed_onlybool, default=True

打印self时，是仅列出与默认值不同的self参数（False），还是列出所有参数名称和值（False）。不嵌套，即仅影响self，不影响组件估计器。

warningsstr, “on” (default), or “off”

是否发出警告，仅影响来自sktime的警告

• “on” = 将发出来自sktime的警告

• “off” = 不会发出来自sktime的警告

backend:parallelstr, optional, default=”None”

广播/向量化时使用的并行化后端之一

• “None”: 按顺序执行循环，简单的列表推导式

• “loky”, “multiprocessing” and “threading”: 使用joblib.Parallel

• “joblib”: 自定义和第三方joblib后端，例如spark

• “dask”: 使用dask，需要在环境中安装dask包

• “ray”: 使用ray，需要在环境中安装ray包

backend:parallel:paramsdict, optional, default={} (no parameters passed)

作为配置传递给并行化后端的附加参数。有效键取决于backend:parallel的值

• “None”: 没有附加参数，忽略backend_params

• “loky”, “multiprocessing” and “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, default=True; False阻止ray在并行化后

    关闭。

  • “logger_name”: str, default=”ray”; 使用的日志记录器名称。

  • “mute_warnings”: bool, default=False; 如果为True，则抑制警告

remember_databool, default=True

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

返回:

self指向自身的引用。

注意

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

set_params(**params)

设置此对象的参数。

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

参数:

**paramsdict

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

返回:

self指向自身的引用（设置参数后）

set_random_state(random_state=None, deep=True, self_policy='copy')

为 self 设置 random_state 伪随机种子参数。

通过self.get_params查找名为random_state的参数，并通过set_params将它们设置为从random_state导出的整数。这些整数通过sample_dependent_seed从链式哈希中采样，并保证种子随机生成器的伪随机独立性。

适用于self中的random_state参数，取决于self_policy，以及剩余的组件对象，当且仅当deep=True时。

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

参数:

random_stateint, RandomState instance or None, default=None

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

deepbool, default=True

是否在skbase对象值参数（即组件估计器）中设置随机状态。

• 如果为False，则仅设置self的random_state参数（如果存在）。

• 如果为True，则也会在组件对象中设置random_state参数。

self_policystr, one of {“copy”, “keep”, “new”}, default=”copy”

• “copy” : self.random_state设置为输入random_state

• “keep” : self.random_state保持不变

• “new” : self.random_state设置为一个新的随机状态，

从输入random_state派生，并且通常与它不同

返回:

self指向自身的引用

set_tags(**tag_dict)

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

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

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

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

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

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

参数:

**tag_dictdict

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

返回:

Self

指向自身的引用。

update(y, X=None, update_params=True)

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

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

• update_params=True: 拟合到目前为止所有观测到的数据

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

所需状态

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

在self中访问

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

• self.cutoff, self.is_fitted

写入 self

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

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

参数:

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

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

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

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

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

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

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

Xsktime兼容格式的时间序列, optional (default=None).

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

update_paramsbool, optional (default=True)

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

返回:

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_params=True: 拟合到目前为止所有观测到的数据

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

所需状态

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

在self中访问

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

• self.cutoff, self.is_fitted

写入self（除非reset_forecaster=True）

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

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

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

参数:

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

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

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

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

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

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

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

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

例如，SlidingWindowSplitter或ExpandingWindowSplitter；默认值 = ExpandingWindowSplitter，initial_window=1，其他默认值 = y/X中的个体数据点一个接一个地添加和预测，initial_window = 1，step_length = 1，fh = 1

Xsktime兼容格式的时间序列, optional (default=None)

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

update_paramsbool, optional (default=True)

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

reset_forecasterbool, optional (default=True)

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

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

返回:

y_pred对多个分割批次中的点预测进行列表的对象

格式取决于总体预测的截止点和绝对范围对

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

• 如果绝对范围点集合不唯一：类型为pandas DataFrame，行和列索引为时间戳，行索引对应于从中预测的截止点，列索引对应于预测的绝对范围，条目是根据行索引预测的列索引的点预测，如果在该（截止点，范围）对处没有预测，则条目为nan

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

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

此方法对于单步更新和进行预测非常有用。

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

所需状态

需要状态为“已拟合”。

在self中访问

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

写入 self

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

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

参数:

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

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

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

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

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

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

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

fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

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

Xsktime兼容格式的时间序列, optional (default=None)

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

update_paramsbool, optional (default=True)

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

返回:

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

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