VECM#
- class VECM(dates=None, freq=None, missing='none', k_ar_diff=1, coint_rank=1, deterministic='n', seasons=0, first_season=0, method='ml', exog_coint=None, exog_coint_fc=None)[source]#
向量误差修正模型,来自 statsmodels。
直接接口到
statsmodels.tsa.vector_ar.vecm
。VECM (向量误差修正模型) 是一个受限的 VAR 模型,用于处理协整的非平稳时间序列。
- 参数:
- datesarray_like of datetime,可选
有关更多信息,请参阅
statsmodels.tsa.base.tsa_model.TimeSeriesModel
。- freqstr,可选
有关更多信息,请参阅
statsmodels.tsa.base.tsa_model.TimeSeriesModel
。- missingstr,可选,默认=”none”
有关更多信息,请参阅
statsmodels.base.model.Model
。- k_ar_diffint,可选,默认=1
模型中的滞后差分数量。等于上述公式中的 \(k_{ar} - 1\)。
- coint_rankint,可选,默认=1
协整秩,等于矩阵 \(\\Pi\) 的秩以及 \(\\alpha\) 和 \(\\beta\) 的列数。
- deterministicstr,可选,默认=”n”
必须是以下之一:{
"n"
,"co"
,"ci"
,"lo"
,"li"
}"n"
- 无确定性项"co"
- 协整关系之外的常数项"ci"
- 协整关系之内的常数项"lo"
- 协整关系之外的线性趋势项"li"
- 协整关系之内的线性趋势项
这些可以组合使用(例如
"cili"
或"colo"
表示带截距的线性趋势)。使用常数项时,必须选择是将其限制在协整关系内(即"ci"
)还是不加限制(即"co"
)。不要同时使用"ci"
和"co"
。线性项的"li"
和"lo"
也适用同样规则。有关更多信息,请参阅 Notes 部分。- seasonsint,可选,默认值: 0
季节性周期的周期数。0 表示无季节性。
- first_seasonint,可选,默认值: 0
第一个观测值的季节。
- methodstr {“ml”},默认值: “ml”
要使用的估计方法。“ml” 代表最大似然估计。
- exog_coint可选,标量 (float),大小为 nobs 的 1D ndarray,
大小为 (any, neqs) 的 2D ndarray/pd.DataFrame。协整关系内的确定性项。
- exog_coint_fc可选,标量 (float),大小为 nobs 的 1D ndarray,
大小为 (any, neqs) 的 2D ndarray/pd.DataFrame。exog_coint 的预测值
- 属性:
示例
>>> import numpy as np >>> import pandas as pd >>> from sktime.forecasting.vecm import VECM >>> from sktime.split import temporal_train_test_split >>> from sktime.forecasting.base import ForecastingHorizon >>> index = pd.date_range(start="2005", end="2006-12", freq="ME") >>> df = pd.DataFrame(np.random.randint(0, 100, size=(23, 2)), ... columns=list("AB"), ... index=pd.PeriodIndex(index)) >>> train, test = temporal_train_test_split(df) >>> sktime_model = VECM() >>> fh = ForecastingHorizon([1, 3, 4, 5, 7, 9]) >>> _ = sktime_model.fit(train, fh=fh) >>> fc2 = sktime_model.predict(fh=fh)
方法
check_is_fitted
([method_name])检查估计器是否已拟合。
克隆
()获取一个具有相同超参数和配置的对象的克隆。
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])计算/返回方差预测。
重置
()将对象重置到初始化后的干净状态。
save
([path, serialization_format])将序列化的自身保存到字节对象或 (.zip) 文件。
score
(y[, X, fh])使用 MAPE (非对称) 对预测结果进行评分。
set_config
(**config_dict)将配置标志设置为给定值。
set_params
(**params)设置此对象的参数。
set_random_state
([random_state, deep, ...])为此自身设置 random_state 伪随机种子参数。
set_tags
(**tag_dict)将实例级标签覆盖设置为给定值。
update
(y[, X, update_params])更新截止点值,并且可选地更新已拟合参数。
update_predict
(y[, cv, X, update_params, ...])在测试集上迭代更新模型并进行预测。
update_predict_single
([y, fh, X, update_params])用新数据更新模型并进行预测。
- classmethod get_test_params(parameter_set='default')[source]#
返回估计器的测试参数设置。
- 参数:
- parameter_setstr,默认值=”default”
要返回的测试参数集的名称,用于测试。如果某个值未定义特殊参数,将返回 “default” 参数集。目前预测器没有保留值。
- 返回:
- paramsdict 或 list of dict,默认值 = {}
用于创建类的测试实例的参数。每个 dict 都是用于构造“有趣”测试实例的参数,即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个(或唯一一个)字典。
- check_is_fitted(method_name=None)[source]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。在调用对象的fit
方法时,is_fitted
属性应设置为True
。如果不是,则引发
NotFittedError
。- 参数:
- method_namestr,可选
调用此方法的函数名称。如果提供,错误消息将包含此信息。
- 引发:
- 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
。- 引发:
- 如果克隆不符合规范,由于错误的
__init__
,则引发 RuntimeError。
- 如果克隆不符合规范,由于错误的
- clone_tags(estimator, tag_names=None)[source]#
从另一个对象克隆标签作为动态覆盖。
每个兼容
scikit-base
的对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是对象构造后不会更改的静态标志。clone_tags
从另一个对象estimator
设置动态标签覆盖。clone_tags
方法应仅在对象的__init__
方法中调用,即在构造期间或通过__init__
直接在构造后调用。动态标签被设置为
estimator
中指定名称tag_names
的标签值。tag_names
的默认设置是将estimator
中的所有标签写入self
。当前标签值可以通过
get_tags
或get_tag
查看。- 参数:
- estimator:class:BaseObject 或派生类的实例
- tag_namesstr 或 list of str,默认值 = None
要克隆的标签名称。默认值 (
None
) 克隆estimator
中的所有标签。
- 返回:
- self
self
的引用。
- classmethod create_test_instance(parameter_set='default')[source]#
使用第一个测试参数集构造类的实例。
- 参数:
- parameter_setstr,默认值=”default”
要返回的测试参数集的名称,用于测试。如果某个值未定义特殊参数,将返回 “default” 参数集。
- 返回:
- instance带有默认参数的类实例
- classmethod create_test_instances_and_names(parameter_set='default')[source]#
创建所有测试实例的列表及其名称列表。
- 参数:
- parameter_setstr,默认值=”default”
要返回的测试参数集的名称,用于测试。如果某个值未定义特殊参数,将返回 “default” 参数集。
- 返回:
- objscls 实例列表
第 i 个实例是
cls(**cls.get_test_params()[i])
- namesstr 列表,长度与 objs 相同
第 i 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个,命名约定为
{cls.__name__}-{i}
,否则为{cls.__name__}
- property cutoff[source]#
截止点 = 预测器的“当前时间”状态。
- 返回:
- cutoffpandas 兼容索引元素,或 None
如果已设置截止点,则为 pandas 兼容索引元素;否则为 None
- fit(y, X=None, fh=None)[source]#
拟合预测器到训练数据。
- 状态变更
将状态变更为“已拟合”。
写入自身
设置以“_”结尾的已拟合模型属性,已拟合属性可通过
get_fitted_params
查看。将
self.is_fitted
标志设置为True
。将
self.cutoff
设置为y
中看到的最后一个索引。如果传递了
fh
,则将其存储到self.fh
。
- 参数:
- y
sktime
兼容数据容器格式的时间序列。 用于拟合预测器的时间序列。
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
包含Series
类型的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
中传递,不是可选的- X
sktime
兼容格式的时间序列,可选 (默认值=None)。 用于拟合模型的外生时间序列。应与
y
具有相同的 scitype (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含y.index
。
- y
- 返回:
- 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
包含Series
类型的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) 被强制转换。
- X
sktime
兼容格式的时间序列,可选 (默认值=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
设置,定义在实例上。要包含来自动态标签的覆盖,请使用
get_tags
。- collected_tagsdict
标签名称:标签值对的字典。通过嵌套继承从
_tags
类属性收集。不受通过set_tags
或clone_tags
设置的动态标签覆盖。
- get_config()[source]#
获取自身的配置标志。
Configs 是
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]#
检查对象是否由其他 BaseObjects 组成。
复合对象是参数中包含其他对象的对象。在实例上调用,因为这可能因实例而异。
- 返回:
- composite: bool
对象的任何参数的值是否为
BaseObject
后代实例。
- property is_fitted[source]#
是否已调用
fit
方法。检查对象的
_is_fitted` 属性,该属性在对象构建期间应初始化为 ``False
,并在调用对象的 fit 方法时设置为 True。- 返回:
- bool
估计器是否已 拟合。
- classmethod load_from_path(serial)[source]#
从文件位置加载对象。
- 参数:
- serialZipFile(path).open(“object) 的结果
- 返回:
- 反序列化的自身,其输出位于
path
,来自cls.save(path)
- 反序列化的自身,其输出位于
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回:
- 反序列化的自身,其输出为
serial
,来自cls.save(None)
- 反序列化的自身,其输出为
- predict(fh=None, X=None)[source]#
预测未来时间序列。
- 所需状态
要求状态为“已拟合”,即
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)
用于预测的外生时间序列。其数据类型 (
Series
,Panel
, 或Hierarchical
) 应与fit
中y
的数据类型相同。如果self.get_tag("X-y-must-have-same-index")
为 True,则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.cutoff
,self.is_fitted
- 写入自身
如果传递了
fh
且之前未传递过,则将其存储到self.fh
。
- 参数:
- fhint, list, pd.Index 可强制转换类型,或
ForecastingHorizon
,默认值=None 预测视界,编码了要预测的时间戳。如果已在
fit
中传入,则不应再次传入。如果未在 fit 中传入,则必须传入,不可选。如果
fh
非 None 且类型非ForecastingHorizon
,则在内部会被强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或int
数组类型,则被解释为相对预测视界,并强制转换为相对ForecastingHorizon(fh, is_relative=True)
。如果
fh
的类型是pd.Index
,则被解释为绝对预测视界,并强制转换为绝对ForecastingHorizon(fh, is_relative=False)
。
- Xsktime 兼容格式的时间序列,可选 (默认值=None)
用于预测的外生时间序列。其数据类型 (
Series
,Panel
, 或Hierarchical
) 应与fit
中y
的数据类型相同。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引引用。- coverage浮点数或唯一浮点数列表,可选 (默认值=0.90)
预测区间的名义覆盖率
- fhint, list, pd.Index 可强制转换类型,或
- 返回:
- pred_intpd.DataFrame
- 列具有多级索引:第一级是在 fit 中 y 的变量名,
- 第二级是计算区间的覆盖率分数。
顺序与输入
coverage
相同。
第三级是字符串 “lower” 或 “upper”,表示区间的下限/上限。
- 行索引是 fh,如果 fit 中看到的 y 是 Panel 或 Hierarchical 类型,则具有附加(上层)实例级别。
从 fit 中看到的 y 的实例级别。
- 条目是区间下限/上限的预测值,
对于列索引中的变量,在第二级列索引中的名义覆盖率下,根据第三级列索引为下限/上限,对应于行索引。区间上限/下限预测等同于在 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.cutoff
,self.is_fitted
- 写入自身
如果传递了
fh
且之前未传递过,则将其存储到self.fh
。
- 参数:
- fhint, list, pd.Index 可强制转换类型,或
ForecastingHorizon
,默认值=None 预测视界,编码了要预测的时间戳。如果已在
fit
中传入,则不应再次传入。如果未在 fit 中传入,则必须传入,不可选。如果
fh
非 None 且类型非ForecastingHorizon
,则在内部会被强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或int
数组类型,则被解释为相对预测视界,并强制转换为相对ForecastingHorizon(fh, is_relative=True)
。如果
fh
的类型是pd.Index
,则被解释为绝对预测视界,并强制转换为绝对ForecastingHorizon(fh, is_relative=False)
。
- Xsktime 兼容格式的时间序列,可选 (默认值=None)
用于预测的外生时间序列。其数据类型 (
Series
,Panel
, 或Hierarchical
) 应与fit
中y
的数据类型相同。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引引用。- marginal布尔值,可选 (默认值=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.cutoff
,self.is_fitted
- 写入自身
如果传递了
fh
且之前未传递过,则将其存储到self.fh
。
- 参数:
- fhint, list, pd.Index 可强制转换类型,或
ForecastingHorizon
,默认值=None 预测视界,编码了要预测的时间戳。如果已在
fit
中传入,则不应再次传入。如果未在 fit 中传入,则必须传入,不可选。如果
fh
非 None 且类型非ForecastingHorizon
,则在内部会被强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或int
数组类型,则被解释为相对预测视界,并强制转换为相对ForecastingHorizon(fh, is_relative=True)
。如果
fh
的类型是pd.Index
,则被解释为绝对预测视界,并强制转换为绝对ForecastingHorizon(fh, is_relative=False)
。
- Xsktime 兼容格式的时间序列,可选 (默认值=None)
用于预测的外生时间序列。其数据类型 (
Series
,Panel
, 或Hierarchical
) 应与fit
中y
的数据类型相同。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引引用。- alpha浮点数或唯一浮点数列表,可选 (默认值=[0.05, 0.95])
一个或多个概率值,在这些值处计算分位数预测。
- fhint, list, pd.Index 可强制转换类型,或
- 返回:
- quantilespd.DataFrame
- 列具有多级索引:第一级是在 fit 中 y 的变量名,
第二级是传入函数的 alpha 值。
- 行索引是 fh,如果 fit 中看到的 y 是 Panel 或 Hierarchical 类型,则具有附加(上层)实例级别。
从 fit 中看到的 y 的实例级别。
- 条目是分位数预测值,对于列索引中的变量,
在第二级列索引中的分位数概率处,对应于行索引。
- predict_residuals(y=None, X=None)[source]#
返回时间序列预测的残差。
将对 y.index 处的预测值计算残差。
如果 fit 中必须传入 fh,则必须与 y.index 一致。如果 y 是 np.ndarray,且 fit 中没有传入 fh,则残差将在 fh 范围为 range(len(y.shape[0])) 处计算。
- 所需状态
要求状态为“已拟合”。如果已设置 fh,则必须对应于 y 的索引(pandas 或整数)。
- 访问自身中的属性
以“_”结尾的已拟合模型属性。self.cutoff, self._is_fitted
- 写入自身
无返回值。
- 参数:
- ysktime 兼容数据容器格式的时间序列
带有真实观测值的时间序列,用于计算残差。必须与 predict 的预期返回值具有相同的类型、维度和索引。
如果为 None,则使用到目前为止看到的 y (self._y),特别是
如果之前只调用过一次 fit,则生成样本内残差
如果 fit 要求
fh
,则必须指向 fit 中 y 的索引
- Xsktime 兼容格式的时间序列,可选 (默认值=None)
用于更新和预测的外生时间序列。其数据类型 (
Series
,Panel
, 或Hierarchical
) 应与fit
中y
的数据类型相同。如果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
数据类型,相同的格式(参见上文)
- predict_var(fh=None, X=None, cov=False)[source]#
计算/返回方差预测。
- 所需状态
要求状态为“已拟合”,即
self.is_fitted=True
。
访问自身中的属性
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
- 写入自身
如果传递了
fh
且之前未传递过,则将其存储到self.fh
。
- 参数:
- fhint, list, pd.Index 可强制转换类型,或
ForecastingHorizon
,默认值=None 预测视界,编码了要预测的时间戳。如果已在
fit
中传入,则不应再次传入。如果未在 fit 中传入,则必须传入,不可选。如果
fh
非 None 且类型非ForecastingHorizon
,则在内部会被强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或int
数组类型,则被解释为相对预测视界,并强制转换为相对ForecastingHorizon(fh, is_relative=True)
。如果
fh
的类型是pd.Index
,则被解释为绝对预测视界,并强制转换为绝对ForecastingHorizon(fh, is_relative=False)
。
- Xsktime 兼容格式的时间序列,可选 (默认值=None)
用于预测的外生时间序列。其数据类型 (
Series
,Panel
, 或Hierarchical
) 应与fit
中y
的数据类型相同。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引引用。- cov布尔值,可选 (默认值=False)
如果为 True,计算协方差矩阵预测。如果为 False,计算边际方差预测。
- fhint, list, pd.Index 可强制转换类型,或
- 返回:
- pred_varpd.DataFrame,格式取决于
cov
变量 - 如果 cov=False
- 列名与在
fit
/update
中传入的y
的列名完全相同。 对于无名称格式,列索引将是 RangeIndex。
- 行索引是 fh,具有附加级别等于实例级别,
从 fit 中看到的 y 的实例级别。
从 fit 中看到的 y。条目是方差预测值,对于列索引中的变量。给定变量和 fh 索引的方差预测是根据观测数据预测的该变量和索引的预测方差。
从 fit 中看到的 y。条目是方差预测值,对于列索引中的变量。
- 列名与在
- 如果 cov=True
- 列索引是多级索引:第一级是变量名(如上)
第二级是 fh。
- 行索引是 fh,具有附加级别等于实例级别,
从 fit 中看到的 y 的实例级别。
- 条目是(协)方差预测值,对于列索引中的变量,
以及行和列时间索引之间的协方差。
注意:不同变量之间不返回协方差预测。
- pred_varpd.DataFrame,格式取决于
- reset()[source]#
将对象重置到初始化后的干净状态。
结果是将
self
设置回构造函数调用后的状态,保留相同的超参数。由set_config
设置的配置值也保留。调用
reset
会删除所有对象属性,除了超参数 = 写入
self
的__init__
参数,例如,self.paramname
,其中paramname
是__init__
的参数。包含双下划线的对象属性,即字符串“__”。例如,名为“__myattr”的属性被保留。
配置属性,配置保持不变。也就是说,
reset
前后get_config
的结果相同。
类和对象方法以及类属性也不受影响。
等同于
clone
,不同之处在于reset
修改self
而非返回新对象。在调用
self.reset()
后,self
的值和状态与构造函数调用type(self)(**self.get_params(deep=False))
后获得的对象相同。- 返回:
- self
类实例被重置为干净的初始化后状态,但保留当前超参数值。
- save(path=None, serialization_format='pickle')[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”) 为 True,X.index 必须包含 y.index。
- 返回:
- score浮点数
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_only布尔值,默认值=True
打印 self 时是仅列出与默认值不同的 self 参数(True),还是列出所有参数名和值(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”:布尔值,默认值=True;False 防止
ray
在并行化后 关闭。
- “shutdown_ray”:布尔值,默认值=True;False 防止
“logger_name”:str,默认值=“ray”;使用的日志记录器名称。
“mute_warnings”:布尔值,默认值=False;如果为 True,则抑制警告。
- remember_data布尔值,默认值=True
`self._X` 和 `self._y` 是否在 fit 中存储并在 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
:仅更新截止点并记住数据
- 所需状态
要求状态为“已拟合”,即
self.is_fitted=True
。
访问自身中的属性
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
写入自身
将
self.cutoff
更新为在y
中看到的最新索引。如果
update_params=True
,则更新以“_”结尾的已拟合模型属性。
- 参数:
- y
sktime
兼容数据容器格式的时间序列。 用于更新预测器的时间序列。
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
包含Series
类型的pd.DataFrame
Hierarchical
scitype = 分层集合,用于分层预测。pd.DataFrame
带有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅预测教程
examples/01_forecasting.ipynb
- X
sktime
兼容格式的时间序列,可选 (默认值=None)。 用于更新模型拟合的外生时间序列。其 数据类型 (
Series
,Panel
, 或Hierarchical
) 应与y
的数据类型相同。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含y.index
。- update_params布尔值,可选 (默认值=True)
模型参数是否应该更新。如果为
False
,则仅更新截止点,模型参数(例如,系数)不更新。
- y
- 返回:
- 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.cutoff
,self.is_fitted
- 写入 self(除非
reset_forecaster=True
) 将
self.cutoff
更新为在y
中看到的最新索引。如果
update_params=True
,则更新以“_”结尾的已拟合模型属性。
如果
reset_forecaster=True
,不更新状态。- 参数:
- y
sktime
兼容数据容器格式的时间序列。 用于更新预测器的时间序列。
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
包含Series
类型的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)
用于更新和预测的外生时间序列。其数据类型 (
Series
,Panel
, 或Hierarchical
) 应与fit
中y
的数据类型相同。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引引用。- update_params布尔值,可选 (默认值=True)
模型参数是否应该更新。如果为
False
,则仅更新截止点,模型参数(例如,系数)不更新。- reset_forecaster布尔值,可选 (默认值=True)
如果为 True,则不改变预测器的状态,即 update/predict 序列使用副本运行,self 的截止点、模型参数、数据内存不改变。
如果为 False,则在运行 update/predict 序列时将更新 self,就像直接调用 update/predict 一样。
- y
- 返回:
- y_pred汇集来自多个分割批次的点预测的对象
格式取决于总体预测的 (截止点, 绝对预测视界) 对。
如果绝对预测视界点的集合是唯一的:类型是 sktime 兼容数据容器格式的时间序列,输出中省略截止点,具有与最近传入的 y 相同的类型:Series, Panel, Hierarchical 数据类型,相同的格式(参见上文)。
如果绝对预测视界点的集合不是唯一的:类型是 pandas DataFrame,其行索引和列索引是时间戳。行索引对应于用于预测的截止点,列索引对应于预测的绝对预测视界。条目是根据行索引预测的列索引的点预测。如果在该 (截止点, 预测视界) 对处没有预测,则条目为 nan。
- update_predict_single(y=None, fh=None, X=None, update_params=True)[source]#
用新数据更新模型并进行预测。
此方法对于在单个步骤中更新和进行预测非常有用。
如果没有实现特定于评估器的更新方法,则默认回退是先更新,然后预测。
- 所需状态
要求状态为“已拟合”。
- 访问自身中的属性
以“_”结尾的已拟合模型属性。指向已见数据: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,更新以“_”结尾的已拟合模型属性。
- 参数:
- y
sktime
兼容数据容器格式的时间序列。 用于更新预测器的时间序列。
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
包含Series
类型的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)
用于更新和预测的外生时间序列。其数据类型 (
Series
,Panel
, 或Hierarchical
) 应与fit
中y
的数据类型相同。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引引用。- update_params布尔值,可选 (默认值=True)
模型参数是否应该更新。如果为
False
,则仅更新截止点,模型参数(例如,系数)不更新。
- y
- 返回:
- y_predsktime 兼容数据容器格式的时间序列
在
fh
的点预测,索引与fh
相同。y_pred
与最近传递的y
具有相同类型:Series
,Panel
,Hierarchical
scitype,格式相同(见上文)