DirectReductionForecaster#
- class DirectReductionForecaster(estimator, window_length=10, transformers=None, X_treatment='concurrent', impute_method='bfill', pooling='local', windows_identical=False)[source]#
直接降维预测器,包括单输出、多输出、外生变量Direct。
实现直接降维,将预测任务转换为表格回归任务。
当没有
X
时,如果X_treatment = "concurrent"
,默认为 DirMO(直接多输出);如果X_treatment = "shifted"
,则默认为简单直接(直接单输出)。可以通过传入兼容
scikit-learn
的单输出转换器来配置具有并发X
行为的直接单输出模式。算法详情
- 在
fit
中,给定内生时间序列y
以及可能存在的外生变量X
将
estimator
拟合到如下定义的特征-标签对。- 如果 X_treatment = “concurrent”
特征 =
y(t)
,y(t-1)
, …,y(t-window_size)
;如果提供X
,则包含X(t+h)
。 标签 =y(t+h)
,对于预测范围h
中的每个h
,遍历所有已观察到上述特征(即存在于索引中)的t
(每个h
分别拟合一个评估器)- 如果 X_treatment = “shifted”
特征 =
y(t)
,y(t-1)
, …,y(t-window_size)
;如果提供X
,则包含X(t)
。 标签 =y(t+h_1)
, …,y(t+h_k)
,对于预测范围h_j
中的所有h_j
,遍历所有已观察到上述特征(即存在于索引中)的t
。 评估器被拟合为一个多输出评估器(同时预测所有h_j
)
在
predict
中,给定可能存在的外生变量X
,在截断时间c
,如果 X_treatment = “concurrent”将拟合好的评估器的预测应用于特征 =
y(c)
,y(c-1)
, …,y(c-window_size)
,如果提供X
,则包含X(c+h)
,以获取预测范围h
中每个h
对应的y(c+h)
预测值- 如果 X_treatment = “shifted”
将拟合好的评估器的预测应用于特征 =
y(c)
,y(c-1)
, …,y(c-window_size)
,如果提供X
,则包含X(c)
,以获取预测范围h_j
中y(c+h_1)
, …,y(c+h_k)
的预测值
- 参数:
- estimatorsklearn 回归器,必须兼容 sklearn 接口
降维算法中使用的表格回归算法
- window_lengthint,可选,默认为 10
降维算法中使用的窗口长度
- transformers当前未使用
- X_treatmentstr,可选,可以是 “concurrent”(默认)或 “shifted” 之一
确定用于预测 y(t+h) 的 X 的时间戳,对于范围 h “concurrent”: y(t+h) 根据滞后的 y 和 X(t+h) 预测,适用于 fh 中的所有 h
特别地,如果未指定 y 的滞后项,y(t+h) 将根据 X(t) 预测
- “shifted”: y(t+h) 根据滞后的 y 和 X(t) 预测,适用于 fh 中的所有 h
特别地,如果未指定 y 的滞后项,y(t+h) 将根据 X(t+h) 预测
- impute_methodstr, None,或 sktime 转换器,可选
用于填充滞后数据中缺失值的方法
默认=”bfill”
如果为 str,允许的字符串是
Imputer.method
参数的值,详见此处。要传递更多参数,可以直接传入Imputer
转换器,如下所述。如果为 sktime 转换器,此转换器将应用于滞后数据。这需要是一个能够移除缺失数据的转换器,并且可以是
Imputer
。如果为 None,则在应用
Lag
转换器时不进行填充
- poolingstr,可以是 [“local”, “global”, “panel”] 之一,可选,默认为 “local”
用于池化数据以拟合监督回归模型的级别。“local” = 单元/实例级别,每个最低层级一个降维模型。“global” = 顶层,忽略层级,在池化数据上总体一个降维模型。“panel” = 倒数第二层级,每个面板级别 (-2) 一个降维模型;如果只有 2 层或更少层级,“global” 和 “panel” 结果相同;如果只有 1 层级(单个时间序列),则所有三个设置一致。
- windows_identicalbool,可选,默认为 False
指定所有直接模型是使用相同数量的观测值还是不同数量的观测值。
True : 统一窗口长度为(总观测值 - 最大预测范围)。注意:当前,由于 ReductionTransformer 中的反向填充,窗口长度不会导致缺失值。如果不进行填充,窗口大小对应于(总观测值 + 1 - window_length + 最大预测范围)。
False : 每个预测范围的窗口大小不同。窗口长度对应于(总观测值 + 1 - window_length + 预测范围)。
- 属性:
cutoff (截断点)
截断点 = 预测器的“当前时间”状态。
fh (预测范围)
传入的预测范围。
is_fitted (是否已拟合)
是否已调用
fit
。
方法
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_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])计算/返回方差预测。
将对象重置为干净的初始化后状态。
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
。is_fitted
属性应在调用对象的fit
方法时设置为True
。如果不是,则引发
NotFittedError
。- 参数:
- method_namestr,可选
调用此方法的方法的名称。如果提供,错误消息将包含此信息。
- 引发:
- NotFittedError
如果评估器尚未拟合。
- clone()[source]#
获取具有相同超参数和配置的对象的克隆。
克隆是一个不同的对象,没有共享引用,处于初始化后状态。此函数等同于返回
self
的sklearn.clone
。等同于构造一个
type(self)
的新实例,使用self
的参数,即type(self)(**self.get_params(deep=False))
。如果在
self
上设置了配置,克隆也将具有与原始对象相同的配置,等同于调用cloned_self.set_config(**self.get_config())
。在值上也等同于调用
self.reset
,区别在于clone
返回一个新对象,而不是像reset
那样改变self
。- 引发:
- 如果克隆不符合要求,由于
__init__
有误,则会引发 RuntimeError。
- 如果克隆不符合要求,由于
- clone_tags(estimator, tag_names=None)[source]#
从另一个对象克隆标签作为动态覆盖。
每个兼容
scikit-base
的对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是静态标志,在对象构造后不会改变。clone_tags
从另一个对象estimator
设置动态标签覆盖。clone_tags
方法只能在对象的__init__
方法中调用,即在构造期间或通过__init__
构造之后立即调用。动态标签被设置为
estimator
中标签的值,名称由tag_names
指定。tag_names
的默认设置是将estimator
中的所有标签写入self
。可以通过
get_tags
或get_tag
查看当前标签值。- 参数:
- estimator:class:BaseObject 或其派生类的实例
- tag_namesstr 或 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')[源代码]#
创建所有测试实例列表及其名称列表。
- 参数:
- parameter_setstr,默认为 “default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回 “default” 集。
- 返回:
- objscls 实例列表
第 i 个实例是
cls(**cls.get_test_params()[i])
- names字符串列表,长度与 objs 相同
第 i 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个,命名约定为
{cls.__name__}-{i}
,否则为{cls.__name__}
- property cutoff[源代码]#
截断点 = 预测器的“当前时间”状态。
- 返回:
- cutoffpandas 兼容的索引元素,或 None
如果已设置截止点,则为 pandas 兼容的索引元素;否则为 None
- fit(y, X=None, fh=None)[源代码]#
将预测器拟合到训练数据。
- 状态改变
状态改变为“已拟合”。
写入 self
设置以“_”结尾的已拟合模型属性,已拟合属性可通过
get_fitted_params
查看。将
self.is_fitted
标志设置为True
。将
self.cutoff
设置为 y 中看到的最后一个索引。如果传入 fh,则将
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
,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 或
ForecastingHorizon
,默认=None 编码要预测的时间戳的预测范围。如果
self.get_tag("requires-fh-in-fit")
为True
,则必须在fit
中传入,非可选- Xsktime 兼容格式的时间序列,可选(默认=None)。
用于拟合模型的外生时间序列。应与
y
具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含y.index
。
- 返回:
- self对 self 的引用。
- fit_predict(y, X=None, fh=None, X_pred=None)[源代码]#
拟合并预测未来范围的时间序列。
与
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
,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 或
ForecastingHorizon
(非可选) 编码要预测的时间戳的预测范围。
如果 fh 不是 None 且不是 `ForecastingHorizon` 类型,它将通过调用
_check_fh
被强制转换为 `ForecastingHorizon`。特别是,如果 fh 是pd.Index
类型,它将通过ForecastingHorizon(fh, is_relative=False)
被强制转换。- Xsktime 兼容格式的时间序列,可选(默认=None)。
用于拟合模型的外生时间序列。应与
y
具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含y.index
。- X_predsktime 兼容格式的时间序列,可选(默认=None)
用于预测的外生时间序列。如果传入,将用于预测而不是 X。应与
fit
中的 y 具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含 fh 索引引用。
- 返回:
- y_predsktime 兼容数据容器格式的时间序列
在
fh
处的点预测,与fh
具有相同的索引。y_pred
与最近传入的y
类型相同:Series
、Panel
、Hierarchical
scitype,格式相同(见上文)
- classmethod get_class_tag(tag_name, tag_value_default=None)[源代码]#
从类中获取类标签值,考虑来自父类的标签继承。
每个
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()[源代码]#
从类中获取类标签,考虑来自父类的标签继承。
每个兼容
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()[源代码]#
获取对象的配置标志。
配置是
self
的键值对,通常用作控制行为的瞬态标志。get_config
返回动态配置,这些配置会覆盖默认配置。默认配置设置在类或其父类的类属性
_config
中,并被通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用下保留。- 返回:
- config_dictdict
配置名 : 配置值 对的字典。通过嵌套继承从
_config
类属性收集,然后收集来自_config_dynamic
对象属性的任何覆盖和新标签。
- get_fitted_params(deep=True)[源代码]#
获取已拟合参数。
- 所需状态
要求状态为“已拟合”。
- 参数:
- deep布尔值,默认=True
是否返回组件的已拟合参数。
如果为 True,将返回此对象的参数名 : 值字典,包括可拟合组件(= BaseEstimator 值参数)的已拟合参数。
如果为 False,将返回此对象的参数名 : 值字典,但不包括组件的已拟合参数。
- 返回:
- fitted_params键为字符串类型的字典
已拟合参数字典,参数名 : 参数值 键值对包括:
始终:此对象的所有已拟合参数,通过
get_param_names
获取的值是此对象的该键对应的已拟合参数值如果
deep=True
,还包含组件参数的键值对,组件参数索引为[componentname]__[paramname]
,componentname
的所有参数以paramname
及其值的形式出现如果
deep=True
,还包含任意层级的组件递归,例如,[componentname]__[componentcomponentname]__[paramname]
等
- classmethod get_param_defaults()[源代码]#
获取对象的参数默认值。
- 返回:
- default_dict: dict[str, Any]
键是
cls
中在__init__
中定义了默认值的所有参数。值是在__init__
中定义的默认值。
- classmethod get_param_names(sort=True)[源代码]#
获取对象的参数名称。
- 参数:
- sort布尔值,默认=True
是否按字母顺序排序(True)或按它们在类
__init__
中出现的顺序(False)返回参数名称。
- 返回:
- param_names: list[str]
cls
的参数名称列表。如果sort=False
,则按它们在类__init__
中出现的顺序排列。如果sort=True
,则按字母顺序排列。
- get_params(deep=True)[源代码]#
获取此对象的参数值字典。
- 参数:
- deep布尔值,默认=True
是否返回组件的参数。
如果
True
,将返回此对象的参数名 : 值dict
,包括组件(=BaseObject
值参数)的参数。如果
False
,将返回此对象的参数名 : 值dict
,但不包括组件的参数。
- 返回:
- params键为字符串类型的字典
参数字典,参数名 : 参数值 键值对包括:
始终:此对象的所有参数,通过
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)[源代码]#
从实例获取标签值,考虑标签层级继承和覆盖。
每个兼容
scikit-base
的对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是静态标志,在对象构造后不会改变。get_tag
方法从实例中检索名称为tag_name
的单个标签的值,考虑标签覆盖,优先级降序如下:在实例上通过
set_tags
或clone_tags
设置的标签,
在实例构造时。
在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序。
- 参数:
- tag_namestr
要检索的标签名称
- tag_value_default任意类型,可选;默认=None
如果未找到标签,则使用默认/回退值
- raise_error布尔值
未找到标签时是否引发
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()[源代码]#
从实例获取标签,考虑标签层级继承和覆盖。
每个兼容
scikit-base
的对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是静态标志,在对象构造后不会改变。get_tags
方法返回一个标签字典,其中的键是类或其任何父类中设置的任何_tags
属性的键,或通过set_tags
或clone_tags
设置的标签。值是相应的标签值,覆盖优先级降序如下:
在实例上通过
set_tags
或clone_tags
设置的标签,
在实例构造时。
在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序。
- 返回:
- collected_tagsdict
标签名 : 标签值 对的字典。通过嵌套继承从
_tags
类属性收集,然后收集来自_tags_dynamic
对象属性的任何覆盖和新标签。
- is_composite()[源代码]#
检查对象是否由其他 BaseObject 组成。
组合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回:
- composite: bool
对象是否有任何参数的值是
BaseObject
的派生实例。
- property is_fitted[源代码]#
是否已调用
fit
。检查对象的
_is_fitted` 属性,该属性在对象构造期间应初始化为 ``False
,并在调用对象的 fit 方法时设置为 True。- 返回:
- bool
估计器是否已 fit。
- classmethod load_from_path(serial)[源代码]#
从文件位置加载对象。
- 参数:
- serial
ZipFile(path).open(“object)
的结果
- serial
- 返回:
cls.save(path)
在path
处输出的反序列化的 self
- classmethod load_from_serial(serial)[源代码]#
从序列化的内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回:
cls.save(None)
输出serial
的反序列化的 self
- predict(fh=None, X=None)[源代码]#
预测未来范围的时间序列。
- 所需状态
要求状态为“已拟合”,即
self.is_fitted=True
。
访问 self 中的属性
以“_”结尾的已拟合模型属性。
self.cutoff
、self.is_fitted
- 写入 self
如果传入 fh 且之前未传入过,则将
fh
存储到self.fh
。
- 参数:
- fhint、list、可强制转换为 pd.Index 或
ForecastingHorizon
,默认=None 编码要预测的时间戳的预测范围。如果已在
fit
中传入,则不应再次传入。如果未在 fit 中传入,则必须传入,非可选如果 fh 不是 None 且不是 `ForecastingHorizon` 类型,它将通过调用
_check_fh
被强制转换为 `ForecastingHorizon`。特别是,如果 fh 是pd.Index
类型,它将通过ForecastingHorizon(fh, is_relative=False)
被强制转换。- Xsktime 兼容格式的时间序列,可选(默认=None)
用于预测的外生时间序列。应与
fit
中的 y 具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含 fh 索引引用。
- fhint、list、可强制转换为 pd.Index 或
- 返回:
- y_predsktime 兼容数据容器格式的时间序列
在
fh
处的点预测,与fh
具有相同的索引。y_pred
与最近传入的y
类型相同:Series
、Panel
、Hierarchical
scitype,格式相同(见上文)
- predict_interval(fh=None, X=None, coverage=0.9)[源代码]#
计算/返回预测区间预测。
如果
coverage
是可迭代的,将计算多个区间。- 所需状态
要求状态为“已拟合”,即
self.is_fitted=True
。
访问 self 中的属性
以“_”结尾的已拟合模型属性。
self.cutoff
、self.is_fitted
- 写入 self
如果传入 fh 且之前未传入过,则将
fh
存储到self.fh
。
- 参数:
- fhint、list、可强制转换为 pd.Index 或
ForecastingHorizon
,默认=None 编码要预测的时间戳的预测范围。如果已在
fit
中传入,则不应再次传入。如果未在 fit 中传入,则必须传入,非可选如果
fh
不是 None 且不是ForecastingHorizon
类型,它将在内部被强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或 int 的类数组,它被解释为相对预测范围,并被强制转换为相对ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,它被解释为绝对预测范围,并被强制转换为绝对ForecastingHorizon(fh, is_relative=False)
。
- Xsktime 兼容格式的时间序列,可选(默认=None)
用于预测的外生时间序列。应与
fit
中的 y 具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含 fh 索引引用。- coveragefloat 或唯一 float 值列表,可选(默认=0.90)
预测区间名义覆盖度
- fhint、list、可强制转换为 pd.Index 或
- 返回:
- pred_intpd.DataFrame
- 列具有多级索引:第一级是 `fit` 中 y 的变量名,
- 第二级是计算区间的覆盖度分数。
与输入
coverage
中的顺序相同。
第三级是字符串“lower”或“upper”,表示区间下限/上限。
- 行索引是 fh,附加(上级)级别等于实例级别,
来自 `fit` 中看到的 y,如果 `fit` 中看到的 y 是 Panel 或 Hierarchical。
- 条目是下限/上限区间的预测,
对于列索引中的变量,在第二列索引中的名义覆盖度下,取决于第三列索引的 lower/upper,以及行索引。上限/下限区间预测等效于覆盖度 c 的 alpha = 0.5 - c/2, 0.5 + c/2 处的分位数预测。
- predict_proba(fh=None, X=None, marginal=True)[源代码]#
计算/返回完全概率预测。
注意
目前仅为 Series(非面板、非分层)y 实现。
返回的分布对象需要安装
skpro
。
- 所需状态
要求状态为“已拟合”,即
self.is_fitted=True
。
访问 self 中的属性
以“_”结尾的已拟合模型属性。
self.cutoff
、self.is_fitted
- 写入 self
如果传入 fh 且之前未传入过,则将
fh
存储到self.fh
。
- 参数:
- fhint、list、可强制转换为 pd.Index 或
ForecastingHorizon
,默认=None 编码要预测的时间戳的预测范围。如果已在
fit
中传入,则不应再次传入。如果未在 fit 中传入,则必须传入,非可选如果
fh
不是 None 且不是ForecastingHorizon
类型,它将在内部被强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或 int 的类数组,它被解释为相对预测范围,并被强制转换为相对ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,它被解释为绝对预测范围,并被强制转换为绝对ForecastingHorizon(fh, is_relative=False)
。
- Xsktime 兼容格式的时间序列,可选(默认=None)
用于预测的外生时间序列。应与
fit
中的 y 具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含 fh 索引引用。- marginal布尔值,可选(默认=True)
返回的分布是否按时间索引是边际分布
- fhint、list、可强制转换为 pd.Index 或
- 返回:
- pred_distskpro BaseDistribution
如果 `marginal=True`,则为预测分布;如果 `marginal=False` 且方法已实现,则按时间点为边际分布;否则为联合分布
- predict_quantiles(fh=None, X=None, alpha=None)[源代码]#
计算/返回分位数预测。
如果
alpha
是可迭代的,将计算多个分位数。- 所需状态
要求状态为“已拟合”,即
self.is_fitted=True
。
访问 self 中的属性
以“_”结尾的已拟合模型属性。
self.cutoff
、self.is_fitted
- 写入 self
如果传入 fh 且之前未传入过,则将
fh
存储到self.fh
。
- 参数:
- fhint、list、可强制转换为 pd.Index 或
ForecastingHorizon
,默认=None 编码要预测的时间戳的预测范围。如果已在
fit
中传入,则不应再次传入。如果未在 fit 中传入,则必须传入,非可选如果
fh
不是 None 且不是ForecastingHorizon
类型,它将在内部被强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或 int 的类数组,它被解释为相对预测范围,并被强制转换为相对ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,它被解释为绝对预测范围,并被强制转换为绝对ForecastingHorizon(fh, is_relative=False)
。
- Xsktime 兼容格式的时间序列,可选(默认=None)
用于预测的外生时间序列。应与
fit
中的 y 具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含 fh 索引引用。- alphafloat 或唯一 float 值列表,可选(默认=[0.05, 0.95])
计算分位数预测的概率或概率列表。
- fhint、list、可强制转换为 pd.Index 或
- 返回:
- quantilespd.DataFrame
- 列具有多级索引:第一级是 `fit` 中 y 的变量名,
第二级是传入函数的 alpha 值。
- 行索引是 fh,附加(上级)级别等于实例级别,
来自 `fit` 中看到的 y,如果 `fit` 中看到的 y 是 Panel 或 Hierarchical。
- 条目是分位数预测,对于列索引中的变量,
在第二列索引中的分位数概率下,以及行索引。
- predict_residuals(y=None, X=None)[源代码]#
返回时间序列预测的残差。
将计算 y.index 处预测的残差。
如果 fh 必须在 fit 中传入,则必须与 y.index 一致。如果 y 是 np.ndarray,且未在 fit 中传入 fh,则将在 `range(len(y.shape[0]))` 的 fh 处计算残差。
- 所需状态
要求状态为“已拟合”。如果已设置 fh,则必须与 y 的索引(pandas 或整数)一致
- 访问 self 中的属性
以“_”结尾的已拟合模型属性。self.cutoff, self._is_fitted
- 写入 self
无。
- 参数:
- ysktime 兼容数据容器格式的时间序列
带有真实观测值的时间序列,用于计算残差。必须与 predict 的预期返回结果具有相同的类型、维度和索引。
如果为 None,则使用目前为止看到的 y (
self._y
),特别是如果之前仅调用了一次 fit,则生成样本内残差
如果 fit 需要
fh
,则它必须指向 fit 中 y 的索引
- Xsktime 兼容格式的时间序列,可选(默认=None)
用于更新和预测的外生时间序列。应与
fit
中的 y 具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须同时包含 fh 索引引用和 y.index。
- 返回:
- y_ressktime 兼容数据容器格式的时间序列
在
fh
处的预测残差,与fh
具有相同的索引。y_res
与最近传入的y
类型相同:Series
、Panel
、Hierarchical
scitype,格式相同(见上文)
- predict_var(fh=None, X=None, cov=False)[源代码]#
计算/返回方差预测。
- 所需状态
要求状态为“已拟合”,即
self.is_fitted=True
。
访问 self 中的属性
以“_”结尾的已拟合模型属性。
self.cutoff
、self.is_fitted
- 写入 self
如果传入 fh 且之前未传入过,则将
fh
存储到self.fh
。
- 参数:
- fhint、list、可强制转换为 pd.Index 或
ForecastingHorizon
,默认=None 编码要预测的时间戳的预测范围。如果已在
fit
中传入,则不应再次传入。如果未在 fit 中传入,则必须传入,非可选如果
fh
不是 None 且不是ForecastingHorizon
类型,它将在内部被强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或 int 的类数组,它被解释为相对预测范围,并被强制转换为相对ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,它被解释为绝对预测范围,并被强制转换为绝对ForecastingHorizon(fh, is_relative=False)
。
- Xsktime 兼容格式的时间序列,可选(默认=None)
用于预测的外生时间序列。应与
fit
中的 y 具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则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 是 Panel 或 Hierarchical。
条目是方差预测,对于列索引中的变量。给定变量和 fh 索引的方差预测是预测的
给定观测数据,该变量和索引的方差。
- 列名与在
- 如果 cov=True
- 列索引是多级索引:第一级是变量名(如上)
第二级是 fh。
- 行索引是 fh,附加级别等于实例级别,
来自 `fit` 中看到的 y,如果 `fit` 中看到的 y 是 Panel 或 Hierarchical。
- 条目是(协)方差预测,对于列索引中的变量,以及
行和列中时间索引之间的协方差。
注意:不同变量之间不返回协方差预测。
- pred_varpd.DataFrame,格式取决于
- reset()[源代码]#
将对象重置为干净的初始化后状态。
结果是将 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')[源代码]#
将序列化的对象保存到字节类对象或到 (.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)[源代码]#
使用 MAPE(非对称)根据真实值对预测进行评分。
- 参数:
- ypd.Series、pd.DataFrame 或 np.ndarray (1D 或 2D)
用于评分的时间序列
- fhint、list、可强制转换为 pd.Index 或
ForecastingHorizon
,默认=None 编码要预测的时间戳的预测范围。
- Xpd.DataFrame 或 2D np.array,可选(默认=None)
用于评分的外生时间序列。如果
self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含 y.index
- 返回:
- scorefloat
self.predict(fh, X)
相对于 y_test 的 MAPE 损失。
- set_config(**config_dict)[源代码]#
将配置标志设置为给定值。
- 参数:
- config_dictdict
配置名 : 配置值 对的字典。有效的配置、值及其含义如下所示
- displaystr,“diagram”(默认)或“text”
jupyter 内核如何显示 self 的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_only布尔值,默认=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”:布尔值,默认=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)[源代码]#
设置此对象的参数。
该方法适用于简单的 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')[源代码]#
为此对象设置 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 以在多次函数调用中获得可复现的输出。
- deep布尔值,默认=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)[源代码]#
将实例级别标签覆盖设置为给定值。
每个
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)[源代码]#
更新截断点值,并可选地更新拟合参数。
如果未实现特定于估计器的 update 方法,则默认回退如下:
update_params=True
:拟合目前为止所有观测数据update_params=False
:仅更新截止点并记住数据
- 所需状态
要求状态为“已拟合”,即
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
,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
- Xsktime 兼容格式的时间序列,可选(默认=None)。
用于更新模型拟合的外生时间序列。应与 y 具有相同的 scitype(
Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含 y.index。- update_params布尔值,可选(默认=True)
是否应更新模型参数。如果为
False
,则仅更新截止点,模型参数(例如,系数)不会更新。
- 返回:
- self对 self 的引用
- update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[源代码]#
在测试集上迭代进行预测并更新模型。
用于执行多个
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.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
,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
- cv继承自 BaseSplitter 的时间序列交叉验证生成器,可选
例如,
SlidingWindowSplitter
或ExpandingWindowSplitter
;默认 =ExpandingWindowSplitter
,`initial_window=1`,且默认为 y/X 中的单个数据点逐一添加并预测,initial_window = 1
,step_length = 1
且fh = 1
- Xsktime 兼容格式的时间序列,可选(默认=None)
用于更新和预测的外生时间序列。应与
fit
中的 y 具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含 fh 索引引用。- update_params布尔值,可选(默认=True)
是否应更新模型参数。如果为
False
,则仅更新截止点,模型参数(例如,系数)不会更新。- reset_forecaster布尔值,可选(默认=True)
如果为 True,则不会改变预测器的状态,即使用副本运行 update/predict 序列,self 的截止点、模型参数、数据内存不变
如果为 False,则在运行 update/predict 序列时会像直接调用 update/predict 一样更新 self
- 返回:
- y_pred汇总来自多个分割批次的点预测的对象
格式取决于总体预测的 (截止点, 绝对预测范围) 对
如果绝对预测范围点集合唯一:类型为 sktime 兼容数据容器格式的时间序列,输出中抑制截止点,与最近传入的 y 类型相同:Series、Panel、Hierarchical scitype,格式相同(见上文)
如果绝对预测范围点集合不唯一:类型为 pandas DataFrame,行索引和列索引均为时间戳,行索引对应于从中预测的截止点,列索引对应于预测的绝对预测范围。条目是根据行索引预测的列索引的点预测。如果未在该 (截止点, 预测范围) 对处进行预测,则条目为 nan
- update_predict_single(y=None, fh=None, X=None, update_params=True)[源代码]#
用新数据更新模型并进行预测。
此方法可用于在单个步骤中进行更新和预测。
如果未实现特定于估计器的 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
,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 或
ForecastingHorizon
,默认=None 编码要预测的时间戳的预测范围。如果已在
fit
中传入,则不应再次传入。如果未在 fit 中传入,则必须传入,非可选- Xsktime 兼容格式的时间序列,可选(默认=None)
用于更新和预测的外生时间序列。应与
fit
中的 y 具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含 fh 索引引用。- update_params布尔值,可选(默认=True)
是否应更新模型参数。如果为
False
,则仅更新截止点,模型参数(例如,系数)不会更新。
- 返回:
- y_predsktime 兼容数据容器格式的时间序列
在
fh
处的点预测,与fh
具有相同的索引。y_pred
与最近传入的y
类型相同:Series
、Panel
、Hierarchical
scitype,格式相同(见上文)
- 在