MOIRAIForecaster#

class MOIRAIForecaster(checkpoint_path: str, context_length=200, patch_size=32, num_samples=100, num_feat_dynamic_real=0, num_past_feat_dynamic_real=0, map_location=None, target_dim=2, broadcasting=False, deterministic=False, batch_size=32, use_source_package=False)[source]#

用于使用 MOIRAI 预测器的适配器。

参数:

checkpoint_pathstr, 默认=None

模型检查点的路径。支持的权重可在 [1] 获取。

context_lengthint, 默认=200

上下文窗口的长度，模型将作为推理输入的时间点。

patch_sizeint, 默认=32

用于执行分块的时间步长。

num_samplesint, 默认=100

采样的数量。

map_locationstr, 默认=None

模型使用的硬件。

target_dimint, 默认=2

目标的维度。

deterministicbool, 默认=False

是否使用确定性模型。

batch_sizeint, 默认=32

每个推理批次中的样本数量。

broadcastingbool, 默认=False

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

use_source_packagebool, 默认=False: 如果为 True，模型和配置将直接从源包 uni2ts.models.moirai 加载。如果你想绕过本地版本的包或在需要源包最新更新的环境中工作，这很有用。如果为 False，模型和配置将从 sktime 中维护的本地版本包加载。要安装源包，请按照此处的说明进行操作 [2]。

属性:

cutoff (截止点): 截止点 = 预测器的“当前时间”状态。
fh (预测范围): 传递的预测范围。
is_fitted (是否已拟合): 是否已调用 fit 方法。

参考文献

[1]

https://hugging-face.cn/collections/sktime/moirai-variations-66ba3bc9f1dfeeafaed3b974

[2]

https://pypi.ac.cn/project/uni2ts/1.1.0/

示例

>>> from sktime.forecasting.moirai_forecaster import MOIRAIForecaster
>>> import pandas as pd
>>> import numpy as np
>>> morai_forecaster = MOIRAIForecaster(
...     checkpoint_path=f"sktime/moirai-1.0-R-small"
... )
>>> y = np.random.normal(0, 1, (30, 2))
>>> X = y * 2 + np.random.normal(0, 1, (30,1))
>>> index = pd.date_range("2020-01-01", periods=30, freq="D")
>>> y = pd.DataFrame(y, index=index)
>>> X = pd.DataFrame(X, columns=["x1", "x2"], index=index)
>>> morai_forecaster.fit(y, X=X)
>>> X_test = pd.DataFrame(np.random.normal(0, 1, (10, 2)),
...                      columns=["x1", "x2"],
...                      index=pd.date_range("2020-01-31", periods=10, freq="D"),
... )
>>> forecast = morai_forecaster.predict(fh=range(1, 11), X=X_test)

方法

`check_is_fitted`([method_name])	检查估计器是否已拟合。
`check_period_index`(df)	检查索引是否为 PeriodIndex。
`check_range_index`(df)	检查索引是否为范围索引。
`clone (克隆)`()	获取具有相同超参数和配置的对象克隆。
`clone_tags`(estimator[, tag_names])	将另一个对象的标签克隆为动态覆盖。
`create_pandas_dataset`(df, target[, ...])	从输入数据创建 gluonts PandasDataset。
`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])	返回估计器的测试参数设置。
`handle_range_index`(index)	将 RangeIndex 转换为虚拟 DatetimeIndex。
`infer_freq`(index)	推断索引的频率。
`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 (重置)`()	将对象重置到干净的初始化后状态。
`return_time_index`(df)	给定任何类型的索引，返回时间索引。
`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 中的第一个（或唯一一个）字典。

create_pandas_dataset(df, target, dynamic_features=None, forecast_horizon=0)[source]#

从输入数据创建 gluonts PandasDataset。

参数:

dfpd.DataFrame: 输入数据。
targetstr: 目标列名。
dynamic_featureslist, 默认=None: 动态特征列表。
forecast_horizonint, 默认=0: 预测范围。

返回:

datasetPandasDataset: Pandas 数据集。
df_configdict: 输入数据的配置。

infer_freq(index)[source]#

推断索引的频率。

参数:

index: pd.Index: 时间序列数据的索引。

注意

仅使用索引的前 3 个值来推断频率。在多索引时间点的情况下，将返回 freq=None。

return_time_index(df)[source]#: 给定任何类型的索引，返回时间索引。

check_range_index(df)[source]#: 检查索引是否为范围索引。

check_period_index(df)[source]#: 检查索引是否为 PeriodIndex。

handle_range_index(index)[source]#

将 RangeIndex 转换为虚拟 DatetimeIndex。

因为 gluonts PandasDataset 期望 DatetimeIndex。

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 或 list of 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 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个，命名约定为 {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 (instance, time)、3D np.ndarray (instance, variable, time)、list of Series 类型 pd.DataFrame
Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, default=None

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

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

用于拟合模型的外部时间序列。应与 y 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index")，则 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 (instance, time)、3D np.ndarray (instance, variable, time)、list of Series 类型 pd.DataFrame
Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参阅 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 兼容格式的时间序列，可选 (default=None)。

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

X_predsktime 兼容格式的时间序列，可选 (default=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 的标签的值，同时考虑到标签覆盖，优先级从高到低依次为：

在类的 _tags 属性中设置的标签。
在父类的 _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 属性的任何键。

值为相应的标签值，覆盖优先级从高到低依次为：

在类的 _tags 属性中设置的标签。
在父类的 _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, default=True

是否返回组件的拟合参数。

如果为 True，将返回此对象的参数名称：值字典，包括可拟合组件（= BaseEstimator 值的参数）的拟合参数。
如果为 False，将返回此对象的参数名称：值字典，但不包括组件的拟合参数。

返回:

fitted_params带有 str 类型键的字典

拟合参数字典，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, default=True: 是否按字母顺序返回参数名称 (True)，或按它们在类的 __init__ 中出现的顺序返回 (False)。

返回:

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

get_params(deep=True)[source]#

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

参数:

deepbool, default=True

是否返回组件的参数。

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

返回:

params带有 str 类型键的字典

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

总是：此对象的所有参数，如通过 get_param_names 获取的值是此对象该键的参数值，值总是与构建时传递的值相同
如果 deep=True，则还包含组件参数的键/值对，组件的参数以 [componentname]__[paramname] 索引，componentname 的所有参数都以 paramname 及其值出现
如果 deep=True，则还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等。

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

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

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

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

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

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

在实例构建时。

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

按照继承顺序。

参数:

tag_namestr: 要检索的标签名称
tag_value_default任意类型，可选；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 设置的标签。

值为相应的标签值，覆盖优先级从高到低依次为：

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

在实例构建时。

在类的 _tags 属性中设置的标签。
在父类的 _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) 输出的第 1 个元素

返回:

反序列化的 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, default=None: 编码预测时间戳的预测范围。如果在 fit 中已传递，则不应再传递。如果在 fit 中未传递，则必须传递，不可选。
Xsktime 兼容格式的时间序列，可选 (default=None): 用于预测的外部时间序列。应与 fit 中的 y 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 fh 索引引用。如果未传递 y（未执行全局预测），则 X 应仅包含要预测的时间点。如果传递了 y（执行全局预测），则 X 必须包含所有历史值和要预测的时间点。
ysktime 兼容格式的时间序列，可选 (default=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, 可选 (default=None): 编码预测时间戳的预测范围。如果在 fit 中已传递，则不应再传递。如果在 fit 中未传递，则必须传递，不可选。
Xsktime 兼容格式的时间序列，可选 (default=None): 用于预测的外部时间序列。应与 fit 中的 y 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 fh 索引引用。如果传递了 y（执行全局预测），则 X 必须包含所有历史值和要预测的时间点。
coveragefloat 或唯一值列表，可选 (default=0.90): 预测区间(s) 的名义覆盖率(s)
ysktime 兼容格式的时间序列，可选 (default=None): 应预测时间序列的历史值。如果不为 None，将执行全局预测。仅传递历史值，而不是要预测的时间点。

返回:

pred_intpd.DataFrame

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

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

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

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

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

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

对于列索引中的 var，在第二列索引中的名义覆盖率处，下限/上限取决于第三列索引，对于行索引。上限/下限区间预测等价于对 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（非面板、非分层）y 实现。

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

访问 self 中的内容

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

self.cutoff, self.is_fitted

写入 self: 如果 fh 已传递且之前未传递过，则将 fh 存储到 self.fh。

参数:

fhint, list, np.array 或 ForecastingHorizon, 可选 (default=None): 编码预测时间戳的预测范围。如果在 fit 中已传递，则不应再传递。如果在 fit 中未传递，则必须传递，不可选。
Xsktime 兼容格式的时间序列，可选 (default=None): 用于预测的外部时间序列。应与 fit 中的 y 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 fh 索引引用。如果传递了 y（执行全局预测），则 X 必须包含所有历史值和要预测的时间点。
marginalbool, optional (default=True): 返回的分布是否按时间索引边际
ysktime 兼容格式的时间序列，可选 (default=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, 可选 (default=None): 编码预测时间戳的预测范围。如果在 fit 中已传递，则不应再传递。如果在 fit 中未传递，则必须传递，不可选。
Xsktime 兼容格式的时间序列，可选 (default=None): 用于预测的外部时间序列。应与 fit 中的 y 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 fh 索引引用。如果传递了 y（执行全局预测），则 X 必须包含所有历史值和要预测的时间点。
alphafloat 或唯一值列表，可选 (default=[0.05, 0.95]): 计算分位数预测的概率或概率列表。
ysktime 兼容格式的时间序列，可选 (default=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)[source]#

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

将计算 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 兼容格式的时间序列，可选 (default=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, 可选 (default=None): 编码预测时间戳的预测范围。如果在 fit 中已传递，则不应再传递。如果在 fit 中未传递，则必须传递，不可选。
Xsktime 兼容格式的时间序列，可选 (default=None): 用于预测的外部时间序列。应与 fit 中的 y 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 fh 索引引用。
covbool, optional (default=False): 如果为 True，则计算协方差矩阵预测。如果为 False，则计算边际方差预测。
ysktime 兼容格式的时间序列，可选 (default=None): 应预测时间序列的历史值。如果不为 None，将执行全局预测。仅传递历史值，而不是要预测的时间点。

返回:

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

如果 cov=False

列名与 fit/update 中传递的 y 的列名完全相同。: 对于无名格式，列索引将为 RangeIndex。
行索引是 fh，附加级别等于实例级别，: 来自 fit 中看到的 y，如果 fit 中看到的 y 是 Panel 或 Hierarchical。

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

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

如果 cov=True

列索引是多级索引：第一级是变量名（同上）: 第二级是 fh。
行索引是 fh，附加级别等于实例级别，: 来自 fit 中看到的 y，如果 fit 中看到的 y 是 Panel 或 Hierarchical。
条目是（协）方差预测，对于列索引中的 var，以及: 行和列中时间索引之间的协方差。

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

注意

如果 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"，则将在当前工作目录创建 zip 文件 estimator.zip。
path="/home/stored/estimator"，则 zip 文件 estimator.zip 将

存储在 /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, default=None: 编码预测时间戳的预测范围。
Xpd.DataFrame 或 2D np.array，可选 (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)[source]#

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

参数:

config_dictdict

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

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

jupyter kernel 如何显示 self 的实例

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

print_changed_onlybool, default=True

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

warningsstr, “on” (默认), 或 “off”

是否引发警告，仅影响 sktime 的警告

“on” = 将引发来自 sktime 的警告
“off” = 将不引发来自 sktime 的警告

backend:parallelstr, 可选, default=”None”

广播/向量化时用于并行化的后端，以下之一：

“None”：顺序执行循环，简单的列表推导
“loky”, “multiprocessing” 和 “threading”：使用 joblib.Parallel
“joblib”：自定义和第三方 joblib 后端，例如 spark
“dask”：使用 dask，需要环境中包含 dask 包
“ray”：使用 ray，需要环境中包含 ray 包

backend:parallel:paramsdict, 可选, default={} (未传递参数)

作为配置传递给并行化后端的附加参数。有效的键取决于 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, 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引用 self。

注意

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

set_params(**params)[source]#

设置此对象的参数。

该方法适用于简单的 skbase 对象以及组合对象。参数键字符串 <component>__<parameter> 可用于组合对象（即包含其他对象的对象），以访问组件 <component> 中的 <parameter>。如果不包含 <component>__ 的字符串 <parameter> 能够明确引用（例如，没有两个组件参数具有名称 <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, default=None

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

deepbool, default=True

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

如果为 False，将仅设置 self 的 random_state 参数（如果存在）。
如果为 True，也将设置组件对象中的 random_state 参数。

self_policystr, 以下之一: {“copy”, “keep”, “new”}, default=”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_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

将 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)、list of Series 类型 pd.DataFrame
Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

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

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

update_paramsbool, optional (default=True)

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

返回:

self引用 self

update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#

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

用于执行多次 update / predict 执行序列的快捷方式，基于时间分割器 cv 进行数据回放。

与以下操作相同（如果只有 y 和 cv 不是默认值）：

self.update(y=cv.split_series(y)[0][0])
记住 self.predict()（稍后在单个批次中返回）
self.update(y=cv.split_series(y)[1][0])
记住 self.predict()（稍后在单个批次中返回）
等等
返回所有记住的预测

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

update_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)、list of Series 类型 pd.DataFrame
Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

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

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

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

用于更新和预测的外部时间序列，应与 fit 中的 y 具有相同的 scitype（Series、Panel 或 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，就像直接调用更新/预测一样。

返回:

y_pred一个对象，用于汇总多个分割批次的点预测

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

如果绝对范围点集合是唯一的：类型是 sktime 兼容数据容器格式的时间序列，输出中省略了截止点，具有与最近传递的 y 相同的类型：Series、Panel、Hierarchical scitype，相同的格式（见上文）。
如果绝对范围点集合不是唯一的：类型是 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，则更新以“_”结尾的模型属性。
写入 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)、list of Series 类型 pd.DataFrame
Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, default=None

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

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

用于更新和预测的外部时间序列，应与 fit 中的 y 具有相同的 scitype（Series、Panel 或 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，相同的格式（见上文）