指数平滑#
- class ExponentialSmoothing(trend=None, damped_trend=False, seasonal=None, sp=None, initial_level=None, initial_trend=None, initial_seasonal=None, use_boxcox=None, initialization_method='estimated', smoothing_level=None, smoothing_trend=None, smoothing_seasonal=None, damping_trend=None, optimized=True, remove_bias=False, start_params=None, method=None, minimize_kwargs=None, use_brute=True, random_state=None)[source]#
Holt-Winters 指数平滑预测器。
直接接口,用于
statsmodels.tsa.holtwinters
。默认设置使用简单的指数平滑,不包含趋势和季节性成分。
- 参数:
- trend{“add”, “mul”, “additive”, “multiplicative”, None}, default=None
趋势成分类型。
- damped_trendbool, default=False
趋势成分是否应该被阻尼。
- seasonal{“add”, “mul”, “additive”, “multiplicative”, None}, default=None
季节性成分类型。可取值:
- spint or None, default=None
要考虑的季节周期数。
- initial_levelfloat or None, default=None
简单指数平滑的 alpha 值,如果设置了该值,则将使用此值。
- initial_trendfloat or None, default=None
Holt 趋势方法的 beta 值,如果设置了该值,则将使用此值。
- initial_seasonalfloat or None, default=None
Holt-Winters 季节性方法的 gamma 值,如果设置了该值,则将使用此值。
- use_boxcox{True, False, ‘log’, float}, default=None
是否应对数据首先应用 Box-Cox 转换?如果为 ‘log’ 则应用对数转换。如果为 float 则使用等于该 float 值的 lambda。
- initialization_method:{‘estimated’,’heuristic’,’legacy-heuristic’,’known’,None},
default=’estimated’ 用于初始化递推的方法。如果使用 ‘known’ 初始化,则必须传入
initial_level
,如果适用,还需要传入initial_trend
和initial_seasonal
。‘heuristic’ 使用基于数据的启发式方法估计初始水平、趋势和季节状态。‘estimated’ 使用与初始猜测相同的启发式方法,但随后将初始状态作为拟合过程的一部分进行估计。- smoothing_levelfloat, optional
简单指数平滑的 alpha 值,如果设置了该值,则将使用此值。
- 浮点数,可选
Holt 趋势方法的 beta 值,如果设置了该值,则将使用此值。
- smoothing_seasonalfloat, optional
Holt-Winters 季节性方法的 gamma 值,如果设置了该值,则将使用此值。
- damping_trendfloat, optional
阻尼方法的 phi 值,如果设置了该值,则将使用此值。
- optimizedbool, optional
通过最大化对数似然来估计模型参数。
- remove_biasbool, optional
通过强制平均残差等于零来消除预测值和拟合值中的偏差。
- start_paramsarray_like, optional
优化拟合时使用的起始值。如果未提供,则通过网格搜索和基于数据初始值的合理值组合确定起始值。有关模型参数的结构,请参见备注。
- methodstr, default “SLSQP”
使用的最小化器。有效选项包括 “L-BFGS-B” 、 “TNC”、“SLSQP”(默认)、“Powell”、“trust-constr”、“basinhopping”(也称“bh”)和“least_squares”(也称“ls”)。basinhopping 尝试多个起始值,以在非凸问题中找到全局最小值,因此比其他方法慢。
- minimize_kwargsdict[str, Any]
一个字典,包含传递给 SciPy 的 minimize 函数(如果方法是 “L-BFGS-B”、“TNC”、“SLSQP”、“Powell” 或“trust-constr” 中的一个)或 SciPy 的 basinhopping 或 least_squares 函数的关键字参数。有效关键字取决于优化器。请查阅 SciPy 文档以获取完整的选项列表。
- use_brutebool, optional
使用暴力(网格)优化器搜索良好的起始值。如果为 False,则使用一组朴素的起始值。
- random_stateint, RandomState instance or None, optional ,
default=None - 如果为 int,则 random_state 是随机数生成器使用的种子;如果为 RandomState 实例,则 random_state 是随机数生成器;如果为 None,则随机数生成器是 np.random 使用的 RandomState 实例。
- 属性:
参考文献
- [1] Hyndman, Rob J., and George Athanasopoulos. Forecasting: principles
and practice. OTexts, 2014.
示例
>>> from sktime.datasets import load_airline >>> from sktime.forecasting.exp_smoothing import ExponentialSmoothing >>> y = load_airline() >>> forecaster = ExponentialSmoothing( ... trend='add', seasonal='multiplicative', sp=12 ... ) >>> forecaster.fit(y) ExponentialSmoothing(...) >>> 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])从类中获取类标签值,具有父类标签级别的继承。
从类中获取类标签,具有父类标签级别的继承。
获取 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])返回评估器的测试参数设置。
检查对象是否由其他 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])将序列化的 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"
集。当前预测器没有保留值。
- Returns:
- params :dict or list of dict , default = {}
要创建类的测试实例的参数。每个字典都是构造一个“有趣”测试实例的参数,例如
MyClass(**params)
或MyClass(**params[i])
创建一个有效的测试实例。create_test_instance
使用 `params 中的第一个(或唯一一个)字典
- check_is_fitted(method_name=None)[source]#
检查评估器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。is_fitted
属性应在调用对象的fit
方法时设置为True
。如果不是,则引发
NotFittedError
。- 参数:
- method_namestr, optional
调用此函数的方法名称。如果提供,错误消息将包含此信息。
- 引发:
- 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 or list of str, default = None
字符串或字符串列表,默认 = None 要克隆的标签名称。默认值 (
None
) 克隆estimator
中的所有标签。
- Returns:
- self
self
的引用。
- classmethod create_test_instance(parameter_set='default')[source]#
使用第一个测试参数集构造类的实例。
- 参数:
- parameter_setstr, default=”default”
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,将返回 “default” 集。
- Returns:
- instanceinstance of the class with default parameters
- 具有默认参数的类实例
创建所有测试实例的列表及其名称列表。
-
字符串列表,与 objs 长度相同。第 i 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个,命名约定为
{cls.__name__}-{i}
,否则为{cls.__name__}
。 截至点 = 预测器的“当前时间”状态。
- pandas 兼容的索引元素,或 None;如果已设置截止点,则为 pandas 兼容的索引元素;否则为 None
已传递的预测范围。
- property fh[source]#
将预测器拟合到训练数据。
将状态变更为“已拟合”。
写入 self
设置以“_”结尾的已拟合模型属性,已拟合属性可通过
get_fitted_params
进行检查。将
self.is_fitted
标志设置为True
。将
self.cutoff
设置为在y
中看到的最后一个索引。
- 参数:
- 如果传递了
fh
,则将其存储到self.fh
。 ysktime 兼容数据容器格式的时间序列。
用于拟合预测器的时间序列。
Series
scitype = 单个时间序列,普通预测。pd.DataFrame
、pd.Series
或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合,全局/面板预测。具有 2 级行MultiIndex
(instance, time
) 的pd.DataFrame
,3Dnp.ndarray
(instance, variable, time
),Series 类型的pd.DataFrame
的list
。
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- 整数、列表、可强制转换为 pd.Index 或
ForecastingHorizon
,默认=None 编码要预测的时间戳的预测范围。如果self.get_tag("requires-fh-in-fit")
为True
,则必须在fit
中传递,而不是可选的。 Xtime series in
sktime
compatible format, optional (default=None).
- 如果传递了
- Returns:
- sktime 兼容格式的时间序列,可选(默认=None)。用于拟合模型的外部时间序列。应与
y
具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含y.index
。
- sktime 兼容格式的时间序列,可选(默认=None)。用于拟合模型的外部时间序列。应与
- selfReference to self.
拟合并预测未来范围的时间序列。
self 的引用。
将状态变更为“已拟合”。
- 参数:
- 与
fit(y, X, fh).predict(X_pred)
相同。如果未传递X_pred
,则与fit(y, fh, X).predict(X)
相同。 ysktime 兼容数据容器格式的时间序列。
用于拟合预测器的时间序列。
Series
scitype = 单个时间序列,普通预测。pd.DataFrame
、pd.Series
或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合,全局/面板预测。具有 2 级行MultiIndex
(instance, time
) 的pd.DataFrame
,3Dnp.ndarray
(instance, variable, time
),Series 类型的pd.DataFrame
的list
。
Hierarchical
scitype = 分层集合,用于分层预测。具有 3 级或更多行MultiIndex
(hierarchy_1, ..., hierarchy_n, time
) 的pd.DataFrame
。- 将
fh
存储到self.fh
。 ysktime 兼容数据容器格式的时间序列
fhint, list, pd.Index coercible, or
ForecastingHorizon
(not optional)- 整数、列表、可强制转换为 pd.Index 或
ForecastingHorizon
,默认=None 编码要预测的时间戳的预测范围。如果self.get_tag("requires-fh-in-fit")
为True
,则必须在fit
中传递,而不是可选的。 Xtime series in
sktime
compatible format, optional (default=None).- 整数、列表、可强制转换为 pd.Index 或
ForecastingHorizon
(非可选)编码要预测的时间戳的预测范围。 如果 fh 不是 None 且类型不是 ForecastingHorizon,则通过调用 _check_fh 强制转换为 ForecastingHorizon。特别是,如果 fh 类型为 pd.Index,则通过 ForecastingHorizon(fh, is_relative=False) 强制转换。
- 与
- Returns:
- X_predtime series in sktime compatible format, optional (default=None)
sktime 兼容格式的时间序列,可选(默认=None)。用于预测的外部时间序列。如果传递,将在 predict 中使用它而不是 X。应与
fit
中y
具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引引用。
- y_predtime series in sktime compatible data container format
从类中获取类标签值,具有父类标签级别的继承。
sktime 兼容数据容器格式的时间序列。在
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
- 要检索可能包含实例覆盖的标签值,请改用
- Returns:
- 任意类型 如果未找到标签,则为默认/回退值。
tag_value
-
self
中tag_name
标签的值。如果未找到,返回tag_value_default
。 从类中获取类标签,具有父类标签级别的继承。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是构造对象后不更改的静态标志。如果评估器尚未拟合。
classmethod get_class_tags()[source]#
get_class_tags
方法是一个类方法,仅考虑类级别的标签值和覆盖来检索标签的值。get_class_tag
方法是一个类方法,仅考虑类级别的标签值和覆盖来检索标签的值。它从对象中返回名称为
tag_name
的标签的值,考虑标签覆盖,优先级从高到低如下:
设置在类
_tags
属性中的标签。它返回一个字典,其键是类或其任何父类中设置的
_tags
任何属性的键。值是对应的标签值,覆盖的优先级从高到低如下:
设置在父类
_tags
属性中的标签,按继承顺序。实例可以根据超参数覆盖这些标签。
- 要检索可能包含实例覆盖的标签,请改用
get_tags
方法。 要包含动态标签的覆盖,请使用
get_tags
。
- collected_tagsdict
获取 self 的配置标志。
字典 标签名称:标签值 对。通过嵌套继承从
_tags
类属性收集。不受通过set_tags
或clone_tags
设置的动态标签覆盖。配置是
self
的键值对,通常用作控制行为的瞬时标志。get_config
返回动态配置,这些配置会覆盖默认配置。- Returns:
- 默认配置在类或其父类的
_config
类属性中设置,并被通过set_config
设置的动态配置覆盖。 配置在
clone
或reset
调用下保留。
- 默认配置在类或其父类的
- config_dictdict
获取拟合参数。
- 字典 配置名称:配置值 对。通过嵌套继承从 _config 类属性收集,然后来自 _onfig_dynamic 对象属性的任何覆盖和新标签。
- 参数:
- 所需状态
要求状态为“已拟合”。
deepbool, default=True
布尔值,默认=True 是否返回组件的拟合参数。
- Returns:
- 如果为 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]
等。
- default_dict: dict[str, Any]
键是
cls
在__init__
中定义了默认值的所有参数。值是在__init__
中定义的默认值。
- param_names: list[str]
获取此对象的参数值字典。
- 参数:
- Returns:
- 如果为
True
,将返回此对象的参数名称:值dict
,包括组件(=BaseObject
值的参数)的参数。 如果为
False
,将返回此对象的参数名称:值dict
,但不包括组件的参数。paramsdict with str-valued keys
键为字符串的字典 拟合参数字典,paramname : paramvalue 键值对包括
始终:此对象的所有拟合参数,如通过
get_param_names
获取的那样,值是该键在此对象中的拟合参数值
- 如果为
- 键为字符串的字典 参数字典,paramname : paramvalue 键值对包括
从实例获取标签值,具有标签级别的继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是构造对象后不更改的静态标志。始终:此对象的所有参数,如通过
get_param_names
获取的那样,值是该键在此对象中的参数值,值始终与构造时传递的值相同。get_tag
方法从实例中检索名称为tag_name
的单个标签的值,考虑标签覆盖,优先级从高到低如下:get_class_tag
方法是一个类方法,仅考虑类级别的标签值和覆盖来检索标签的值。它从对象中返回名称为
tag_name
的标签的值,考虑标签覆盖,优先级从高到低如下:
设置在类
_tags
属性中的标签。- 参数:
- 要检索可能包含实例覆盖的标签值,请改用
get_tag
方法。 在实例上通过
set_tags
或clone_tags
设置的标签,在实例构造时设置。- 要检索的标签名称
tag_value_defaultany type, optional; default=None
- 任意类型,可选;默认=None 如果未找到标签,则为默认/回退值
raise_errorbool
- 要检索可能包含实例覆盖的标签值,请改用
- Returns:
- 布尔值 当未找到标签时是否引发
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
兼容对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是构造对象后不更改的静态标志。get_class_tags
方法是一个类方法,仅考虑类级别的标签值和覆盖来检索标签的值。get_tag
方法从实例中检索名称为tag_name
的单个标签的值,考虑标签覆盖,优先级从高到低如下:get_class_tag
方法是一个类方法,仅考虑类级别的标签值和覆盖来检索标签的值。它从对象中返回名称为
tag_name
的标签的值,考虑标签覆盖,优先级从高到低如下:
设置在类
_tags
属性中的标签。- Returns:
get_tags
方法返回一个标签字典,其键是类或其任何父类中设置的_tags
任何属性的键,或者通过set_tags
或clone_tags
设置的标签的键。collected_tagsdict
-
字典 标签名称:标签值 对。通过嵌套继承从
_tags
类属性收集,然后来自_tags_dynamic
对象属性的任何覆盖和新标签。 检查对象是否由其他 BaseObjects 组成。
- Returns:
- 复合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
composite: bool
-
布尔值 对象是否包含任何其值为
BaseObject
后代实例的参数。 是否已调用
fit
。- Returns:
- 检查对象的
_is_fitted` 属性,该属性应在对象构造期间初始化为 ``False
,并在调用对象的 fit 方法时设置为 True。 bool
- 检查对象的
- 布尔值 评估器是否已 fit。
从文件位置加载对象。
- ZipFile(path).open(“object) 的结果
从序列化内存容器加载对象。
- 参数:
- deserialized self resulting in output at
path
, ofcls.save(path)
- deserialized self resulting in output at
- Returns:
- 反序列化的 self,其结果位于
path
,来自cls.save(path)
的输出
- 反序列化的 self,其结果位于
- classmethod load_from_serial(serial)[source]#
预测未来范围的时间序列。
- 字典 配置名称:配置值 对。通过嵌套继承从 _config 类属性收集,然后来自 _onfig_dynamic 对象属性的任何覆盖和新标签。
serial1st element of output of
cls.save(None)
cls.save(None)
输出的第一个元素deserialized self resulting in output
serial
, ofcls.save(None)
self.cutoff
,self.is_fitted
- 参数:
- 有关数据格式的更多详细信息,请参见 mtype 的词汇表。有关用法,请参见预测教程
examples/01_forecasting.ipynb
。 预测范围,编码了要预测的时间戳。如果已经在
fit
中传递过,则不应再次传递。如果尚未在 fit 中传递,则必须传递,不可选。fhint, list, pd.Index coercible, or
ForecastingHorizon
(not optional)- X与
sktime
兼容格式的时间序列,可选 (默认=None) 用于预测的外生时间序列。应与
fit
中的y
具有相同的科学类型(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为真,则X.index
必须包含fh
的索引引用。
- 有关数据格式的更多详细信息,请参见 mtype 的词汇表。有关用法,请参见预测教程
- Returns:
- X_predtime series in sktime compatible format, optional (default=None)
sktime 兼容格式的时间序列,可选(默认=None)。用于预测的外部时间序列。如果传递,将在 predict 中使用它而不是 X。应与
fit
中y
具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引引用。
- predict_interval(fh=None, X=None, coverage=0.9)[source]#
计算/返回预测区间预测。
如果
coverage
是可迭代的,将计算多个区间。- 字典 配置名称:配置值 对。通过嵌套继承从 _config 类属性收集,然后来自 _onfig_dynamic 对象属性的任何覆盖和新标签。
serial1st element of output of
cls.save(None)
cls.save(None)
输出的第一个元素deserialized self resulting in output
serial
, ofcls.save(None)
self.cutoff
,self.is_fitted
- 参数:
- 有关数据格式的更多详细信息,请参见 mtype 的词汇表。有关用法,请参见预测教程
examples/01_forecasting.ipynb
。 预测范围,编码了要预测的时间戳。如果已经在
fit
中传递过,则不应再次传递。如果尚未在 fit 中传递,则必须传递,不可选。如果
fh
不是 None 且不是ForecastingHorizon
类型,则在内部会被强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或 array-like 的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")
为真,则X.index
必须包含fh
的索引引用。- coveragefloat 或包含唯一值的 float 列表,可选 (默认=0.90)
预测区间的名义覆盖率
- 有关数据格式的更多详细信息,请参见 mtype 的词汇表。有关用法,请参见预测教程
- Returns:
- pred_intpd.DataFrame
- 列具有多级索引:第一级是 fit 中 y 的变量名,
- 第二级是计算区间的覆盖率分数。
顺序与输入的
coverage
一致。
第三级是字符串“lower”或“upper”,表示区间的下限/上限。
- 行索引是 fh,如果 fit 中看到的 y 是 Panel 或 Hierarchical,则具有额外的(上层)索引级别,与实例级别相同。
来自 fit 中看到的 y。
- 条目是下限/上限区间的预测值,
对应于列索引中的变量、第二级列索引中的名义覆盖率、第三级列索引中的 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
。
- 字典 配置名称:配置值 对。通过嵌套继承从 _config 类属性收集,然后来自 _onfig_dynamic 对象属性的任何覆盖和新标签。
serial1st element of output of
cls.save(None)
cls.save(None)
输出的第一个元素deserialized self resulting in output
serial
, ofcls.save(None)
self.cutoff
,self.is_fitted
- 参数:
- 有关数据格式的更多详细信息,请参见 mtype 的词汇表。有关用法,请参见预测教程
examples/01_forecasting.ipynb
。 预测范围,编码了要预测的时间戳。如果已经在
fit
中传递过,则不应再次传递。如果尚未在 fit 中传递,则必须传递,不可选。如果
fh
不是 None 且不是ForecastingHorizon
类型,则在内部会被强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或 array-like 的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")
为真,则X.index
必须包含fh
的索引引用。- marginalbool, 可选 (默认=True)
返回的分布是否按时间索引是边际分布
- 有关数据格式的更多详细信息,请参见 mtype 的词汇表。有关用法,请参见预测教程
- Returns:
- pred_distskpro BaseDistribution
预测分布。如果 marginal=True,则为按时间点的边际分布;如果 marginal=False 且方法已实现,则为联合分布。
- predict_quantiles(fh=None, X=None, alpha=None)[source]#
计算/返回分位数预测。
如果
alpha
是可迭代的,将计算多个分位数。- 字典 配置名称:配置值 对。通过嵌套继承从 _config 类属性收集,然后来自 _onfig_dynamic 对象属性的任何覆盖和新标签。
serial1st element of output of
cls.save(None)
cls.save(None)
输出的第一个元素deserialized self resulting in output
serial
, ofcls.save(None)
self.cutoff
,self.is_fitted
- 参数:
- 有关数据格式的更多详细信息,请参见 mtype 的词汇表。有关用法,请参见预测教程
examples/01_forecasting.ipynb
。 预测范围,编码了要预测的时间戳。如果已经在
fit
中传递过,则不应再次传递。如果尚未在 fit 中传递,则必须传递,不可选。如果
fh
不是 None 且不是ForecastingHorizon
类型,则在内部会被强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或 array-like 的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")
为真,则X.index
必须包含fh
的索引引用。- alphafloat 或包含唯一值的 float 列表,可选 (默认=[0.05, 0.95])
计算分位数预测值的概率或概率列表。
- 有关数据格式的更多详细信息,请参见 mtype 的词汇表。有关用法,请参见预测教程
- Returns:
- 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,则残差将计算在 range(len(y.shape[0])) 的 fh 处。
- 字典 配置名称:配置值 对。通过嵌套继承从 _config 类属性收集,然后来自 _onfig_dynamic 对象属性的任何覆盖和新标签。
要求状态为“已拟合”。如果已设置 fh,则必须与 y 的索引(pandas 或整数)对应。
cls.save(None)
输出的第一个元素拟合模型属性以“_”结尾。self.cutoff, self._is_fitted
- 将状态变更为“已拟合”。
无。
- 参数:
- 与
fit(y, X, fh).predict(X_pred)
相同。如果未传递X_pred
,则与fit(y, fh, X).predict(X)
相同。 带有真实观测值的时间序列,用于计算残差。必须具有与 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")
为真,则X.index
必须同时包含fh
索引引用和y.index
。
- 与
- Returns:
- y_res与
sktime
兼容数据容器格式的时间序列 在
fh
处的预测残差,具有与fh
相同的索引。y_res
的类型与最近传递的y
相同:Series
,Panel
,Hierarchical
科学类型,格式相同(见上文)。
- y_res与
- predict_var(fh=None, X=None, cov=False)[source]#
计算/返回方差预测。
- 字典 配置名称:配置值 对。通过嵌套继承从 _config 类属性收集,然后来自 _onfig_dynamic 对象属性的任何覆盖和新标签。
serial1st element of output of
cls.save(None)
cls.save(None)
输出的第一个元素deserialized self resulting in output
serial
, ofcls.save(None)
self.cutoff
,self.is_fitted
- 参数:
- 有关数据格式的更多详细信息,请参见 mtype 的词汇表。有关用法,请参见预测教程
examples/01_forecasting.ipynb
。 预测范围,编码了要预测的时间戳。如果已经在
fit
中传递过,则不应再次传递。如果尚未在 fit 中传递,则必须传递,不可选。如果
fh
不是 None 且不是ForecastingHorizon
类型,则在内部会被强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或 array-like 的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")
为真,则X.index
必须包含fh
的索引引用。- covbool, 可选 (默认=False)
如果为 True,计算协方差矩阵预测值。如果为 False,计算边际方差预测值。
- 有关数据格式的更多详细信息,请参见 mtype 的词汇表。有关用法,请参见预测教程
- Returns:
- pred_varpd.DataFrame,格式取决于
cov
变量 - 如果 cov=False
- 列名与
fit
/update
中传递的y
的列名完全一致。 对于无名格式,列索引将是 RangeIndex。
- 行索引是 fh,具有与实例级别相同的额外级别,
来自 fit 中看到的 y。
条目是方差预测值,对应于列索引中的变量。给定变量和 fh 索引的方差预测值是该变量和索引在观测数据下的预测方差。
来自 fit 中看到的 y。
- 列名与
- 如果 cov=True
- 列索引是多级索引:第一级是变量名(如上)
第二级是 fh。
- 行索引是 fh,具有与实例级别相同的额外级别,
来自 fit 中看到的 y。
- 条目是(协)方差预测值,对应于列索引中的变量,以及
行索引和列索引中时间索引之间的协方差。
注意:不同变量之间不返回协方差预测值。
- pred_varpd.DataFrame,格式取决于
- reset()[source]#
将对象重置为初始化后的干净状态。
将
self
设置为构造函数调用后直接的状态,保留相同的超参数。通过set_config
设置的配置值也保留。reset
调用会删除所有对象属性,除了超参数 =
__init__
的参数并写入self
,例如self.paramname
,其中paramname
是__init__
的参数。包含双下划线的对象属性,即字符串“__”。例如,名为“__myattr”的属性会被保留。
配置属性,配置保持不变。也就是说,
reset
前后get_config
的结果是相同的。
类和对象方法,以及类属性也不受影响。
等同于
clone
,区别在于reset
修改self
而不是返回新对象。在
self.reset()
调用后,self
的值和状态与构造函数调用 ``type(self)(**self.get_params(deep=False))`` 后获得的对象相同。- Returns:
- self
类实例被重置为干净的初始化后状态,但保留当前的超参数值。
- save(path=None, serialization_format='pickle')[source]#
将序列化的 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, 默认 = “pickle”
用于序列化的模块。可用选项有“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- Returns:
- 如果
path
为 None - 内存中序列化的 self - 如果
path
是文件位置 - 指向文件的 ZipFile
- 如果
- score(y, X=None, fh=None)[source]#
使用 MAPE(非对称)评估预测与真实值的差距。
- 参数:
- ypd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D)
用于评分的时间序列
- 有关数据格式的更多详细信息,请参见 mtype 的词汇表。有关用法,请参见预测教程
examples/01_forecasting.ipynb
。 ysktime 兼容数据容器格式的时间序列
- Xpd.DataFrame 或 2D np.array,可选 (默认=None)
用于评分的外生时间序列。如果 self.get_tag(“X-y-must-have-same-index”) 为真,则 X.index 必须包含 y.index。
- Returns:
- scorefloat
self.predict(fh, X) 相对于 y_test 的 MAPE 损失。
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- 默认配置在类或其父类的
_config
类属性中设置,并被通过set_config
设置的动态配置覆盖。 配置名 : 配置值 对的字典。有效的配置、值及其含义如下所示。
- displaystr, “diagram” (默认), 或 “text”
jupyter 内核如何显示 self 的实例
“diagram” = html 方框图表示
“text” = 字符串打印输出
- print_changed_onlybool, 默认=True
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 将默认为“不执行任何操作”,而不是“重新拟合所有已见数据”。
- 默认配置在类或其父类的
- Returns:
- selfself 的引用。
注意
改变对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
此方法适用于简单的 skbase 对象和复合对象。参数键字符串
<component>__<parameter>
可用于复合对象(即包含其他对象的对象),以访问组件<component>
中的<parameter>
。如果引用清晰(例如,没有两个组件参数具有相同的名称<parameter>
),也可以使用字符串<parameter>
,不带<component>__
。- 参数:
- **paramsdict
BaseObject 参数,键必须是
<component>__<parameter>
字符串。如果唯一,__
后缀可以作为完整字符串的别名,唯一性在 get_params 键中。
- Returns:
- selfself 的引用(参数已设置后)
- set_random_state(random_state=None, deep=True, self_policy='copy')[source]#
为 self 设置 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_policystr, {“copy”, “keep”, “new”} 之一, 默认=”copy”
“copy” :
self.random_state
被设置为输入random_state
“keep” :
self.random_state
保持不变“new” :
self.random_state
被设置为一个新的随机状态,
从输入
random_state
派生,通常与之不同。
- Returns:
- selfself 的引用
- set_tags(**tag_dict)[source]#
将实例级别标签覆盖设置为给定值。
sktime 兼容数据容器格式的时间序列。在
fh
处的点预测,与fh
具有相同的索引。y_pred
与最近传递的y
具有相同类型:Series
、Panel
、Hierarchical
scitype,相同格式(见上文)。标签是特定于实例
self
的键值对,它们是构建对象后不会更改的静态标志。它们可用于元数据检查,或用于控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名,字典值是要设置的标签值。set_tags
方法应仅在对象的__init__
方法中,在构建过程中调用,或在__init__
后直接调用。当前标签值可以通过
get_tags
或get_tag
进行检查。- 参数:
- **tag_dictdict
标签名 : 标签值 对的字典。
- Returns:
- Self
self 的引用。
- update(y, X=None, update_params=True)[source]#
更新截止值,可选地更新拟合参数。
如果未实现估计器特定的 update 方法,默认的回退行为如下:
update_params=True
:拟合迄今为止所有观测到的数据update_params=False
:仅更新 cutoff 并记住数据
- 字典 配置名称:配置值 对。通过嵌套继承从 _config 类属性收集,然后来自 _onfig_dynamic 对象属性的任何覆盖和新标签。
serial1st element of output of
cls.save(None)
cls.save(None)
输出的第一个元素deserialized self resulting in output
serial
, ofcls.save(None)
self.cutoff
,self.is_fitted
将状态变更为“已拟合”。
将
self.cutoff
更新为y
中看到的最新索引。如果
update_params=True
,则更新以“_”结尾的拟合模型属性。
- 参数:
- 如果传递了
fh
,则将其存储到self.fh
。 用于更新预测器的时间序列。
用于拟合预测器的时间序列。
Series
scitype = 单个时间序列,普通预测。pd.DataFrame
、pd.Series
或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合,全局/面板预测。具有 2 级行MultiIndex
(instance, time
) 的pd.DataFrame
,3Dnp.ndarray
(instance, variable, time
),Series 类型的pd.DataFrame
的list
。
Hierarchical
scitype = 分层集合,用于分层预测。具有 3 级或更多行MultiIndex
(hierarchy_1, ..., hierarchy_n, time
) 的pd.DataFrame
。- 整数、列表、可强制转换为 pd.Index 或
ForecastingHorizon
,默认=None 编码要预测的时间戳的预测范围。如果self.get_tag("requires-fh-in-fit")
为True
,则必须在fit
中传递,而不是可选的。 用于更新模型拟合的外生时间序列。应与
y
具有相同的 科学类型(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为真,则X.index
必须包含y.index
。- update_paramsbool, 可选 (默认=True)
是否应更新模型参数。如果为
False
,则仅更新 cutoff,模型参数(例如系数)不更新。
- 如果传递了
- Returns:
- selfself 的引用
- 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 并记住数据
- 字典 配置名称:配置值 对。通过嵌套继承从 _config 类属性收集,然后来自 _onfig_dynamic 对象属性的任何覆盖和新标签。
serial1st element of output of
cls.save(None)
cls.save(None)
输出的第一个元素deserialized self resulting in output
serial
, ofcls.save(None)
self.cutoff
,self.is_fitted
- 写入 self(除非
reset_forecaster=True
) 将
self.cutoff
更新为y
中看到的最新索引。如果
update_params=True
,则更新以“_”结尾的拟合模型属性。
如果
reset_forecaster=True
,则不更新状态。- 参数:
- 如果传递了
fh
,则将其存储到self.fh
。 用于更新预测器的时间序列。
用于拟合预测器的时间序列。
Series
scitype = 单个时间序列,普通预测。pd.DataFrame
、pd.Series
或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合,全局/面板预测。具有 2 级行MultiIndex
(instance, time
) 的pd.DataFrame
,3Dnp.ndarray
(instance, variable, time
),Series 类型的pd.DataFrame
的list
。
Hierarchical
scitype = 分层集合,用于分层预测。具有 3 级或更多行MultiIndex
(hierarchy_1, ..., hierarchy_n, time
) 的pd.DataFrame
。- cv继承自 BaseSplitter 的时间交叉验证生成器,可选
例如,
SlidingWindowSplitter
或ExpandingWindowSplitter
;默认 = ExpandingWindowSplitter,initial_window=1
且默认 = 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")
为真,则X.index
必须包含fh
索引引用。- update_paramsbool, 可选 (默认=True)
是否应更新模型参数。如果为
False
,则仅更新 cutoff,模型参数(例如系数)不更新。- reset_forecasterbool, 可选 (默认=True)
如果为 True,则不改变预测器的状态,即 update/predict 序列在副本上运行,self 的 cutoff、模型参数、数据内存不改变。
如果为 False,则在运行 update/predict 序列时更新 self,就像直接调用 update/predict 一样。
- 如果传递了
- Returns:
- y_pred对象,用于制表来自多个分割批次的点预测
格式取决于预测的(cutoff,绝对预测范围)对的集合。
如果绝对预测范围点的集合是唯一的:类型是与 sktime 兼容数据容器格式的时间序列,输出中隐藏 cutoff,其类型与最近传递的 y 相同:Series、Panel、Hierarchical 科学类型,格式相同(见上文)。
如果绝对预测范围点的集合不唯一:类型是 pandas DataFrame,行索引和列索引都是时间戳,行索引对应于进行预测的 cutoffs,列索引对应于进行预测的绝对预测范围,条目是行索引预测的列索引的点预测。如果在该(cutoff,预测范围)对处没有预测,则条目为 nan。
- 来自 fit 中看到的 y。
使用新数据更新模型并进行预测。
update_predict_single(y=None, fh=None, X=None, update_params=True)[source]#
此方法对于在一个步骤中进行更新和预测非常有用。
- 字典 配置名称:配置值 对。通过嵌套继承从 _config 类属性收集,然后来自 _onfig_dynamic 对象属性的任何覆盖和新标签。
cls.save(None)
输出的第一个元素如果未实现估计器特定的 update 方法,默认的回退行为是先 update,然后 predict。
- 将状态变更为“已拟合”。
拟合模型属性以“_”结尾。指向已见数据的指针,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
,则将其存储到self.fh
。 用于更新预测器的时间序列。
用于拟合预测器的时间序列。
Series
scitype = 单个时间序列,普通预测。pd.DataFrame
、pd.Series
或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合,全局/面板预测。具有 2 级行MultiIndex
(instance, time
) 的pd.DataFrame
,3Dnp.ndarray
(instance, variable, time
),Series 类型的pd.DataFrame
的list
。
Hierarchical
scitype = 分层集合,用于分层预测。具有 3 级或更多行MultiIndex
(hierarchy_1, ..., hierarchy_n, time
) 的pd.DataFrame
。- 有关数据格式的更多详细信息,请参见 mtype 的词汇表。有关用法,请参见预测教程
examples/01_forecasting.ipynb
。 预测范围,编码了要预测的时间戳。如果已经在
fit
中传递过,则不应再次传递。如果尚未在 fit 中传递,则必须传递,不可选。- X与 sktime 兼容格式的时间序列,可选 (默认=None)
用于更新和预测的外生时间序列。应与
fit
中的y
具有相同的科学类型(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为真,则X.index
必须包含fh
索引引用。- update_paramsbool, 可选 (默认=True)
是否应更新模型参数。如果为
False
,则仅更新 cutoff,模型参数(例如系数)不更新。
- 如果传递了
- Returns:
- X_predtime series in sktime compatible format, optional (default=None)
sktime 兼容格式的时间序列,可选(默认=None)。用于预测的外部时间序列。如果传递,将在 predict 中使用它而不是 X。应与
fit
中y
具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引引用。