PolynomialTrendForecaster#
- class PolynomialTrendForecaster(regressor=None, degree=1, with_intercept=True, prediction_intervals=False)[源代码]#
使用多项式趋势预测时间序列数据。
使用 `regressor` 参数指定的 `sklearn` 回归器,在提取多项式特征后,对时间序列值与其对应索引进行回归。与 `TrendForecaster` 相同,只是在开始时将 `regressor` 与应用于时间索引的转换步骤 `PolynomialFeatures(degree, with_intercept)` 组成了管道。
在 `fit` 中,对于输入时间序列 \((v_i, p(t_i)), i = 1, \dots, T\),其中 \(v_i\) 是值,\(t_i\) 是时间戳,\(p\) 是度为 `degree` 的多项式特征转换,并且根据 `with_intercept` 是否包含截距,拟合一个 `sklearn` 模型 \(v_i = f(p(t_i)) + \epsilon_i\),其中 \(f\) 是当 `regressor.fit` 传入 `X` = \(p(t_i)\) 的向量,`y` = \(v_i\) 的向量时拟合的模型。
在 `predict` 中,对于新的时间点 \(t_*\),预测 \(f(p(t_*))\),其中 \(f\) 是在上面 `fit` 中拟合的函数,\(p\) 是上面相同多项式特征转换。
`regressor` 的默认值是线性回归 = `sklearn` `LinearRegression`,使用默认参数。`degree` 的默认值是 1。
如果时间戳是 `pd.DatetimeIndex`,拟合系数的单位是从 1970 年开始的天数。如果时间戳是 `pd.PeriodIndex`,系数的单位是从 1970 年开始的(完整)周期数。
- 参数:
- regressorsklearn 回归器估计器对象,默认值 = None
定义回归模型类型。如果未设置,将默认为 sklearn.linear_model.LinearRegression
- degreeint, 默认值 = 1
多项式函数的次数
- with_interceptbool, 默认值=True
如果为 True,则包含一个所有多项式幂次为零的特征(即全为 1 的列,在线性模型中充当截距项)。
- prediction_intervalsbool, 默认值=False
是否计算预测区间。如果为 True,在拟合期间会进行额外计算,以便在预测期间计算预测区间。预测区间按照 [1] 的第 7.9 节计算。公式是标准的,基于拟合数据的 OLS 回归模型。 [1] 中的公式假设回归模型包含截距,并在 with_intercept 为 False 时进行适当修改。
- 属性:
- regressor_sklearn 回归器估计器对象
拟合的回归器对象。这是一个拟合好的 `sklearn` 管道,包含步骤 `PolynomialFeatures(degree, with_intercept)`,后接一个 `regressor` 的克隆。
参考资料
[1]Hyndman, Rob J. 和 George Athanasopoulos. Forecasting: principles
and practice, 第 3 版. OTexts: Melbourne, Australia. OTexts.com/fpp3.
示例
>>> from sktime.datasets import load_airline >>> from sktime.forecasting.trend import PolynomialTrendForecaster >>> y = load_airline() >>> forecaster = PolynomialTrendForecaster(degree=1) >>> forecaster.fit(y) PolynomialTrendForecaster(...) >>> y_pred = forecaster.predict(fh=[1,2,3])
方法
check_is_fitted
([method_name])检查估计器是否已拟合。
clone
()获取具有相同超参数和配置的对象的克隆。
clone_tags
(estimator[, tag_names])从另一个对象克隆标签作为动态覆盖。
create_test_instance
([parameter_set])使用第一个测试参数集构造类的实例。
create_test_instances_and_names
([parameter_set])创建所有测试实例的列表及其名称列表。
fit
(y[, X, fh])将预测器拟合到训练数据。
fit_predict
(y[, X, fh, X_pred])拟合并预测未来时间序列。
get_class_tag
(tag_name[, tag_value_default])从类获取类标签值,继承父类的标签级别。
从类获取类标签,继承父类的标签级别。
获取自身的配置标志。
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_setstr, 默认值 = “default”
要返回的测试参数集的名称,用于测试。如果没有为某个值定义特殊参数,将返回
"default"
集。
- 返回:
- paramsdict 或 dict 列表, 默认值 = {}
用于创建类测试实例的参数。每个 dict 都是构造一个“有趣的”测试实例的参数,例如
MyClass(**params)
或MyClass(**params[i])
创建一个有效的测试实例。create_test_instance
使用params
中的第一个(或唯一一个)字典。
- check_is_fitted(method_name=None)[源代码]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。在调用对象的fit
方法时,is_fitted
属性应设置为True
。如果不是,则引发
NotFittedError
异常。- 参数:
- method_namestr, 可选
调用此函数的方法的名称。如果提供,错误消息将包含此信息。
- 引发:
- NotFittedError
如果估计器尚未拟合。
- clone()[源代码]#
获取具有相同超参数和配置的对象的克隆。
克隆是具有相同超参数和配置但没有共享引用的不同对象,处于初始化后状态。此函数等同于返回
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)[源代码]#
从另一个对象克隆标签作为动态覆盖。
每个
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
对
self
的引用。
- classmethod create_test_instance(parameter_set='default')[源代码]#
使用第一个测试参数集构造类的实例。
- 参数:
- 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])
- namesstr 列表,长度与 objs 相同
第 i 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个,命名约定为
{cls.__name__}-{i}
,否则为{cls.__name__}
。
- property cutoff[源代码]#
Cut-off = 预测器的“当前时间”状态。
- 返回:
- cutoffpandas 兼容索引元素,或 None
如果截止值已设置,则是 pandas 兼容索引元素;否则为 None
- fit(y, X=None, fh=None)[源代码]#
将预测器拟合到训练数据。
- 状态更改
将状态更改为“已拟合”。
写入自身
设置以“_”结尾的已拟合模型属性,已拟合属性可通过
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 = 时间序列集合,全局/面板预测。带有 2 级行MultiIndex
(instance, time)
的pd.DataFrame
,3D np.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
中传递,不是可选的。- X
sktime
兼容格式的时间序列,可选 (默认值=None)。 用于拟合模型的外生时间序列。应与
y
具有相同的 scitype (Series
,Panel
, 或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含y.index
。
- y
- 返回:
- 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)
。- 状态更改
将状态更改为“已拟合”。
写入自身
设置以“_”结尾的已拟合模型属性,已拟合属性可通过
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
,3D np.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) 将其强制转换。
- X
sktime
兼容格式的时间序列,可选 (默认值=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()[源代码]#
获取自身的配置标志。
Configs 是
self
的键值对,通常用作控制行为的临时标志。get_config
返回动态配置,这些配置会覆盖默认配置。默认配置在类或其父类的类属性
_config
中设置,并被通过set_config
设置的动态配置覆盖。Configs 在
clone
或reset
调用中保留。- 返回:
- config_dictdict
配置名称 : 配置值对的字典。通过嵌套继承从 _config 类属性收集,然后是 _onfig_dynamic 对象属性中的任何覆盖和新标签。
- get_fitted_params(deep=True)[源代码]#
获取已拟合参数。
- 所需状态
要求状态为“已拟合”。
- 参数:
- 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()[源代码]#
获取对象的默认参数。
- 返回:
- default_dict: dict[str, Any]
键是
cls
中在__init__
中定义了默认值的所有参数。值是__init__
中定义的默认值。
- classmethod get_param_names(sort=True)[源代码]#
获取对象的参数名称。
- 参数:
- sortbool, 默认值=True
是否按字母顺序(True)或按它们在类
__init__
中出现的顺序(False)返回参数名称。
- 返回:
- param_names: list[str]
cls
的参数名称列表。如果sort=False
,顺序与它们在类__init__
中出现的顺序相同。如果sort=True
,按字母顺序排序。
- get_params(deep=True)[源代码]#
获取此对象的参数值字典。
- 参数:
- deepbool, 默认值=True
是否返回组件的参数。
如果为
True
,将为此对象返回一个参数名称 : 值字典,包括组件(=BaseObject
值参数)的参数。如果为
False
,将为此对象返回一个参数名称 : 值字典,但不包括组件的参数。
- 返回:
- 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)[源代码]#
从实例获取标签值,包括标签级别的继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储有关对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是对象构建后不会改变的静态标志。get_tag
方法从实例中检索名称为tag_name
的单个标签的值,考虑标签覆盖,按以下优先级从高到低排序通过
set_tags
或clone_tags
在实例上设置的标签,
在实例构建时。
在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序。
- 参数:
- tag_namestr
要检索的标签名称
- tag_value_default任意类型,可选;默认值=None
如果未找到标签,则为默认/备用值
- raise_errorbool
未找到标签时是否引发
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)[源代码]#
从文件位置加载对象。
- 参数:
- serialZipFile(path).open(“object) 的结果
- 返回:
- 反序列化的自身,其结果位于
path
,即cls.save(path)
的输出
- 反序列化的自身,其结果位于
- classmethod load_from_serial(serial)[源代码]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回:
- 反序列化的自身,其结果为
serial
,即cls.save(None)
的输出
- 反序列化的自身,其结果为
- predict(fh=None, X=None)[源代码]#
预测未来时间序列。
- 所需状态
要求状态为“已拟合”,即
self.is_fitted=True
。
访问自身
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
- 写入自身
如果传递了
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) 将其强制转换。
- X
sktime
兼容格式的时间序列,可选 (默认值=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.cutoff
,self.is_fitted
- 写入自身
如果传递了
fh
且之前未传递过,则将其存储到self.fh
中。
- 参数:
- fhint, list, 可强制转换为 pd.Index, 或
ForecastingHorizon
, 默认值=None 编码要预测时间戳的预测范围。如果在
fit
中已传递过,则不应再传递。如果在 fit 中未传递过,则必须传递,不是可选的。如果
fh
不是 None 且不是ForecastingHorizon
类型,则内部(通过_check_fh
)将其强制转换为ForecastingHorizon
。如果
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")
,则X.index
必须包含fh
索引引用。- coveragefloat 或 包含唯一值的 float 列表,可选 (默认值=0.90)
预测区间(s) 的名义覆盖率(s)
- fhint, list, 可强制转换为 pd.Index, 或
- 返回:
- pred_intpd.DataFrame
- 列具有多级索引:第一级是 fit 中 y 的变量名,
- 第二级是计算区间的覆盖率。
顺序与输入
coverage
中的顺序相同。
第三级是字符串“lower”或“upper”,分别表示区间的下限/上限。
- 行索引是 fh,额外的(上层)级别等于实例级别,
来自 fit 中看到的 y,如果 fit 中看到的 y 是 Panel 或 Hierarchical。
- 条目是区间的下限/上限预测,
对于列索引中的变量,在第二列索引中的名义覆盖率处,根据第三列索引是 lower/upper,对应于行索引。上限/下限区间预测等同于对于 coverage 中的 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.cutoff
,self.is_fitted
- 写入自身
如果传递了
fh
且之前未传递过,则将其存储到self.fh
中。
- 参数:
- fhint, list, 可强制转换为 pd.Index, 或
ForecastingHorizon
, 默认值=None 编码要预测时间戳的预测范围。如果在
fit
中已传递过,则不应再传递。如果在 fit 中未传递过,则必须传递,不是可选的。如果
fh
不是 None 且不是ForecastingHorizon
类型,则内部(通过_check_fh
)将其强制转换为ForecastingHorizon
。如果
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")
,则X.index
必须包含fh
索引引用。- marginalbool, 可选 (默认值=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.cutoff
,self.is_fitted
- 写入自身
如果传递了
fh
且之前未传递过,则将其存储到self.fh
中。
- 参数:
- fhint, list, 可强制转换为 pd.Index, 或
ForecastingHorizon
, 默认值=None 编码要预测时间戳的预测范围。如果在
fit
中已传递过,则不应再传递。如果在 fit 中未传递过,则必须传递,不是可选的。如果
fh
不是 None 且不是ForecastingHorizon
类型,则内部(通过_check_fh
)将其强制转换为ForecastingHorizon
。如果
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")
,则X.index
必须包含fh
索引引用。- alphafloat 或包含唯一值的 float 列表,可选 (default=[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.cutoff, self._is_fitted
- 写入自身
无。
- 参数:
- ysktime 兼容数据容器格式的时间序列
包含地面真实观测值的时间序列,用于计算残差。必须与 predict 的预期返回类型、维度和索引相同。
如果为 None,则使用目前为止看到的 y (self._y),特别是
如果之前进行过一次 fit 调用,则会产生样本内残差
如果 fit 需要
fh
,则它必须在 fit 中指向 y 的索引
- Xsktime 兼容格式的时间序列,可选 (default=None)
用于更新和预测的外部时间序列。应与
fit
中y
的 scitype(Series
、Panel
或Hierarchical
)相同。如果self.get_tag("X-y-must-have-same-index")
,则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.cutoff
,self.is_fitted
- 写入自身
如果传递了
fh
且之前未传递过,则将其存储到self.fh
中。
- 参数:
- fhint, list, 可强制转换为 pd.Index, 或
ForecastingHorizon
, 默认值=None 编码要预测时间戳的预测范围。如果在
fit
中已传递过,则不应再传递。如果在 fit 中未传递过,则必须传递,不是可选的。如果
fh
不是 None 且不是ForecastingHorizon
类型,则内部(通过_check_fh
)将其强制转换为ForecastingHorizon
。如果
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")
,则X.index
必须包含fh
索引引用。- covbool,可选 (default=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”的属性会保留。
配置属性,配置保持不变。也就是说,
get_config
在reset
前后的结果是相等的。
类和对象方法,以及类属性也不受影响。
等同于
clone
,不同之处在于reset
修改self
而不是返回一个新对象。在调用
self.reset()
后,self
在值和状态上等于构造函数调用 ``type(self)(**self.get_params(deep=False))`` 后获得的对象。- 返回:
- self
类实例重置为干净的后初始化状态,但保留当前超参数值。
- 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”,则会在当前工作目录创建 zip 文件
estimator.zip
。path=”/home/stored/estimator”,则会在
/home/stored/
中存储 zip 文件estimator.zip
。- 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, 可选 (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 名称 : config 值对的字典。有效的 config、值及其含义如下所示
- displaystr, “diagram” (默认), 或 “text”
jupyter 内核如何显示 self 的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool, default=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, 可选, 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_jobs
,在这种情况下必须将backend
作为backend_params
的键传递。如果未传递n_jobs
,则默认为-1
,其他参数将默认为joblib
默认值。“dask”:可以传递任何有效的
dask.compute
键,例如scheduler
“ray”:可以传递以下键
“ray_remote_args”:有效的
ray.init
键的字典- “shutdown_ray”:bool,默认=True;False 防止
ray
在并行化后关闭。
- “shutdown_ray”:bool,默认=True;False 防止
“logger_name”:str,默认=”ray”;要使用的日志记录器名称。
“mute_warnings”:bool,默认=False;如果为 True,则抑制警告
- remember_databool, default=True
在 fit 中是否存储 self._X 和 self._y,并在 update 中更新。如果为 True,则存储并更新 self._X 和 self._y。如果为 False,则不存储和更新 self._X 和 self._y。这在使用 save 时会减小序列化大小,但 update 将默认为“不做任何事情”而不是“重新拟合所有已看到的数据”。
- 返回:
- self指向 self 的引用。
注意
更改对象状态,将 config_dict 中的 configs 复制到 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]#
为自身设置 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,则仅设置 self 的 random_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_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.cutoff
,self.is_fitted
写入自身
将
self.cutoff
更新为y
中看到的最新索引。如果
update_params=True
,则更新以“_”结尾的已拟合模型属性。
- 参数:
- y
sktime
兼容数据容器格式的时间序列。 用于更新预测器的时间序列。
在
sktime
中,个体数据格式是所谓的 mtype 规范,每个 mtype 都实现了一个抽象的 scitype。Series
scitype = 单个时间序列,普通预测。pd.DataFrame
,pd.Series
, 或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合,全局/面板预测。带有 2 级行MultiIndex
(instance, time)
的pd.DataFrame
,3D np.ndarray
(instance, variable, time)
,或Series
类型pd.DataFrame
的list
Hierarchical
scitype = 分层集合,用于分层预测。带有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
的pd.DataFrame
有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅预测教程
examples/01_forecasting.ipynb
- X
sktime
兼容格式的时间序列,可选 (默认值=None)。 用于更新模型拟合的外部时间序列。应与
y
的 scitype(Series
、Panel
或Hierarchical
)相同。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含y.index
。- update_paramsbool, 可选 (default=True)
是否应更新模型参数。如果为
False
,则仅更新 cutoff,模型参数(例如,系数)不会更新。
- y
- 返回:
- self指向 self 的引用
- update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#
对测试集进行迭代预测和模型更新。
执行多个
update
/predict
链式调用的简写,基于时间分割器cv
进行数据回放。与以下操作相同(如果只有
y
,cv
非默认)self.update(y=cv.split_series(y)[0][0])
记住
self.predict()
(稍后在单个批次中返回)self.update(y=cv.split_series(y)[1][0])
记住
self.predict()
(稍后在单个批次中返回)等等
返回所有记住的预测
如果未实现特定于估计器的 update 方法,则默认回退如下:
update_params=True
:对迄今为止所有观测到的数据进行拟合update_params=False
:仅更新 cutoff 并记住数据
- 所需状态
要求状态为“已拟合”,即
self.is_fitted=True
。
访问自身
以“_”结尾的已拟合模型属性。
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 = 时间序列集合,全局/面板预测。带有 2 级行MultiIndex
(instance, time)
的pd.DataFrame
,3D np.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
;default = initial_window=1 的 ExpandingWindowSplitter,并且 defaults = y/X 中的单个数据点逐个添加和预测,initial_window = 1
,step_length = 1
和fh = 1
- Xsktime 兼容格式的时间序列,可选 (default=None)
用于更新和预测的外部时间序列。应与
fit
中y
的 scitype(Series
、Panel
或Hierarchical
)相同。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。- update_paramsbool, 可选 (default=True)
是否应更新模型参数。如果为
False
,则仅更新 cutoff,模型参数(例如,系数)不会更新。- reset_forecasterbool, 可选 (default=True)
如果为 True,将不会改变预测器的状态,即 update/predict 序列使用副本运行,并且 self 的 cutoff、模型参数、数据内存不会改变
如果为 False,将按照直接调用 update/predict 的方式在运行 update/predict 序列时更新 self
- y
- 返回:
- 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。
- 所需状态
要求状态为“已拟合”。
- 访问自身
以“_”结尾的已拟合模型属性。指向已看到数据的指针,self._y 和 self.X self.cutoff, self._is_fitted。如果 update_params=True,则更新以“_”结尾的模型属性。
- 写入自身
通过附加行,使用
y
和X
更新 self._y 和 self._X。将 self.cutoff 和 self._cutoff 更新为在y
中看到的最后一个索引。如果 update_params=True,更新以“_”结尾的已拟合模型属性。
- 参数:
- y
sktime
兼容数据容器格式的时间序列。 用于更新预测器的时间序列。
在
sktime
中,个体数据格式是所谓的 mtype 规范,每个 mtype 都实现了一个抽象的 scitype。Series
scitype = 单个时间序列,普通预测。pd.DataFrame
,pd.Series
, 或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合,全局/面板预测。带有 2 级行MultiIndex
(instance, time)
的pd.DataFrame
,3D np.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 兼容格式的时间序列,可选 (default=None)
用于更新和预测的外部时间序列。应与
fit
中y
的 scitype(Series
、Panel
或Hierarchical
)相同。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。- update_paramsbool, 可选 (default=True)
是否应更新模型参数。如果为
False
,则仅更新 cutoff,模型参数(例如,系数)不会更新。
- y
- 返回:
- y_predsktime 兼容数据容器格式的时间序列
在
fh
处的点预测,与fh
具有相同的索引。y_pred
的类型与最近传递的y
的类型相同:Series
,Panel
,Hierarchical
scitype,格式相同(见上文)。