FhPlexForecaster#
- class FhPlexForecaster(forecaster, fh_params=None, fh_lookup='relative', fh_contiguous=False)[source]#
根据预测范围元素使用不同的参数。
当提供预测范围 [f1, f2, …, fn] 时,将使用 fh=f1 和参数 fh_params[f1] 来拟合预测器以预测 f1,使用 fh=f2 和参数 fh_params[f2] 来拟合预测器以预测 f2,依此类推。
若要根据每个范围使用不同的估计器,请将
FhPlexForecaster
与MultiplexForecaster
或MultiplexTransformer
之一结合使用。- 参数:
- forecastersktime 兼容的预测器
- fh_paramsdict, list, callable, 或 eval 定义 callable 的 str
指定每个 fh 元素使用的预测器 dict:键 = fh 元素,值 = 预测器的参数 dict list:第 i 个条目是第 i 个 fh 元素的预测器参数 dict callable:将 fh 元素映射到预测器参数 dict str:eval(fh_params) 必须定义一个将 fh 元素映射到参数 dict 的 lambda 参数 dict 不必完整,只需覆盖
forecaster
的参数- fh_lookupstr, 选项包括 “relative”(默认)、“absolute” 或 “as-is” 之一
指定 dict 或 callable 中使用的 fh 元素 如果是 “relative”,fh 将被强制转换为相对 ForecastingHorizon 如果是 “absolute”,fh 将被强制转换为绝对 ForecastingHorizon 如果是 “as-is”,fh 将被强制转换为 ForecastingHorizon(但不是相对/绝对)
- fh_contiguousbool, 默认值=False
是否强制内部循环中的 fh 连续 False:要求 fh_params[fN] 对应的预测器只预测 fN True:要求 fh_params[fN] 对应的预测器预测 1, 2, …, fN
然后输出被子集到 fN 的预测 只有当预测器只能预测连续范围时,才需要此选项
注意:如果在内部使用网格搜索,则
True
将导致调优指标在范围 1, 2, …, fN 上进行评估,而不仅仅是 fN
- 属性:
- forecasters_sktime 预测器的 dict
键是 fh 元素(根据
fh_lookup
强制转换) 条目是forecaster
的克隆,用于拟合和预测
示例
>>> from sktime.datasets import load_airline >>> from sktime.forecasting.naive import NaiveForecaster >>> from sktime.forecasting.compose import FhPlexForecaster
简单示例 - 每个 fh 元素使用相同参数 >>> y = load_airline() >>> f = FhPlexForecaster(NaiveForecaster()) >>> f.fit(y, fh=[1, 2, 3]) FhPlexForecaster(…) >>> # get individual fitted forecasters >>> f.forecasters_ # doctest: +SKIP {1: NaiveForecaster(), 2: NaiveForecaster(), 3: NaiveForecaster()} >>> fitted_params = f.get_fitted_params() # or via get_fitted_params >>> y_pred = f.predict()
简单示例 - 每个 fh 元素使用不同参数 >>> y = load_airline() >>> fh_params = [{}, {“strategy”: “last”}, {“strategy”: “mean”}] >>> f = FhPlexForecaster(NaiveForecaster(), fh_params=fh_params) >>> f.fit(y, fh=[1, 2, 3]) FhPlexForecaster(…) >>> # get individual fitted forecasters >>> f.forecasters_ # doctest: +SKIP {1: NaiveForecaster(), 2: NaiveForecaster(), 3: NaiveForecaster(strategy=’mean’)} >>> y_pred = f.predict()
方法
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])返回估计器的测试参数设置。
检查对象是否由其他 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')[source]#
返回估计器的测试参数设置。
- 参数:
- parameter_setstr, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,将返回
"default"
集。
- 返回:
- paramsdict 或 list of dict
- check_is_fitted(method_name=None)[source]#
检查估计器是否已拟合。
检查估计器是否已拟合。在调用对象的
fit
方法时,is_fitted
属性应设置为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 或 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 个元素是测试中 obj 的第 i 个实例的名称。命名约定是
{cls.__name__}-{i}
(如果实例多于一个),否则是{cls.__name__}
- property cutoff[source]#
截止点 = 预测器的“当前时间”状态。
- 返回:
- cutoffpandas 兼容的索引元素,或 None
pandas 兼容的索引元素(如果已设置截止点);否则为 None
- 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
,带有 2 级行MultiIndex
(instance, time)
,3D np.ndarray
(instance, variable, time)
,list
ofSeries
类型的pd.DataFrame
Hierarchical
scitype = 分层集合,用于分层预测。pd.DataFrame
,带有 3 级或更多级行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
,带有 2 级行MultiIndex
(instance, time)
,3D np.ndarray
(instance, variable, time)
,list
ofSeries
类型的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 兼容格式的时间序列,可选(默认值=None)。
用于拟合模型的外生时间序列。应与
y
具有相同的 scitype(Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为真,则X.index
必须包含y.index
。- X_predsktime 兼容格式的时间序列,可选(默认值=None)
用于预测的外生时间序列。如果传入,将用于预测而不是 X。应与
fit
中的y
具有相同的 scitype(Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为真,则X.index
必须包含fh
索引引用。
- 返回:
- y_predsktime 兼容数据容器格式的时间序列
在
fh
上的点预测,索引与fh
相同。y_pred
的类型与最近传入的y
相同:Series
,Panel
,Hierarchical
scitype,格式相同(参见上文)
- classmethod get_class_tag(tag_name, tag_value_default=None)[source]#
从类中获取类标签值,带有来自父类的标签级别继承。
每个
scikit-base
兼容对象都有一个标签字典,用于存储关于对象的元数据。get_class_tag
方法是一个类方法,它仅考虑类级别标签值和覆盖来检索标签的值。它返回对象中名称为
tag_name
的标签值,考虑标签覆盖,优先级按以下降序排列:在类的
_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
在实例上定义的。collected_tagsdict
- 标签名称:标签值对字典。通过嵌套继承从
_tags
类属性收集。不受set_tags
或clone_tags
设置的动态标签覆盖。 标签名称: 标签值 对的字典。通过嵌套继承从
_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
的单个标签的值,并考虑标签覆盖,优先级降序如下:在实例上通过
set_tags
或clone_tags
设置的标签,
在实例构建时设置的标签。
在类的
_tags
属性中设置的标签。在父类的
_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
。
- 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]#
检查对象是否由其他 BaseObject 组成。
复合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回:
- 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,其结果与
cls.save(path)
在path
处的输出相同
- 解序列化的 self,其结果与
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第1个元素
- serial
- 返回:
- 解序列化的 self,其结果与
cls.save(None)
的输出serial
相同
- 解序列化的 self,其结果与
- predict(fh=None, X=None)[source]#
预测未来范围的时间序列。
- 所需状态
要求状态为“已拟合”,即
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) 被强制转换。
- X
sktime
兼容格式的时间序列,可选 (默认为 None) 用于预测的外生时间序列。应与
fit
中的y
具有相同的 science type(Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。
- fhint, list, pd.Index 可强制转换类型, 或
- 返回:
- 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
- 写入自身
如果传递了
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)
。
- X
sktime
兼容格式的时间序列,可选 (默认为 None) 用于预测的外生时间序列。应与
fit
中的y
具有相同的 science type(Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。- coveragefloat 或 float 唯一值列表, 可选 (默认为 0.90)
预测区间(s)的名义覆盖率
- fhint, list, pd.Index 可强制转换类型, 或
- 返回:
- pred_intpd.DataFrame
- 列具有多级索引:第一级是 fit 中 y 的变量名,
- 第二级是计算区间的覆盖率分数。
顺序与输入
coverage
中的顺序相同。
第三级是字符串“lower”或“upper”,表示区间的下限/上限。
- 行索引是 fh,如果 fit 中看到的 y 是 Panel 或 Hierarchical,则附加(上层)级别等于实例级别。
行的索引。
- 条目是下限/上限区间的预测值,
对于列索引中的变量,在第二级列索引中的名义覆盖率下,根据第三级列索引确定下限/上限,对于行索引中的时间点。上限/下限区间的预测值等同于在 alpha = 0.5 - c/2, 0.5 + c/2 (c 在 coverage 中) 处的分位数预测值。
- predict_proba(fh=None, X=None, marginal=True)[source]#
计算/返回完全概率预测。
注意
目前仅针对 Series(非 Panel,非 Hierarchical)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)
。
- X
sktime
兼容格式的时间序列,可选 (默认为 None) 用于预测的外生时间序列。应与
fit
中的y
具有相同的 science type(Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。- marginalbool, 可选 (默认为 True)
返回的分布是否按时间索引是边际分布
- fhint, list, pd.Index 可强制转换类型, 或
- 返回:
- 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
- 写入自身
如果传递了
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)
。
- X
sktime
兼容格式的时间序列,可选 (默认为 None) 用于预测的外生时间序列。应与
fit
中的y
具有相同的 science type(Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。- alphafloat 或 float 唯一值列表, 可选 (默认为 [0.05, 0.95])
计算分位数预测的概率或概率列表。
- fhint, list, pd.Index 可强制转换类型, 或
- 返回:
- quantilespd.DataFrame
- 列具有多级索引:第一级是 fit 中 y 的变量名,
第二层是传递给函数的 alpha 值。
- 行索引是 fh,如果 fit 中看到的 y 是 Panel 或 Hierarchical,则附加(上层)级别等于实例级别。
行的索引。
- 条目是分位数预测值,对于列索引中的变量,
在第二级列索引中的分位数概率下,对于行索引中的时间点。
- predict_residuals(y=None, X=None)[source]#
返回时间序列预测的残差。
将计算在 y.index 处的预测残差。
如果 fh 必须在 fit 中传递,则必须与 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 兼容格式的时间序列, 可选 (默认为 None)
用于更新和预测的外生时间序列。应与
fit
中的y
具有相同的 science type(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
science type,相同的格式(见上文)。
- predict_var(fh=None, X=None, cov=False)[source]#
计算/返回方差预测。
- 所需状态
要求状态为“已拟合”,即
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)
。
- X
sktime
兼容格式的时间序列,可选 (默认为 None) 用于预测的外生时间序列。应与
fit
中的y
具有相同的 science type(Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。- covbool, 可选 (默认为 False)
如果为 True,计算协方差矩阵预测值。如果为 False,计算边际方差预测值。
- fhint, list, pd.Index 可强制转换类型, 或
- 返回:
- pred_varpd.DataFrame, 格式取决于
cov
变量 - 如果 cov=False
- 列名与
fit
/update
中传递的y
完全相同。 对于无名格式,列索引将是 RangeIndex。
- 行索引是 fh,附加级别等于实例级别,
行的索引。
从 fit 中看到的 y 中获取的,如果 fit 中看到的 y 是 Panel 或 Hierarchical。
条目是方差预测值,对于列索引中的变量。给定变量和 fh 索引的方差预测是该变量和索引在给定观测数据下的预测方差。
- 列名与
- 如果 cov=True
- 列索引是多级索引:第一级是变量名(如上)
第二级是 fh。
- 行索引是 fh,附加级别等于实例级别,
行的索引。
- 条目是(协)方差预测值,对于列索引中的变量,以及
行和列中时间索引之间的协方差。
注意:不同变量之间不返回协方差预测值。
- pred_varpd.DataFrame, 格式取决于
- reset()[source]#
将对象重置到干净的初始化后状态。
导致将
self
设置为其在构造函数调用后直接具有的状态,具有相同的超参数。通过set_config
设置的配置值也会保留。一次
reset
调用会删除任何对象属性,除了超参数 = 写入
self
的__init__
参数,例如,self.paramname
其中paramname
是__init__
的参数包含双下划线的对象属性,即字符串“__”。例如,名为“__myattr”的属性会被保留。
config 属性,config 将保留不变。也就是说,
reset
前后的get_config
结果是相等的。
类方法、对象方法和类属性也不受影响。
等同于
clone
,不同之处在于reset
会修改self
而不是返回一个新对象。在调用
self.reset()
后,self
的值和状态与构造函数调用 ``type(self)(**self.get_params(deep=False))`` 获得的对象相同。- 返回:
- self
类实例重置为干净的初始化后状态,但保留当前的超参数值。
- classmethod 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, 默认为 “pickle”
用于序列化的模块。可用选项为“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
path
为 None - 内存中的序列化 self - 如果
path
为文件位置 - 指向文件的 ZipFile
- 如果
- score(y, X=None, fh=None)[source]#
使用 MAPE(非对称)对预测与真实值进行评分。
- 参数:
- ypd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D)
要评分的时间序列
- fhint, list, pd.Index 可强制转换类型, 或
ForecastingHorizon
, 默认值=None 编码要预测的时间戳的预测范围。
- Xpd.DataFrame 或 2D np.array, 可选 (默认为 None)
要评分的外生时间序列。如果 self.get_tag(“X-y-must-have-same-index”),则 X.index 必须包含 y.index
- 返回:
- scorefloat
self.predict(fh, X)
相对于 y_test 的 MAPE 损失。
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- config_dictdict
配置名称: 配置值 对的字典。有效的配置、值及其含义如下所述:
- displaystr, “diagram” (默认) 或 “text”
jupyter 内核显示 self 实例的方式
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool, 默认为 True
打印 self 时是否只列出与默认值不同的 self 参数 (False),或所有参数名称和值 (False)。不嵌套,即只影响 self,不影响组件估计器。
- warningsstr, “on” (默认) 或 “off”
是否引发警告,仅影响来自 sktime 的警告
“on” = 将引发来自 sktime 的警告
“off” = 将不引发来自 sktime 的警告
- backend:parallelstr, 可选, 默认为 “None”
广播/向量化时用于并行化的后端,以下之一:
“None”: 顺序执行循环,简单的列表推导
“loky”, “multiprocessing” 和 “threading”: 使用
joblib.Parallel
“joblib”: 自定义和第三方
joblib
后端,例如spark
“dask”: 使用
dask
,需要在环境中安装dask
包“ray”: 使用
ray
,需要在环境中安装ray
包
- backend:parallel:paramsdict, 可选, 默认为 {} (不传递参数)
作为配置传递给并行化后端的额外参数。有效的键取决于
backend:parallel
的值“None”: 无额外参数,
backend_params
被忽略“loky”, “multiprocessing” 和 “threading”: 默认
joblib
后端。此处可传递joblib.Parallel
的任何有效键,例如n_jobs
,但backend
除外,它由backend
直接控制。如果未传递n_jobs
,则默认为-1
,其他参数默认为joblib
的默认值。“joblib”: 自定义和第三方
joblib
后端,例如spark
。此处可传递joblib.Parallel
的任何有效键,例如n_jobs
,在这种情况下,backend
必须作为backend_params
的一个键传递。如果未传递n_jobs
,则默认为-1
,其他参数默认为joblib
的默认值。“dask”: 可传递
dask.compute
的任何有效键,例如scheduler
“ray”: 可传递以下键:
“ray_remote_args”:
ray.init
的有效键字典- “shutdown_ray”: bool, 默认为 True;False 可防止
ray
在并行化后 关闭。
- “shutdown_ray”: bool, 默认为 True;False 可防止
“logger_name”: str, 默认为 “ray”;要使用的日志记录器名称。
“mute_warnings”: bool, 默认为 False;如果为 True,则抑制警告
- remember_databool, 默认为 True
fit 中是否存储 self._X 和 self._y,并在 update 中更新。如果为 True,则存储并更新 self._X 和 self._y。如果为 False,则不存储和更新 self._X 和 self._y。这在使用 save 时可以减小序列化大小,但 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, 默认为 None
伪随机数生成器,控制随机整数的生成。传递 int 可在多次函数调用中获得可重现的输出。
- deepbool, 默认值=True
是否在值为 skbase 对象的参数中设置随机状态,即组件估计器中。
如果为 False,则仅设置
self
的random_state
参数(如果存在)。如果为 True,则也会在组件对象中设置
random_state
参数。
- self_policystr, “copy”, “keep”, “new” 之一, 默认为 “copy”
“copy” :
self.random_state
设置为输入的random_state
“keep” :
self.random_state
保持原样“new” :
self.random_state
设置为一个新的随机状态,
从输入的
random_state
派生,通常与之不同。
- 返回:
- 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
:仅更新 cutoff 并记住数据
- 所需状态
要求状态为“已拟合”,即
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
,带有 2 级行MultiIndex
(instance, time)
,3D np.ndarray
(instance, variable, time)
,list
ofSeries
类型的pd.DataFrame
Hierarchical
scitype = 分层集合,用于分层预测。pd.DataFrame
,带有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参阅 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对 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
:仅更新 cutoff 并记住数据
- 所需状态
要求状态为“已拟合”,即
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
ofSeries
类型的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 兼容格式的时间序列, 可选 (默认为 None)
用于更新和预测的外生时间序列。应与
fit
中的y
具有相同的 science type(Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。- update_paramsbool, 可选 (默认为 True)
是否应更新模型参数。如果为
False
,则仅更新 cutoff,模型参数(例如,系数)不更新。- reset_forecasterbool, 可选 (默认为 True)
如果为 True,则不会更改预测器的状态,即更新/预测序列以副本运行,self 的 cutoff、模型参数、数据内存不会改变
如果为 False,则在运行更新/预测序列时,将像直接调用 update/predict 一样更新 self
- 返回:
- y_pred汇总多个分割批次点预测的对象
格式取决于整体预测的 (cutoff, 绝对时间范围) 对
如果绝对时间范围点的集合是唯一的:类型是 sktime 兼容数据容器格式的时间序列,输出中会省略 cutoff,与最近传递的 y 类型相同:Series, Panel, Hierarchical scitype,格式相同(见上文)
如果绝对时间范围点的集合不是唯一的:类型是一个 pandas DataFrame,行和列索引都是时间戳,行索引对应于预测所依据的 cutoff,列索引对应于预测的绝对时间范围,条目是在该 (cutoff, 时间范围) 对下的点预测值,如果在该对下没有进行预测,则条目为 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._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
ofSeries
类型的pd.DataFrame
Hierarchical
scitype = 分层集合,用于分层预测。pd.DataFrame
,带有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅预测教程
examples/01_forecasting.ipynb
- fhint, list, pd.Index 可强制转换类型, 或
ForecastingHorizon
, 默认值=None 预测未来时间点的时间点编码。如果已在
fit
中传递,则不应再次传递。如果未在 fit 中传递,则必须传递,不是可选的。- Xsktime 兼容格式的时间序列, 可选 (默认为 None)
用于更新和预测的外生时间序列。应与
fit
中的y
具有相同的 science type(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,格式相同(参见上文)