TBATS#
- class TBATS(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)[source]#
用于具有多重季节性时间序列的 TBATS 预测器。
封装了 [1] 中对 [2] 提出的方法的实现。参见 [3] 查看 [1] 创建者撰写的博客文章,其中简要解释了 TBATS 模型。参见 [4] 查看关于多重季节性的讨论以及 TBATS 与其他一些方法的比较讨论。
TBATS 是以下各项的首字母缩写:
三角季节性
Box-Cox 变换
ARMA 误差
趋势
季节性分量
TBATS 设计用于预测具有多重季节性周期的时间序列。例如,日数据可能具有每周模式和年度模式。或者小时数据可以有三个季节性周期:每日模式、每周模式和年度模式。
在 TBATS 中,对原始时间序列应用 Box-Cox 变换,然后将其建模为指数平滑趋势、季节性分量和 ARMA 分量的线性组合。季节性分量通过傅里叶级数使用三角函数建模。TBATS 使用 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 的浮点数, 可选 (默认=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)
仅适用于高级用户。提供此参数以覆盖默认行为
- 属性:
另请参见
BATS
StatsForecastAutoTBATS
参考文献
[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]Skorupa. Multiple Seasonalities using TBATS in Python.
[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.tbats import TBATS >>> y = load_airline() >>> forecaster = TBATS( ... use_box_cox=False, ... use_trend=False, ... use_damped_trend=False, ... sp=12, ... use_arma_errors=False, ... n_jobs=1) >>> forecaster.fit(y) TBATS(...) >>> 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_fitted_params
([deep])获取已拟合参数。
获取对象的默认参数。
get_param_names
([sort])获取对象的参数名称。
get_params
([deep])获取此对象的参数值字典。
get_tag
(tag_name[, tag_value_default, ...])从实例中获取标签值,并包含标签级别继承和覆盖。
get_tags
()从实例中获取标签,并包含标签级别继承和覆盖。
get_test_params
([parameter_set])返回估计器的测试参数设置。
检查对象是否由其他 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, ...])为 self 设置 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”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回
"default"
集。
- Returns:
- paramsdict or list of dict
- check_is_fitted(method_name=None)[source]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。is_fitted
属性应在调用对象的fit
方法时设置为True
。如果不是,则引发
NotFittedError
。- 参数:
- method_namestr, optional
调用此方法的方法的名称。如果提供,错误消息将包含此信息。
- Raises:
- NotFittedError
如果估计器尚未拟合。
- 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
。- Raises:
- 如果克隆不符合规范(由于
__init__
存在错误),则引发 RuntimeError。
- 如果克隆不符合规范(由于
- clone_tags(estimator, tag_names=None)[source]#
从另一个对象克隆标签作为动态覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是对象构造后不会更改的静态标志。clone_tags
从另一个对象estimator
设置动态标签覆盖。clone_tags
方法应仅在对象的__init__
方法中(在构造期间),或在通过__init__
构造后直接调用。动态标签设置为
estimator
中标签的值,名称由tag_names
指定。tag_names
的默认设置将estimator
中的所有标签写入self
。当前标签值可通过
get_tags
或get_tag
进行检查。- 参数:
- estimator:class:BaseObject 或派生类的实例
- tag_namesstr 或 str 列表, default = None
要克隆的标签名称。默认值 (
None
) 克隆estimator
中的所有标签。
- Returns:
- self
对
self
的引用。
- classmethod create_test_instance(parameter_set='default')[source]#
使用第一个测试参数集构造类的实例。
- 参数:
- parameter_setstr, default=”default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回 “default” 集。
- Returns:
- instance带默认参数的类实例
- classmethod create_test_instances_and_names(parameter_set='default')[source]#
创建所有测试实例及其名称列表。
- 参数:
- parameter_setstr, default=”default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回 “default” 集。
- Returns:
- objscls 实例列表
第 i 个实例是
cls(**cls.get_test_params()[i])
- namesstr 列表,与 objs 长度相同
第 i 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个,命名约定为
{cls.__name__}-{i}
,否则为{cls.__name__}
- property cutoff[source]#
截止点 = 预测器的“当前时间”状态。
- Returns:
- cutoffpandas 兼容索引元素,或 None
如果已设置截止点,则为 pandas 兼容索引元素;否则为 None
- fit(y, X=None, fh=None)[source]#
将预测器拟合到训练数据。
- 状态改变
将状态更改为“已拟合”。
写入 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
),Series 类型pd.DataFrame
的list
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
。
- Returns:
- 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
),Series 类型pd.DataFrame
的list
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)
用于预测的外部时间序列。如果传递,将用于 predict 而不是 X。应与 fit 中的
y
具有相同的 scitype (Series
,Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。
- Returns:
- 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任意类型
未找到标签时的默认/备用值。
- Returns:
- 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
调用中保留。- Returns:
- config_dictdict
配置名称:配置值 对的字典。通过嵌套继承从 _config 类属性收集,然后是 _onfig_dynamic 对象属性中的任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取已拟合参数。
- 状态要求
要求状态为“已拟合”。
- 参数:
- deepbool, default=True
是否返回组件的拟合参数。
如果为 True,将返回此对象的参数名称:值字典,包括可拟合组件(= BaseEstimator 值参数)的拟合参数。
如果为 False,将返回此对象的参数名称:值字典,但不包括组件的拟合参数。
- Returns:
- 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]#
获取对象的参数默认值。
- Returns:
- default_dict: dict[str, Any]
键是
cls
的所有在__init__
中定义了默认值的参数。值是默认值,与__init__
中定义的相同。
- classmethod get_param_names(sort=True)[source]#
获取对象的参数名称。
- 参数:
- sortbool, default=True
是否按字母顺序 (True) 或按它们在类
__init__
中出现的顺序 (False) 返回参数名称。
- Returns:
- param_names: list[str]
cls
的参数名称列表。如果sort=False
,则与它们在类__init__
中出现的顺序相同。如果sort=True
,则按字母顺序排序。
- get_params(deep=True)[source]#
获取此对象的参数值字典。
- 参数:
- deepbool, default=True
是否返回组件的参数。
如果为
True
,将返回此对象的参数名称:值dict
,包括组件(=BaseObject
值参数)的参数。如果为
False
,将返回此对象的参数名称:值dict
,但不包括组件的参数。
- Returns:
- 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
的单个标签的值,在考虑标签覆盖时,优先级按以下顺序递减通过
set_tags
或clone_tags
在实例上设置的标签,
在实例构造时。
类属性
_tags
中设置的标签。父类属性
_tags
中设置的标签,
按继承顺序。
- 参数:
- tag_namestr
要检索的标签名称
- tag_value_default任意类型,可选;default=None
未找到标签时的默认/备用值
- raise_errorbool
未找到标签时是否引发
ValueError
- Returns:
- tag_valueAny
self
中tag_name
标签的值。如果未找到,则在raise_error
为 True 时引发错误,否则返回tag_value_default
。
- Raises:
- ValueError,如果
raise_error
为True
。 当
tag_name
不在self.get_tags().keys()
中时,将引发ValueError
。
- ValueError,如果
- get_tags()[source]#
从实例中获取标签,并包含标签级别继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是对象构造后不会更改的静态标志。get_tags
方法返回一个标签字典,其键是类或其任何父类中设置的任何_tags
属性的键,或者通过set_tags
或clone_tags
设置的标签。值是相应的标签值,覆盖优先级按以下顺序递减
通过
set_tags
或clone_tags
在实例上设置的标签,
在实例构造时。
类属性
_tags
中设置的标签。父类属性
_tags
中设置的标签,
按继承顺序。
- Returns:
- collected_tagsdict
标签名称:标签值 对的字典。通过嵌套继承从
_tags
类属性收集,然后是_tags_dynamic
对象属性中的任何覆盖和新标签。
- is_composite()[source]#
检查对象是否由其他 BaseObjects 组成。
复合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- Returns:
- composite: bool
对象是否包含任何值为
BaseObject
后代实例的参数。
- property is_fitted[source]#
是否已调用
fit
。检查对象的
_is_fitted` 属性,该属性应在对象构造期间初始化为 ``False
,并在调用对象的 fit 方法时设置为 True。- Returns:
- bool
估计器是否已 fit。
- classmethod load_from_path(serial)[source]#
从文件位置加载对象。
- 参数:
- serialZipFile(path).open(“object) 的结果
- Returns:
- 反序列化的 self,其输出位于
cls.save(path)
的path
处
- 反序列化的 self,其输出位于
- classmethod load_from_serial(serial)[source]#
从序列化的内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- Returns:
- 反序列化的 self,其输出为
cls.save(None)
的serial
- 反序列化的 self,其输出为
- predict(fh=None, X=None)[source]#
在未来范围内预测时间序列。
- 状态要求
要求状态为“已拟合”,即
self.is_fitted=True
。
访问 self 中的属性
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
- 写入 self
如果传递了
fh
且之前未传递,则将其存储到self.fh
。
- 参数:
- fhint、list、可强制转换为 pd.Index 或
ForecastingHorizon
,default=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
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。
- fhint、list、可强制转换为 pd.Index 或
- Returns:
- y_predsktime 兼容数据容器格式的时间序列
在
fh
处的点预测,具有与fh
相同的索引。y_pred
具有与最近传递的y
相同的类型:Series
、Panel
、Hierarchical
scitype,格式相同(见上文)
- predict_interval(fh=None, X=None, coverage=0.9)[source]#
计算/返回预测区间预测。
如果
coverage
是可迭代的,将计算多个区间。- 状态要求
要求状态为“已拟合”,即
self.is_fitted=True
。
访问 self 中的属性
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
- 写入 self
如果传递了
fh
且之前未传递,则将其存储到self.fh
。
- 参数:
- fhint、list、可强制转换为 pd.Index 或
ForecastingHorizon
,default=None 编码要预测的时间戳的预测范围。如果已在
fit
中传递,则不应再传递。如果在 fit 中未传递,则必须传递,不是可选的。如果
fh
不是 None 且不是ForecastingHorizon
类型,则内部(通过_check_fh
)会强制转换为ForecastingHorizon
。如果
fh
是int
或类似 array 的int
,则将其解释为相对范围,并强制转换为相对ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,则将其解释为绝对范围,并强制转换为绝对ForecastingHorizon(fh, is_relative=False)
。
- Xsktime 兼容格式的时间序列,可选 (default=None)
用于预测的外部时间序列。应与 fit 中的
y
具有相同的 scitype (Series
,Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。- coveragefloat 或 float 的唯一值列表,可选 (default=0.90)
预测区间名义覆盖率
- fhint、list、可强制转换为 pd.Index 或
- Returns:
- 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 的分位数预测。
- predict_proba(fh=None, X=None, marginal=True)[source]#
计算/返回完全概率预测。
注意
目前仅针对 Series(非面板,非分层)y 实现。
需要安装
skpro
以返回分布对象。
- 状态要求
要求状态为“已拟合”,即
self.is_fitted=True
。
访问 self 中的属性
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
- 写入 self
如果传递了
fh
且之前未传递,则将其存储到self.fh
。
- 参数:
- fhint、list、可强制转换为 pd.Index 或
ForecastingHorizon
,default=None 编码要预测的时间戳的预测范围。如果已在
fit
中传递,则不应再传递。如果在 fit 中未传递,则必须传递,不是可选的。如果
fh
不是 None 且不是ForecastingHorizon
类型,则内部(通过_check_fh
)会强制转换为ForecastingHorizon
。如果
fh
是int
或类似 array 的int
,则将其解释为相对范围,并强制转换为相对ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,则将其解释为绝对范围,并强制转换为绝对ForecastingHorizon(fh, is_relative=False)
。
- Xsktime 兼容格式的时间序列,可选 (default=None)
用于预测的外部时间序列。应与 fit 中的
y
具有相同的 scitype (Series
,Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。- marginalbool, optional (default=True)
返回的分布是否按时间索引是边际的
- fhint、list、可强制转换为 pd.Index 或
- Returns:
- pred_distskpro BaseDistribution
如果 marginal=True,则为预测分布,将是按时间点的边际分布,如果 marginal=False 且由方法实现,将是联合分布
- predict_quantiles(fh=None, X=None, alpha=None)[source]#
计算/返回分位数预测。
如果
alpha
是可迭代的,将计算多个分位数。- 状态要求
要求状态为“已拟合”,即
self.is_fitted=True
。
访问 self 中的属性
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
- 写入 self
如果传递了
fh
且之前未传递,则将其存储到self.fh
。
- 参数:
- fhint、list、可强制转换为 pd.Index 或
ForecastingHorizon
,default=None 编码要预测的时间戳的预测范围。如果已在
fit
中传递,则不应再传递。如果在 fit 中未传递,则必须传递,不是可选的。如果
fh
不是 None 且不是ForecastingHorizon
类型,则内部(通过_check_fh
)会强制转换为ForecastingHorizon
。如果
fh
是int
或类似 array 的int
,则将其解释为相对范围,并强制转换为相对ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,则将其解释为绝对范围,并强制转换为绝对ForecastingHorizon(fh, is_relative=False)
。
- Xsktime 兼容格式的时间序列,可选 (default=None)
用于预测的外部时间序列。应与 fit 中的
y
具有相同的 scitype (Series
,Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。- alphafloat 或 float 的唯一值列表,可选 (default=[0.05, 0.95])
计算分位数预测的概率或列表。
- fhint、list、可强制转换为 pd.Index 或
- Returns:
- quantilespd.DataFrame
- 列具有多重索引:第一级是 fit 中 y 的变量名,
第二级是传递给函数的 alpha 值。
- 行索引是 fh,具有等于实例级别的附加(上层)级别,
来自 fit 中看到的 y,如果 fit 中看到的 y 是 Panel 或 Hierarchical。
- 条目是分位数预测,对于列索引中的变量,
在第二列索引中的分位数概率处,对于行索引。
- predict_residuals(y=None, X=None)[source]#
返回时间序列预测的残差。
将计算 y.index 处预测值的残差。
如果 fit 中必须传递 fh,则必须与 y.index 一致。如果 y 是 np.ndarray,且 fit 中未传递 fh,则将使用范围为 len(y.shape[0]) 的 fh 计算残差。
- 状态要求
要求状态为“已拟合”。如果已设置 fh,则必须与 y(pandas 或整数)的索引对应。
- 访问 self 中的属性
以“_”结尾的拟合模型属性。self.cutoff, self._is_fitted
- 写入 self
无。
- 参数:
- ysktime 兼容数据容器格式的时间序列
具有真实观测值的时间序列,用于计算残差。必须具有与 predict 预期返回值的类型、维度和索引相同。
如果为 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
。
- Returns:
- y_ressktime 兼容数据容器格式的时间序列
fh
处的预测残差,具有与fh
相同的索引。y_res
具有与最近传递的y
相同的类型:Series
、Panel
、Hierarchical
scitype,格式相同(见上文)
- predict_var(fh=None, X=None, cov=False)[source]#
计算/返回方差预测。
- 状态要求
要求状态为“已拟合”,即
self.is_fitted=True
。
访问 self 中的属性
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
- 写入 self
如果传递了
fh
且之前未传递,则将其存储到self.fh
。
- 参数:
- fhint、list、可强制转换为 pd.Index 或
ForecastingHorizon
,default=None 编码要预测的时间戳的预测范围。如果已在
fit
中传递,则不应再传递。如果在 fit 中未传递,则必须传递,不是可选的。如果
fh
不是 None 且不是ForecastingHorizon
类型,则内部(通过_check_fh
)会强制转换为ForecastingHorizon
。如果
fh
是int
或类似 array 的int
,则将其解释为相对范围,并强制转换为相对ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,则将其解释为绝对范围,并强制转换为绝对ForecastingHorizon(fh, is_relative=False)
。
- 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,计算边际方差预测。
- fhint、list、可强制转换为 pd.Index 或
- Returns:
- pred_varpd.DataFrame,格式取决于
cov
变量 - 如果 cov=False
- 列名与 fit/
update
中传递的y
的列名完全相同。 对于无名格式,列索引将是 RangeIndex。
- 行索引是 fh,具有等于实例级别的附加级别,
来自 fit 中看到的 y,如果 fit 中看到的 y 是 Panel 或 Hierarchical。
条目是方差预测,针对列索引中的变量。给定变量和 fh 索引的方差预测是预测的
给定观测数据,该变量和索引的方差。
- 列名与 fit/
- 如果 cov=True
- 列索引是多重索引:第一级是变量名(同上)
第二级是 fh。
- 行索引是 fh,具有等于实例级别的附加级别,
来自 fit 中看到的 y,如果 fit 中看到的 y 是 Panel 或 Hierarchical。
- 条目是(协)方差预测,针对列索引中的变量,以及
行索引和列索引中的时间索引之间的协方差。
注意:不同变量之间不返回协方差预测。
- pred_varpd.DataFrame,格式取决于
- reset()[source]#
将对象重置到初始化后的干净状态。
结果是将
self
设置为其构造函数调用后直接处于的状态,具有相同的超参数。通过set_config
设置的配置值也会保留。reset
调用会删除任何对象属性,除了超参数 =
__init__
的参数,写入self
,例如self.paramname
,其中paramname
是__init__
的参数包含双下划线(即字符串“__”)的对象属性。例如,名为“__myattr”的属性会被保留。
配置属性,配置保持不变。也就是说,
reset
前后get_config
的结果相等。
类方法和对象方法,以及类属性也不受影响。
等同于
clone
,不同之处在于reset
修改self
,而不是返回一个新对象。在调用
self.reset()
后,self
的值和状态与构造函数调用type(self)(**self.get_params(deep=False))
后获得的对象相等。- Returns:
- 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”。请注意,非默认格式可能需要安装其他软依赖。
- Returns:
- 如果
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
- Returns:
- scorefloat
self.predict(fh, X) 相对于 y_test 的 MAPE 损失。
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- config_dictdict
配置名称:配置值 对的字典。下面列出了有效的配置、值及其含义。
- displaystr, “diagram”(默认)或“text”
jupyter kernel 如何显示 self 的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool, default=True
打印 self 时是否只列出与默认值不同的 self 参数 (False),或所有参数名称和值 (False)。不嵌套,即仅影响 self 而不影响组件估计器。
- warningsstr, “on”(默认)或“off”
是否引发警告,仅影响来自 sktime 的警告
“on” = 将引发来自 sktime 的警告
“off” = 不会引发来自 sktime 的警告
- backend:parallelstr, optional, default=”None”
广播/向量化时用于并行化的后端之一
“None”:按顺序执行循环,简单的列表推导
“loky”、“multiprocessing”和“threading”:使用
joblib.Parallel
“joblib”:自定义和第三方
joblib
后端,例如spark
“dask”:使用
dask
,需要在环境中安装dask
包“ray”:使用
ray
,需要在环境中安装ray
包
- backend:parallel:paramsdict, optional, 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,默认 True;False 阻止
ray
在并行化后 关闭。
- “shutdown_ray”:bool,默认 True;False 阻止
“logger_name”:str,默认“ray”;要使用的记录器名称。
“mute_warnings”:bool,默认 False;如果为 True,则抑制警告。
- remember_databool, default=True
self._X 和 self._y 是否在 fit 中存储并在 update 中更新。如果为 True,则存储并更新 self._X 和 self._y。如果为 False,则不存储和更新 self._X 和 self._y。这会减少使用 save 时的序列化大小,但 update 将默认为“什么都不做”而不是“重新拟合所有已见数据”。
- Returns:
- 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 键中是唯一的。
- Returns:
- self对 self 的引用(设置参数后)
- set_random_state(random_state=None, deep=True, self_policy='copy')[source]#
为 self 设置 random_state 伪随机种子参数。
通过
self.get_params
找到名为random_state
的参数,并通过set_params
将它们设置为通过sample_dependent_seed
链式哈希从random_state
导出的整数。这些整数通过链式哈希从sample_dependent_seed
中采样,并保证种子随机生成器的伪随机独立性。适用于
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, default=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
,通常与输入状态不同
- Returns:
- self对 self 的引用
- set_tags(**tag_dict)[source]#
将实例级别标签覆盖设置为给定值。
每个
scikit-base
兼容对象都有一个标签字典,用于存储关于对象的元数据。标签是特定于实例
self
的键值对,它们是静态标志,在对象构建后不会改变。它们可用于元数据检查或控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名,字典值是要设置的标签值。set_tags
方法应仅在对象的__init__
方法中调用,在构建期间,或通过__init__
直接在构建后调用。当前标签值可通过
get_tags
或get_tag
进行检查。- 参数:
- **tag_dictdict
标签名: 标签值 对的字典。
- Returns:
- 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
),Series 类型pd.DataFrame
的list
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")
为 True,则X.index
必须包含y.index
。- update_paramsbool, 可选 (default=True)
是否应更新模型参数。如果为
False
,则仅更新截止点,模型参数(例如,系数)不更新。
- Returns:
- 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
),Series 类型pd.DataFrame
的list
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")
为 True,则X.index
必须包含fh
索引引用。- update_paramsbool, 可选 (default=True)
是否应更新模型参数。如果为
False
,则仅更新截止点,模型参数(例如,系数)不更新。- reset_forecasterbool, 可选 (default=True)
如果为 True,则不会改变预测器的状态,即更新/预测序列是在副本上运行的,self 的截止点、模型参数、数据记忆不会改变
如果为 False,则在运行更新/预测序列时会更新 self,就像直接调用 update/predict 一样
- Returns:
- 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
),Series 类型pd.DataFrame
的list
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")
为 True,则X.index
必须包含fh
索引引用。- update_paramsbool, 可选 (default=True)
是否应更新模型参数。如果为
False
,则仅更新截止点,模型参数(例如,系数)不更新。
- Returns:
- y_predsktime 兼容数据容器格式的时间序列
在
fh
处的点预测,具有与fh
相同的索引。y_pred
具有与最近传递的y
相同的类型:Series
、Panel
、Hierarchical
scitype,格式相同(见上文)