NaiveVariance#
- class NaiveVariance(forecaster, initial_window=1, verbose=False)[来源]#
基于朴素策略计算预测方差。
NaiveVariance 为预测器 (`forecaster`) 添加了基于朴素时间序列假设计算预测方差的能力。其简单策略如下: - 设 \(y_1,\dots,y_T\) 是我们拟合估计器 \(f\) 的时间序列。 - 设 \(\widehat{y}_{ij}\) 是对时间点 \(j\) 的预测,通过将预测器拟合到部分时间序列 \(y_1,\dots,y_i\) 获得。 - 我们计算残差矩阵 \(R=(r_{ij})=(y_j-\widehat{y}_{ij})\) 。 - 对 \(y_{T+k}\) 的方差预测 \(v_k\) 为 \(\frac{1}{T-k}\sum_{i=1}^{T-k} a_{i,i+k}^2\),因为我们平均了所有提前 \(k\) 个时间点的预测的平方残差。 - 对于协方差矩阵预测,公式变为 \(Cov(y_k, y_l)=\frac{\sum_{i=1}^N \hat{r}_{k,k+i}*\hat{r}_{l,l+i}}{N}\)。
- 生成的预测器将实现
predict_interval
,predict_quantiles
,predict_var
和predict_proba
,即使封装的预测器forecaster
不具备此功能;对于点预测 (predict`),其行为与封装的预测器相同。
- 参数:
- forecaster估计器
用于添加概率预测的估计器
- initial_window整型,可选,默认为 1
计算残差时用于拟合的最小初始索引数
- verbose布尔型,可选,默认为 False
如果窗口中的数据点过少是否打印警告
- 属性:
示例
>>> from sktime.datasets import load_airline >>> from sktime.forecasting.naive import NaiveForecaster, NaiveVariance >>> y = load_airline() >>> forecaster = NaiveForecaster(strategy="drift") >>> variance_forecaster = NaiveVariance(forecaster) >>> variance_forecaster.fit(y) NaiveVariance(...) >>> var_pred = variance_forecaster.predict_var(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])返回估计器的测试参数设置。
检查对象是否由其他 BaseObject 组成。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化内存容器加载对象。
predict
([fh, X])在未来范围预测时间序列。
predict_interval
([fh, X, coverage])计算/返回预测区间预测。
predict_proba
([fh, X, marginal])计算/返回完全概率预测。
predict_quantiles
([fh, X, alpha])计算/返回分位数预测。
predict_residuals
([y, X])返回时间序列预测的残差。
predict_var
([fh, X, cov])计算/返回方差预测。
reset
()将对象重置到初始化后的干净状态。
save
([path, serialization_format])将序列化的自身保存到字节类对象或 (.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')[来源]#
返回估计器的测试参数设置。
- 参数:
- parameter_set字符串,默认为“default”
要返回的测试参数集的名称,用于测试中。如果未为某个值定义特殊参数,则将返回“default”集。
- 返回:
- params字典或字典列表
- check_is_fitted(method_name=None)[来源]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。is_fitted
属性应在调用对象的fit
方法时设置为True
。如果不是,则引发
NotFittedError
。- 参数:
- method_name字符串,可选
调用此函数的方法的名称。如果提供,错误消息将包含此信息。
- 抛出:
- NotFittedError
如果估计器尚未拟合。
- clone()[来源]#
获取具有相同超参数和配置的对象的克隆。
克隆是另一个没有共享引用、处于初始化后状态的对象。此函数等同于返回自身的
sklearn.clone
。等同于构造一个新的
type(self)
实例,使用自身的参数,即type(self)(**self.get_params(deep=False))
。如果在自身上设置了配置,则克隆也将具有与原始对象相同的配置,等同于调用
cloned_self.set_config(**self.get_config())
。在值上等同于调用自身的
reset
,但不同之处在于clone
返回一个新对象,而不是像reset
那样改变自身。- 抛出:
- 如果克隆不符合要求,则引发 RuntimeError,原因在于
__init__
有缺陷。
- 如果克隆不符合要求,则引发 RuntimeError,原因在于
- clone_tags(estimator, tag_names=None)[来源]#
从另一个对象克隆标签作为动态覆盖。
每个兼容
scikit-base
的对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。方法
clone_tags
只能在对象的__init__
方法中调用,即在构造期间或通过__init__
直接构造之后调用。动态标签被设置为
estimator
中标签的值,名称由tag_names
指定。tag_names
的默认设置将estimator
中的所有标签写入到自身。当前标签值可以通过
get_tags
或get_tag
查看。estimator:class:BaseObject 或派生类的实例
- 要返回的测试参数集的名称,用于测试中。如果未为某个值定义特殊参数,则将返回“default”集。
使用第一个测试参数集构造类的一个实例。
- objscls 实例列表
创建所有测试实例的列表及其名称列表。
- cutoffpandas 兼容索引元素,或 None
截止点 = 预测器的“当前时间”状态。
- 状态改变
将预测器拟合到训练数据。
- 将状态改变为“已拟合”。
写入自身
设置以“_”结尾的已拟合模型属性,可通过
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
具有两级行MultiIndex
(instance, time
),3D np.ndarray
(instance, variable, time`), `list` 的 `Series` 类型 `pd.DataFrame`
Hierarchical
scitype = 分层集合,用于分层预测。pd.DataFrame
具有三级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time`)
有关数据格式的更多详细信息,请参见术语表中的 mtype。有关用法,请参见预测教程
examples/01_forecasting.ipynb
fh整型、列表、可强制转换为 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对自身的引用。
- 返回:
-
与
fit(y, X, fh).predict(X_pred)
相同。如果X_pred
未传递,则与fit(y, fh, X).predict(X)
相同。 在未来范围拟合并预测时间序列。
将
fh
存储到self.fh
。- 将状态改变为“已拟合”。
写入自身
设置以“_”结尾的已拟合模型属性,可通过
get_fitted_params
检查已拟合属性。将
self.is_fitted
标志设置为True
。将
self.cutoff
设置为y
中看到的最后一个索引。如果传递了
fh
,则将其存储到self.fh
。ysktime 兼容数据容器格式的时间序列
- 参数:
- fh整型、列表、可强制转换为 pd.Index 的对象,或
ForecastingHorizon
(不可选) sktime 中的独立数据格式称为mtype规范,每种 mtype 实现一个抽象的scitype。
Series
scitype = 单个时间序列,普通预测。pd.DataFrame
,pd.Series
, 或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合,全局/面板预测。pd.DataFrame
具有两级行MultiIndex
(instance, time
),3D np.ndarray
(instance, variable, time`), `list` 的 `Series` 类型 `pd.DataFrame`
Hierarchical
scitype = 分层集合,用于分层预测。pd.DataFrame
具有三级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time`)
有关数据格式的更多详细信息,请参见术语表中的 mtype。有关用法,请参见预测教程
examples/01_forecasting.ipynb
fh整型、列表、可强制转换为 pd.Index 的对象,或
ForecastingHorizon
,默认为 None- 编码要预测的时间戳的预测范围。
如果 fh 不为 None 且类型不是 ForecastingHorizon,则通过调用 _check_fh 将其强制转换为 ForecastingHorizon。特别是,如果 fh 的类型是 pd.Index,则通过 ForecastingHorizon(fh, is_relative=False) 强制转换。
X_predsktime 兼容格式的时间序列,可选(默认为 None)
- 用于拟合模型的外生时间序列。应与
y
的 scitype 相同(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含y.index
。 self对自身的引用。
- 用于预测的外生时间序列。如果传递,将用于预测而不是 X。应与 fit 中的 y 的 scitype 相同(
Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。 y_predsktime 兼容数据容器格式的时间序列
- fh整型、列表、可强制转换为 pd.Index 的对象,或
- 返回:
-
每个兼容
scikit-base
的对象都有一个标签字典,用于存储关于对象的元数据。 从类中获取类标签值,并继承父类的标签级别。
get_class_tag
方法是一个类方法,仅考虑类级别的标签值和覆盖来检索标签的值。它返回名称为
tag_name
的标签值,考虑了标签覆盖,按以下优先级降序排列:在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,按继承顺序。
不考虑实例上的动态标签覆盖,即通过
set_tags
或clone_tags
设置的标签,这些标签在实例上定义。要检索具有潜在实例覆盖的标签值,请使用
get_tag
方法。tag_name字符串
-
get_class_tags
方法是一个类方法,仅考虑类级别的标签值和覆盖来检索标签的值。 从类中获取类标签,并继承父类的标签级别。
每个兼容
scikit-base
的对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。它返回一个字典,其中键是在类或其任何父类中设置的任何
_tags
属性的键。值是相应的标签值,覆盖的优先级按以下降序排列:
实例可以根据超参数覆盖这些标签。
在父类的
_tags
属性中设置的标签,按继承顺序。
不考虑实例上的动态标签覆盖,即通过
set_tags
或clone_tags
设置的标签,这些标签在实例上定义。要检索具有潜在实例覆盖的标签,请使用
get_tags
方法。要包含来自动态标签的覆盖,请使用
get_tags
。要检索具有潜在实例覆盖的标签值,请使用
get_tag
方法。collected_tags字典
- 配置是自身的键值对,通常用作控制行为的瞬态标志。
获取自身的配置标志。
get_config
返回动态配置,这些配置覆盖默认配置。默认配置在类或其父类的类属性
_config
中设置,并通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用下保留。config_dict字典
- 所需状态
获取已拟合参数。
- 需要状态为“已拟合”。
deep布尔型,默认为 True
- 参数:
- 是否返回组件的已拟合参数。
如果为 True,将返回此对象的参数名称 : 参数值字典,包括可拟合组件(= BaseEstimator 值参数)的已拟合参数。
如果为 False,将返回此对象的参数名称 : 参数值字典,但不包括组件的已拟合参数。
fitted_params键为字符串的字典
- 返回:
- 已拟合参数字典,`paramname : paramvalue` 键值对包含:
始终:此对象的所有已拟合参数,如同通过
get_param_names
获取,值为该键对应的此对象的已拟合参数值
- 获取对象的默认参数值。
default_dict: dict[str, Any]
- 获取对象的参数名称。
sort布尔型,默认为 True
- 是否返回组件的参数。
获取此对象的参数值字典。
- 参数:
- 是否返回组件的已拟合参数。
如果
True
,将返回一个参数名称 : 参数值dict
,包括组件的参数(=BaseObject
值参数)。如果
False
,将返回一个参数名称 : 参数值dict
,但不包括组件的参数。params键为字符串的字典
- 返回:
-
get_tag
方法检索名称为tag_name
的单个标签值,考虑了标签覆盖,按以下优先级降序排列: 从实例中获取标签值,并考虑标签级别继承和覆盖。
每个兼容
scikit-base
的对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。通过
set_tags
或clone_tags
在实例上设置的标签,在实例构造时。
要检索的标签名称
在父类的
_tags
属性中设置的标签,按继承顺序。
不考虑实例上的动态标签覆盖,即通过
set_tags
或clone_tags
设置的标签,这些标签在实例上定义。- 参数:
- 标签值的名称。
tag_value_default任意类型,可选;默认为 None
- 如果未找到标签,则为默认/回退值
raise_error布尔型
- 当未找到标签时,是否抛出
ValueError
错误 tag_value任意类型
- 返回:
self
中tag_name
标签的值。如果未找到,则在raise_error
为 True 时抛出错误,否则返回tag_value_default
。ValueError,如果
raise_error
是True
。
- 抛出:
-
get_tags
方法返回一个标签字典,其中键是在类或其任何父类中设置的任何_tags
属性的键,或者通过set_tags
或clone_tags
设置的标签。 从实例中获取标签,并考虑标签级别继承和覆盖。
每个兼容
scikit-base
的对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。collected_tags字典
实例可以根据超参数覆盖这些标签。
在实例构造时。
要检索的标签名称
在父类的
_tags
属性中设置的标签,按继承顺序。
不考虑实例上的动态标签覆盖,即通过
set_tags
或clone_tags
设置的标签,这些标签在实例上定义。
- 组合对象是指包含其他对象作为参数的对象。在实例上调用,因为可能因实例而异。
检查对象是否由其他 BaseObject 组成。
composite: bool
-
检查对象的
_is_fitted` 属性,该属性应在对象构造期间初始化为 ``False
,并在调用对象的fit
方法时设置为 True。 是否已调用
fit
。bool
- serialZipFile(path).open(“object”) 的结果
从文件位置加载对象。
-
serial
cls.save(None)
输出的第一个元素 从序列化内存容器加载对象。
-
所需状态为“已拟合”,即
self.is_fitted=True
。 在未来范围预测时间序列。
- 需要状态为“已拟合”。
访问自身属性
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
如果
fh
已传递且之前未传递,则将其存储到self.fh
。
- 设置以“_”结尾的已拟合模型属性,可通过
get_fitted_params
检查已拟合属性。 编码要预测的时间戳的预测范围。如果已在
fit
中传递,则不应再次传递。如果未在 fit 中传递,则必须传递,不可选
- 参数:
- 编码要预测的时间戳的预测范围。如果
self.get_tag("requires-fh-in-fit")
是True
,则必须在fit
中传递,不可选 Xsktime 兼容格式的时间序列,可选(默认为 None)
X_predsktime 兼容格式的时间序列,可选(默认为 None)
- 用于预测的外生时间序列。应与 fit 中的 y 的 scitype 相同(
Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。 用于预测的外部时间序列。应具有与
fit
中的y
相同的科学类型 (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
是可迭代的,则将计算多个区间。- 需要状态为“已拟合”。
访问自身属性
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
如果
fh
已传递且之前未传递,则将其存储到self.fh
。
- 设置以“_”结尾的已拟合模型属性,可通过
get_fitted_params
检查已拟合属性。 编码要预测的时间戳的预测范围。如果已在
fit
中传递,则不应再次传递。如果未在 fit 中传递,则必须传递,不可选
- 参数:
- 编码要预测的时间戳的预测范围。如果
self.get_tag("requires-fh-in-fit")
是True
,则必须在fit
中传递,不可选 Xsktime 兼容格式的时间序列,可选(默认为 None)
如果
fh
不为 None 且不是ForecastingHorizon
类型,则内部将其强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或类似int
的数组,则将其解释为相对预测期,并强制转换为相对的ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,则将其解释为绝对预测期,并强制转换为绝对的ForecastingHorizon(fh, is_relative=False)
。
- 用于预测的外生时间序列。应与 fit 中的 y 的 scitype 相同(
Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。 用于预测的外部时间序列。应具有与
fit
中的y
相同的科学类型 (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引引用。- coveragefloat 或 具有唯一值的 float 列表,可选 (默认=0.90)
预测区间的标称覆盖率
- 编码要预测的时间戳的预测范围。如果
- 返回:
- pred_intpd.DataFrame
- 列具有多重索引:第一级是 fit 中 y 的变量名,
- 第二级是计算区间的覆盖率分数。
顺序与输入
coverage
中的顺序相同。
第三级是字符串“lower”或“upper”,表示区间下限/上限。
- 行索引是 fh,如果 fit 中看到的 y 是 Panel 或 Hierarchical,则附加的上层索引等于实例层级。
来自 fit 中看到的 y。
- 条目是区间下限/上限的预测,
针对列索引中的变量,第二列索引中的标称覆盖率,以及第三列索引确定的下限/上限,对应的行索引。对于 c 在 coverage 中的值,区间上限/下限预测等同于在 alpha = 0.5 - c/2, 0.5 + c/2 时的分位数预测。
- predict_proba(fh=None, X=None, marginal=True)[source]#
计算/返回完全概率预测。
注意
目前仅对 Series (非 Panel, 非 Hierarchical) y 实现。
返回的分布对象需要安装
skpro
。
- 需要状态为“已拟合”。
访问自身属性
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
如果
fh
已传递且之前未传递,则将其存储到self.fh
。
- 设置以“_”结尾的已拟合模型属性,可通过
get_fitted_params
检查已拟合属性。 编码要预测的时间戳的预测范围。如果已在
fit
中传递,则不应再次传递。如果未在 fit 中传递,则必须传递,不可选
- 参数:
- 编码要预测的时间戳的预测范围。如果
self.get_tag("requires-fh-in-fit")
是True
,则必须在fit
中传递,不可选 Xsktime 兼容格式的时间序列,可选(默认为 None)
如果
fh
不为 None 且不是ForecastingHorizon
类型,则内部将其强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或类似int
的数组,则将其解释为相对预测期,并强制转换为相对的ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,则将其解释为绝对预测期,并强制转换为绝对的ForecastingHorizon(fh, is_relative=False)
。
- 用于预测的外生时间序列。应与 fit 中的 y 的 scitype 相同(
Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。 用于预测的外部时间序列。应具有与
fit
中的y
相同的科学类型 (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引引用。- marginalbool,可选 (默认=True)
返回的分布是否按时间索引进行边际化
- 编码要预测的时间戳的预测范围。如果
- 返回:
- 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
。
- 设置以“_”结尾的已拟合模型属性,可通过
get_fitted_params
检查已拟合属性。 编码要预测的时间戳的预测范围。如果已在
fit
中传递,则不应再次传递。如果未在 fit 中传递,则必须传递,不可选
- 参数:
- 编码要预测的时间戳的预测范围。如果
self.get_tag("requires-fh-in-fit")
是True
,则必须在fit
中传递,不可选 Xsktime 兼容格式的时间序列,可选(默认为 None)
如果
fh
不为 None 且不是ForecastingHorizon
类型,则内部将其强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或类似int
的数组,则将其解释为相对预测期,并强制转换为相对的ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,则将其解释为绝对预测期,并强制转换为绝对的ForecastingHorizon(fh, is_relative=False)
。
- 用于预测的外生时间序列。应与 fit 中的 y 的 scitype 相同(
Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。 用于预测的外部时间序列。应具有与
fit
中的y
相同的科学类型 (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引引用。- alphafloat 或 具有唯一值的 float 列表,可选 (默认=[0.05, 0.95])
计算分位数预测的概率或概率列表。
- 编码要预测的时间戳的预测范围。如果
- 返回:
- 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,则残差将根据 len(y.shape[0]) 的范围计算。
- 需要状态为“已拟合”。
需要处于“已拟合”状态。如果已设置 fh,则必须与 y (pandas 或整数) 的索引对应。
- 以“_”结尾的已拟合模型属性。
拟合模型属性以“_”结尾。self.cutoff, self._is_fitted
- 设置以“_”结尾的已拟合模型属性,可通过
get_fitted_params
检查已拟合属性。 无。
- 参数:
- fh整型、列表、可强制转换为 pd.Index 的对象,或
ForecastingHorizon
(不可选) 用于计算残差的具有真实观测值的时间序列。必须与 predict 的预期返回类型、维度和索引相同。
如果为 None,则使用迄今为止已见的 y (self._y),特别地,
如果之前只有一个 fit 调用,则生成样本内残差
如果 fit 需要
fh
,则它必须指向 fit 中 y 的索引
- Xsktime 兼容格式的时间序列,可选 (默认=None)
用于更新和预测的外部时间序列。应具有与
fit
中的y
相同的科学类型 (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须同时包含fh
索引引用和y.index
。
- fh整型、列表、可强制转换为 pd.Index 的对象,或
- 返回:
- 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
。
- 设置以“_”结尾的已拟合模型属性,可通过
get_fitted_params
检查已拟合属性。 编码要预测的时间戳的预测范围。如果已在
fit
中传递,则不应再次传递。如果未在 fit 中传递,则必须传递,不可选
- 参数:
- 编码要预测的时间戳的预测范围。如果
self.get_tag("requires-fh-in-fit")
是True
,则必须在fit
中传递,不可选 Xsktime 兼容格式的时间序列,可选(默认为 None)
如果
fh
不为 None 且不是ForecastingHorizon
类型,则内部将其强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或类似int
的数组,则将其解释为相对预测期,并强制转换为相对的ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,则将其解释为绝对预测期,并强制转换为绝对的ForecastingHorizon(fh, is_relative=False)
。
- 用于预测的外生时间序列。应与 fit 中的 y 的 scitype 相同(
Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。 用于预测的外部时间序列。应具有与
fit
中的y
相同的科学类型 (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引引用。- covbool,可选 (默认=False)
如果为 True,计算协方差矩阵预测。如果为 False,计算边际方差预测。
- 编码要预测的时间戳的预测范围。如果
- 返回:
- pred_varpd.DataFrame,格式取决于
cov
变量 - 如果 cov=False
- 列名与
fit
/update
中传递的y
的列名完全相同。 对于无名格式,列索引将是 RangeIndex。
- 行索引是 fh,附加层级等于实例层级,
来自 fit 中看到的 y。
来自 fit 中看到的 y。条目是方差预测,针对列索引中的变量。对于给定变量和 fh 索引的方差预测是根据观测数据预测的
该变量和索引的方差。
- 列名与
- 如果 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))`` 后获得的对象相等。- 返回:
- 对自身的引用。
类实例重置到干净的 post-init 状态,但保留当前的超参数值。
- 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) 创建一个 zip 文件
estimator.zip
。path=”/home/stored/estimator” 则会在
/home/stored/
中存储一个 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)
用于评分的时间序列
- 编码要预测的时间戳的预测范围。如果
self.get_tag("requires-fh-in-fit")
是True
,则必须在fit
中传递,不可选 如果 fh 不为 None 且类型不是 ForecastingHorizon,则通过调用 _check_fh 将其强制转换为 ForecastingHorizon。特别是,如果 fh 的类型是 pd.Index,则通过 ForecastingHorizon(fh, is_relative=False) 强制转换。
- Xpd.DataFrame, 或 2D np.array,可选 (默认=None)
用于评分的外部时间序列。如果 self.get_tag(“X-y-must-have-same-index”) 为 True,则 X.index 必须包含 y.index。
- 返回:
- scorefloat
self.predict(fh, X) 相对于 y_test 的 MAPE 损失。
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- 配置名称 : 配置值对的字典。从 _config 类属性通过嵌套继承收集,然后是来自 _onfig_dynamic 对象属性的任何覆盖和新标签。
配置名称:配置值 对的字典。有效的配置、值及其含义如下所示:
- 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_data布尔型,默认为 True
remember_databool,默认=True
- 返回:
- 是否在 fit 中存储 self._X 和 self._y,并在 update 中更新。如果为 True,则存储并更新 self._X 和 self._y。如果为 False,则不存储和更新 self._X 和 self._y。这在使用 save 时减小了序列化大小,但 update 将默认为“不做任何事情”,而不是“重新拟合所有已见数据”。
self对自身的引用。
注意
- 更改对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
设置此对象的参数。
- 参数:
- 该方法适用于简单的 skbase 对象以及复合对象。参数键字符串
<component>__<parameter>
可用于复合对象(即包含其他对象的对象),以访问组件<component>
中的<parameter>
。字符串<parameter>
(不带<component>__
)也可用于无歧义的引用,例如,没有两个组件参数具有相同的名称<parameter>
。 **paramsdict
- 该方法适用于简单的 skbase 对象以及复合对象。参数键字符串
- 返回:
- BaseObject 参数,键必须是
<component>__<parameter>
字符串。__
后缀可以作为完整字符串的别名,如果它们在 get_params 键中是唯一的。
- BaseObject 参数,键必须是
- self对自身的引用(设置参数后)
为自身设置 random_state 伪随机种子参数。
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#
通过
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
派生,通常与它不同
- 从输入的
- self对自身的引用
将实例级别标签覆盖设置为给定值。
get_class_tag
方法是一个类方法,仅考虑类级别的标签值和覆盖来检索标签的值。标签是实例
self
特定的键值对,它们是静态标志,在对象构造后不会更改。它们可用于元数据检查或控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要设置的标签值。estimator:class:BaseObject 或派生类的实例
- 参数:
set_tags
方法应仅在对象的__init__
方法中,构造期间,或通过__init__
构造后直接调用。**tag_dictdict
- 返回:
- 标签名称:标签值 对的字典。
Self
- 对自身的引用。
更新截止点值,并可选地更新已拟合参数。
update(y, X=None, update_params=True)[source]#
如果尚未实现特定于估计器的更新方法,则默认回退如下:
update_params=True
: 拟合迄今为止所有观测到的数据
- 需要状态为“已拟合”。
访问自身属性
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
如果
fh
已传递且之前未传递,则将其存储到self.fh
。
设置以“_”结尾的已拟合模型属性,可通过
get_fitted_params
检查已拟合属性。update_params=False
: 仅更新截止点并记住数据更新
self.cutoff
到y
中看到的最新索引。
- 参数:
- 用于拟合预测器的时间序列。
如果
update_params=True
,则更新以“_”结尾的拟合模型属性。Series
scitype = 单个时间序列,普通预测。pd.DataFrame
,pd.Series
, 或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合,全局/面板预测。pd.DataFrame
具有两级行MultiIndex
(instance, time
),3D np.ndarray
(instance, variable, time`), `list` 的 `Series` 类型 `pd.DataFrame`
Hierarchical
scitype = 分层集合,用于分层预测。pd.DataFrame
具有三级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time`)
有关数据格式的更多详细信息,请参见术语表中的 mtype。有关用法,请参见预测教程
examples/01_forecasting.ipynb
fh整型、列表、可强制转换为 pd.Index 的对象,或
ForecastingHorizon
,默认为 None- 用于拟合模型的外生时间序列。应与
y
的 scitype 相同(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含y.index
。 用于更新预测器的时间序列。
- 用于更新模型拟合的外部时间序列。应具有与
y
相同的 科学类型 (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含y.index
。 update_paramsbool,可选 (默认=True)
- 返回:
- 从输入的
random_state
派生,通常与它不同
- 从输入的
-
是否应更新模型参数。如果
False
,则仅更新截止点,模型参数(例如,系数)不更新。 在测试集上迭代地进行预测和模型更新。
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)[0][0])
self.update(y=cv.split_series(y)[1][0])
等等
update(y, X=None, update_params=True)[source]#
如果尚未实现特定于估计器的更新方法,则默认回退如下:
update_params=True
: 拟合迄今为止所有观测到的数据
- 需要状态为“已拟合”。
访问自身属性
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
如果
fh
已传递且之前未传递,则将其存储到self.fh
。
- 返回所有记住的预测
update_params=False
: 仅更新截止点并记住数据更新
self.cutoff
到y
中看到的最新索引。
写入 self (除非
reset_forecaster=True
)- 参数:
- 用于拟合预测器的时间序列。
如果
update_params=True
,则更新以“_”结尾的拟合模型属性。Series
scitype = 单个时间序列,普通预测。pd.DataFrame
,pd.Series
, 或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合,全局/面板预测。pd.DataFrame
具有两级行MultiIndex
(instance, time
),3D np.ndarray
(instance, variable, time`), `list` 的 `Series` 类型 `pd.DataFrame`
Hierarchical
scitype = 分层集合,用于分层预测。pd.DataFrame
具有三级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time`)
有关数据格式的更多详细信息,请参见术语表中的 mtype。有关用法,请参见预测教程
examples/01_forecasting.ipynb
fh整型、列表、可强制转换为 pd.Index 的对象,或
ForecastingHorizon
,默认为 None- 如果
reset_forecaster=True
,则不更新状态。 cv继承自 BaseSplitter 的时间交叉验证生成器,可选
- Xsktime 兼容格式的时间序列,可选 (默认=None)
例如,
SlidingWindowSplitter
或ExpandingWindowSplitter
;默认 = 具有initial_window=1
和默认值的 ExpandingWindowSplitter = y/X 中的单个数据点逐个添加并预测,initial_window = 1
,step_length = 1
和fh = 1
。- 用于更新模型拟合的外部时间序列。应具有与
y
相同的 科学类型 (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含y.index
。 update_paramsbool,可选 (默认=True)
- 用于更新和预测的外部时间序列。应具有与
fit
中的y
相同的科学类型 (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引引用。 reset_forecasterbool,可选 (默认=True)
如果为 True,则不会改变预测器的状态,即更新/预测序列在副本上运行,并且 self 的截止点、模型参数、数据内存不会改变。
- 返回:
- 如果为 False,则在运行更新/预测序列时会更新 self,就像直接调用更新/预测一样。
y_pred对来自多个分割批次的点预测进行制表的对象
格式取决于预测的(截止点,绝对预测期)对
如果绝对预测期点的集合是唯一的:类型是 sktime 兼容数据容器格式的时间序列,输出中省略了截止点,类型与最近传递的 y 相同:Series, Panel, Hierarchical 科学类型,格式相同 (参见上文)
- 如果绝对预测期点的集合不是唯一的:类型是 pandas DataFrame,行和列索引都是时间戳,行索引对应于进行预测的截止点,列索引对应于进行预测的绝对预测期,条目是该(截止点,预测期)对的点预测,如果在该对没有进行预测,则条目为 nan。
使用新数据更新模型并进行预测。
update_predict_single(y=None, fh=None, X=None, update_params=True)[source]#
此方法对于一步完成更新和预测很有用。
- 需要状态为“已拟合”。
deep布尔型,默认为 True
- 以“_”结尾的已拟合模型属性。
如果尚未实现特定于估计器的更新方法,则默认回退是先更新,然后预测。
- 设置以“_”结尾的已拟合模型属性,可通过
get_fitted_params
检查已拟合属性。 拟合模型属性以“_”结尾。指向已见数据的指针,self._y 和 self.X self.cutoff, self._is_fitted 如果 update_params=True,则模型属性以“_”结尾。
通过附加行更新 self._y 和 self._X 以及
y
和X
。更新 self.cutoff 和 self._cutoff 到y
中看到的最后一个索引。如果 update_params=True,
- 参数:
- 用于拟合预测器的时间序列。
如果
update_params=True
,则更新以“_”结尾的拟合模型属性。Series
scitype = 单个时间序列,普通预测。pd.DataFrame
,pd.Series
, 或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合,全局/面板预测。pd.DataFrame
具有两级行MultiIndex
(instance, time
),3D np.ndarray
(instance, variable, time`), `list` 的 `Series` 类型 `pd.DataFrame`
Hierarchical
scitype = 分层集合,用于分层预测。pd.DataFrame
具有三级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time`)
有关数据格式的更多详细信息,请参见术语表中的 mtype。有关用法,请参见预测教程
examples/01_forecasting.ipynb
fh整型、列表、可强制转换为 pd.Index 的对象,或
ForecastingHorizon
,默认为 None- 编码要预测的时间戳的预测范围。如果
self.get_tag("requires-fh-in-fit")
是True
,则必须在fit
中传递,不可选 Xsktime 兼容格式的时间序列,可选(默认为 None)
- Xsktime 兼容格式的时间序列,可选 (默认=None)
例如,
SlidingWindowSplitter
或ExpandingWindowSplitter
;默认 = 具有initial_window=1
和默认值的 ExpandingWindowSplitter = y/X 中的单个数据点逐个添加并预测,initial_window = 1
,step_length = 1
和fh = 1
。- 用于更新模型拟合的外部时间序列。应具有与
y
相同的 科学类型 (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含y.index
。 update_paramsbool,可选 (默认=True)
- 返回: