PluginParamsForecaster#

class PluginParamsForecaster(param_est, forecaster, params=None, update_params=False)[source]#

将参数估计器的参数插入到预测器中。

fit 方法中,首先将 param_est 拟合到传入的数据上

  • fit 方法的 y 参数作为第一个参数传递给 param_est.fit

  • 如果 param_est.fit 方法有第二个参数,则 fit 方法的 X 参数作为第二个参数传递

  • 如果 param_est.fit 方法的剩余参数中有 fh,则 fit 方法的 fh 参数将作为 fh 传递

然后,使用所需/选定的参数调用 forecaster.set_params。已拟合的 param_est 的参数将传递给 forecaster,源/目标参数对由 selfparams 参数指定,详见下文。

接着,将 forecaster 拟合到 fit 中传入的数据上。

此后,行为与设置了这些参数的 forecaster 完全相同。update 行为由 update_params 参数控制。

示例:使用 param_est 进行季节性测试以确定 sp 参数;forecaster 是一个带有 sp 参数的预测器,例如 ExponentialSmoothing

参数:
param_estsktime 估计器对象,具有 fit 方法,继承自 BaseEstimator

例如,继承自 BaseParamFitter 或 forecaster 的估计器,这是一个“蓝图”估计器,调用 fit 时其状态不会改变

forecastersktime 预测器,即继承自 BaseForecaster 的估计器

这是一个“蓝图”估计器,调用 fit 时其状态不会改变

paramsNone, str, str 列表, 包含 str 值/键的 dict, 可选, 默认为 None

确定 param_est 中的哪些参数将插入到 forecaster 中。 None: param_est 的所有参数都将插入到 forecaster 中,仅插入 forecasterparam_est 中都存在的参数 str 列表: 列表中的参数将插入到同名参数中,仅插入 forecasterparam_est 中都存在的参数 str: 被视为一个包含单个字符串元素的 str 列表 dict: 名称为值的参数将插入到名称为键的参数中,仅插入 param_est 中存在键且 forecaster 中存在值的参数

update_paramsbool, 可选, 默认为 False

在 self.update 中是否更新由 param_est_ 拟合的参数

属性:
param_est_sktime 参数估计器,是 param_est 中估计器的克隆

调用 fit 时,此克隆将在 pipeline 中进行拟合

forecaster_sktime 预测器,是 forecaster 的克隆

调用 fit 时,此克隆将在 pipeline 中进行拟合

param_map_dict

fit 中使用的从 param_est_forecaster_ 的参数映射,过滤掉仅存在于其中一个的参数后

示例

>>> from sktime.datasets import load_airline
>>> from sktime.forecasting.naive import NaiveForecaster
>>> from sktime.param_est.plugin import PluginParamsForecaster
>>> from sktime.param_est.seasonality import SeasonalityACF
>>> from sktime.transformations.series.difference import Differencer
>>>
>>> y = load_airline()  
>>>
>>> # sp_est is a seasonality estimator
>>> # ACF assumes stationarity so we concat with differencing first
>>> sp_est = Differencer() * SeasonalityACF()  
>>>
>>> # fcst is a forecaster with a "sp" parameter which we want to tune
>>> fcst = NaiveForecaster()  
>>>
>>> # sp_auto is auto-tuned via PluginParamsForecaster
>>> sp_auto = PluginParamsForecaster(sp_est, fcst)  
>>>
>>> # fit sp_auto to data, predict, and inspect the tuned sp parameter
>>> sp_auto.fit(y, fh=[1, 2, 3])  
PluginParamsForecaster(...)
>>> y_pred = sp_auto.predict()  
>>> sp_auto.forecaster_.get_params()["sp"]  
12
>>> # shorthand ways to specify sp_auto, via dunder, does the same
>>> sp_auto = sp_est * fcst  
>>> # or entire pipeline in one go
>>> sp_auto = Differencer() * SeasonalityACF() * NaiveForecaster()  

使用字典将“foo”参数插入到“sp”中

>>> from sktime.param_est.fixed import FixedParams
>>> sp_plugin = PluginParamsForecaster(
...     FixedParams({"foo": 12}), NaiveForecaster(), params={"sp": "foo"}
... )  

方法

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_class_tags()

从类中获取类标签,带有父类的标签级别继承。

get_config()

获取 self 的配置标志。

get_fitted_params([deep])

获取已拟合参数。

get_param_defaults()

获取对象的参数默认值。

get_param_names([sort])

获取对象的参数名称。

get_params([deep])

获取此对象的参数值字典。

get_tag(tag_name[, tag_value_default, ...])

从实例获取标签值,带有标签级别继承和覆盖。

get_tags()

从实例获取标签,带有标签级别继承和覆盖。

get_test_params([parameter_set])

返回估计器的测试参数设置。

is_composite()

检查对象是否由其他 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])

将序列化的 self 保存到 bytes-like 对象或 (.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" 集。目前没有为 forecaster 定义保留值。

返回值:
paramsdict 或 dict 列表, 默认为 {}

用于创建类测试实例的参数。每个 dict 都是用于构建“有趣”测试实例的参数,即 MyClass(**params)MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个(或唯一)字典。

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 Trueis_fitted 属性应在调用对象的 fit 方法时设置为 True

如果不是,则引发 NotFittedError 异常。

参数:
method_namestr, 可选

调用此方法的名称。如果提供,错误消息将包含此信息。

抛出:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

获取具有相同超参数和配置的对象的克隆。

克隆是一个没有共享引用、处于初始化后状态的不同对象。此函数等同于返回 sklearn.cloneself

等同于构造 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_tagsget_tag 进行检查。

参数:
estimator:class:BaseObject 或其派生类的一个实例
tag_namesstr 或 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')[source]#

创建所有测试实例的列表以及它们的名称列表。

参数:
parameter_setstr, 默认为“default”

要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,则将返回 “default” 集。

返回值:
objscls 实例列表

第 i 个实例是 cls(**cls.get_test_params()[i])

namesstr 列表,长度与 objs 相同

第 i 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个,命名约定为 {cls.__name__}-{i},否则为 {cls.__name__}

property cutoff[source]#

截断点 = 预测器的“当前时间”状态。

返回值:
cutoffpandas 兼容的索引元素,或 None

如果已设置截断点,则为 pandas 兼容的索引元素;否则为 None

property fh[source]#

已传入的预测范围。

fit(y, X=None, fh=None)[source]#

将预测器拟合到训练数据。

状态改变

将状态更改为“已拟合”。

写入 self

  • 设置以“_”结尾的已拟合模型属性,已拟合属性可通过 get_fitted_params 检查。

  • self.is_fitted 标志设置为 True

  • self.cutoff 设置为在 y 中看到的最后一个索引。

  • 如果传入了 fh,则将 fh 存储到 self.fh

参数:
y采用 sktime 兼容数据容器格式的时间序列。

用于拟合预测器的时间序列。

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), 或 listSeries 类型 pd.DataFrame

  • Hierarchical scitype = 分层集合,用于分层预测。pd.DataFrame 具有三级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息,请参阅 mtype 的术语表。有关用法,请参阅预测教程 examples/01_forecasting.ipynb

fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认为 None

编码要预测的时间戳的预测范围。如果 self.get_tag("requires-fh-in-fit")True,则必须在 fit 中传入,不可选

X采用 sktime 兼容格式的时间序列,可选 (默认为 None)。

用于拟合模型的外生时间序列。应与 y 具有相同的 scitype (Series, PanelHierarchical)。如果 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)[source]#

拟合并预测未来范围的时间序列。

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

参数:
y采用 sktime 兼容数据容器格式的时间序列

用于拟合预测器的时间序列。

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), 或 listSeries 类型 pd.DataFrame

  • Hierarchical scitype = 分层集合,用于分层预测。pd.DataFrame 具有三级或更多级行 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) 进行强制转换

X采用 sktime 兼容格式的时间序列,可选 (默认为 None)。

用于拟合模型的外生时间序列。应与 y 具有相同的 scitype (Series, PanelHierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为真,则 X.index 必须包含 y.index

X_pred采用 sktime 兼容格式的时间序列,可选 (默认为 None)

用于预测的外生时间序列。如果传入,将用于 predict 而不是 X。应与 fit 中的 y 具有相同的 scitype (Series, PanelHierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为真,则 X.index 必须包含 fh 索引参考。

返回值:
y_pred采用 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 的标签的值,考虑了标签覆盖,优先级从高到低如下:

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签,

按继承顺序。

不考虑通过 set_tagsclone_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 属性的任何键。

值是相应的标签值,覆盖优先级从高到低如下:

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签,

按继承顺序。

实例可以根据超参数覆盖这些标签。

要检索可能包含实例覆盖的标签,请改用 get_tags 方法。

不考虑通过 set_tagsclone_tags 在实例上设置的动态标签覆盖。

若要包含动态标签的覆盖,请使用 get_tags

collected_tagsdict

标签名称 : 标签值 对的字典。通过嵌套继承从 _tags 类属性收集。不会被通过 set_tagsclone_tags 设置的动态标签覆盖。

get_config()[source]#

获取 self 的配置标志。

配置是 self 的键值对,通常用作控制行为的瞬时标志。

get_config 返回动态配置,这些配置会覆盖默认配置。

默认配置设置在类或其父类的类属性 _config 中,并被通过 set_config 设置的动态配置覆盖。

配置在 clonereset 调用下保留。

返回值:
config_dictdict

配置名称 : 配置值 对的字典。通过嵌套继承从 _config 类属性收集,然后是 _onfig_dynamic 对象属性中的任何覆盖和新标签。

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态

需要状态为“已拟合”。

参数:
deepbool, 默认为 True

是否返回组件的已拟合参数。

  • 如果为 True,将返回此对象的参数名称 : 值字典,包括可拟合组件 (= BaseEstimator 值的参数) 的已拟合参数。

  • 如果为 False,将返回此对象的参数名称 : 值字典,但不包括组件的已拟合参数。

返回值:
fitted_params键为 str 类型的 dict

已拟合参数的字典,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]#

获取对象的参数名称。

参数:
sortbool, 默认为 True

是按字母顺序返回参数名称 (True),还是按它们在类 __init__ 中出现的顺序返回 (False)。

返回值:
param_names: list[str]

cls 的参数名称列表。如果 sort=False,则与它们在类 __init__ 中出现的顺序相同。如果 sort=True,则按字母顺序排序。

get_params(deep=True)[source]#

获取此对象的参数值字典。

参数:
deepbool, 默认为 True

是否返回组件的参数。

  • 如果为 True,将返回此对象的参数名称 : 值 的 dict,包括组件 (= BaseObject 类型值的参数) 的参数。

  • 如果为 False,将返回此对象的参数名称 : 值 的 dict,但不包括组件的参数。

返回值:
params键为 str 类型的 dict

参数字典,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 的单个标签的值,考虑标签覆盖,优先级从高到低如下:

  1. 通过 set_tagsclone_tags 在实例上设置的标签,

在实例构造时。

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签,

按继承顺序。

参数:
tag_namestr

要检索的标签名称

tag_value_default任意类型,可选;默认为 None

如果未找到标签,则为默认/备用值

raise_errorbool

当未找到标签时是否引发 ValueError

返回值:
tag_valueAny

self 中名称为 tag_name 的标签的值。如果未找到,且 raise_error 为 True,则引发错误,否则返回 tag_value_default

抛出:
ValueError, 如果 raise_errorTrue

如果 tag_name 不在 self.get_tags().keys() 中,则会引发 ValueError

get_tags()[source]#

从实例获取标签,带有标签级别继承和覆盖。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储有关对象的元数据,或控制对象的行为。

标签是特定于实例 self 的键值对,它们是对象构造后不会改变的静态标志。

get_tags 方法返回一个标签字典,其键是类或其任何父类中设置的 _tags 属性的任何键,或通过 set_tagsclone_tags 设置的标签。

值是相应的标签值,覆盖优先级从高到低如下:

  1. 通过 set_tagsclone_tags 在实例上设置的标签,

在实例构造时。

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签,

按继承顺序。

返回值:
collected_tagsdict

标签名称 : 标签值 对的字典。通过嵌套继承从 _tags 类属性收集,然后是 _tags_dynamic 对象属性中的任何覆盖和新标签。

is_composite()[source]#

检查对象是否由其他 BaseObject 组成。

复合对象是一个包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。

返回值:
composite: bool

对象是否有任何参数的值是 BaseObject 的后代实例。

property is_fitted[source]#

是否已调用 fit

检查对象的 _is_fitted` 属性,该属性应在对象构造期间初始化为 ``False,并在调用对象的 fit 方法时设置为 True。

返回值:
bool

估计器是否已 fit

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回值:
反序列化 self 得到的结果在 path 处,是 cls.save(path) 的输出
classmethod load_from_serial(serial)[source]#

从序列化内存容器加载对象。

参数:
serialcls.save(None) 输出的第1个元素
返回值:
反序列化 self,得到 cls.save(None) 输出的 serial
predict(fh=None, X=None)[source]#

预测未来范围的时间序列。

所需状态

要求状态为“已拟合”,即 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 兼容格式的时间序列,可选 (default=None)

用于预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型(Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True,则 X.index 必须包含 fh 的索引参考。

返回值:
y_pred采用 sktime 兼容数据容器格式的时间序列

fh 上的点预测,与 fh 具有相同的索引。y_pred 的类型与最近传入的 y 类型相同: Series, Panel, Hierarchical scitype, 格式相同 (见上文)

predict_interval(fh=None, X=None, coverage=0.9)[source]#

计算/返回预测区间预测。

如果 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)。

  • 如果 fhint 或 int 的 array-like 对象,则解释为相对预测期,并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fhpd.Index 类型,则解释为绝对预测期,并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)

Xsktime 兼容格式的时间序列,可选 (default=None)

用于预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型(Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True,则 X.index 必须包含 fh 的索引参考。

coveragefloat 或包含唯一值的 float 列表,可选 (default=0.90)

预测区间(s) 的名义覆盖率

返回值:
pred_intpd.DataFrame
列具有多重索引:第一级是 fity 的变量名,
第二级是计算区间的覆盖率分数。

顺序与输入 coverage 中的顺序相同。

第三级是字符串“lower”或“upper”,表示区间的下限/上限。

行索引是 fh,如果 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(非 panel,非 hierarchical)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)。

  • 如果 fhint 或 int 的 array-like 对象,则解释为相对预测期,并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fhpd.Index 类型,则解释为绝对预测期,并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)

Xsktime 兼容格式的时间序列,可选 (default=None)

用于预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型(Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True,则 X.index 必须包含 fh 的索引参考。

marginalbool,可选 (default=True)

返回的分布是否按时间索引是边际分布

返回值:
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

写入 self

如果传入了 fh 且之前未传入过,则将 fh 存储到 self.fh

参数:
fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认为 None

预测期,编码了要预测的时间点。如果已在 fit 中传入,则不应再次传入。如果在 fit 中未传入,则必须传入,不是可选参数。

如果 fh 非 None 且类型不是 ForecastingHorizon,则会在内部被强制转换为 ForecastingHorizon(通过 _check_fh)。

  • 如果 fhint 或 int 的 array-like 对象,则解释为相对预测期,并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fhpd.Index 类型,则解释为绝对预测期,并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)

Xsktime 兼容格式的时间序列,可选 (default=None)

用于预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型(Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True,则 X.index 必须包含 fh 的索引参考。

alphafloat 或包含唯一值的 float 列表,可选 (default=[0.05, 0.95])

计算分位数预测的概率值或概率列表。

返回值:
quantilespd.DataFrame
列具有多重索引:第一级是 fity 的变量名,

第二级是传递给函数的 alpha 值。

行索引是 fh,如果 fit 中看到的 y 是 Panel 或 Hierarchical 类型,则包含等于实例级别的附加(上层)级别。

(无翻译,原文本似乎有误,直接跳过)

条目是分位数预测值,对应于列索引中的变量,

在第二列索引中的分位数概率下,对应于行索引。

predict_residuals(y=None, X=None)[source]#

返回时间序列预测的残差。

将计算在 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

无。

参数:
y采用 sktime 兼容数据容器格式的时间序列

带有真实观测值的时间序列,用于计算残差。必须与 predict 预期的返回类型、维度和索引相同。

如果为 None,则使用到目前为止看到的 y (self._y),特别是

  • 如果之前只有一次 fit 调用,则产生样本内残差

  • 如果 fit 需要 fh,则它必须指向 fit 中 y 的索引

Xsktime 兼容格式的时间序列,可选 (default=None)

用于更新和预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型(Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True,则 X.index 必须包含 fh 的索引参考和 y.index

返回值:
y_ressktime 兼容数据容器格式的时间序列

fh 处的预测残差,具有与 fh 相同的索引。y_res 与最近传入的 y 类型相同:Series, Panel, Hierarchical 科学类型,格式相同(见上文)。

predict_var(fh=None, X=None, cov=False)[source]#

计算/返回方差预测。

所需状态

要求状态为“已拟合”,即 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)。

  • 如果 fhint 或 int 的 array-like 对象,则解释为相对预测期,并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fhpd.Index 类型,则解释为绝对预测期,并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)

Xsktime 兼容格式的时间序列,可选 (default=None)

用于预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型(Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True,则 X.index 必须包含 fh 的索引参考。

covbool,可选 (default=False)

如果为 True,则计算协方差矩阵预测。如果为 False,则计算边际方差预测。

返回值:
pred_varpd.DataFrame,格式取决于 cov 变量
如果 cov=False
列名与在 fit/update 中传入的 y 的列名完全相同。

对于无名格式,列索引将是 RangeIndex。

行索引是 fh,包含等于实例级别的附加级别,

(无翻译,原文本似乎有误,直接跳过)

条目是方差预测值,对应于列索引中的变量。给定变量和 fh 索引的方差预测是在给定观测数据下,该变量和索引的预测方差。

(无翻译,原文本似乎有误,直接跳过)

如果 cov=True
列索引是多重索引:第一级是变量名(如上文)

第二级是 fh

行索引是 fh,包含等于实例级别的附加级别,

(无翻译,原文本似乎有误,直接跳过)

条目是(协)方差预测值,对应于列索引中的变量,以及

行索引和列索引中时间索引之间的协方差。

注意:不返回不同变量之间的协方差预测。

reset()[source]#

将对象重置到干净的初始化后状态。

self 设置为构造函数调用后直接所处的状态,保持相同的超参数。set_config 设置的配置值也会保留。

一个 reset 调用会删除所有对象属性,除了

  • 超参数 = __init__ 的参数并写入到 self,例如 self.paramname,其中 paramname__init__ 的参数。

  • 包含双下划线字符串“__”的对象属性。例如,名为“__myattr”的属性会保留。

  • config 属性,config 会保留不变。也就是说,reset 前后 get_config 的结果是相等的。

类和对象方法以及类属性也不受影响。

等同于 clone,但区别在于 reset 修改 self 而非返回新对象。

在调用 self.reset() 后,self 在值和状态上等于构造函数调用 type(self)(**self.get_params(deep=False)) 后获得的对象。

返回值:
self

类实例重置为干净的初始化后状态,但保留当前超参数值。

save(path=None, serialization_format='pickle')[source]#

将序列化的 self 保存到 bytes-like 对象或 (.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",则会在 /home/stored/ 中存储一个 zip 文件 estimator.zip

(无翻译,原文本似乎有误,直接跳过)

serialization_format: str, default = “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, 可选 (default=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_dictdict

配置名称:配置值 对的字典。有效的 config、值及其含义如下所述:

displaystr,“diagram”(默认),或“text”

jupyter kernel 如何显示 self 的实例

  • “diagram” = html 方框图表示

  • “text” = 字符串打印输出

print_changed_onlybool, default=True

打印 self 时是否仅列出与默认值不同的参数(True),或列出所有参数名和值(False)。不嵌套,即仅影响 self,不影响组件估计器。

warningsstr,“on”(默认),或“off”

是否触发警告,仅影响来自 sktime 的警告

  • “on” = 将触发来自 sktime 的警告

  • “off” = 将不触发来自 sktime 的警告

backend:parallelstr, 可选, default=”None”

广播/向量化时用于并行的后端,选项之一:

  • “None”: 顺序执行循环,简单的列表推导式

  • “loky”, “multiprocessing” 和 “threading”: 使用 joblib.Parallel

  • “joblib”: 自定义和第三方 joblib 后端,例如 spark

  • “dask”: 使用 dask,需要在环境中安装 dask

  • “ray”: 使用 ray,需要在环境中安装 ray

backend:parallel:paramsdict, 可选, default={} (未传递参数)

作为配置传递给并行化后端的额外参数。有效键取决于 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_jobsbackend 在这种情况下必须作为 backend_params 的一个键传递。如果未传递 n_jobs,则默认为 -1,其他参数将使用 joblib 默认值。

  • “dask”: 可以传递 dask.compute 的任何有效键,例如 scheduler

  • “ray”: 可以传递以下键:

    • “ray_remote_args”: ray.init 的有效键字典

    • “shutdown_ray”: bool, default=True; False 防止 ray 在并行化后关闭。

      (无翻译,原文本似乎有误,直接跳过)

    • “logger_name”: str, default=”ray”; 要使用的 logger 名称。

    • “mute_warnings”: bool, default=False; 如果为 True,则抑制警告。

remember_databool, default=True

是否在 fit 中存储 self._X 和 self._y 并在 update 中更新。如果为 True,则 self._X 和 self._y 被存储和更新。如果为 False,则 self._X 和 self._y 不被存储和更新。这在使用 save 时会减小序列化大小,但 update 将默认为“不执行任何操作”,而不是“根据所有已见数据重新拟合”。

返回值:
self指向 self 的引用。

注意

更改对象状态,将 config_dict 中的 config 复制到 self._config_dynamic。

set_params(**params)[source]#

设置此对象的参数。

此方法适用于简单的 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')[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,default=None

用于控制随机整数生成的伪随机数生成器。传入 int 可在多次函数调用中获得可重复输出。

deepbool, 默认为 True

是否在 skbase 对象值参数中设置随机状态,即组件估计器。

  • 如果为 False,则仅设置 selfrandom_state 参数(如果存在)。

  • 如果为 True,则也会设置组件对象中的 random_state 参数。

self_policystr,{“copy”, “keep”, “new”} 之一,default=”copy”
  • “copy” : self.random_state 设置为输入的 random_state

  • “keep” : self.random_state 保持不变

  • “new” : self.random_state 设置为一个新的随机状态,

从输入的 random_state 派生,通常与它不同。

返回值:
self指向 self 的引用
set_tags(**tag_dict)[source]#

将实例级别标签覆盖设置为给定值。

每个 scikit-base 兼容对象都有一个标签字典,用于存储有关对象的元数据。

标签是特定于实例 self 的键值对,它们是静态标志,对象构造后不会更改。它们可用于元数据检查或控制对象行为。

set_tags 将动态标签覆盖设置为 tag_dict 中指定的值,其中键是标签名称,字典值是要设置的标签值。

set_tags 方法应仅在对象的 __init__ 方法中(构造期间)或构造后直接通过 __init__ 调用。

当前标签值可以通过 get_tagsget_tag 进行检查。

参数:
**tag_dictdict

标签名:标签值 对的字典。

返回值:
Self

指向 self 的引用。

update(y, X=None, update_params=True)[source]#

更新截断值,以及可选地更新已拟合参数。

如果没有实现特定于估计器的 update 方法,默认回退如下:

  • update_params=True:拟合到目前为止所有观测到的数据

  • update_params=False:仅更新截止点并记住数据

所需状态

要求状态为“已拟合”,即 self.is_fitted=True

访问 self 中的以下属性:

  • 以“_”结尾的已拟合模型属性。

  • self.cutoff, self.is_fitted

写入 self

  • self.cutoff 更新为 y 中看到的最新索引。

  • 如果 update_params=True,则更新以“_”结尾的已拟合模型属性。

参数:
y采用 sktime 兼容数据容器格式的时间序列。

用于更新预测器的时间序列。

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), 或 listSeries 类型 pd.DataFrame

  • Hierarchical scitype = 分层集合,用于分层预测。pd.DataFrame 具有三级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息,请参阅 mtype 的术语表。有关用法,请参阅预测教程 examples/01_forecasting.ipynb

X采用 sktime 兼容格式的时间序列,可选 (默认为 None)。

用于更新模型拟合的外生时间序列。应与 y 具有相同的科学类型Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True,则 X.index 必须包含 y.index

update_paramsbool,可选 (default=True)

是否更新模型参数。如果为 False,则仅更新截止点,模型参数(例如系数)不更新。

返回值:
self指向 self 的引用
update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#

在测试集上迭代更新模型并进行预测。

执行多次 update / predict 的快捷方式,基于时间分割器 cv 进行数据回放。

与以下操作相同(如果只有 ycv 非默认):

  1. self.update(y=cv.split_series(y)[0][0])

  2. 记住 self.predict()(稍后以单批次返回)

  3. self.update(y=cv.split_series(y)[1][0])

  4. 记住 self.predict()(稍后以单批次返回)

  5. 等等

  6. 返回所有记住的预测

如果没有实现特定于估计器的 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,则不更新状态。

参数:
y采用 sktime 兼容数据容器格式的时间序列。

用于更新预测器的时间序列。

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), 或 listSeries 类型 pd.DataFrame

  • Hierarchical scitype = 分层集合,用于分层预测。pd.DataFrame 具有三级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息,请参阅 mtype 的术语表。有关用法,请参阅预测教程 examples/01_forecasting.ipynb

cv继承自 BaseSplitter 的时间序列交叉验证生成器,可选

例如,SlidingWindowSplitterExpandingWindowSplitter;默认值 = 具有 initial_window=1 的 ExpandingWindowSplitter 和默认值 = y/X 中的单个数据点被逐个添加和预测,initial_window = 1, step_length = 1fh = 1

Xsktime 兼容格式的时间序列,可选 (default=None)

用于更新和预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型(Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True,则 X.index 必须包含 fh 的索引参考。

update_paramsbool,可选 (default=True)

是否更新模型参数。如果为 False,则仅更新截止点,模型参数(例如系数)不更新。

reset_forecasterbool,可选 (default=True)
  • 如果为 True,则不会更改预测器的状态,即 update/predict 序列在副本上运行,self 的截止点、模型参数、数据内存不发生变化

  • 如果为 False,则 update/predict 序列运行时会更新 self,就像直接调用 update/predict 一样

返回值:
y_pred汇总多个分割批次点预测的对象

格式取决于预测的(截止点,绝对预测期)对的集合

  • 如果绝对预测点集合是唯一的:类型是 sktime 兼容数据容器格式的时间序列,输出中省略了截止点,与最近传入的 y 类型相同:Series, Panel, Hierarchical 科学类型,格式相同(见上文)

  • 如果绝对预测点集合不唯一:类型是一个 pandas DataFrame,行索引和列索引都是时间戳,行索引对应于从中进行预测的截止点,列索引对应于进行预测的绝对预测期,条目是该(截止点,预测期)对的点预测值,如果在该对处没有进行预测,则条目为 nan

update_predict_single(y=None, fh=None, X=None, update_params=True)[source]#

使用新数据更新模型并进行预测。

此方法用于在一个步骤中更新并进行预测。

如果没有实现特定于估计器的 update 方法,默认的回退操作是先 update,然后 predict。

所需状态

需要状态为“已拟合”。

访问 self 中的以下属性:

以“_”结尾的已拟合模型属性。指向已见数据的指针,self._y 和 self.X。self.cutoff, self._is_fitted。如果 update_params=True,则还有以“_”结尾的模型属性。

写入 self

通过追加行的方式,用 yX 更新 self._y 和 self._X。将 self.cutoff 和 self._cutoff 更新为 y 中看到的最后一个索引。如果 update_params=True,

更新以“_”结尾的已拟合模型属性。

参数:
y采用 sktime 兼容数据容器格式的时间序列。

用于更新预测器的时间序列。

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), 或 listSeries 类型 pd.DataFrame

  • Hierarchical scitype = 分层集合,用于分层预测。pd.DataFrame 具有三级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息,请参阅 mtype 的术语表。有关用法,请参阅预测教程 examples/01_forecasting.ipynb

fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认为 None

预测期,编码了要预测的时间点。如果已在 fit 中传入,则不应再次传入。如果在 fit 中未传入,则必须传入,不是可选参数。

Xsktime 兼容格式的时间序列,可选 (default=None)

用于更新和预测的外生时间序列。应与 fit 中的 y 具有相同的科学类型(Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True,则 X.index 必须包含 fh 的索引参考。

update_paramsbool,可选 (default=True)

是否更新模型参数。如果为 False,则仅更新截止点,模型参数(例如系数)不更新。

返回值:
y_pred采用 sktime 兼容数据容器格式的时间序列

fh 上的点预测,与 fh 具有相同的索引。y_pred 的类型与最近传入的 y 类型相同: Series, Panel, Hierarchical scitype, 格式相同 (见上文)