ChronosForecaster#

class ChronosForecaster(model_path: str, config: dict = None, seed: int | None = None, use_source_package: bool = False, ignore_deps: bool = False)[source]#

Amazon Research 的 Chronos 和 Chronos-Bolt 零样本预测器的接口。

Chronos 和 Chronos-Bolt 是 Amazon 为时间序列预测开发的预训练时间序列基础模型。此方法已在 [2] 中提出，官方代码可在 [1] 获取。

参数:
model_pathstr

Chronos huggingface 模型的路径。

configdict, 可选, 默认={}

一个字典，指定模型的配置设置。可用的配置选项包括控制预测行为、采样和硬件偏好的超参数。对于 Chronos 模型，字典可以包含以下键：

  • “num_samples”int, 可选

    预测期间生成的样本数。取这些样本的中位数作为每个时间戳的预测值。

  • “temperature”float, 可选

    预测的采样温度。值越高会增加预测的随机性，而值越低会使其更具确定性。

  • “top_k”int, 可选

    采样期间将采样池限制在前 k 个预测中。

  • “top_p”float, 可选

    核心采样的累积概率阈值。控制预测的多样性。

以下配置选项在两种模型中都可用：- “limit_prediction_length” : bool, 默认=False

如果为 True，则将预测长度限制在模型的上下文长度以内。

  • “torch_dtype”torch.dtype, 默认=torch.bfloat16

    用于模型权重和操作的数据类型（例如，torch.float32、torch.float16 或 torch.bfloat16）。

  • “device_map”str, 默认=”cpu”

    指定运行模型的设备，例如，“cpu”用于 CPU 推理，“cuda”用于 GPU，或“mps”用于 Apple Silicon。

如果未提供，则使用预训练模型或系统配置中的默认值。

seed: int, 可选, 默认=None

用于 transformers 的随机种子。

use_source_package: bool, 可选, 默认=False

如果为 True，模型将直接从源包 chronos 加载。这对于绕过本地包版本或在需要源包最新更新的环境中工作时很有用。如果为 False，模型将从 sktime 中维护的本地包版本加载。要安装源包，请按照此处 [1] 的说明进行。

ignore_deps: bool, 可选, 默认=False

如果为 True，将忽略依赖项检查，用户需要手动处理所需包的安装。如果为 False，该类将强制执行 Chronos 所需的默认依赖项。

属性:
model_pipeline: ChronosPipeline or ChronosBoltPipeline

用于预测的底层模型管道

is_bolt: bool

指示模型是否为 Chronos-Bolt 模型，以确保仅根据模型路径进行有效区分。

参考

[2]

Abdul Fatir Ansari, Lorenzo Stella, Caner Turkmen, 等 (2024)。

Chronos: Learning the Language of Time Series

示例

>>> # Example using 'amazon/chronos-t5-tiny' model
>>> from sktime.datasets import load_airline
>>> from sktime.forecasting.chronos import ChronosForecaster
>>> from sktime.split import temporal_train_test_split
>>> from sktime.forecasting.base import ForecastingHorizon
>>> y = load_airline()
>>> y_train, y_test = temporal_train_test_split(y)
>>> fh = ForecastingHorizon(y_test.index, is_relative=False)
>>> forecaster = ChronosForecaster("amazon/chronos-t5-tiny")  
>>> forecaster.fit(y_train)  
>>> y_pred = forecaster.predict(fh)  

>>> # Example using 'amazon/chronos-bolt-tiny' model
>>> from sktime.datasets import load_airline
>>> from sktime.forecasting.chronos import ChronosForecaster
>>> from sktime.split import temporal_train_test_split
>>> from sktime.forecasting.base import ForecastingHorizon
>>> y = load_airline()
>>> y_train, y_test = temporal_train_test_split(y)
>>> fh = ForecastingHorizon(y_test.index, is_relative=False)
>>> forecaster = ChronosForecaster("amazon/chronos-bolt-tiny")  
>>> forecaster.fit(y_train)  
>>> y_pred = forecaster.predict(fh)

方法

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')[source]#

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

参数:
parameter_setstr, 默认=”default”

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

返回:
paramsdict 或 list of dict
check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError 异常。

参数:
method_namestr, 可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

克隆是具有相同超参数和配置但没有共享引用的不同对象，处于初始化后状态。此函数等效于返回 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)[source]#

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

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

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

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

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

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

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

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

参数:
estimator:class:BaseObject 或派生类的实例
tag_namesstr 或 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 = 时间序列集合，全局/面板预测。pd.DataFrame，具有 2 级行 MultiIndex (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，或 Series 类型的 pd.DataFrame 的 list

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame，具有 3 级或更多级别行 MultiIndex (层级 1, ..., 层级 n, 时间)

有关数据格式的更多详细信息，请参阅 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 = 时间序列集合，全局/面板预测。pd.DataFrame，具有 2 级行 MultiIndex (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，或 Series 类型的 pd.DataFrame 的 list

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame，具有 3 级或更多级别行 MultiIndex (层级 1, ..., 层级 n, 时间)

有关数据格式的更多详细信息，请参阅 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 兼容的对象都有一个标签字典，用于存储关于对象的元数据。

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

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

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

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

按继承顺序。

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

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

参数:
tag_namestr

标签值的名称。

tag_value_default任意类型

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

返回:
tag_value

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

classmethod get_class_tags()[source]#

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

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

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

The get_class_tags method is a class method, and retrieves the value of a tag taking into account only class-level tag values and overrides.

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

值是相应的标签值，优先级降序覆盖如下：

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

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

按继承顺序。

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

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

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

对于包含来自动态标签的覆盖，请使用 get_tags。

collected_tagsdict

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

get_config()[source]#

获取对象的配置标志。

配置是 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

已拟合参数字典，包含 参数名称 : 参数值 键值对

  • 始终：此对象的所有已拟合参数，如通过 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键为 str 的 dict

参数字典，包含 参数名称 : 参数值 键值对

  • 始终：此对象的所有参数，如通过 get_param_names 获取的值是此对象该键的参数值，值始终与构造时传递的值相同

  • 如果 deep=True，还包含组件参数的键值对，组件参数的索引格式为 [componentname]__[paramname]，componentname 的所有参数都以 paramname 形式出现，并带有其值

  • 如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

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

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

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

get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，考虑标签覆盖，优先级降序如下：

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

在实例构造时。

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

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

按继承顺序。

参数:
tag_namestr

要检索的标签名称

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

如果未找到标签，则为默认/备用值

raise_errorbool

标签未找到时是否引发 ValueError 异常

返回:
tag_value任意类型

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

引发:
ValueError，如果 raise_error 为 True。

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

get_tags()[source]#

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

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

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

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

值是相应的标签值，优先级降序覆盖如下：

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

在实例构造时。

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

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

按继承顺序。

返回:
collected_tagsdict

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

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，其输出在 path 处，来自 cls.save(path)
classmethod load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化的 self，其输出为 serial，来自 cls.save(None)
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")，则 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")，则 X.index 必须包含 fh 索引引用。如果传入了 y（执行全局预测），则 X 必须包含所有历史值和要预测的时间点。

coverage浮点数或包含唯一浮点数的列表，可选（默认=0.90）

预测区间的名义覆盖率

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

应预测的时间序列的历史值。如果非 None，将执行全局预测。只传入历史值，不要传入要预测的时间点。

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

顺序与输入 coverage 中的顺序相同。

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

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

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

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

对于列索引中的变量，在第二列索引中的名义覆盖率下，取决于第三列索引是 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（非 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")，则 X.index 必须包含 fh 索引引用。如果传入了 y（执行全局预测），则 X 必须包含所有历史值和要预测的时间点。

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

alpha浮点数或包含唯一浮点数的列表，可选（默认=[0.05, 0.95]）

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

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

应预测的时间序列的历史值。如果非 None，将执行全局预测。只传入历史值，不要传入要预测的时间点。

返回:
quantilespd.DataFrame
列具有多级索引：第一级是 fit 中 y 的变量名，

第二级是传入函数的 alpha 值。

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

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

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

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

注意事项

如果 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 或 integer）对应。

在 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")，则 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")，则 X.index 必须包含 fh 索引引用。

cov布尔值，可选（默认=False）

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

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

应预测的时间序列的历史值。如果非 None，将执行全局预测。只传入历史值，不要传入要预测的时间点。

返回:
pred_varpd.DataFrame，格式取决于 cov 变量
如果 cov=False
列名与在 fit/update 中传入的 y 的列名完全相同。

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

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

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

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

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

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

第二级是 fh。

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

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

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

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

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

注意事项

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

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

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

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

参数:
pathNone 或文件位置（str 或 Path）

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

  • path=”estimator” 则会在当前工作目录 (cwd) 创建一个 zip 文件 estimator.zip。

  • path=”/home/stored/estimator” 则会在

存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

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

返回:
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 引用该文件的 ZipFile
score(y, X=None, fh=None)[source]#

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

参数:
ypd.Series, pd.DataFrame 或 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

返回:
score浮点数

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

  • “diagram” = html 方框图表示

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

print_changed_only布尔值，默认=True

打印 self 时是否只列出与默认值不同的 self 参数 (True)，或者列出所有参数名称和值 (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:params字典，可选，默认={}（未传递参数）

作为配置传递给并行处理后端的附加参数。有效键取决于 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”：布尔值，默认=True；False 防止 ray 在并行处理后

      关闭。

    • “logger_name”：str，默认=”ray”；要使用的日志记录器名称。

    • “mute_warnings”：布尔值，默认=False；如果为 True，则抑制警告

remember_data布尔值，默认=True

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

返回:
self对 self 的引用。

注意事项

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

set_params(**params)[source]#

设置此对象的参数。

该方法适用于简单的 skbase 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象，即包含其他对象的对象，以访问组件 <component> 中的 <parameter>。如果没有两个组件的参数名称相同，也可以使用不带 <component>__ 的字符串 <parameter>，如果这样做不会引起歧义。

参数:
**params字典

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

返回:
self对 self 的引用（参数设置后）
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

设置对象的 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_dict字典

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

返回:
Self

对 self 的引用。

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

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

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

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

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

所需状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入 self

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

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

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

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

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

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

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

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame，具有 3 级或更多级别行 MultiIndex (层级 1, ..., 层级 n, 时间)

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

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

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

update_params布尔值，可选（默认=True）

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

返回:
self对 self 的引用
update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#

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

此方法是执行多个 update / predict 链式操作的简写，数据回放基于时间分割器 cv。

与以下内容相同（如果只有 y、cv 非默认）

  1. self.update(y=cv.split_series(y)[0][0])

  2. 记住 self.predict() （稍后在单个批次中返回）

  3. self.update(y=cv.split_series(y)[1][0])

  4. 记住 self.predict() （稍后在单个批次中返回）

  5. 等等

  6. 返回所有记住的预测结果

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

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

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

所需状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入 self（除非 reset_forecaster=True）

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

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

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

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

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

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

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

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

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame，具有 3 级或更多级别行 MultiIndex (层级 1, ..., 层级 n, 时间)

有关数据格式的更多详细信息，请参阅 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_params布尔值，可选（默认=True）

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

reset_forecaster布尔值，可选（默认=True）

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

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

返回:
y_pred用于表格化多个分割批次的点预测的对象

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

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

  • 如果绝对范围点集合不唯一：类型是 pandas DataFrame，行和列索引均为时间戳。行索引对应于从中预测的截止点，列索引对应于预测的绝对范围。条目是根据行索引预测的列索引的点预测值。如果在该 (cutoff, horizon) 对上没有进行预测，则条目为 nan。

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

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

此方法有助于一步完成更新和预测。

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

所需状态

要求状态为“已拟合”。

在 self 中访问

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

写入 self

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

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

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

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

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

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

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

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame，具有 3 级或更多级别行 MultiIndex (层级 1, ..., 层级 n, 时间)

有关数据格式的更多详细信息，请参阅 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_params布尔值，可选（默认=True）

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

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

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