SkforecastAutoreg#

class SkforecastAutoreg(regressor: object, lags: int | ndarray | list, transformer_y: object | None = None, transformer_exog: object | None = None, weight_func: Callable | None = None, differentiation: int | None = None, fit_kwargs: dict | None = None, binner_kwargs: dict | None = None)[source]#

skforecast.ForecasterAutoreg.ForecasterAutoreg 类适配器 [1]。

参数:
regressor与 scikit-learn API 兼容的回归器或管道

与 scikit-learn API 兼容的回归器或管道实例

lagsint, list, numpy ndarray, range

用作预测器的滞后项。索引从 1 开始，所以滞后 1 等于 t-1。

  • int: 包含从 1 到 lags（包含）的滞后项。

  • list, 1d numpy ndarray 或 range: 仅包含 lags 中存在的滞后项，所有元素必须为 int。

lags，所有元素必须是整数。

transformer_y对象转换器（预处理器），默认 None

与 scikit-learn 预处理 API 兼容的转换器（预处理器）实例，具有方法：fit, transform, fit_transform 和 inverse_transform。ColumnTransformers 不允许使用，因为它们没有 inverse_transform 方法。转换在训练预测器之前应用于 y。

transformer_exog对象转换器（预处理器），默认 None

与 scikit-learn 预处理 API 兼容的转换器（预处理器）实例。转换在训练预测器之前应用于 exog。使用 ColumnTransformers 时 inverse_transform 不可用。

weight_funcCallable, 默认 None

根据索引定义每个样本个体权重的函数。例如，为某些日期分配较低权重的函数。如果 regressor 的 fit 方法没有 sample_weight 参数，则忽略此参数。生成的 sample_weight 不能有负值。

differentiationint, 默认 None

在训练预测器之前应用于时间序列的差分阶数。如果为 None，则不应用差分。差分阶数是差分操作应用于时间序列的次数。差分涉及计算序列中连续数据点之间的差异。差分在 predict() 和 predict_interval() 的输出中被反转。

fit_kwargsdict, 默认 None

要传递给回归器的 fit 方法的附加参数。

binner_kwargsdict, 默认 None

要传递给 KBinsDiscretizer 的附加参数，用于根据与每个残差相关的预测值将残差离散化为 k 个 bin。The `encode’ argument is always set to ‘ordinal’ and `dtype’ to np.float64。

属性:
cutoff

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

fh

传递的预测范围。

is_fitted

是否已调用 fit。

参考

示例

>>> from sktime.forecasting.compose import SkforecastAutoreg

无外部变量

>>> from sklearn.linear_model import LinearRegression
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> forecaster = SkforecastAutoreg(  
...     LinearRegression(), 2
... )
>>> forecaster.fit(y)  
SkforecastAutoreg(lags=2, regressor=LinearRegression())
>>> y_pred = forecaster.predict(fh=[1, 2, 3])  
>>> y_pred_int = forecaster.predict_interval(  
...     fh=[2], coverage=[0.9, 0.95]
... )
>>> y_pred_qtl = forecaster.predict_quantiles(  
...     fh=[1, 3], alpha=[0.8, 0.3, 0.2, 0.7]
... )

有外部变量

>>> from sklearn.ensemble import RandomForestRegressor
>>> from sktime.datasets import load_longley
>>> y, X = load_longley()
>>> y_train = y.head(n=12)
>>> y_test = y.tail(n=4)
>>> X_train = X.head(n=12)
>>> X_test = X.tail(n=4)
>>> forecaster = SkforecastAutoreg(  
...     RandomForestRegressor(), [2, 4]
... )
>>> forecaster.fit(y_train, X=X_train)  
SkforecastAutoreg(lags=[2, 4], regressor=RandomForestRegressor())
>>> y_pred = forecaster.predict(fh=[1, 2, 3], X=X_test)  
>>> y_pred_int = forecaster.predict_interval(  
...     fh=[1, 3], X=X_test, coverage=[0.6, 0.4]
... )
>>> y_pred_qtl = forecaster.predict_quantiles(  
...     fh=[1, 3], X=X_test, alpha=[0.01, 0.5]
... )

方法

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

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

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

将序列化的自身保存到字节类对象或 (.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, 可选

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

抛出:
未拟合错误

如果估计器尚未拟合。

clone()[source]#

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

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

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

状态改变

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

写入自身

  • 设置以“_”结尾的已拟合模型属性，已拟合属性可通过 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 具有两级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list of Series 类型的 pd.DataFrame

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

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

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

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

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

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

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

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 具有三级或更多级行 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 兼容格式的时间序列，可选 (默认值=None)。

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

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

用于预测的外部时间序列。如果传递，将在 predict 中使用，而不是 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

tag_name 标签在 self 中的值。如果未找到，则返回 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

tag_name 标签在 self 中的值。如果未找到，则在 raise_error 为 True 时抛出错误，否则返回 tag_value_default。

抛出:
ValueError, 如果 raise_error 为 True。

如果 tag_name 不在 self.get_tags().keys() 中，则抛出 ValueError。

get_tags()[source]#

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

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

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

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

值是对应的标签值，优先级降序如下：

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

在实例构造时。

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

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

按照继承顺序。

返回:
collected_tags字典

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

is_composite()[源]#

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

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

返回:
composite: 布尔值

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

属性 is_fitted[源]#

是否已调用 fit。

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

返回:
布尔值

评估器是否已 fit。

类方法 load_from_path(serial)[源]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回:
反序列化自身，结果输出到 path，来自 cls.save(path)
类方法 load_from_serial(serial)[源]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化自身，结果输出 serial，来自 cls.save(None)
predict(fh=None, X=None)[源]#

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

所需状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入自身

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

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

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

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

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

用于预测的外生时间序列。应与 fit 中的 y 具有相同的数据类型 (scitype) (Series, Panel, or 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，格式相同（见上文）

predict_interval(fh=None, X=None, coverage=0.9)[源]#

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

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

所需状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入自身

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

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

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

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

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

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

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

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

coverage浮点数或包含唯一浮点数的列表，可选 (default=0.90)

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

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

与输入 coverage 中的顺序相同。

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

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

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

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

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

predict_proba(fh=None, X=None, marginal=True)[源]#

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

注意

  • 目前仅针对 Series（非面板、非分层）y 实现。

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

所需状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入自身

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

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

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

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

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

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

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

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

marginal布尔值，可选 (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

写入自身

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

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

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

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

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

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

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

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

alpha浮点数或包含唯一浮点数的列表，可选 (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

写入自身

无。

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

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

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

  • 如果之前只进行了一次 fit 调用，则会产生样本内残差

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

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

用于更新和预测的外生时间序列 应与 fit 中的 y 具有相同的数据类型 (scitype) (Series, Panel, or Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 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

写入自身

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

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

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

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

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

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

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

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

cov布尔值，可选 (default=False)

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

返回:
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。

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

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

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

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

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

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

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

参数:
pathNone 或文件位置 (str 或 Path)

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

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

  • path=”/home/stored/estimator”，则会生成一个 zip 文件 estimator.zip，并存储在

存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

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

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

使用 MAPE（非对称）对预测结果进行评分。

参数:
ypd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D)

用于评分的时间序列

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

编码要预测的时间戳的预测范围。

Xpd.DataFrame, 或 2D np.array, 可选 (default=None)

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

返回:
score浮点数

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

另请参阅

sktime.performance_metrics.forecasting.mean_absolute_percentage_error
set_config(**config_dict)[源]#

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

参数:
config_dictdict

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

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

jupyter kernel 如何显示自身的实例

  • “diagram” = html 框图表示

  • “text” = 字符串输出

print_changed_only布尔值, default=True

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

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:params字典, 可选, 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”: 布尔值, default=True; False 会阻止 ray 在并行化后

      关闭。

    • “logger_name”: str, default=”ray”; 要使用的 logger 名称。

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

remember_data布尔值, default=True

self._X 和 self._y 是否在 fit 中存储，并在 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>。如果这使得引用明确，也可以使用不带 <component>__ 的字符串 <parameter>，例如，不存在两个同名参数的组件。

参数:
**params字典

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

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

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

通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将其设置为从 random_state 派生的整数。这些整数是通过链式哈希 (chain hashing) 从 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, 默认值=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对自身的引用
set_tags(**tag_dict)[源]#

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

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

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

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

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

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

参数:
**tag_dict字典

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

返回:
自身

对自身的引用。

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

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

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

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

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

所需状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入自身

  • 将 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 具有两级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list of Series 类型的 pd.DataFrame

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

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

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

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

update_params布尔值，可选 (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

写入自身（除非 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 具有两级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list of Series 类型的 pd.DataFrame

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

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

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

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

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

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

update_params布尔值，可选 (default=True)

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

reset_forecaster布尔值，可选 (default=True)

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

  • 如果为 False，则在运行 update/predict 序列时会更新自身，就像直接调用 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，则为以 “_” 结尾的模型属性。

写入自身

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

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

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

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

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

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

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

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

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

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

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

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

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

update_params布尔值，可选 (default=True)

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

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

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