AutoREG#
- class AutoREG(lags=None, trend='c', seasonal=False, hold_back=None, period=None, missing='none', deterministic=None, cov_type='nonrobust', cov_kwds=None, use_t=True, dynamic=False)[source]#
自回归 AR-X(p) 模型。
使用条件最大似然法 (OLS) 估计 AR-X 模型。
- 参数:
- lags{None, int, list[int]}
模型中包含的滞后数量(如果为整数)或要包含的滞后索引列表。例如,[1, 4] 将只包含滞后 1 和 4,而 lags=4 将包含滞后 1, 2, 3 和 4。None 表示排除所有 AR 滞后,行为与 0 相同。
- trend{‘n’, ‘c’, ‘t’, ‘ct’}
模型中包含的趋势项
‘n’ - 无趋势。
‘c’ - 仅常数项。
‘t’ - 仅时间趋势。
‘ct’ - 常数项和时间趋势。
- seasonalbool
一个标志,指示是否在模型中包含季节性虚拟变量。如果 seasonal 为 True 且 trend 包含 ‘c’,则第一个周期将从季节项中排除。
- hold_back{None, int}
从估计样本中排除的初始观测值数量。如果为 None,则 hold_back 等于模型中的最大滞后。设置为非零值可生成具有不同滞后长度的可比较模型。例如,要比较 lags=3 和 lags=1 的模型的拟合度,请将 hold_back=3,这确保两个模型都使用观测值 3,…,nobs 进行估计。hold_back 必须 >= 模型中的最大滞后。
- period{None, int}
数据的周期。仅在 seasonal 为 True 时使用。如果使用包含已知频率的 pandas 对象,则可以省略此参数。
- missingstr
可用选项包括 ‘none’, ‘drop’, 和 ‘raise’。如果为 ‘none’,则不进行 NaN 检查。如果为 ‘drop’,则删除任何包含 NaN 的观测值。如果为 ‘raise’,则引发错误。默认值为 ‘none’。
- deterministicDeterministicProcess
一个确定性过程。如果提供,则忽略 trend 和 seasonal。如果 trend 不为 “n” 且 seasonal 不为 False,则会发出警告。
- 属性:
示例
使用 AutoREG 预测单变量数据。
>>> from sktime.forecasting.auto_reg import AutoREG >>> from sktime.datasets import load_airline >>> from sktime.forecasting.base import ForecastingHorizon >>> data = load_airline() >>> autoreg_sktime = AutoREG(lags=2, trend="c") >>> autoreg_sktime.fit(y=data) AutoREG(lags=2) >>> fh = ForecastingHorizon([x for x in range(1, 13)]) >>> y_pred = autoreg_sktime.predict(fh=fh)
使用 AutoREG 预测带有外生数据。
>>> from sktime.forecasting.auto_reg import AutoREG >>> from sktime.datasets import load_longley >>> from sktime.forecasting.base import ForecastingHorizon >>> y, X_og = load_longley() >>> X_oos = X_og.iloc[-5:, :] >>> y, X = y.iloc[:-5], X_og.iloc[:-5, :] >>> X, X_oos = X[["GNPDEFL", "GNP"]], X_oos[["GNPDEFL", "GNP"]] >>> autoreg_sktime = AutoREG(lags=2, trend="c") >>> autoreg_sktime.fit(y=y, X=X) AutoREG(lags=2) >>> fh = ForecastingHorizon([x for x in range(1, 4)]) >>> y_pred = autoreg_sktime.predict(X=X_oos, fh=fh)
方法
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])从类中获取类标签值,包括从父类继承的标签。
从类中获取类标签,包括从父类继承的标签。
获取 self 的配置标志。
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])将序列化的 self 保存到字节类对象或 (.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"
集。当前预测器没有保留值。
- 返回值:
- paramsdict or list of dict, default = {}
创建类的测试实例的参数。每个 dict 都是构造一个“有趣”的测试实例的参数,即
MyClass(**params)
或MyClass(**params[i])
创建一个有效的测试实例。create_test_instance
使用params
中的第一个(或唯一一个)字典。
- check_is_fitted(method_name=None)[source]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。在调用对象的fit
方法时,is_fitted
属性应设置为True
。如果不是,则引发
NotFittedError
。- 参数:
- method_namestr, optional
调用此函数的方法的名称。如果提供,错误消息将包含此信息。
- 引发:
- 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
检查。- 参数:
- estimatorBaseObject 或派生类的实例
- tag_namesstr or list of str, default = None
要克隆的标签名称。默认值 (
None
) 克隆来自estimator
的所有标签。
- 返回值:
- self
对
self
的引用。
- classmethod create_test_instance(parameter_set='default')[source]#
使用第一个测试参数集构造类的实例。
- 参数:
- parameter_setstr, default=”default”
要返回的测试参数集的名称,用于测试。如果某个值未定义特殊参数,则将返回 “default” 集。
- 返回值:
- instance具有默认参数的类的实例
- classmethod create_test_instances_and_names(parameter_set='default')[source]#
创建所有测试实例列表及其名称列表。
- 参数:
- parameter_setstr, default=”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]#
将预测器拟合到训练数据。
- 状态更改
将状态更改为“已拟合”。
写入 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 = 时间序列集合,全局/面板预测。带有 2 级行MultiIndex
((instance, time)
) 的pd.DataFrame
、3D np.ndarray
((instance, variable, time)
) 或Series
类型的pd.DataFrame
列表Hierarchical
scitype = 分层集合,用于分层预测。带有 3 级或更多级行MultiIndex
((hierarchy_1, ..., hierarchy_n, time)
) 的pd.DataFrame
有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅预测教程
examples/01_forecasting.ipynb
。- fhint, list, pd.Index coercible, or
ForecastingHorizon
, default=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
。
- 返回值:
- 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 = 时间序列集合,全局/面板预测。带有 2 级行MultiIndex
((instance, time)
) 的pd.DataFrame
、3D np.ndarray
((instance, variable, time)
) 或Series
类型的pd.DataFrame
列表Hierarchical
scitype = 分层集合,用于分层预测。带有 3 级或更多级行MultiIndex
((hierarchy_1, ..., hierarchy_n, time)
) 的pd.DataFrame
有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅预测教程
examples/01_forecasting.ipynb
。- fhint, list, pd.Index coercible, or
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)[source]#
从类中获取类标签值,包括从父类继承的标签。
每个
scikit-base
兼容对象都包含一个标签字典,用于存储有关对象的元数据。get_class_tag
方法是一个类方法,仅考虑类级别标签值和覆盖来检索标签的值。它从对象中返回名称为
tag_name
的标签的值,考虑标签覆盖,优先级按降序排列如下:在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序。
不考虑实例上的动态标签覆盖,即通过
set_tags
或clone_tags
在实例上定义的标签。要检索可能包含实例覆盖的标签值,请改用
get_tag
方法。- 参数:
- tag_namestr
标签值的名称。
- tag_value_defaultany type
如果未找到标签,则使用的默认/备用值。
- 返回值:
- 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 的配置标志。
配置是
self
的键值对,通常用作控制行为的瞬态标志。get_config
返回动态配置,这些配置会覆盖默认配置。默认配置设置在类或其父类的
_config
类属性中,并通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用下保留。- 返回值:
- config_dictdict
配置名称:配置值对的字典。通过嵌套继承从 _config 类属性收集,然后是来自 _onfig_dynamic 对象属性的任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取已拟合参数。
- 所需状态
要求状态为“已拟合”。
- 参数:
- deepbool, default=True
是否返回组件的已拟合参数。
如果为 True,将返回此对象的参数名称:值字典,包括可拟合组件的已拟合参数(= BaseEstimator 值的参数)。
如果为 False,将返回此对象的参数名称:值字典,但不包括组件的已拟合参数。
- 返回值:
- fitted_paramsdict with str-valued keys
已拟合参数字典,paramname : paramvalue 键值对包括:
始终:此对象的所有已拟合参数,如通过
get_param_names
所述,值是该键对应的此对象的已拟合参数值。如果
deep=True
,还包含组件参数的键/值对,组件参数按[componentname]__[paramname]
索引,componentname
的所有参数以paramname
及其值出现。如果
deep=True
,还包含任意级别的组件递归,例如[componentname]__[componentcomponentname]__[paramname]
等。
- classmethod get_param_defaults()[source]#
获取对象的参数默认值。
- 返回值:
- default_dict: dict[str, Any]
键是
cls
中在__init__
中定义了默认值的所有参数。值是默认值,如__init__
中定义。
- classmethod get_param_names(sort=True)[source]#
获取对象的参数名称。
- 参数:
- sortbool, default=True
是否按字母顺序(True)或按它们在类
__init__
中出现的顺序(False)返回参数名称。
- 返回值:
- param_names: list[str]
cls
的参数名称列表。如果sort=False
,则按它们在类__init__
中出现的顺序;如果sort=True
,则按字母顺序排序。
- get_params(deep=True)[source]#
获取此对象的参数值字典。
- 参数:
- deepbool, default=True
是否返回组件的参数。
如果为
True
,将返回此对象的参数名称:值dict
,包括组件的参数(=BaseObject
值的参数)。如果为
False
,将返回此对象的参数名称:值dict
,但不包括组件的参数。
- 返回值:
- paramsdict with str-valued keys
参数字典,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,结果输出到
path
,来自cls.save(path)
- 反序列化的 self,结果输出到
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回值:
- 反序列化的 self,结果输出
serial
,来自cls.save(None)
- 反序列化的 self,结果输出
- predict(fh=None, X=None)[source]#
在未来范围预测时间序列。
- 所需状态
要求状态为“已拟合”,即
self.is_fitted=True
。
访问 self 中的
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
- 写入 self
如果
fh
被传入且之前未被传入,则将fh
存储到self.fh
。
- 参数:
- fhint, list, pd.Index coercible, or
ForecastingHorizon
, default=None 预测时点的时间戳编码的预测 horizon。如果已在
fit
中传入,则不应再次传入。如果未在 fit 中传入,则必须传入,非可选。如果 fh 不为 None 且不是 ForecastingHorizon 类型,则通过调用 _check_fh 将其强制转换为 ForecastingHorizon。特别是,如果 fh 是 pd.Index 类型,则通过 ForecastingHorizon(fh, is_relative=False) 将其强制转换。
- X
sktime
兼容格式的时间序列,可选 (default=None) 用于预测的外生时间序列。应与
fit
中的y
具有相同的 scitype (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引参考。
- fhint, list, pd.Index coercible, or
- 返回值:
- 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
被传入且之前未被传入,则将fh
存储到self.fh
。
- 参数:
- fhint, list, pd.Index coercible, or
ForecastingHorizon
, default=None 预测时点的时间戳编码的预测 horizon。如果已在
fit
中传入,则不应再次传入。如果未在 fit 中传入,则必须传入,非可选。如果
fh
不是 None 且不是ForecastingHorizon
类型,则在内部会被强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或int
的 array-like,则被解释为相对 horizon,并被强制转换为相对的ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,则被解释为绝对 horizon,并被强制转换为绝对的ForecastingHorizon(fh, is_relative=False)
。
- X
sktime
兼容格式的时间序列,可选 (default=None) 用于预测的外生时间序列。应与
fit
中的y
具有相同的 scitype (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引参考。- coveragefloat 或 唯一值的 float 列表,可选 (default=0.90)
预测区间(s) 的名义覆盖率
- fhint, list, pd.Index coercible, or
- 返回值:
- pred_intpd.DataFrame
- 列具有多重索引:第一层是在 fit 中 y 的变量名,
- 第二层是计算区间的覆盖率分数。
顺序与输入
coverage
中的顺序相同。
第三层是字符串“lower”或“upper”,表示区间的下限/上限。
- 行索引是 fh,附加(上方)层次等于实例层次,
来自 fit 中看到的 y,如果 fit 中看到的 y 是 Panel 或 Hierarchical。
- 条目是区间下限/上限的预测,
对于 col 索引中的变量,在第二 col 索引的名义覆盖率下,取决于第三 col 索引是 lower/upper,对于行索引。区间上限/下限预测等同于对于 coverage 中的 c,在 alpha = 0.5 - c/2, 0.5 + c/2 处的分位数预测。
- predict_proba(fh=None, X=None, marginal=True)[source]#
计算/返回完全概率预测。
注意
目前仅针对 Series (非 Panel, 非 Hierarchical) y 实现。
返回的分布对象需要安装
skpro
。
- 所需状态
要求状态为“已拟合”,即
self.is_fitted=True
。
访问 self 中的
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
- 写入 self
如果
fh
被传入且之前未被传入,则将fh
存储到self.fh
。
- 参数:
- fhint, list, pd.Index coercible, or
ForecastingHorizon
, default=None 预测时点的时间戳编码的预测 horizon。如果已在
fit
中传入,则不应再次传入。如果未在 fit 中传入,则必须传入,非可选。如果
fh
不是 None 且不是ForecastingHorizon
类型,则在内部会被强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或int
的 array-like,则被解释为相对 horizon,并被强制转换为相对的ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,则被解释为绝对 horizon,并被强制转换为绝对的ForecastingHorizon(fh, is_relative=False)
。
- X
sktime
兼容格式的时间序列,可选 (default=None) 用于预测的外生时间序列。应与
fit
中的y
具有相同的 scitype (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引参考。- marginalbool, 可选 (default=True)
返回的分布是否按时间索引是边缘分布
- fhint, list, pd.Index coercible, or
- 返回值:
- 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
被传入且之前未被传入,则将fh
存储到self.fh
。
- 参数:
- fhint, list, pd.Index coercible, or
ForecastingHorizon
, default=None 预测时点的时间戳编码的预测 horizon。如果已在
fit
中传入,则不应再次传入。如果未在 fit 中传入,则必须传入,非可选。如果
fh
不是 None 且不是ForecastingHorizon
类型,则在内部会被强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或int
的 array-like,则被解释为相对 horizon,并被强制转换为相对的ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,则被解释为绝对 horizon,并被强制转换为绝对的ForecastingHorizon(fh, is_relative=False)
。
- X
sktime
兼容格式的时间序列,可选 (default=None) 用于预测的外生时间序列。应与
fit
中的y
具有相同的 scitype (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引参考。- alphafloat 或 唯一值的 float 列表,可选 (default=[0.05, 0.95])
计算分位数预测的概率或概率列表。
- fhint, list, pd.Index coercible, or
- 返回值:
- quantilespd.DataFrame
- 列具有多重索引:第一层是在 fit 中 y 的变量名,
第二层是传递给函数的 alpha 值。
- 行索引是 fh,附加(上方)层次等于实例层次,
来自 fit 中看到的 y,如果 fit 中看到的 y 是 Panel 或 Hierarchical。
- 条目是分位数预测,用于 col 索引中的变量,
在第二 col 索引中的分位数概率下,用于行索引。
- predict_residuals(y=None, X=None)[source]#
返回时间序列预测的残差。
将针对 y.index 处的预测计算残差。
如果在 fit 中必须传递 fh,则必须与 y.index 一致。如果 y 是 np.ndarray,并且在 fit 中没有传递 fh,则残差将计算在 range(len(y.shape[0])) 的 fh 处。
- 所需状态
要求状态为“已拟合”。如果已设置 fh,则必须与 y 的索引(pandas 或整数)对应。
- 访问 self 中的
以“_”结尾的已拟合模型属性。self.cutoff, self._is_fitted
- 写入 self
无。
- 参数:
- ysktime 兼容数据容器格式的时间序列
具有真实观测值的时间序列,用于计算残差。必须与 predict 的预期返回具有相同的类型、维度和索引。
如果为 None,则使用目前已见的 y (self._y),特别是
如果之前只调用了一次 fit,则会产生内样本残差
如果 fit 需要
fh
,则它必须指向 fit 中 y 的索引
- X
sktime
兼容格式的时间序列,可选 (default=None) 用于更新和预测的外生时间序列。应与
fit
中的y
具有相同的 scitype (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须同时包含fh
索引参考和y.index
。
- 返回值:
- y_res
sktime
兼容数据容器格式的时间序列 fh
处的预测残差,具有与fh
相同的索引。y_res
具有与最近传入的y
相同的类型:Series
,Panel
,Hierarchical
scitype,格式相同(见上文)
- y_res
- predict_var(fh=None, X=None, cov=False)[source]#
计算/返回方差预测。
- 所需状态
要求状态为“已拟合”,即
self.is_fitted=True
。
访问 self 中的
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
- 写入 self
如果
fh
被传入且之前未被传入,则将fh
存储到self.fh
。
- 参数:
- fhint, list, pd.Index coercible, or
ForecastingHorizon
, default=None 预测时点的时间戳编码的预测 horizon。如果已在
fit
中传入,则不应再次传入。如果未在 fit 中传入,则必须传入,非可选。如果
fh
不是 None 且不是ForecastingHorizon
类型,则在内部会被强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或int
的 array-like,则被解释为相对 horizon,并被强制转换为相对的ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,则被解释为绝对 horizon,并被强制转换为绝对的ForecastingHorizon(fh, is_relative=False)
。
- X
sktime
兼容格式的时间序列,可选 (default=None) 用于预测的外生时间序列。应与
fit
中的y
具有相同的 scitype (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引参考。- covbool, 可选 (default=False)
如果为 True,计算协方差矩阵预测。如果为 False,计算边缘方差预测。
- fhint, list, pd.Index coercible, or
- 返回值:
- pred_varpd.DataFrame,格式取决于
cov
变量 - 如果 cov=False
- 列名与
fit
/update
中传递的y
的列名完全相同。 对于无名称的格式,列索引将是 RangeIndex。
- 行索引是 fh,附加层次等于实例层次,
来自 fit 中看到的 y,如果 fit 中看到的 y 是 Panel 或 Hierarchical。
条目是方差预测,用于 col 索引中的变量。
给定变量和 fh 索引的方差预测是给定观测数据下该变量和索引的预测方差。
- 列名与
- 如果 cov=True
- 列索引是多重索引:第一层是变量名(如上)
第二层是 fh。
- 行索引是 fh,附加层次等于实例层次,
来自 fit 中看到的 y,如果 fit 中看到的 y 是 Panel 或 Hierarchical。
- 条目是(协)方差预测,用于 col 索引中的变量,以及
行和列中的时间索引之间的协方差。
注意:不同变量之间不返回协方差预测。
- 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))`` 获取的对象相等。- 返回值:
- self
类实例重置为初始状态后的干净状态,但保留当前的超参数值。
- save(path=None, serialization_format='pickle')[source]#
将序列化的 self 保存到字节类对象或 (.zip) 文件。
行为:如果
path
为 None,则返回内存中的序列化 self;如果path
是文件位置,则将 self 作为 zip 文件存储在该位置保存的文件是 zip 文件,包含以下内容: _metadata - 包含 self 的类,即 type(self) _obj - 序列化的 self。此类使用默认序列化 (pickle)。
- 参数:
- pathNone 或文件位置 (str 或 Path)
如果为 None,self 保存到内存对象;如果为文件位置,self 保存到该文件位置。如果
path=”estimator”,则将在当前工作目录创建 zip 文件
estimator.zip
。path=”/home/stored/estimator”,则 zip 文件
estimator.zip
将
存储在
/home/stored/
中。- serialization_format: str, default = “pickle”
用于序列化的模块。可用选项有“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回值:
- 如果
path
为 None - 内存中的序列化 self - 如果
path
是文件位置 - 引用该文件的 ZipFile
- 如果
- score(y, X=None, fh=None)[source]#
使用 MAPE(非对称)对预测结果与真实值进行评分。
- 参数:
- ypd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D)
要评分的时间序列
- fhint, list, pd.Index coercible, or
ForecastingHorizon
, default=None 编码要预测的时间戳的预测范围。
- Xpd.DataFrame, 或 2D np.array, 可选 (default=None)
要评分的外生时间序列。如果 self.get_tag(“X-y-must-have-same-index”) 为 True,则 X.index 必须包含 y.index
- 返回值:
- scorefloat
self.predict(fh, X) 相对于 y_test 的 MAPE 损失。
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- config_dictdict
配置名称:配置值对的字典。下方列出了有效的配置、值及其含义
- displaystr, “diagram” (default), 或 “text”
jupyter 内核如何显示 self 的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool, default=True
打印 self 时,是仅列出与默认值不同的 self 参数 (False),还是列出所有参数名称和值 (False)。不嵌套,即仅影响 self 而不影响组件估计器。
- warningsstr, “on” (default), 或 “off”
是否发出警告,仅影响来自 sktime 的警告
“on” = 将发出来自 sktime 的警告
“off” = 将不发出来自 sktime 的警告
- backend:parallelstr, 可选, default=”None”
广播/向量化时用于并行的后端,选项之一
“None”: 顺序执行循环,简单的列表推导式
“loky”, “multiprocessing” 和 “threading”: 使用
joblib.Parallel
“joblib”: 自定义和第三方
joblib
后端,例如spark
“dask”: 使用
dask
,需要环境中有dask
包“ray”: 使用
ray
,需要环境中有ray
包
- backend:parallel:paramsdict, 可选, default={} (未传递参数)
作为配置传递给并行后端的附加参数。有效键取决于
backend:parallel
的值“None”: 无附加参数,
backend_params
被忽略“loky”, “multiprocessing” 和 “threading”: 默认
joblib
后端,任何joblib.Parallel
的有效键都可以传递到此处,例如n_jobs
,除了backend
由backend
直接控制。如果未传递n_jobs
,则默认为-1
,其他参数默认为joblib
默认值。“joblib”: 自定义和第三方
joblib
后端,例如spark
。任何joblib.Parallel
的有效键都可以传递到此处,例如n_jobs
,在此情况下必须将backend
作为backend_params
的键传递。如果未传递n_jobs
,则默认为-1
,其他参数默认为joblib
默认值。“dask”: 任何
dask.compute
的有效键都可以传递,例如scheduler
“ray”: 可以传递以下键
“ray_remote_args”:
ray.init
的有效键字典- “shutdown_ray”: bool, default=True; False 会阻止
ray
在并行化后 关闭。
- “shutdown_ray”: bool, default=True; False 会阻止
“logger_name”: str, default=”ray”; 要使用的日志器名称。
“mute_warnings”: bool, default=False; 如果为 True,则抑制警告
- remember_databool, default=True
在 fit 中是否存储 self._X 和 self._y,并在 update 中更新。如果为 True,则存储和更新 self._X 和 self._y。如果为 False,则不存储和更新 self._X 和 self._y。这会减少使用 save 时的序列化大小,但 update 将默认为“不执行任何操作”,而不是“重新拟合到所有已见数据”。
- 返回值:
- self对 self 的引用。
注意
改变对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
此方法适用于简单的 skbase 对象和组合对象。参数键字符串
<component>__<parameter>
可用于组合对象(即包含其他对象的对象),以访问组件<component>
中的<parameter>
。字符串<parameter>
(不带<component>__
)也可用于引用明确的情况,例如组件中没有两个参数名称都为<parameter>
。- 参数:
- **paramsdict
BaseObject 参数,键必须是
<component>__<parameter>
字符串。__
后缀可以作为完整字符串的别名,如果它们在 get_params 键中是唯一的。
- 返回值:
- 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
派生的整数。这些整数从链式哈希中采样,保证种子随机生成器的伪随机独立性。根据
self_policy
,应用于self
中的random_state
参数,并且当且仅当deep=True
时应用于剩余的组件对象。注意:即使
self
没有random_state
参数,或者任何组件都没有random_state
参数,也会调用set_params
。因此,set_random_state
将重置任何scikit-base
对象,即使是那些没有random_state
参数的对象。- 参数:
- random_stateint, RandomState 实例或 None, default=None
伪随机数生成器,用于控制随机整数的生成。传入 int 可在多次函数调用中获得可重现的输出。
- deepbool, default=True
是否在 skbase 对象值的参数(即组件估计器)中设置 random state。
如果为 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,
从输入的
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 方法,则默认回退如下
update_params=True
: 拟合到目前所有观测到的数据update_params=False
: 仅更新 cutoff 并记住数据
- 所需状态
要求状态为“已拟合”,即
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 = 时间序列集合,全局/面板预测。带有 2 级行MultiIndex
((instance, time)
) 的pd.DataFrame
、3D np.ndarray
((instance, variable, time)
) 或Series
类型的pd.DataFrame
列表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")
为 True,则X.index
必须包含y.index
。- update_paramsbool, 可选 (default=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 方法,则默认回退如下
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 = 时间序列集合,全局/面板预测。带有 2 级行MultiIndex
((instance, time)
) 的pd.DataFrame
、3D np.ndarray
((instance, variable, time)
) 或Series
类型的pd.DataFrame
列表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
- X
sktime
兼容格式的时间序列,可选 (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
,仅更新 cutoff,模型参数(例如系数)不更新。- reset_forecasterbool, 可选 (default=True)
如果为 True,则不会改变预测器的状态,即 update/predict 序列使用副本运行,并且 self 的 cutoff、模型参数、数据内存不变
如果为 False,则在 update/predict 序列运行时更新 self,就像直接调用 update/predict 一样
- 返回值:
- y_pred汇总来自多个分割批次的点预测的对象
格式取决于(cutoff,绝对 horizon)对的总体预测
如果绝对 horizon 点的集合是唯一的:类型是 sktime 兼容数据容器格式的时间序列,输出中省略 cutoff,类型与最近传入的 y 相同:Series, Panel, Hierarchical scitype,格式相同(见上文)
如果绝对 horizon 点的集合不唯一:类型是 pandas DataFrame,行和列索引为时间戳,行索引对应预测时的 cutoff,列索引对应预测的绝对 horizon,条目是根据行索引预测的列索引的点预测,如果在该 (cutoff, horizon) 对没有预测,则条目为 nan。
- update_predict_single(y=None, fh=None, X=None, update_params=True)[source]#
使用新数据更新模型并进行预测。
此方法用于一步完成更新和预测。
如果未实现特定于估计器的 update 方法,则默认回退为先 update,然后 predict。
- 所需状态
要求状态为“已拟合”。
- 访问 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 = 时间序列集合,全局/面板预测。带有 2 级行MultiIndex
((instance, time)
) 的pd.DataFrame
、3D np.ndarray
((instance, variable, time)
) 或Series
类型的pd.DataFrame
列表Hierarchical
scitype = 分层集合,用于分层预测。带有 3 级或更多级行MultiIndex
((hierarchy_1, ..., hierarchy_n, time)
) 的pd.DataFrame
有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅预测教程
examples/01_forecasting.ipynb
。- fhint, list, pd.Index coercible, or
ForecastingHorizon
, default=None 预测时点的时间戳编码的预测 horizon。如果已在
fit
中传入,则不应再次传入。如果未在 fit 中传入,则必须传入,非可选。- X
sktime
兼容格式的时间序列,可选 (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
,仅更新 cutoff,模型参数(例如系数)不更新。
- 返回值:
- y_predsktime 兼容数据容器格式的时间序列
在
fh
上的点预测,索引与fh
相同。y_pred
的类型与最近传递的y
相同:Series
、Panel
、Hierarchical
scitype,格式相同(见上)。