BATS

class BATS(use_box_cox=None, box_cox_bounds=(0, 1), use_trend=None, use_damped_trend=None, sp=None, use_arma_errors=True, show_warnings=True, n_jobs=None, multiprocessing_start_method='spawn', context=None)

适用于具有多种季节性的时间序列的 BATS 预测器。

对[1]中方法在[2]中提出的实现的封装。请参阅[3]，了解[1]的创建者撰写的博客文章，其中简要解释了 BATS 模型。请参阅[4]，了解有关多种季节性的讨论以及 BATS 与其他一些方法的比较。

BATS 是以下各项的首字母缩写：

• Box-Cox 变换

• ARMA 误差

• 趋势

• 季节性成分

BATS 旨在预测具有多种季节性周期的时间序列。例如，每日数据可能具有每周模式和年度模式。或者每小时数据可以具有三个季节性周期：每日模式、每周模式和年度模式。

在 BATS 中，对原始时间序列应用 Box-Cox 变换，然后将其建模为指数平滑趋势、季节性成分和 ARMA 成分的线性组合。BATS 使用 AIC 进行一些超参数调整（例如保留哪些成分，丢弃哪些成分）。

参数:

use_box_cox: bool 或 None，可选（默认=None）

是否应应用原始序列的 Box-Cox 变换。当为 None 时，将考虑这两种情况，并根据 AIC 选择更好的。

box_cox_bounds: tuple，形状=(2,)，可选（默认=(0, 1)）

Box-Cox 参数的最小值和最大值。

use_trend: bool 或 None，可选（默认=None）

指示是否包含趋势。当为 None 时，将考虑这两种情况，并根据 AIC 选择更好的。

use_damped_trend: bool 或 None，可选（默认=None）

指示是否在趋势中包含阻尼参数。仅在使用了趋势时应用。当为 None 时，将考虑这两种情况，并根据 AIC 选择更好的。

sp: Iterable 或 array-like 的浮点数，可选（默认=None）

“季节周期”的缩写。每个周期的长度（每个周期中的观察数量）。此处接受 int 和 float 值。当为 None 或空数组时，将拟合非季节性模型。

use_arma_errors: bool，可选（默认=True）

当为 True 时，BATS 将尝试通过使用 ARMA 建模残差来改进模型。将根据 AIC 选择最佳模型。如果为 False，则不考虑 ARMA 残差建模。

show_warnings: bool，可选（默认=True）

是否显示警告。另请参阅包含所有与模型相关警告的 Model.warnings 变量。

n_jobs: int，可选（默认=None）

拟合 BATS 模型时并行运行多少个作业。未提供时，BATS 将尝试利用所有可用的 CPU 内核。

multiprocessing_start_method: str，可选（默认='spawn'）

线程应如何启动。另请参阅

https://docs.pythonlang.cn/3/library/multiprocessing.html#contexts-and-start-methods

context: abstract.ContextInterface，可选（默认=None）

仅适用于高级用户。提供此参数以覆盖默认行为

属性:

cutoff

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

fh

已传递的预测范围。

is_fitted

是否已调用 fit 方法。

另请参阅

TBATS

StatsForecastAutoTBATS

参考文献

[1] (1,2)

intive-DataScience/tbats

[2]

De Livera, A.M., Hyndman, R.J., & Snyder, R. D. (2011), Forecasting time series with complex seasonal patterns using exponential smoothing, Journal of the American Statistical Association, 106(496), 1513-1527. DOI: https://doi.org/10.1198/jasa.2011.tm09771

[3]

7. Skorupa. 在 Python 中使用 TBATS 进行多重季节性预测。

https://medium.com/intive-developers/forecasting-time-series-with-multiple-seasonalities-using-tbats-in-python-398a00ac0e8a

[4]

R.J. Hyndman, G. Athanasopoulos. Forecasting: Principles and Practice. https://otexts.com/fpp2/complexseasonality.html

示例

>>> from sktime.datasets import load_airline
>>> from sktime.forecasting.bats import BATS
>>> y = load_airline()
>>> forecaster = BATS(  
...     use_box_cox=False,
...     use_trend=False,
...     use_damped_trend=False,
...     sp=12,
...     use_arma_errors=False,
...     n_jobs=1)
>>> forecaster.fit(y)  
BATS(...)
>>> y_pred = forecaster.predict(fh=[1,2,3])  

方法

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()	检查对象是否由其他 BaseObject 组成。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化内存容器加载对象。
predict([fh, X])	在未来范围内预测时间序列。
predict_interval([fh, X, coverage])	计算/返回预测区间预测。
predict_proba([fh, X, marginal])	计算/返回完全概率预测。
predict_quantiles([fh, X, alpha])	计算/返回分位数预测。
predict_residuals([y, X])	返回时间序列预测的残差。
predict_var([fh, X, cov])	计算/返回方差预测。
reset()	将对象重置为初始状态后的干净状态。
save([path, serialization_format])	将序列化的自身保存为字节类对象或保存到 (.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')

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

参数:

parameter_setstr, 默认值=”default”

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

返回:

paramsdict 或 list of dict

check_is_fitted(method_name=None)

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:

method_namestr, 可选

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

引发:

NotFittedError

如果估计器尚未拟合。

clone()

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

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

将另一个对象的标签克隆为动态覆盖。

每个与 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 的引用。

classmethod create_test_instance(parameter_set='default')

使用第一个测试参数集构建该类的一个实例。

参数:

parameter_setstr, 默认值=”default”

返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，将返回 “default” 集。

返回:

instance具有默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')

创建所有测试实例列表及其名称列表。

参数:

parameter_setstr, 默认值=”default”

返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，将返回 “default” 集。

返回:

objscls 实例列表

第 i 个实例是 cls(**cls.get_test_params()[i])。

namesstr 列表，长度与 objs 相同

第 i 个元素是测试中 obj 的第 i 个实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}。

property cutoff

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

返回:

cutoffpandas 兼容的索引元素，或 None

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

property fh

已传递的预测范围。

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

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

状态变化

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

写入自身

• 设置以“_”结尾的拟合模型属性，拟合属性可通过 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, 默认值=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。

返回:

自身对自身的引用。

fit_predict(y, X=None, fh=None, X_pred=None)

在未来范围内拟合和预测时间序列。

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

状态变化

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

写入自身

• 设置以“_”结尾的拟合模型属性，拟合属性可通过 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) 进行强制转换。

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

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

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

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

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

每个与 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()

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

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

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

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

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

值是相应的标签值，覆盖优先级从高到低如下：

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

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

按继承顺序。

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

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

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

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

collected_tagsdict

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

get_config()

获取自身的配置标志。

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

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

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

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

返回:

config_dictdict

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

get_fitted_params(deep=True)

获取已拟合参数。

所需状态

要求状态为“已拟合”。

参数:

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

获取对象的参数默认值。

返回:

default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)

获取对象的参数名称。

参数:

sortbool, 默认值=True

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

返回:

param_names: list[str]

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

get_params(deep=True)

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

参数:

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)

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

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

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

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

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

在实例构造时。

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

3. 在父类的 _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()

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

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

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

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

值是相应的标签值，覆盖优先级从高到低如下：

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

在实例构造时。

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

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

按继承顺序。

返回:

collected_tagsdict

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

is_composite()

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

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

返回:

composite: bool

对象是否有任何参数的值是 BaseObject 的派生实例。

property is_fitted

是否已调用 fit 方法。

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

返回:

bool

估计器是否已 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

serialZipFile(path).open("object") 的结果

返回:

cls.save(path) 在 path 处产生的反序列化自身。

classmethod load_from_serial(serial)

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

参数:

serialcls.save(None) 输出的第 1 个元素

返回:

cls.save(None) 产生的输出 serial 的反序列化自身。

predict(fh=None, X=None)

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

所需状态

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

访问自身

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

• self.cutoff, self.is_fitted

写入自身

如果传入了 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 兼容格式的时间序列，可选 (默认值=None)

用于预测的外部时间序列。应与 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，格式相同（见上）。

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

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

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

所需状态

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

访问自身

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

• self.cutoff, self.is_fitted

写入自身

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

参数:

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

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

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

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

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

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

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

coveragefloat 或唯一 float 值列表，可选 (默认值=0.90)

预测区间名义覆盖率

返回:

pred_intpd.DataFrame

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

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

与输入 coverage 的顺序相同。

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

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

如果 fit 中看到的 y 是 Panel 或 Hierarchical，则为 fit 中看到的 y 的实例级别。

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

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

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

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

注意

• 目前仅针对 Series (非面板，非分层) y 实现。

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

所需状态

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

访问自身

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

• self.cutoff, self.is_fitted

写入自身

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

参数:

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

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

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

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

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

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

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

marginalbool, 可选 (默认值=True)

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

返回:

pred_distskpro BaseDistribution

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

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

计算/返回分位数预测。

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

所需状态

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

访问自身

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

• self.cutoff, self.is_fitted

写入自身

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

参数:

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

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

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

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

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

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

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

alphafloat 或唯一 float 值列表，可选 (默认值=[0.05, 0.95])

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

返回:

quantilespd.DataFrame

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

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

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

如果 fit 中看到的 y 是 Panel 或 Hierarchical，则为 fit 中看到的 y 的实例级别。

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

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

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.cutoff, self._is_fitted

写入自身

无。

参数:

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") 为 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.cutoff, self.is_fitted

写入自身

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

参数:

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

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

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

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

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

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

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

covbool, 可选 (默认值=False)

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

返回:

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

如果 cov=False

列名与在 fit`/update 中传入的 y 的列名完全相同。

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

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

如果 fit 中看到的 y 是 Panel 或 Hierarchical，则为 fit 中看到的 y 的实例级别。

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

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

如果 cov=True

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

第 2 级是 fh。

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

如果 fit 中看到的 y 是 Panel 或 Hierarchical，则为 fit 中看到的 y 的实例级别。

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

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

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

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))`` 后获得的对象相同。

返回:

自身

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

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

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

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

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

参数:

pathNone 或文件位置 (str 或 Path)

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

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

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

存储在 /home/stored/ 中。

serialization_format: str, 默认值 = “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, 可选 (默认值=None)

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

返回:

scorefloat

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

另请参阅

sktime.performance_metrics.forecasting.mean_absolute_percentage_error

set_config(**config_dict)

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

参数:

config_dictdict

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

displaystr, "diagram" (默认), 或 "text"

jupyter 内核如何显示自身的实例

• “diagram” = html 框图表示

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

print_changed_onlybool, 默认值=True

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

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

是否在 fit 中存储 self._X 和 self._y，并在 update 中更新它们。如果为 True，则存储并更新 self._X 和 self._y。如果为 False，则不存储和更新 self._X 和 self._y。这在使用 save 时会减少序列化大小，但 update 将默认为“什么也不做”，而不是“对所有已见数据重新进行拟合”。

返回:

self自身的引用。

注意

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

set_params(**params)

设置此对象的参数。

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

参数:

**paramsdict

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

返回:

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

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

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

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

适用于 self 中的 random_state 参数（取决于 self_policy），并且仅在 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 对象 valued 参数中的随机状态，即组件估计器。

• 如果为 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自身的引用

set_tags(**tag_dict)

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

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

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

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

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

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

参数:

**tag_dictdict

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

返回:

自身

自身的引用。

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

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

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

• update_params=True: 对目前所有已观察到的数据进行拟合

• update_params=False: 仅更新 cutoff 并记住数据

所需状态

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

访问自身

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

• 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 = 时间序列集合，全局/面板预测。具有 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。

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

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

update_paramsbool, 可选 (默认为 True)

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

返回:

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 方法，默认回退如下：

• update_params=True: 对目前所有已观察到的数据进行拟合

• update_params=False: 仅更新 cutoff 并记住数据

所需状态

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

访问自身

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

• 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 = 时间序列集合，全局/面板预测。具有 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 具有相同的科学类型 (scitype)（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为真，则 X.index 必须包含 fh 索引引用。

update_paramsbool, 可选 (默认为 True)

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

reset_forecasterbool, 可选 (默认为 True)

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

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

返回:

y_pred用于将来自多个分割批次的点预测制成表格的对象

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

• 如果 absolute horizon 点的集合是唯一的：类型为 sktime 兼容数据容器格式的时间序列，输出中省略 cutoff，与最近传递的 y 类型相同：Series, Panel, Hierarchical 科学类型 (scitype)，格式相同（见上文）。

• 如果 absolute horizon 点的集合不唯一：类型为 pandas DataFrame，行索引和列索引均为时间戳；行索引对应于进行预测的 cutoffs，列索引对应于预测的 absolute horizons；条目是根据行索引预测列索引的点预测值；如果在该 (cutoff, horizon) 对上未进行预测，则条目为 nan。

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

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

此方法可用于一步完成更新和进行预测。

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

所需状态

要求状态为“已拟合”。

访问自身

以 “_” 结尾的拟合模型属性。指向已见数据的指针，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 = 时间序列集合，全局/面板预测。具有 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 具有相同的科学类型 (scitype)（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为真，则 X.index 必须包含 fh 索引引用。

update_paramsbool, 可选 (默认为 True)

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

返回:

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

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