VARReduce#
- class VARReduce(lags=1, regressor=None)[source]#
一种灵活的类似VAR的预测器,结合了表格化和回归。
输入数据 Y_in 是一个包含 n 个时间序列的多元时间序列数据。一个 n = 2 的示例:
index
ts1
ts2
1 2 3 4 5
11 12 13 14 15
6 7 8 9 10
拟合过程分为两步: 1. 表格化
对于 Y_in 中的每个时间步和每个时间序列,都会生成滞后值 X。滞后值的数量由 lags 参数决定。
下面是 lags = 2 的示例 Y_in 的 X。请注意缺少最早的两个时间步,因为没有相应的滞后值可用。
index
ts1_lag1
ts2_lag1
ts1_lag2
ts2_lag2
3 4 5
12 13 14
7 8 9
11 12 13
6 7 8
- 回归
选择的回归器以 Y_in 为目标,以 X 为预测变量进行拟合。注意要先移除 Y_in 中前 lags 个数据点,因为它们在 X 中没有对应的索引(即上面示例中的前两个数据点)。
对于预测,Y_in 中最后 lags 个观测值被重新构建为滞后预测变量 X_forecast,并传递给训练好的回归器以获得预测结果。X_forecast 如下所示。
index
ts1_lag1
ts2_lag1
ts1_lag2
ts2_lag2
6
15
10
14
9
默认情况下,使用 LinearRegression,其结果等同于传统的VAR模型。或者,可以使用任何与scikit-learn兼容的回归器来引入正则化和/或非线性。
- 例如
VARReduce(regressor = Ridge()) 等同于带有 L2 正则化的 VAR;
VARReduce(regressor = Lasso()) 等同于带有 L1 正则化的 VAR。
当输入数据包含相对于数据点而言大量的时间序列时,这两种模型可用于引入正则化并防止过拟合。
- 参数:
- lagsint, 可选, 默认值=1
模型中包含的滞后值的数量。
- regressor对象, 可选 (默认值=LinearRegression())
用于拟合模型的回归器。必须与scikit-learn兼容。
- 属性:
- coefficients_np.ndarray, 形状 (lags, num_series, num_series)
模型的估计系数;仅当回归器具有 coef_ 属性时可用
- intercept_np.ndarray, 形状 (num_series,)
每个时间序列的截距;仅当回归器具有 coef_ 属性时可用
- num_seriesint
正在建模的时间序列数量。
- var_namesstr列表
正在建模的时间序列的名称
示例
>>> from sktime.forecasting.var_reduce import VARReduce >>> from sklearn.linear_model import Lasso >>> from sktime.datasets import load_longley >>> _, y = load_longley() >>> forecaster = VARReduce(regressor=Lasso()) >>> forecaster.fit(y) VARReduce(...) >>> 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, ...])为对象设置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])使用新数据更新模型并进行预测。
- 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。
- 如果克隆不符合规范(由于错误的
- check_is_fitted(method_name=None)[source]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。is_fitted
属性应在调用对象的fit
方法时设置为True
。如果不是,则引发
NotFittedError
。- 参数:
- method_namestr, 可选
调用此方法的函数的名称。如果提供,错误消息将包含此信息。
- 引发:
- NotFittedError
如果估计器尚未拟合。
- clone_tags(estimator, tag_names=None)[source]#
从另一个对象克隆标签作为动态覆盖。
每个与
scikit-base
兼容的对象都含有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。clone_tags
方法只能在对象的__init__
方法中调用,即在构造期间或通过__init__
直接构造之后。动态标签被设置为
estimator
中标签的值,名称由tag_names
指定。默认值
tag_names
将estimator
中的所有标签写入self
。可以通过
get_tags
或get_tag
查看当前的标签值。estimator:class:BaseObject 或派生类的实例
- 使用第一个测试参数集构造类的实例。
使用第一个测试参数集构造类的实例。
- 参数:
- parameter_setstr, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,将返回 “default” 集。
- self
- instance具有默认参数的类的实例
- classmethod create_test_instances_and_names(parameter_set='default')[source]#
创建所有测试实例的列表及其名称列表。
- 参数:
- parameter_setstr, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,将返回 “default” 集。
- self
- 创建所有测试实例的列表及其名称列表。
objscls实例列表
- 第 i 个实例是
cls(**cls.get_test_params()[i])
namesstr列表, 与 objs 长度相同
-
第 i 个元素是 objs 中第 i 个实例在测试中的名称。如果实例数量多于一个,命名约定为
{cls.__name__}-{i}
,否则为{cls.__name__}
-
- self
- 截止点 = 预测器的“当前时间”状态。
cutoffpandas 兼容的索引元素, 或 None
- 已传递的预测范围。
将预测器拟合到训练数据。
将状态更改为“已拟合”。
写入自身
设置以“_”结尾的拟合模型属性,可以通过
get_fitted_params
查看拟合属性。将
self.is_fitted
标志设置为True
。将
self.cutoff
设置为在y
中看到的最后一个索引。
- 参数:
- 如果传递了
fh
,则将fh
存储到self.fh
。 y
sktime
兼容数据容器格式的时间序列。用于拟合预测器的时间序列。
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)。
- 如果传递了
- self
- 用于拟合模型的外部时间序列。应与
y
具有相同的 scitype (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,X.index
必须包含y.index
。
- 用于拟合模型的外部时间序列。应与
- selfself 的引用。
在未来预测范围上拟合和预测时间序列。
fit_predict(y, X=None, fh=None, X_pred=None)[source]#
将状态更改为“已拟合”。
写入自身
设置以“_”结尾的拟合模型属性,可以通过
get_fitted_params
查看拟合属性。将
self.is_fitted
标志设置为True
。等同于
fit(y, X, fh).predict(X_pred)
。如果未传递X_pred
,则等同于fit(y, fh, X).predict(X)
。
- 参数:
- 将
fh
存储到self.fh
。 y
sktime
兼容数据容器格式的时间序列。用于拟合预测器的时间序列。
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)
- ysktime 兼容数据容器格式的时间序列
fhint, list, 可强制转换为 pd.Index, 或
ForecastingHorizon
(非可选)编码预测时间戳的预测范围。
- 编码预测时间戳的预测范围。如果
self.get_tag("requires-fh-in-fit")
为True
,则必须在fit
中传递,不可选。 X
sktime
兼容格式的时间序列, 可选 (默认值=None)。- 如果 fh 不是 None 且不是 ForecastingHorizon 类型,则通过调用 _check_fh 将其强制转换为 ForecastingHorizon。特别是,如果 fh 是 pd.Index 类型,则通过 ForecastingHorizon(fh, is_relative=False) 将其强制转换。
X_predsktime 兼容格式的时间序列, 可选 (默认值=None)
- 将
- self
- 用于预测的外部时间序列。如果传递,将在 predict 中使用而不是 X。应与
fit
中的y
具有相同的 scitype (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为真,X.index
必须包含fh
索引引用。 y_predsktime 兼容数据容器格式的时间序列
- 用于预测的外部时间序列。如果传递,将在 predict 中使用而不是 X。应与
-
在
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任何类型
- 要检索可能包含实例覆盖的标签值,请使用
- self
- 如果未找到标签,则为默认/备用值。
tag_value
-
self
中tag_name
标签的值。如果未找到,则返回tag_value_default
。 从类获取类标签,带有来自父类的标签级别继承。
每个与
scikit-base
兼容的对象都含有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。classmethod get_class_tags()[source]#
get_class_tags
方法是一个类方法,仅考虑类级别标签值和覆盖来检索标签值。它返回一个字典,其键是类或其任何父类中设置的
_tags
属性的任何键。它从对象中返回名称为
tag_name
的标签值,考虑了标签覆盖,按以下降序优先级排列:在类的
_tags
属性中设置的标签。
在父类
_tags
属性中设置的标签,值是相应的标签值,覆盖按以下降序优先级排列:
实例可以根据超参数覆盖这些标签。
按继承顺序。
要检索可能包含实例覆盖的标签,请使用
get_tags
方法代替。- 要包含来自动态标签的覆盖,请使用
get_tags
。 collected_tagsdict
-
标签名称 : 标签值 对的字典。通过嵌套继承从
_tags
类属性收集。不受通过set_tags
或clone_tags
设置的动态标签覆盖。 获取对象的配置标志。
Configs 是
self
的键值对,通常用作控制行为的瞬时标志。get_config
返回动态配置,这些配置会覆盖默认配置。默认配置设置在类或其父类的
_config
类属性中,并通过set_config
设置的动态配置进行覆盖。- self
- 配置在
clone
或reset
调用时保留。 config_dictdict
- 配置在
- 配置名称 : 配置值 对的字典。通过嵌套继承从 _config 类属性收集,然后从 _onfig_dynamic 对象属性中获取任何覆盖和新标签。
获取拟合参数。
- 参数:
- 要求状态为“已拟合”。
deepbool, 默认值=True
是否返回组件的拟合参数。
如果为 True,将返回此对象的参数名称 : 参数值 字典,包括可拟合组件(= BaseEstimator 值参数)的拟合参数。
- self
- 如果为 False,将返回此对象的参数名称 : 参数值 字典,但不包括组件的拟合参数。
fitted_params键为 str 类型的字典
拟合参数字典,参数名 : 参数值 键值对包括:
始终:此对象的所有拟合参数,通过
get_param_names
获取,值为该键对应的拟合参数值,属于此对象如果
deep=True
,还包含组件参数的键/值对 组件参数的索引格式为[componentname]__[paramname]
componentname
的所有参数都显示为paramname
及其值
-
如果
deep=True
,还包含任意级别的组件递归,例如[componentname]__[componentcomponentname]__[paramname]
等 classmethod get_param_defaults()[source]#
- self
- 获取对象的默认参数。
default_dict: dict[str, Any]
-
键是
cls
中在__init__
中定义了默认值的所有参数。值是在__init__
中定义的默认值。 classmethod get_param_names(sort=True)[source]#
- 参数:
- 获取对象的参数名称。
sortbool, 默认值=True
- self
- 是否按字母顺序排序返回参数名称(True),或按其在类
__init__
中出现的顺序返回(False)。 param_names: list[str]
- 是否按字母顺序排序返回参数名称(True),或按其在类
-
cls
的参数名称列表。如果sort=False
,则与它们在类__init__
中出现的顺序相同。如果sort=True
,则按字母顺序排序。 获取此对象的参数值字典。
- 参数:
- self
- 如果为
False
,将返回此对象的参数名称 : 参数值dict
,但不包括组件的参数。 params键为 str 类型的字典
参数字典,参数名 : 参数值 键值对包括:
始终:此对象的所有拟合参数,通过
get_param_names
获取,值为该键对应的拟合参数值,属于此对象如果
deep=True
,还包含组件参数的键/值对 组件参数的索引格式为[componentname]__[paramname]
componentname
的所有参数都显示为paramname
及其值
- 如果为
-
始终:此对象的所有参数,通过
get_param_names
获取,值为该键对应的参数值,属于此对象。值始终与构造时传递的值相同 从实例获取标签值,带有标签级别继承和覆盖。
每个与
scikit-base
兼容的对象都含有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#
get_tag
方法从实例中检索名称为tag_name
的单个标签的值,考虑了标签覆盖,按以下降序优先级排列:
在实例上通过
set_tags
或clone_tags
设置的标签,它从对象中返回名称为
tag_name
的标签值,考虑了标签覆盖,按以下降序优先级排列:在类的
_tags
属性中设置的标签。
在父类
_tags
属性中设置的标签,- 参数:
- 要检索可能包含实例覆盖的标签值,请使用
get_tag
方法代替。 在实例构造时设置。
- 要检索的标签名称
tag_value_default任何类型, 可选;默认值=None
- 如果未找到标签,则为默认/备用值
raise_errorbool
- 要检索可能包含实例覆盖的标签值,请使用
- self
- 当未找到标签时是否引发
ValueError
tag_valueAny
- 当未找到标签时是否引发
- 引发:
self
中tag_name
标签的值。如果未找到,则在raise_error
为 True 时引发错误,否则返回tag_value_default
。ValueError,如果
raise_error
为True
。
-
如果
tag_name
不在self.get_tags().keys()
中,则引发ValueError
。 从实例获取标签,带有标签级别继承和覆盖。
每个与
scikit-base
兼容的对象都含有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。它返回一个字典,其键是类或其任何父类中设置的
_tags
属性的任何键。get_tag
方法从实例中检索名称为tag_name
的单个标签的值,考虑了标签覆盖,按以下降序优先级排列:
在实例上通过
set_tags
或clone_tags
设置的标签,它从对象中返回名称为
tag_name
的标签值,考虑了标签覆盖,按以下降序优先级排列:在类的
_tags
属性中设置的标签。
在父类
_tags
属性中设置的标签,- self
get_tags
方法返回一个标签字典,其键是类或其任何父类中设置的_tags
属性的任何键,或通过set_tags
或clone_tags
设置的标签。collected_tagsdict
-
标签名称 : 标签值 对的字典。通过嵌套继承从
_tags
类属性收集,然后从_tags_dynamic
对象属性中获取任何覆盖和新标签。 返回估计器的测试参数设置。
- 用于创建类测试实例的参数。每个 dict 都是构造一个“有趣”测试实例的参数,即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个(或唯一)字典。
检查对象是否由其他 BaseObjects 组成。
- self
- 复合对象是参数中包含对象的对象。在实例上调用,因为这可能因实例而异。
composite: bool
-
对象是否有任何参数的值是
BaseObject
的后代实例。 -
是否已调用
fit
。- self
- 检查对象的
_is_fitted` 属性,该属性在对象构造期间应初始化为 ``False`,并在调用对象的 fit 方法时设置为 True。
bool
- 检查对象的
- serialZipFile(path).open(“object”) 的结果
从序列化内存容器加载对象。
- predict(fh=None, X=None)[source]#
在未来预测范围上预测时间序列。
访问自身属性
已拟合模型的属性,以“_”结尾。
self.cutoff
,self.is_fitted
- 将状态更改为“已拟合”。
如果
fh
已传入且之前未传入过,则将其存储到self.fh
。
- 参数:
- 有关数据格式的更多详细信息,请参阅 mtype 术语表。有关使用方法,请参阅预测教程
examples/01_forecasting.ipynb
预测时间范围,编码要预测的时间戳。如果已在
fit
中传入,则不应再次传入。如果尚未在 fit 中传入,则必须传入,非可选。编码预测时间戳的预测范围。
- X
sktime
兼容格式的时间序列,可选(默认值=None) 预测中使用的外生时间序列。应与
fit
中的y
具有相同的科学类型(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
的索引引用。
- 有关数据格式的更多详细信息,请参阅 mtype 术语表。有关使用方法,请参阅预测教程
- self
- 用于预测的外部时间序列。如果传递,将在 predict 中使用而不是 X。应与
fit
中的y
具有相同的 scitype (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为真,X.index
必须包含fh
索引引用。 y_predsktime 兼容数据容器格式的时间序列
- 用于预测的外部时间序列。如果传递,将在 predict 中使用而不是 X。应与
- predict_interval(fh=None, X=None, coverage=0.9)[source]#
计算/返回预测区间预测结果。
如果
coverage
是可迭代的,则会计算多个区间。访问自身属性
已拟合模型的属性,以“_”结尾。
self.cutoff
,self.is_fitted
- 将状态更改为“已拟合”。
如果
fh
已传入且之前未传入过,则将其存储到self.fh
。
- 参数:
- 有关数据格式的更多详细信息,请参阅 mtype 术语表。有关使用方法,请参阅预测教程
examples/01_forecasting.ipynb
预测时间范围,编码要预测的时间戳。如果已在
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
具有相同的科学类型(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
的索引引用。- coverage浮点数或包含唯一浮点数值的列表,可选(默认值=0.90)
预测区间的名义覆盖率
- 有关数据格式的更多详细信息,请参阅 mtype 术语表。有关使用方法,请参阅预测教程
- self
- pred_intpd.DataFrame
- 列具有多级索引:第一级是在 fit 中 y 的变量名,
- 第二级是计算区间的覆盖率。
顺序与输入
coverage
中的相同。
第三级是字符串“lower”或“upper”,表示区间的下限/上限。
- 行索引是 fh,附加的(上层)级别等于实例级别,
来自 fit 中见到的 y,如果 fit 中见到的 y 是 Panel 或 Hierarchical 类型。
- 条目是区间下限/上限的预测值,
对于列索引中的变量,在第二列索引中的名义覆盖率下,下限/上限取决于第三列索引,对应于行索引。区间上限/下限预测值等同于对于 coverage 中的 c,在 alpha = 0.5 - c/2 和 0.5 + c/2 处的分位数预测值。
- predict_proba(fh=None, X=None, marginal=True)[source]#
计算/返回完全概率预测结果。
注意
当前仅对 Series (非面板,非层次) y 实现。
需要安装
skpro
以返回分布对象。
访问自身属性
已拟合模型的属性,以“_”结尾。
self.cutoff
,self.is_fitted
- 将状态更改为“已拟合”。
如果
fh
已传入且之前未传入过,则将其存储到self.fh
。
- 参数:
- 有关数据格式的更多详细信息,请参阅 mtype 术语表。有关使用方法,请参阅预测教程
examples/01_forecasting.ipynb
预测时间范围,编码要预测的时间戳。如果已在
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
具有相同的科学类型(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
的索引引用。- marginal布尔值,可选(默认值=True)
返回的分布是否按时间索引是边际分布
- 有关数据格式的更多详细信息,请参阅 mtype 术语表。有关使用方法,请参阅预测教程
- self
- pred_distskpro BaseDistribution
预测分布。如果 marginal=True,将是按时间点的边际分布;如果 marginal=False 且方法已实现,将是联合分布
- predict_quantiles(fh=None, X=None, alpha=None)[source]#
计算/返回分位数预测结果。
如果
alpha
是可迭代的,则会计算多个分位数。访问自身属性
已拟合模型的属性,以“_”结尾。
self.cutoff
,self.is_fitted
- 将状态更改为“已拟合”。
如果
fh
已传入且之前未传入过,则将其存储到self.fh
。
- 参数:
- 有关数据格式的更多详细信息,请参阅 mtype 术语表。有关使用方法,请参阅预测教程
examples/01_forecasting.ipynb
预测时间范围,编码要预测的时间戳。如果已在
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
具有相同的科学类型(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
的索引引用。- alpha浮点数或包含唯一浮点数值的列表,可选(默认值=[0.05, 0.95])
计算分位数预测值时的概率或概率列表。
- 有关数据格式的更多详细信息,请参阅 mtype 术语表。有关使用方法,请参阅预测教程
- self
- 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,则将在范围为 range(len(y.shape[0])) 的 fh 处计算残差。
- get_fitted_params(deep=True)[source]#
要求状态为“已拟合”。如果已设置 fh,则必须与 y 的索引(pandas 或整数)相对应。
- 访问自身属性
已拟合模型的属性,以“_”结尾。
self.cutoff
,self._is_fitted
- 将状态更改为“已拟合”。
无返回值。
- 参数:
- 将
fh
存储到self.fh
。 包含真实观测值的时间序列,用于计算残差。必须与 predict 的预期返回类型、维度和索引相同。
如果为 None,使用截至目前见到的 y (
self._y
),特别是如果之前只调用了一次 fit,则生成样本内残差
如果 fit 需要
fh
,则它必须指向 fit 中 y 的索引
- X
sktime
兼容格式的时间序列,可选(默认值=None) 用于更新和预测的外生时间序列。应与
fit
中的y
具有相同的科学类型(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须同时包含fh
和y.index
的索引引用。
- 将
- self
- y_res
sktime
兼容数据容器格式的时间序列 在
fh`,
处的预测残差,索引与``fh``
相同。y_res
的类型与最近传入的y
相同:Series
、Panel
、Hierarchical
科学类型,格式相同(见上文)
- y_res
- predict_var(fh=None, X=None, cov=False)[source]#
计算/返回方差预测结果。
访问自身属性
已拟合模型的属性,以“_”结尾。
self.cutoff
,self.is_fitted
- 将状态更改为“已拟合”。
如果
fh
已传入且之前未传入过,则将其存储到self.fh
。
- 参数:
- 有关数据格式的更多详细信息,请参阅 mtype 术语表。有关使用方法,请参阅预测教程
examples/01_forecasting.ipynb
预测时间范围,编码要预测的时间戳。如果已在
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
具有相同的科学类型(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
的索引引用。- cov布尔值,可选(默认值=False)
如果为 True,计算协方差矩阵预测值。如果为 False,计算边际方差预测值。
- 有关数据格式的更多详细信息,请参阅 mtype 术语表。有关使用方法,请参阅预测教程
- self
- pred_varpd.DataFrame,格式取决于
cov
变量 - 如果 cov=False
- 列名与在
fit
/update
中传入的y
的列名完全相同。 对于没有名称的格式,列索引将是 RangeIndex。
- 行索引是 fh,附加的级别等于实例级别,
来自 fit 中见到的 y,如果 fit 中见到的 y 是 Panel 或 Hierarchical 类型。
条目是方差预测值,对于列索引中的变量。给定变量和 fh 索引的方差预测值是一个预测的
在该变量和索引处的方差,给定观测数据。
- 列名与在
- 如果 cov=True
- 列索引是多级索引:第一级是变量名(如上所述)
第二级是 fh。
- 行索引是 fh,附加的级别等于实例级别,
来自 fit 中见到的 y,如果 fit 中见到的 y 是 Panel 或 Hierarchical 类型。
- 条目是(协)方差预测值,对于列索引中的变量,以及
行索引和列索引之间时间点的协方差。
注意:不返回不同变量之间的协方差预测值。
- 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
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” 则将在当前工作目录 (cwd) 下创建名为
estimator.zip
的 zip 文件。path=”/home/stored/estimator” 则将创建一个名为
estimator.zip
的 zip 文件,
存储在
/home/stored/
中。- serialization_format: str,默认值 = “pickle”
用于序列化的模块。可用选项为“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- self
- 如果
path
为 None - 内存中的序列化self
- 如果
path
为文件位置 - 指向文件的 ZipFile 对象
- 如果
- score(y, X=None, fh=None)[source]#
使用MAPE(非对称)对预测结果进行评分,与真实值对比。
- 参数:
- ypd.Series, pd.DataFrame, 或 np.ndarray(1D 或 2D)
用于评分的时间序列
- 有关数据格式的更多详细信息,请参阅 mtype 术语表。有关使用方法,请参阅预测教程
examples/01_forecasting.ipynb
fhint, list, 可强制转换为 pd.Index, 或
ForecastingHorizon
(非可选)- Xpd.DataFrame, 或 2D np.array,可选(默认值=None)
用于评分的外生时间序列。如果 self.get_tag(“X-y-must-have-same-index”) 为 True,则 X.index 必须包含 y.index
- self
- score浮点数
self.predict(fh, X)
相对于 y_test 的 MAPE 损失。
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- 配置在
clone
或reset
调用时保留。 配置名称 : 配置值 对的字典。有效的配置项、值及其含义列于下方
- display字符串,“diagram”(默认)或“text”
jupyter 内核如何显示
self
的实例“diagram” = HTML 盒状图表示
“text” = 字符串打印输出
- print_changed_only布尔值,默认值=True
打印
self
时,如果为 True 则只列出与默认值不同的自身参数,如果为 False 则列出所有参数名和值。不递归,即只影响self
自身,不影响组件估计器。- warnings字符串,“on”(默认)或“off”
是否触发警告,仅影响 sktime 发出的警告
“on” = 将触发 sktime 发出的警告
“off” = 将不会触发 sktime 发出的警告
- backend:parallel字符串,可选,默认值=”None”
进行广播/向量化时用于并行计算的后端,选项之一为
“None”:顺序执行循环,简单的列表推导式
“loky”、“multiprocessing”和“threading”:使用
joblib.Parallel
“joblib”:自定义和第三方
joblib
后端,例如spark
“dask”:使用
dask
,需要在环境中安装dask
包“ray”:使用
ray
,需要在环境中安装ray
包
- backend:parallel:params字典,可选,默认值={}(不传递参数)
作为配置传递给并行化后端的额外参数。有效键取决于
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”:字符串,默认值=”ray”;要使用的日志记录器名称。
“mute_warnings”:布尔值,默认值=False;如果为 True,抑制警告
- remember_data布尔值,默认值=True
在 fit 中是否存储并在 update 中更新
self._X
和self._y
。如果为 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>
。- 参数:
- **params字典
BaseObject 参数,键必须是
<component>__<parameter>
字符串。如果<parameter>
在 get_params 键中是唯一的,则可以使用<parameter>
作为完整字符串的别名。
- 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 以在多次函数调用中获得可复现的输出。
- 要求状态为“已拟合”。
是否在值为 skbase 对象的参数(即组件估计器)中设置随机状态。
如果为 False,则仅设置
self
的random_state
参数(如果存在)。如果为 True,也将设置组件对象中的
random_state
参数。
- self_policy字符串,选项之一为 {“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]#
将实例级别标签覆盖设置为给定值。
classmethod get_class_tag(tag_name, tag_value_default=None)[source]#
标签是特定于实例
self
的键值对,它们是对象构造后不会更改的静态标志。它们可用于元数据检查或控制对象的行为。set_tags
将动态标签覆盖值设置为tag_dict
中指定的值,其中键是标签名,字典值是要设置的标签值。方法
set_tags
只能在对象的__init__
方法中(构造期间)调用,或在通过__init__
构造后直接调用。estimator:class:BaseObject 或派生类的实例
- 参数:
- **tag_dict字典
标签名 : 标签值 对的字典。
- self
- 返回
对自身的引用。
- update(y, X=None, update_params=True)[source]#
更新截止值,并可选地更新拟合参数。
如果未实现特定于估计器的 update 方法,则默认回退行为如下:
update_params=True
:拟合所有已观测到的数据update_params=False
:仅更新截止点并记住数据
访问自身属性
已拟合模型的属性,以“_”结尾。
self.cutoff
,self.is_fitted
将状态更改为“已拟合”。
将
self.cutoff
更新为y
中最新的索引。如果
update_params=True
,更新已拟合模型中以“_”结尾的属性。
- 参数:
- 如果传递了
fh
,则将fh
存储到self.fh
。 用于更新预测器的时间序列。
用于拟合预测器的时间序列。
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)
- 编码预测时间戳的预测范围。如果
self.get_tag("requires-fh-in-fit")
为True
,则必须在fit
中传递,不可选。 用于更新模型拟合的外生时间序列。应与
fit
中的y
具有相同的 科学类型(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含y.index
。- update_params布尔值,可选(默认值=True)
是否应该更新模型参数。如果为
False
,则只更新截止点,模型参数(例如,系数)不更新。
- 如果传递了
- 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
:仅更新截止点并记住数据
访问自身属性
已拟合模型的属性,以“_”结尾。
self.cutoff
,self.is_fitted
- 修改
self
的状态(除非reset_forecaster=True
) 将
self.cutoff
更新为y
中最新的索引。如果
update_params=True
,更新已拟合模型中以“_”结尾的属性。
如果
reset_forecaster=True
,则不更新状态。- 参数:
- 如果传递了
fh
,则将fh
存储到self.fh
。 用于更新预测器的时间序列。
用于拟合预测器的时间序列。
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)
- cv继承自 BaseSplitter 的时间序列交叉验证生成器,可选
例如,
SlidingWindowSplitter
或ExpandingWindowSplitter
;默认值 = 使用initial_window=1
的 ExpandingWindowSplitter,默认行为是 y/X 中的单个数据点被逐一添加并预测,initial_window = 1
,step_length = 1
且fh = 1
- X
sktime
兼容格式的时间序列,可选(默认值=None) 用于更新和预测的外生时间序列。应与
fit
中的y
具有相同的科学类型(Series
、Panel
或Hierarchical
)。如果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 一样
- 如果传递了
- self
- y_pred汇总多个分割批次的点预测值的对象
格式取决于预测的总体(截止点,绝对预测范围)对
如果绝对预测范围点集合是唯一的:类型是
sktime
兼容数据容器格式的时间序列,输出中省略截止点;类型与最近传入的 y 相同:Series, Panel, Hierarchical 科学类型,格式相同(见上文)如果绝对预测范围点集合不是唯一的:类型是 pandas DataFrame,行索引和列索引都是时间戳;行索引对应于预测时的截止点;列索引对应于预测的绝对预测范围点;条目是根据行索引(截止点)预测的列索引(预测范围点)的点预测值;如果在该(截止点,预测范围)对下没有进行预测,则条目为 nan
- update_predict_single(y=None, fh=None, X=None, update_params=True)[source]#
使用新数据更新模型并进行预测。
此方法在一个步骤中进行更新和预测,非常有用。
如果未实现特定于估计器的 update 方法,则默认回退行为是先 update,然后 predict。
- get_fitted_params(deep=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,更新已拟合模型中以“_”结尾的属性。
- 参数:
- 如果传递了
fh
,则将fh
存储到self.fh
。 用于更新预测器的时间序列。
用于拟合预测器的时间序列。
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
预测时间范围,编码要预测的时间戳。如果已在
fit
中传入,则不应再次传入。如果尚未在 fit 中传入,则必须传入,非可选。- X
sktime
兼容格式的时间序列,可选(默认值=None) 用于更新和预测的外生时间序列。应与
fit
中的y
具有相同的科学类型(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
的索引引用。- update_params布尔值,可选(默认值=True)
是否应该更新模型参数。如果为
False
,则只更新截止点,模型参数(例如,系数)不更新。
- 如果传递了
- self
- 用于预测的外部时间序列。如果传递,将在 predict 中使用而不是 X。应与
fit
中的y
具有相同的 scitype (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为真,X.index
必须包含fh
索引引用。 y_predsktime 兼容数据容器格式的时间序列
- 用于预测的外部时间序列。如果传递,将在 predict 中使用而不是 X。应与