TimesFMForecaster#

class TimesFMForecaster(context_len=None, horizon_len=128, freq=0, repo_id='google/timesfm-1.0-200m', input_patch_len=32, output_patch_len=128, num_layers=20, model_dims=1280, per_core_batch_size=32, backend='cpu', verbose=False, broadcasting=False, use_source_package=False, ignore_deps=False)[source]#

TimesFM（时间序列基础模型）的实现，用于零样本预测。

TimesFM（时间序列基础模型）是 Google Research 开发的预训练时间序列基础模型，用于时间序列预测。该方法已在 [2] 中提出，官方代码位于 [1]。

TimesFM 可以作为 sktime 中本地维护的包使用，也可以直接从源包使用，这允许用户利用他们自己的环境或从源包 timesfm 获取最新更新。

该类提供了两个标志来处理依赖项和源包行为

  • use_source_package: 确定包代码的来源：False 表示 sktime 中带有默认依赖项的供应商分支。True 表示源包 timesfm。

  • ignore_deps: 如果设置，则完全绕过依赖项检查。这适用于希望手动管理环境的用户。

参数:
context_lenint，可选 (默认=None)

输入上下文序列的长度。如果设置为 None，则上下文长度会自动计算为大于输入时间序列 y 长度的最小 input_patch_len（32）倍数。它应该是 input_patch_len（32）的倍数。目前支持的最大上下文长度为 512，但这可以在未来版本中增加。输入时间序列可以有任何上下文长度，如有必要，模型推理代码将处理填充或截断。

horizon_lenint，可选 (默认=128)

预测视界的长度。如果设置为 None，则预测视界会根据提供的预测视界 fh 动态确定（如果可用）。这可以设置为任何值，但通常建议将其保持小于或等于 context_len 以获得最佳性能。即使 horizon_len 超过 context_len，模型仍将运行。

freqint，可选 (默认=0)

输入时间序列的频率类别。

  • 0：高频、长视界时间序列（例如，每日数据及以上）。

  • 1：中频时间序列（例如，每周、每月数据）。

  • 2：低频、短视界时间序列（例如，每季度、每年数据）。

您可以根据您的特定用例将此参数视为自由参数，但建议遵循这些指南以获得最佳结果。

repo_idstr，可选 (默认=”google/timesfm-1.0-200m”)

模型仓库的标识符。默认模型是 200M 参数版本。

input_patch_lenint，可选 (默认=32)

模型处理的输入块的固定长度。对于 200M 模型，此参数固定为 1280，不应更改。

output_patch_lenint，可选 (默认=128)

模型生成的输出块的固定长度。对于 200M 模型，此参数固定为 1280，不应更改。

num_layersint，可选 (默认=20)

模型架构中的层数。对于 200M 模型，此参数固定为 1280，不应更改。

model_dimsint，可选 (默认=1280)

模型维度。对于 200M 模型，此参数固定为 1280，不应更改。

per_core_batch_sizeint，可选 (默认=32)

模型推理期间每个核心使用的批处理大小。

backendstr，可选 (默认=”cpu”)

要使用的计算后端，可以是“cpu”、“gpu”或“tpu”之一。此设置区分大小写。

verbosebool，可选 (默认=False)

是否在执行期间打印详细日志。

broadcastingbool，默认=False

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

use_source_packagebool，默认=False

如果为 True，模型将直接从源包 timesfm 加载。这也强制要求 timesfm 的版本小于 1.2.0。如果需要从源包获取最新更新，此设置很有用，可绕过本地版本的包。

ignore_depsbool，默认=False

如果为 True，将忽略依赖项检查，用户需要手动处理所需包的安装。如果为 False，则该类将通过 use_source_package 强制执行上述供应商库或 pypi 包所需的默认依赖项。

属性:
截止点

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

fh

已传递的预测视界。

is_fitted

`fit` 是否已被调用。

参考文献

[2]

Das, A., Kong, W., Sen, R., & Zhou, Y. (2024)。

用于时间序列预测的仅解码器基础模型。CoRR。

示例

>>> from sktime.forecasting.timesfm_forecaster import TimesFMForecaster
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> forecaster = TimesFMForecaster(
...     context_len=32,
...     horizon_len=8,
... ) 
>>> forecaster.fit(y, fh=[1, 2, 3]) 
>>> y_pred = forecaster.predict() 

>>> from sktime.forecasting.timesfm_forecaster import TimesFMForecaster
>>> 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 = TimesFMForecaster(
...     context_len=32,
...     horizon_len=8,
... ) 
>>>
>>> # train and predict
>>> forecaster.fit(y, fh=[1, 2, 3]) 
>>> y_pred = forecaster.predict()

方法

check_is_fitted([method_name])

检查估计器是否已拟合。

克隆()

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

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

计算/返回方差预测。

重置()

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

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，默认值 = {}

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:
method_namestr，可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

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

等同于使用 self 的参数构造 type(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 或 list of str，默认值 = None

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

返回:
自身

对 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])

nameslist of str，与 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]#

使用训练数据拟合预测器。

状态更改

状态更改为“已拟合”。

写入自身

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

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

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

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

参数:
y`sktime` 兼容数据容器格式的时间序列。

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

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 中传递，不可选。

X`sktime` 兼容格式的时间序列，可选 (默认值=None)。

用于拟合模型的外生时间序列。应与 y 具有相同的 scitype（Series, Panel 或 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)[source]#

在未来视界拟合和预测时间序列。

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

状态更改

状态更改为“已拟合”。

写入自身

  • 设置以“_”结尾的已拟合模型属性，已拟合属性可通过 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 的 list

  • 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) 强制转换。

X`sktime` 兼容格式的时间序列，可选 (默认值=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)[source]#

从类中获取类标签值，包括父类的标签继承。

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

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 的键值对，它们是对象构造后不会更改的静态标志。

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

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

  • 始终：此对象的所有已拟合参数，通过 get_param_names 获取的值是该键对应的已拟合参数值，属于此对象

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

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

classmethod get_param_defaults()[source]#

获取对象的参数默认值。

返回:
default_dict: dict[str, Any]

键是 cls 中所有在 __init__ 中定义了默认值的参数。值是默认值，如 __init__ 中定义的那样。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数:
sortbool，默认值=True

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

返回:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deepbool，默认值=True

是否返回组件的参数。

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

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

返回:
params具有 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)[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_valueAny

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

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

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

返回:
composite: bool

对象是否有任何参数的值是 BaseObject 的后代实例。

property is_fitted[source]#

`fit` 是否已被调用。

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

返回:
bool

估计器是否已拟合 (`fit`)。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialresult of ZipFile(path).open(“object)
返回:
反序列化 self，其结果位于 path，是 cls.save(path) 的输出。
classmethod load_from_serial(serial)[source]#

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

参数:
serial1st element of output of cls.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

写入自身

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

参数:
fhint, list, pd.Index 可强制转换类型, 或 ForecastingHorizon, 默认值=None

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

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

预测中使用的外生时间序列。应与 fit 中 y 的科学类型 (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

写入自身

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

参数:
fhint, list, np.array 或 ForecastingHorizon，可选（默认为 None）

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

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

预测中使用的外生时间序列。应与 fit 中 y 的科学类型 (Series, Panel, 或 Hierarchical) 相同。如果 self.get_tag("X-y-must-have-same-index") 为真，则 X.index 必须包含 fh 索引引用。如果传递了 y (正在执行全局预测)，则 X 必须包含所有历史值和要预测的时间点。

coveragefloat 或 unique float 值的列表，可选（默认为 0.90）

预测区间的名义覆盖率

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

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

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

与输入 coverage 的顺序相同。

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

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

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

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

对于列索引中的变量，在第二个列索引中的名义覆盖率下，根据第三个列索引是 lower/upper，对应于行索引。对于 coverage 中的 c，上限/下限区间预测等同于 alpha = 0.5 - c/2, 0.5 + c/2 的分位数预测。

注释

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

写入自身

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

参数:
fhint, list, np.array 或 ForecastingHorizon，可选（默认为 None）

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

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

预测中使用的外生时间序列。应与 fit 中 y 的科学类型 (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)[source]#

计算/返回分位数预测。

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

所需状态

要求状态为“已拟合”，即 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 的科学类型 (Series, Panel, 或 Hierarchical) 相同。如果 self.get_tag("X-y-must-have-same-index") 为真，则 X.index 必须包含 fh 索引引用。如果传递了 y (正在执行全局预测)，则 X 必须包含所有历史值和要预测的时间点。

alphafloat 或 unique float 值的列表，可选（默认为 [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

写入自身

无。

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

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

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

  • 如果之前只调用过一次 fit，则生成样本内残差

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

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

用于更新和预测的外生时间序列。应与 fit 中 y 的科学类型 (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 科学类型，格式相同（见上文）

predict_var(fh=None, X=None, cov=False, y=None)[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 的科学类型 (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。

条目是方差预测值，对于列索引中的变量。给定变量和 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))`` 后获得的对象相同。

返回:
自身

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

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”，则将在

存储在 /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

编码要预测的时间戳的预测视界。如果 fh 不是 None 且不是 ForecastingHorizon 类型，则通过调用 _check_fh 将其强制转换为 ForecastingHorizon。

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

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

参数:
config_dictdict

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

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_databool, 默认为 True

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

返回:
selfself 的引用。

注释

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:
**paramsdict

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

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

设置自身的 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 派生，并且通常与它不同

返回:
selfself 的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:
**tag_dictdict

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

返回:
Self

self 的引用。

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

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

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

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

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

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入自身

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

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

参数:
y`sktime` 兼容数据容器格式的时间序列。

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

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

X`sktime` 兼容格式的时间序列，可选 (默认值=None)。

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

update_paramsbool, 可选（默认为 True）

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

返回:
selfself 的引用
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_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，则不更新状态。

参数:
y`sktime` 兼容数据容器格式的时间序列。

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

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

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

例如，SlidingWindowSplitter 或 ExpandingWindowSplitter；默认 = 初始窗口 initial_window=1 的 ExpandingWindowSplitter，以及默认值 = y/X 中的单个数据点一个接一个地添加和预测，initial_window = 1，step_length = 1 和 fh = 1

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

用于更新和预测的外生时间序列。应与 fit 中 y 的科学类型 (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 序列时将更新 self，如同直接调用 update/predict 一样

返回:
y_pred汇总来自多个分割批次的点预测值的对象

格式取决于整体预测的（截止点，绝对范围）对

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

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

update_predict_single(y=None, fh=None, X=None, update_params=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，

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

参数:
y`sktime` 兼容数据容器格式的时间序列。

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

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

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

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

用于更新和预测的外生时间序列。应与 fit 中 y 的科学类型 (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，格式相同（见上文）