ForecastingRandomizedSearchCV
#
- class ForecastingRandomizedSearchCV(forecaster, cv, param_distributions, n_iter=10, scoring=None, strategy='refit', refit=True, verbose=0, return_n_best_forecasters=1, random_state=None, backend='loky', update_behaviour='full_refit', error_score=nan, tune_by_instance=False, tune_by_variable=False, backend_params=None, n_jobs='deprecated')[source]#
执行随机搜索交叉验证以找到最优模型参数。
预测器在初始窗口上拟合,然后使用时间交叉验证来找到最优参数
随机交叉验证基于一个交叉验证迭代器进行,该迭代器编码了交叉验证方案、要搜索的参数分布以及(可选的)用于比较模型性能的评估指标。与 scikit-learn 一样,调优通过通用的超参数接口进行,该接口允许使用不同的超参数重复拟合和评估同一个预测器。
- 参数:
- forecastersktime 预测器, BaseForecaster 实例或兼容接口
要调优的预测器,必须实现 sktime 预测器接口。可以使用 sklearn 回归器,但必须先通过降维组合器之一将其转换为预测器,例如通过
make_reduction
。- cv交叉验证生成器或可迭代对象
例如 SlidingWindowSplitter()
- strategy{“refit”, “update”, “no-update_params”},可选,默认为“refit”
cv拟合中的数据摄取策略,内部传递给
evaluate
,定义了当预测器在窗口扩展时看到新数据时的摄取模式:“refit”=预测器的新副本拟合到每个训练窗口;“update”=预测器按提供的序列用训练窗口数据更新;“no-update_params”=拟合到第一个训练窗口,不进行拟合或更新而重复使用。- update_behaviour: str,可选,默认为“full_refit”
{“full_refit”, “inner_only”, “no_update”}之一预测器调用update时的行为:“full_refit”=调优参数和内部估计器都对所有已见数据进行重新拟合;“inner_only”=不重新调优参数,只更新内部估计器;“no_update”=不更新调优参数也不更新内部估计器。
- param_distributionsdict 或 dict 列表
字典,键是参数名(
str
),值是分布或要尝试的参数列表。分布必须提供用于采样的rvs
方法(例如 scipy.stats.distributions 中的分布)。如果给定列表,则均匀采样。如果给定 dict 列表,则首先均匀采样一个 dict,然后使用该 dict 按上述方式采样参数。- n_iterint,默认为 10
采样的参数设置数量。n_iter 权衡了运行时间和解决方案质量。
- scoringsktime 指标 (BaseMetric),str 或 callable,可选 (默认为 None)
用于调优预测器的评分指标
可以搜索 sktime 指标对象 (BaseMetric) 的后代
使用
registry.all_estimators
搜索工具,例如通过all_estimators("metric", as_dataframe=True)
。如果可调用,必须具有签名
(y_true: 1D np.ndarray, y_pred: 1D np.ndarray) -> float
,假设 np.ndarrays 长度相同,且值越低越好。sktime.performance_metrics.forecasting 中的指标都是这种形式。如果为 str,则使用 registry.resolve_alias 解析为上述之一。有效的字符串是有效的 registry.craft 规范,包括任何 BaseMetric 对象的字符串表示形式,例如 “MeanSquaredError()”;以及指向指标的 registry.ALIAS_DICT 的键。
如果为 None,默认为 MeanAbsolutePercentageError()
- refitbool,可选 (默认为 True)
True = 在拟合时使用最佳参数对整个数据重新拟合预测器;False = 不进行重新拟合。预测器不能用于预测。这用于调优超参数,然后将估计器用作参数估计器,例如通过 get_fitted_params 或 PluginParamsForecaster。
- verboseint,可选 (默认为 0)
- return_n_best_forecasters: int,默认为 1
如果要返回 n 个最佳预测器,可以设置此值,并且 n 个最佳预测器将分配给 n_best_forecasters_。将 return_n_best_forecasters 设置为 -1 以返回所有预测器。
- random_stateint, RandomState 实例或 None,默认为 None
用于从可能值的列表而不是 scipy.stats 分布中进行随机均匀采样的伪随机数生成器状态。传入一个 int 以便在多次函数调用中获得可重现的输出。
- backend{“dask”, “loky”, “multiprocessing”, “threading”},默认为“loky”。
如果指定且
strategy
设置为“refit”,则并行运行 evaluate。“None”:顺序执行循环,简单的列表推导
“loky”、“multiprocessing”和“threading”:使用
joblib.Parallel
循环“joblib”:自定义和第三方
joblib
后端,例如spark
“dask”:使用
dask
,需要在环境中安装dask
包“ray”:使用
ray
,需要在环境中安装ray
包
建议:使用“dask”或“loky”进行并行评估。由于 GIL,使用“threading”不太可能看到加速,并且“dask”和“loky”的序列化后端(
cloudpickle
)通常比“multiprocessing”中使用的标准pickle
库更健壮。- error_score“raise”或数字,默认为 np.nan
如果估计器拟合时发生异常,则分配给分数值。如果设置为“raise”,则抛出异常。如果给定数值,则抛出 FitFailedWarning 警告。
- tune_by_instancebool,可选 (默认为 False)
是否在面板或分层数据传递给调优估计器时,按每个时间序列实例单独调优参数。仅当传递的时间序列是面板或分层时适用。如果为 True,预测器的克隆将单独拟合到每个实例,并在 forecasters_ 属性的字段中可用。这与对自身应用 ForecastByLevel 包装器效果相同。如果为 False,则为所有实例选择相同的最佳参数。
- tune_by_variablebool,可选 (默认为 False)
是否在多变量数据传递给调优估计器时,按每个时间序列变量单独调优参数。仅当传递的时间序列严格为多变量时适用。如果为 True,预测器的克隆将单独拟合到每个变量,并在 forecasters_ 属性的字段中可用。这与对自身应用 ColumnEnsembleForecaster 包装器效果相同。如果为 False,则为所有变量选择相同的最佳参数。
- backend_paramsdict,可选
作为配置传递给后端的额外参数。直接传递给
utils.parallel.parallelize
。有效键取决于backend
的值“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”;要使用的 logger 名称。
“mute_warnings”:bool,默认为 False;如果为 True,则抑制警告
- 属性:
- best_index_int
- best_score_: float
最佳模型的得分
- best_params_dict
参数网格中的最佳参数值
- best_forecaster_估计器
使用最佳参数拟合的估计器
- cv_results_dict
网格搜索交叉验证的结果
- n_best_forecasters_: 元组列表 (“rank”,
) “rank”与 best_forecaster_ 相关
- n_best_scores_: float 列表
n_best_forecasters_ 的得分,按预测器得分从优到劣排序
- forecasters_pd.DataFrame
包含所有拟合的预测器及其参数的 DataFrame。仅当 tune_by_instance=True 或 tune_by_variable=True 且至少其中之一适用时存在。在这种情况下,其他属性不存在于 self 中,仅存在于 forecasters_ 的字段中。
方法
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])返回估计器的测试参数设置。
是复合对象
()检查对象是否由其他 BaseObjects 组成。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化内存容器加载对象。
predict
([fh, X])预测未来范围的时间序列。
predict_interval
([fh, X, coverage])计算/返回预测区间预测。
predict_proba
([fh, X, marginal])计算/返回完全概率预测。
predict_quantiles
([fh, X, alpha])计算/返回分位数预测。
predict_residuals
([y, X])返回时间序列预测的残差。
predict_var
([fh, X, cov])计算/返回方差预测。
重置
()将对象重置到初始状态。
save
([path, serialization_format])将序列化的 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"
集。
- 返回:
- paramsdict 或 dict 列表
- check_is_fitted(method_name=None)[source]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。在调用对象的fit
方法时,应将is_fitted
属性设置为True
。如果不是,则抛出
NotFittedError
异常。- 参数:
- method_namestr,可选
调用此函数的方法名称。如果提供,错误消息将包含此信息。
- 抛出:
- 未拟合错误
如果估计器尚未拟合。
- 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 或 str 列表,默认为 None
要克隆的标签名称。默认值 (
None
) 克隆estimator
中的所有标签。
- 返回:
- 自身
对
self
的引用。
- classmethod create_test_instance(parameter_set='default')[source]#
使用第一个测试参数集构造类的一个实例。
- 参数:
- parameter_setstr,默认为“default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回 “default” 集。
- 返回:
- instance具有默认参数的类实例
- classmethod create_test_instances_and_names(parameter_set='default')[source]#
创建所有测试实例的列表及其名称列表。
- 参数:
- parameter_setstr,默认为“default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回 “default” 集。
- 返回:
- objscls 实例列表
第 i 个实例是
cls(**cls.get_test_params()[i])
- namesstr 列表,长度与 objs 相同
第 i 个元素是测试中 obj 的第 i 个实例的名称。命名约定是
{cls.__name__}-{i}
(如果实例多于一个),否则是{cls.__name__}
。
- property cutoff[source]#
截止点 = 预测器的“当前时间”状态。
- 返回:
- cutoffpandas 兼容索引元素,或 None
pandas 兼容索引元素,如果已设置截止点;否则为 None
- fit(y, X=None, fh=None)[source]#
将预测器拟合到训练数据。
- 状态改变
将状态更改为“fitted”。
写入自身
设置以“_”结尾的拟合模型属性,拟合属性可通过
get_fitted_params
检查。将
self.is_fitted
标志设置为True
。将
self.cutoff
设置为在y
中看到的最后一个索引。如果传递了
fh
,则将fh
存储到self.fh
。
- 参数:
- ysktime 兼容数据容器格式的时间序列。
用于拟合预测器的时间序列。
sktime
中的单个数据格式是所谓的 mtype 规范,每个 mtype 都实现了抽象的 科学类型。Series
科学类型 = 单个时间序列,普通预测。pd.DataFrame
,pd.Series
或np.ndarray
(1D 或 2D)Panel
科学类型 = 时间序列集合,全局/面板预测。pd.DataFrame
具有 2 级行MultiIndex
(instance, time)
,3D np.ndarray
(instance, variable, time)
,list
类型为Series
的pd.DataFrame
Hierarchical
科学类型 = 分层集合,用于分层预测。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
中传递,不可选。- Xsktime 兼容格式的时间序列,可选 (默认为 None)。
用于拟合模型的外生时间序列。应与
y
具有相同的 科学类型 (Series
,Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含y.index
。
- 返回:
- self对自身的引用。
- fit_predict(y, X=None, fh=None, X_pred=None)[source]#
拟合并预测未来范围的时间序列。
等同于
fit(y, X, fh).predict(X_pred)
。如果未传递X_pred
,则等同于fit(y, fh, X).predict(X)
。- 状态改变
将状态更改为“fitted”。
写入自身
设置以“_”结尾的拟合模型属性,拟合属性可通过
get_fitted_params
检查。将
self.is_fitted
标志设置为True
。将
self.cutoff
设置为在y
中看到的最后一个索引。将
fh
存储到self.fh
。
- 参数:
- ysktime 兼容数据容器格式的时间序列
用于拟合预测器的时间序列。
sktime
中的单个数据格式是所谓的 mtype 规范,每个 mtype 都实现了抽象的 科学类型。Series
科学类型 = 单个时间序列,普通预测。pd.DataFrame
,pd.Series
或np.ndarray
(1D 或 2D)Panel
科学类型 = 时间序列集合,全局/面板预测。pd.DataFrame
具有 2 级行MultiIndex
(instance, time)
,3D np.ndarray
(instance, variable, time)
,list
类型为Series
的pd.DataFrame
Hierarchical
科学类型 = 分层集合,用于分层预测。pd.DataFrame
具有 3 级或更多行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参见 mtype 词汇表。有关用法,请参见预测教程
examples/01_forecasting.ipynb
。- fhint, list, 可强制转换为 pd.Index,或
ForecastingHorizon
(非可选) 编码要预测的时间戳的预测范围。
如果 fh 不是 None 且类型不是 ForecastingHorizon,则通过调用 _check_fh 强制转换为 ForecastingHorizon。特别是,如果 fh 是 pd.Index 类型,则通过 ForecastingHorizon(fh, is_relative=False) 强制转换。
- Xsktime 兼容格式的时间序列,可选 (默认为 None)。
用于拟合模型的外生时间序列。应与
y
具有相同的 科学类型 (Series
,Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含y.index
。- X_predsktime 兼容格式的时间序列,可选 (默认为 None)
用于预测的外生时间序列。如果传递,将用于预测而不是 X。应与
fit
中的y
具有相同的科学类型 (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
科学类型,格式相同 (见上文)
- classmethod get_class_tag(tag_name, tag_value_default=None)[source]#
从类中获取类标签值,具有来自父类的标签级别继承。
每个兼容
scikit-base
的对象都有一个标签字典,用于存储关于对象的元数据。get_class_tag
方法是一个类方法,它仅考虑类级别的标签值和覆盖来检索标签的值。它返回对象中名称为
tag_name
的标签值,同时考虑标签覆盖,优先级按降序排列如下:在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按照继承顺序。
不考虑通过
set_tags
或clone_tags
在实例上设置的动态标签覆盖。要检索带有潜在实例覆盖的标签值,请改用
get_tag
方法。- 参数:
- tag_namestr
标签值的名称。
- tag_value_default任意类型
如果未找到标签,则返回的默认/备用值。
- 返回:
- tag_value
self
中tag_name
标签的值。如果未找到,则返回tag_value_default
。
- classmethod get_class_tags()[source]#
从类中获取类标签,具有来自父类的标签级别继承。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是对象构造后不更改的静态标志。get_class_tags
方法是一个类方法,它仅考虑类级别的标签值和覆盖来检索标签的值。它返回一个字典,其键是类或其任何父类中设置的
_tags
属性的任何键。值是相应的标签值,覆盖优先级按降序排列如下:
在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按照继承顺序。
实例可以根据超参数覆盖这些标签。
要检索带有潜在实例覆盖的标签,请改用
get_tags
方法。不考虑通过
set_tags
或clone_tags
在实例上设置的动态标签覆盖。要包含来自动态标签的覆盖,请使用
get_tags
。- collected_tagsdict
标签名称 : 标签值 对的字典。通过嵌套继承从
_tags
类属性收集。不被通过set_tags
或clone_tags
设置的动态标签覆盖。
- get_config()[source]#
获取自身的配置标志。
配置是
self
的键值对,通常用作控制行为的瞬时标志。get_config
返回动态配置,这些配置会覆盖默认配置。默认配置在类或其父类的
_config
类属性中设置,并被通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用下得以保留。- 返回:
- config_dictdict
配置名称 : 配置值 对的字典。通过嵌套继承从 _config 类属性收集,然后从 _onfig_dynamic 对象属性收集任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取拟合参数。
- 所需状态
要求状态为“已拟合”(fitted)。
- 参数:
- deep布尔型, 默认=True
是否返回组件的已拟合参数。
如果为 True,将返回此对象的参数名称 : 值字典,包括可拟合组件(= BaseEstimator 类型参数)的已拟合参数。
如果为 False,将返回此对象的参数名称 : 值字典,但不包括组件的已拟合参数。
- 返回:
- fitted_params键为字符串的字典
已拟合参数的字典,paramname : paramvalue 键值对包括
总是:此对象的所有已拟合参数,通过
get_param_names
获取,值是此对象对应键的已拟合参数值如果
deep=True
,还包含组件参数的键值对,组件参数索引为[componentname]__[paramname]
,componentname
的所有参数都以paramname
及其值的形式出现如果
deep=True
,还包含任意级别的组件递归,例如[componentname]__[componentcomponentname]__[paramname]
等。
- classmethod get_param_defaults()[source]#
获取对象的参数默认值。
- 返回:
- default_dict: dict[str, Any]
键是
cls
的所有在__init__
中定义了默认值的参数。值是默认值,如__init__
中定义。
- classmethod get_param_names(sort=True)[source]#
获取对象的参数名称。
- 参数:
- sort布尔型, 默认=True
是否按字母顺序(True)或在类
__init__
中出现的顺序(False)返回参数名称。
- 返回:
- param_names: list[str]
cls
的参数名称列表。如果sort=False
,则按其在类__init__
中出现的相同顺序排列。如果sort=True
,则按字母顺序排列。
- get_params(deep=True)[source]#
获取此对象的参数值字典。
- 参数:
- deep布尔型, 默认=True
是否返回组件的参数。
如果为
True
,将返回此对象的参数名称 : 值dict
,包括组件(=BaseObject
类型参数)的参数。如果为
False
,将返回此对象的参数名称 : 值dict
,但不包括组件的参数。
- 返回:
- params键为字符串的字典
参数字典,paramname : paramvalue 键值对包括
总是:此对象的所有参数,通过
get_param_names
获取,值是此对象对应键的参数值,值总是与构造时传递的值相同如果
deep=True
,还包含组件参数的键值对,组件参数索引为[componentname]__[paramname]
,componentname
的所有参数都以paramname
及其值的形式出现如果
deep=True
,还包含任意级别的组件递归,例如[componentname]__[componentcomponentname]__[paramname]
等。
- get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#
从实例中获取标签值,具有标签级别继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是对象构造后不更改的静态标志。get_tag
方法从实例中检索名称为tag_name
的单个标签值,同时考虑标签覆盖,优先级按降序排列如下:通过
set_tags
或clone_tags
在实例上设置的标签,
在实例构造时设置。
在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按照继承顺序。
- 参数:
- tag_namestr
要检索的标签的名称
- tag_value_default任意类型, 可选; 默认=None
如果未找到标签,则返回的默认/备用值
- raise_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()[source]#
从实例中获取标签,具有标签级别继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是对象构造后不更改的静态标志。get_tags
方法返回一个标签字典,其键是类或其任何父类中设置的_tags
属性的任何键,或者通过set_tags
或clone_tags
设置的标签的键。值是相应的标签值,覆盖优先级按降序排列如下:
通过
set_tags
或clone_tags
在实例上设置的标签,
在实例构造时设置。
在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按照继承顺序。
- 返回:
- collected_tagsdict
标签名称 : 标签值 对的字典。通过嵌套继承从
_tags
类属性收集,然后从_tags_dynamic
对象属性收集任何覆盖和新标签。
- is_composite()[source]#
检查对象是否由其他 BaseObjects 组成。
复合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回:
- composite: bool
对象是否包含任何参数,其值是
BaseObject
的后代实例。
- property is_fitted[source]#
fit
是否已被调用。检查对象的
_is_fitted` 属性,该属性应在对象构造期间初始化为 ``False
,并在调用对象的 fit 方法时设置为 True。- 返回:
- 布尔型
估计器是否已完成 fit。
- classmethod load_from_path(serial)[source]#
从文件位置加载对象。
- 参数:
- serialZipFile(path).open(“object) 的结果
- 返回:
- 反序列化
self
,得到cls.save(path)
在path
处的输出。
- 反序列化
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回:
- 反序列化
self
,得到cls.save(None)
输出的serial
。
- 反序列化
- predict(fh=None, X=None)[source]#
预测未来范围的时间序列。
- 所需状态
要求状态为“已拟合”,即
self.is_fitted=True
。
在 self 中访问
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
- 写入自身
如果传递了
fh
并且之前未传递过,则将fh
存储到self.fh
。
- 参数:
- fhint, list, 可强制转换为 pd.Index,或
ForecastingHorizon
,默认为 None 编码预测时间点的时间范围(forecasting horizon)。如果在
fit
中已传递,则不应再次传递。如果未在 fit 中传递,则必须传递,不是可选的如果 fh 不是 None 且类型不是 ForecastingHorizon,则通过调用 _check_fh 强制转换为 ForecastingHorizon。特别是,如果 fh 是 pd.Index 类型,则通过 ForecastingHorizon(fh, is_relative=False) 强制转换。
- X
sktime
兼容格式的时间序列, 可选 (默认=None) 用于预测的外生时间序列。应与
fit
中的y
具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引引用。
- fhint, list, 可强制转换为 pd.Index,或
- 返回:
- y_predsktime 兼容数据容器格式的时间序列
在
fh
处的点预测,索引与fh
相同。y_pred
的类型与最近传递的y
相同:Series
,Panel
,Hierarchical
科学类型,格式相同 (见上文)
- predict_interval(fh=None, X=None, coverage=0.9)[source]#
计算/返回预测区间预测。
如果
coverage
是可迭代的,将计算多个区间。- 所需状态
要求状态为“已拟合”,即
self.is_fitted=True
。
在 self 中访问
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
- 写入自身
如果传递了
fh
并且之前未传递过,则将fh
存储到self.fh
。
- 参数:
- fhint, list, 可强制转换为 pd.Index,或
ForecastingHorizon
,默认为 None 编码预测时间点的时间范围(forecasting horizon)。如果在
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
具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引引用。- coverage浮点型或包含唯一浮点值的列表, 可选 (默认=0.90)
预测区间名义覆盖度
- fhint, list, 可强制转换为 pd.Index,或
- 返回:
- pred_intpd.DataFrame
- 列具有多重索引:第一级是
fit
中y
的变量名, - 第二级是计算区间的覆盖率。
顺序与输入
coverage
中的顺序相同。
第三级是字符串“lower”或“upper”,表示区间的下限/上限。
- 行索引是
fh
,附加(上层)级别与实例级别相同, 来自
fit
中使用的y
,如果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.is_fitted=True
。
在 self 中访问
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
- 写入自身
如果传递了
fh
并且之前未传递过,则将fh
存储到self.fh
。
- 参数:
- fhint, list, 可强制转换为 pd.Index,或
ForecastingHorizon
,默认为 None 编码预测时间点的时间范围(forecasting horizon)。如果在
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
具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引引用。- marginal布尔型, 可选 (默认=True)
返回的分布是否按时间索引是边际分布
- fhint, list, 可强制转换为 pd.Index,或
- 返回:
- pred_distskpro BaseDistribution
预测分布,如果 marginal=True,则按时间点是边际分布;如果 marginal=False 且方法已实现,则为联合分布
- predict_quantiles(fh=None, X=None, alpha=None)[source]#
计算/返回分位数预测。
如果
alpha
是可迭代的,将计算多个分位数。- 所需状态
要求状态为“已拟合”,即
self.is_fitted=True
。
在 self 中访问
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
- 写入自身
如果传递了
fh
并且之前未传递过,则将fh
存储到self.fh
。
- 参数:
- fhint, list, 可强制转换为 pd.Index,或
ForecastingHorizon
,默认为 None 编码预测时间点的时间范围(forecasting horizon)。如果在
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
具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引引用。- alpha浮点型或包含唯一浮点值的列表, 可选 (默认=[0.05, 0.95])
计算分位数预测值时使用的概率或概率列表。
- fhint, list, 可强制转换为 pd.Index,或
- 返回:
- quantilespd.DataFrame
- 列具有多重索引:第一级是
fit
中y
的变量名, 第二级是传递给函数的 alpha 值。
- 行索引是
fh
,附加(上层)级别与实例级别相同, 来自
fit
中使用的y
,如果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 处计算
- 所需状态
要求状态为“已拟合”。如果已设置 fh,则必须与 y 的索引(pandas 或整数)相对应
- 在 self 中访问
以“_”结尾的已拟合模型属性。self.cutoff, self._is_fitted
- 写入自身
无。
- 参数:
- ysktime 兼容数据容器格式的时间序列
带有真实观测值的时间序列,用于计算残差。必须与预测的预期返回结果具有相同的类型、维度和索引。
如果为 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")
为 True,则X.index
必须同时包含fh
索引引用和y.index
。
- 返回:
- y_res
sktime
兼容数据容器格式的时间序列 在
fh` 处的预测残差,与 ``fh
具有相同的索引。y_res
的类型与最近传递的y
相同:Series
、Panel
、Hierarchical
scitype,格式相同(见上文)
- y_res
- predict_var(fh=None, X=None, cov=False)[source]#
计算/返回方差预测。
- 所需状态
要求状态为“已拟合”,即
self.is_fitted=True
。
在 self 中访问
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
- 写入自身
如果传递了
fh
并且之前未传递过,则将fh
存储到self.fh
。
- 参数:
- fhint, list, 可强制转换为 pd.Index,或
ForecastingHorizon
,默认为 None 编码预测时间点的时间范围(forecasting horizon)。如果在
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
具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引引用。- cov布尔型, 可选 (默认=False)
如果为 True,计算协方差矩阵预测值。如果为 False,计算边际方差预测值。
- fhint, list, 可强制转换为 pd.Index,或
- 返回:
- pred_varpd.DataFrame, 格式取决于
cov
变量 - 如果 cov=False
- 列名与
fit
/update
中传递的y
完全相同。 对于无名称格式,列索引将是 RangeIndex。
- 行索引是
fh
,附加级别与实例级别相同, 来自
fit
中使用的y
,如果fit
中使用的y
是 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))`` 后获得的对象相同。- 返回:
- 自身
类实例重置为初始化后的干净状态,但保留当前的超参数值。
- 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”,则将在当前工作目录 (cwd) 下创建 zip 文件
estimator.zip
。path=”/home/stored/estimator”,则 zip 文件
estimator.zip
将被
存储在
/home/stored/
中。- serialization_format: str, 默认 = “pickle”
用于序列化的模块。可用选项有“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
path
为 None - 内存中的序列化 self - 如果
path
是文件位置 - 指向该文件的 ZipFile
- 如果
- score(y, X=None, fh=None)[source]#
使用 MAPE (非对称) 评估预测与真实值之间的得分。
- 参数:
- ypd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D)
用于评分的时间序列
- fhint, list, 可强制转换为 pd.Index,或
ForecastingHorizon
,默认为 None 编码要预测的时间戳的预测范围。
- Xpd.DataFrame, 或 2D np.array, 可选 (默认=None)
用于评分的外生时间序列 如果 self.get_tag(“X-y-must-have-same-index”) 为 True,则 X.index 必须包含 y.index
- 返回:
- score浮点型
self.predict(fh, X) 相对于 y_test 的 MAPE 损失。
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- config_dictdict
config 名称 : config 值 对的字典。下面列出了有效的 config、值及其含义
- displaystr, “diagram” (默认), 或 “text”
jupyter 内核如何显示 self 的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool, 默认=True
打印 self 时是只列出与默认值不同的 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, 可选, 默认={} (不传递参数)
作为 config 传递给并行化后端的附加参数。有效键取决于
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”;要使用的 logger 名称。
“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 将默认为“不执行任何操作”,而不是“重新拟合所有已见数据”。
- 返回:
- selfself 的引用。
注意
更改对象状态,将 config_dict 中的 config 复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
此方法适用于简单的 skbase 对象以及复合对象。参数键字符串
<component>__<parameter>
可用于复合对象(即包含其他对象的对象),以访问组件<component>
中的<parameter>
。如果引用明确(例如,没有两个组件参数具有名称<parameter>
),则也可以使用字符串<parameter>
,而不带<component>__
。- 参数:
- **paramsdict
BaseObject 参数,键必须是
<component>__<parameter>
字符串。__
后缀可以作为完整字符串的别名,如果它们在 get_params 键中是唯一的。
- 返回:
- 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 值可在多次函数调用中获得可重现的输出。
- 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
派生,通常与输入不同
- 返回:
- selfself 的引用
- set_tags(**tag_dict)[source]#
将实例级别标签覆盖设置为给定值。
每个兼容
scikit-base
的对象都有一个标签字典,用于存储关于对象的元数据。标签是特定于实例
self
的键值对,它们是构建对象后不会更改的静态标志。它们可用于元数据检查或控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要设置的标签的值。set_tags
方法只能在对象的__init__
方法中调用,即在构建期间或通过__init__
直接调用之后。可以通过
get_tags
或get_tag
检查当前标签值。- 参数:
- **tag_dictdict
标签名称: 标签值 对的字典。
- 返回:
- Self
self 的引用。
- update(y, X=None, update_params=True)[source]#
更新截止值,并可选地更新拟合参数。
如果未实现估计器特定的 update 方法,默认的备用行为如下
update_params=True
: 拟合到目前为止所有观测到的数据update_params=False
: 仅更新 cutoff 并记住数据
- 所需状态
要求状态为“已拟合”,即
self.is_fitted=True
。
在 self 中访问
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
写入自身
将
self.cutoff
更新到y
中见到的最新索引。如果
update_params=True
,更新以 “_” 结尾的已拟合模型属性。
- 参数:
- ysktime 兼容数据容器格式的时间序列。
用于更新预测器的时间序列。
sktime
中的单个数据格式是所谓的 mtype 规范,每个 mtype 都实现了抽象的 科学类型。Series
科学类型 = 单个时间序列,普通预测。pd.DataFrame
,pd.Series
或np.ndarray
(1D 或 2D)Panel
科学类型 = 时间序列集合,全局/面板预测。pd.DataFrame
具有 2 级行MultiIndex
(instance, time)
,3D np.ndarray
(instance, variable, time)
,list
类型为Series
的pd.DataFrame
Hierarchical
科学类型 = 分层集合,用于分层预测。pd.DataFrame
具有 3 级或更多行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参见 mtype 词汇表。有关用法,请参见预测教程
examples/01_forecasting.ipynb
。- Xsktime 兼容格式的时间序列,可选 (默认为 None)。
用于更新模型拟合的外部时间序列。应与
y
具有相同的 scitype (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含y.index
。- update_paramsbool, 可选 (默认=True)
是否应更新模型参数。如果为
False
,则仅更新截止点 (cutoff),模型参数(例如系数)不更新。
- 返回:
- selfself 的引用
- update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#
在测试集上迭代进行预测和模型更新。
根据时间序列分割器
cv
进行数据回放,执行多个update
/predict
链式操作的简写。与以下操作相同(如果只有
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 并记住数据
- 所需状态
要求状态为“已拟合”,即
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 都实现了抽象的 科学类型。Series
科学类型 = 单个时间序列,普通预测。pd.DataFrame
,pd.Series
或np.ndarray
(1D 或 2D)Panel
科学类型 = 时间序列集合,全局/面板预测。pd.DataFrame
具有 2 级行MultiIndex
(instance, time)
,3D np.ndarray
(instance, variable, time)
,list
类型为Series
的pd.DataFrame
Hierarchical
科学类型 = 分层集合,用于分层预测。pd.DataFrame
具有 3 级或更多行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参见 mtype 词汇表。有关用法,请参见预测教程
examples/01_forecasting.ipynb
。- cv继承自 BaseSplitter 的时间序列交叉验证生成器,可选
例如,
SlidingWindowSplitter
或ExpandingWindowSplitter
;默认值为 ExpandingWindowSplitter,其中initial_window=1
且默认值为 y/X 中的独立数据点一个接一个地添加和预测,initial_window = 1
,step_length = 1
且fh = 1
- Xsktime 兼容格式的时间序列, 可选 (默认=None)
用于更新和预测的外部时间序列。应与
fit
中的y
具有相同的 scitype (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引引用。- update_paramsbool, 可选 (默认=True)
是否应更新模型参数。如果为
False
,则仅更新截止点 (cutoff),模型参数(例如系数)不更新。- reset_forecasterbool, 可选 (默认=True)
如果为 True,将不改变预测器的状态,即 update/predict 序列使用副本运行,self 的 cutoff、模型参数、数据内存不改变
如果为 False,将在 update/predict 序列运行时更新 self,就像直接调用 update/predict 一样
- 返回:
- y_pred汇总来自多个分割批次的点预测的对象
格式取决于总体预测的 (cutoff, 绝对 horizon) 对
如果绝对 horizon 点集合唯一:类型是 sktime 兼容数据容器格式的时间序列,输出中抑制 cutoff,与最近传递的 y 具有相同类型:Series, Panel, Hierarchical scitype,相同格式(见上文)
如果绝对 horizon 点集合不唯一:类型是 pandas DataFrame,行索引和列索引是时间戳。行索引对应于从中进行预测的 cutoff,列索引对应于预测的绝对 horizon。条目是该 (cutoff, horizon) 对的点预测。如果在该对没有进行预测,则条目为 nan
- update_predict_single(y=None, fh=None, X=None, update_params=True)[source]#
使用新数据更新模型并进行预测。
此方法对于在单个步骤中更新和进行预测非常有用。
如果未实现估计器特定的 update 方法,默认的备用行为是先 update,然后 predict。
- 所需状态
要求状态为“已拟合”(fitted)。
- 在 self 中访问
以 “_” 结尾的拟合模型属性。指向已见数据的指针,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,更新以 “_” 结尾的已拟合模型属性。
- 参数:
- ysktime 兼容数据容器格式的时间序列。
用于更新预测器的时间序列。
sktime
中的单个数据格式是所谓的 mtype 规范,每个 mtype 都实现了抽象的 科学类型。Series
科学类型 = 单个时间序列,普通预测。pd.DataFrame
,pd.Series
或np.ndarray
(1D 或 2D)Panel
科学类型 = 时间序列集合,全局/面板预测。pd.DataFrame
具有 2 级行MultiIndex
(instance, time)
,3D np.ndarray
(instance, variable, time)
,list
类型为Series
的pd.DataFrame
Hierarchical
科学类型 = 分层集合,用于分层预测。pd.DataFrame
具有 3 级或更多行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参见 mtype 词汇表。有关用法,请参见预测教程
examples/01_forecasting.ipynb
。- fhint, list, 可强制转换为 pd.Index,或
ForecastingHorizon
,默认为 None 编码预测时间点的时间范围(forecasting horizon)。如果在
fit
中已传递,则不应再次传递。如果未在 fit 中传递,则必须传递,不是可选的- Xsktime 兼容格式的时间序列, 可选 (默认=None)
用于更新和预测的外部时间序列。应与
fit
中的y
具有相同的 scitype (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含fh
索引引用。- update_paramsbool, 可选 (默认=True)
是否应更新模型参数。如果为
False
,则仅更新截止点 (cutoff),模型参数(例如系数)不更新。
- 返回:
- y_predsktime 兼容数据容器格式的时间序列
在
fh
处的点预测,索引与fh
相同。y_pred
的类型与最近传递的y
相同:Series
,Panel
,Hierarchical
科学类型,格式相同 (见上文)