StatsForecastAutoTBATS#
- class StatsForecastAutoTBATS(seasonal_periods: int | list[int], use_boxcox: bool | None = None, use_trend: bool | None = None, use_damped_trend: bool | None = None, use_arma_errors: bool =True, bc_lower_bound: float =0.0, bc_upper_bound: float =1.0)[source]#
StatsForecast TBATS 模型。
直接接口到 `statsforecast.models.AutoTBATS`,来自 Nixtla 的 `statsforecast` [1]。
自动从参数 `use_boxcox`、`use_trend`、`use_damped_trend` 和 `use_arma_errors` 的所有可行组合中选择最佳 TBATS 模型。选择使用 AIC 进行。
`use_arma_errors` 的默认值为 `True`,因为它允许评估带有和不带有 ARMA 误差的模型。
- 参数:
- **seasonal_periods**int 或 int 列表。
每单位时间内的观测数量。例如:24 小时数据。
- **use_boxcox**布尔值 (默认=None)
是否使用 Box-Cox 变换。默认情况下两者都尝试。
- **use_trend**布尔值 (默认=None)
是否使用趋势分量。默认情况下两者都尝试。
- **use_damped_trend**布尔值 (默认=None)
是否抑制趋势分量。默认情况下两者都尝试。
- **use_arma_errors**布尔值 (默认=True)
是否使用 ARMA 误差。默认值为 True,这将评估两种模型。
- **bc_lower_bound**浮点数 (默认=0.0)
Box-Cox 变换的下限。
- **bc_upper_bound**浮点数 (默认=1.0)
Box-Cox 变换的上限。
- 属性:
另请参阅
BATS
TBATS
参考
方法
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_tags
()从实例中获取标签,带有标签级别继承和覆盖。
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])将序列化的自身保存到字节类对象或 (.zip) 文件。
score
(y[, X, fh])使用 MAPE(非对称)根据真实值对预测进行评分。
set_config
(**config_dict)将配置标志设置为给定值。
set_params
(**params)设置此对象的参数。
set_random_state
([random_state, deep, ...])为自身设置 random_state 伪随机种子参数。
set_tags
(**tag_dict)将实例级别标签覆盖设置为给定值。
update
(y[, X, update_params])更新截止点值,并可选地更新已拟合参数。
update_predict
(y[, cv, X, update_params, ...])在测试集上迭代进行预测并更新模型。
update_predict_single
([y, fh, X, update_params])使用新数据更新模型并进行预测。
- classmethod get_test_params(parameter_set='default')[source]#
返回估算器的测试参数设置。
- 参数:
- **parameter_set**str,默认=”default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回 `"default"` 集。当前预测器没有保留值。
- 返回:
- **params**dict 或 dict 列表,默认 = {}
用于创建类测试实例的参数。每个 dict 都是构建一个“有趣的”测试实例的参数,即 `MyClass(**params)` 或 `MyClass(**params[i])` 创建一个有效的测试实例。`create_test_instance` 使用 `params` 中的第一个(或唯一一个)字典。
- check_is_fitted(method_name=None)[source]#
检查估算器是否已拟合。
检查 `_is_fitted` 属性是否存在且为 `True`。对象的 `fit` 方法调用中应将 `is_fitted` 属性设置为 `True`。
如果不是,则引发 `NotFittedError` 异常。
- 参数:
- **method_name**str,可选
调用此方法的函数的名称。如果提供,错误消息将包含此信息。
- 引发:
- 未拟合错误
如果估算器尚未拟合。
- clone()[source]#
获取具有相同超参数和配置的对象克隆。
克隆是一个不同的对象,没有共享引用,处于初始化后状态。此函数等效于返回 `self` 的 `sklearn.clone`。
等效于构建 `type(self)` 的新实例,使用 `self` 的参数,即 `type(self)(**self.get_params(deep=False))`。
如果在 `self` 上设置了配置,则克隆也将具有与原始对象相同的配置,等效于调用 `cloned_self.set_config(**self.get_config())`。
其值也等效于调用 `self.reset`,区别在于 `clone` 返回一个新对象,而不是像 `reset` 那样改变 `self`。
- 引发:
- 如果由于错误的 `__init__` 导致克隆不符合要求,则会引发 RuntimeError。
- clone_tags(estimator, tag_names=None)[source]#
从另一个对象克隆标签作为动态覆盖。
每个 `scikit-base` 兼容的对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。
标签是特定于实例 `self` 的键值对,它们是静态标志,在对象构建后不会改变。
`clone_tags` 从另一个对象 `estimator` 设置动态标签覆盖。
`clone_tags` 方法只能在对象的 `__init__` 方法中调用,即在构建期间或通过 `__init__` 直接构建之后。
动态标签被设置为 `estimator` 中标签的值,其名称在 `tag_names` 中指定。
`tag_names` 的默认设置是将 `estimator` 中的所有标签写入 `self`。
当前的标签值可以通过 `get_tags` 或 `get_tag` 进行检查。
- 参数:
- **estimator**:class:BaseObject 或派生类的实例
- **tag_names**str 或 str 列表,默认 = None
要克隆的标签名称。默认值(`None`)克隆 `estimator` 中的所有标签。
- 返回:
- 自身
对 `self` 的引用。
- classmethod create_test_instance(parameter_set='default')[source]#
使用第一个测试参数集构建类的实例。
- 参数:
- **parameter_set**str,默认=”default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回 `“default”` 集。
- 返回:
- **instance**具有默认参数的类实例
- classmethod create_test_instances_and_names(parameter_set='default')[source]#
创建所有测试实例的列表及其名称列表。
- 参数:
- **parameter_set**str,默认=”default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回 `“default”` 集。
- 返回:
- **objs**cls 实例列表
第 i 个实例是 `cls(**cls.get_test_params()[i])`
- **names**str 列表,与 objs 长度相同
第 i 个元素是测试中 objs 的第 i 个实例的名称。命名约定为 `{cls.__name__}-{i}`(如果实例多于一个),否则为 `{cls.__name__}`
- property cutoff[source]#
截止点 = 预测器的“当前时间”状态。
- 返回:
- **cutoff**pandas 兼容的索引元素,或 None
如果已设置截止点,则为 pandas 兼容的索引元素;否则为 None
- fit(y, X=None, fh=None)[source]#
将预测器拟合到训练数据。
- 状态改变
将状态改变为“已拟合”。
写入自身
设置以“_”结尾的已拟合模型属性,已拟合属性可通过 `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 = 时间序列集合,全局/面板预测。带有 2 级行 `MultiIndex` `(实例, 时间)` 的 `pd.DataFrame`,`3D np.ndarray` `(实例, 变量, 时间)`,`Series` 类型的 `pd.DataFrame` 列表
`Hierarchical` scitype = 分层集合,用于分层预测。带有 3 级或更多级行 `MultiIndex` `(层级_1, ..., 层级_n, 时间)` 的 `pd.DataFrame`
有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅预测教程 `examples/01_forecasting.ipynb`
- **fh**int, 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`。
- 返回:
- **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)` 相同。
- 状态改变
将状态改变为“已拟合”。
写入自身
设置以“_”结尾的已拟合模型属性,已拟合属性可通过 `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` `(实例, 时间)` 的 `pd.DataFrame`,`3D np.ndarray` `(实例, 变量, 时间)`,`Series` 类型的 `pd.DataFrame` 列表
`Hierarchical` scitype = 分层集合,用于分层预测。带有 3 级或更多级行 `MultiIndex` `(层级_1, ..., 层级_n, 时间)` 的 `pd.DataFrame`
有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅预测教程 `examples/01_forecasting.ipynb`
- **fh**int, 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_pred**sktime 兼容格式的时间序列,可选 (默认=None)
预测中使用的外生时间序列。如果传递,将在 predict 中使用,而不是 X。应与 `fit` 中的 `y` 具有相同的 scitype(`Series`、`Panel` 或 `Hierarchical`)。如果 `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` 的标签值,考虑了标签覆盖,优先级从高到低如下:
在类的 `_tags` 属性中设置的标签。
在父类的 `_tags` 属性中设置的标签,
按继承顺序排列。
不考虑在实例上通过 `set_tags` 或 `clone_tags` 设置的动态标签覆盖。
要检索带有潜在实例覆盖的标签值,请改用 `get_tag` 方法。
- 参数:
- **tag_name**str
标签值的名称。
- **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_dict**dict
配置名称: 配置值 对的字典。通过嵌套继承从 _config 类属性中收集,然后从 _config_dynamic 对象属性收集任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取已拟合参数。
- 所需状态
要求状态为“已拟合”。
- 参数:
- **deep**布尔值,默认=True
是否返回组件的已拟合参数。
如果为 True,将返回此对象的参数名称 : 值字典,包括可拟合组件(= BaseEstimator 值参数)的已拟合参数。
如果为 False,将返回此对象的参数名称 : 值字典,但不包括组件的已拟合参数。
- 返回:
- **fitted_params**键为 str 的 dict
已拟合参数字典,paramname : paramvalue 键值对包含
始终:此对象的所有已拟合参数,如同通过 `get_param_names` 获取的一样,值是此对象该键的已拟合参数值
如果 `deep=True`,还包含组件参数的键/值对,组件参数的索引格式为 `[组件名称]__[参数名称]`,`组件名称` 的所有参数都以 `参数名称` 及其值的形式出现
如果 `deep=True`,还包含任意级别的组件递归,例如 `[组件名称]__[组件组件名称]__[参数名称]` 等
- 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`,将返回此对象的参数名称 : 值字典,包括组件(= `BaseObject` 值参数)的参数。
如果为 `False`,将返回此对象的参数名称 : 值字典,但不包括组件的参数。
- 返回:
- **params**键为 str 的 dict
参数字典,paramname : paramvalue 键值对包含
始终:此对象的所有参数,如同通过 `get_param_names` 获取的一样,值是此对象该键的参数值,值始终与构造时传递的值相同
如果 `deep=True`,还包含组件参数的键/值对,组件参数的索引格式为 `[组件名称]__[参数名称]`,`组件名称` 的所有参数都以 `参数名称` 及其值的形式出现
如果 `deep=True`,还包含任意级别的组件递归,例如 `[组件名称]__[组件组件名称]__[参数名称]` 等
- 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_name**str
要检索的标签名称
- **tag_value_default**任意类型,可选;默认=None
如果未找到标签,则为默认/备用值
- **raise_error**布尔值
未找到标签时是否引发 `ValueError` 异常
- 返回:
- **tag_value**任意类型
`self` 中 `tag_name` 标签的值。如果未找到,并且 `raise_error` 为 True,则引发异常,否则返回 `tag_value_default`。
- 引发:
- ValueError,如果 `raise_error` 为 `True`。
如果 `tag_name` 不在 `self.get_tags().keys()` 中,则引发 `ValueError` 异常。
- get_tags()[source]#
从实例中获取标签,带有标签级别继承和覆盖。
每个 `scikit-base` 兼容的对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。
标签是特定于实例 `self` 的键值对,它们是静态标志,在对象构建后不会改变。
The
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。- 返回:
- bool
估计器是否已
fit
。
- classmethod load_from_path(serial)[source]#
从文件位置加载对象。
- 参数:
- serialZipFile(path).open(“object) 的结果
- 返回:
- 反序列化后的 self,其输出位于
path
,即cls.save(path)
的输出。
- 反序列化后的 self,其输出位于
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第 1 个元素
- serial
- 返回:
- 反序列化后的 self,其输出为
serial
,即cls.save(None)
的输出。
- 反序列化后的 self,其输出为
- predict(fh=None, X=None)[source]#
预测未来范围的时间序列。
- 所需状态
要求状态为“已拟合”,即
self.is_fitted=True
。
在 self 中访问
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
- 写入自身
如果传入了
fh
且之前未传入,则将fh
存储到self.fh
。
- 参数:
- **fh**int, 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")
为 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
- 写入自身
如果传入了
fh
且之前未传入,则将fh
存储到self.fh
。
- 参数:
- **fh**int, list, 可强制转换为 pd.Index,或 `ForecastingHorizon`,默认=None
编码要预测时间戳的预测范围。如果在
fit
中已传入,则不应再次传入。如果在 fit 中未传入,则必须传入,非可选如果
fh
不是 None 且不是ForecastingHorizon
类型,它将在内部被强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或int
数组类型,则被解释为相对预测期,并强制转换为相对ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,则被解释为绝对预测期,并强制转换为绝对ForecastingHorizon(fh, is_relative=False)
。
- 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)
预测区间(s) 的名义覆盖率。
- 返回:
- pred_intpd.DataFrame
- 列具有多级索引:第一级是 `fit` 中 y 的变量名,
- 第二级是计算区间的覆盖率分数。
顺序与输入
coverage
中的顺序相同。
第三级是字符串“lower”或“upper”,表示区间下限/上限。
- 行索引是 fh,附加的(上层)级别等于实例级别,
来自
fit
中看到的 y,如果fit
中看到的 y 是 Panel 或 Hierarchical。- 条目是区间下限/上限的预测值,
对于列索引中的变量,在第二列索引中的名义覆盖率处,取决于第三列索引是 lower/upper,对应于行索引。区间上限/下限预测值等同于在 alpha = 0.5 - c/2, 0.5 + c/2 (c 在 coverage 中) 处的分位数预测值。
- 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
。
- 参数:
- **fh**int, list, 可强制转换为 pd.Index,或 `ForecastingHorizon`,默认=None
编码要预测时间戳的预测范围。如果在
fit
中已传入,则不应再次传入。如果在 fit 中未传入,则必须传入,非可选如果
fh
不是 None 且不是ForecastingHorizon
类型,它将在内部被强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或int
数组类型,则被解释为相对预测期,并强制转换为相对ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,则被解释为绝对预测期,并强制转换为绝对ForecastingHorizon(fh, is_relative=False)
。
- X`sktime` 兼容格式的时间序列,可选(默认为 None)
用于预测的外生时间序列。应与
fit
中的y
具有相同的 scitype(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.is_fitted=True
。
在 self 中访问
以“_”结尾的已拟合模型属性。
self.cutoff
,self.is_fitted
- 写入自身
如果传入了
fh
且之前未传入,则将fh
存储到self.fh
。
- 参数:
- **fh**int, list, 可强制转换为 pd.Index,或 `ForecastingHorizon`,默认=None
编码要预测时间戳的预测范围。如果在
fit
中已传入,则不应再次传入。如果在 fit 中未传入,则必须传入,非可选如果
fh
不是 None 且不是ForecastingHorizon
类型,它将在内部被强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或int
数组类型,则被解释为相对预测期,并强制转换为相对ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,则被解释为绝对预测期,并强制转换为绝对ForecastingHorizon(fh, is_relative=False)
。
- 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])
计算分位数预测值的概率或概率列表。
- 返回:
- 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,则残差将在 fh 为 range(len(y.shape[0])) 时计算。- 所需状态
要求状态为“已拟合”。如果已设置 fh,则必须与 y 的索引(pandas 或整数)对应。
- 在 self 中访问
以“_”结尾的已拟合模型属性。
self.cutoff
,self._is_fitted
- 写入自身
无。
- 参数:
- **y**sktime 兼容数据容器格式的时间序列
具有真实观测值的时间序列,用于计算残差。必须与 predict 的预期返回类型、维度和索引相同。
如果为 None,则使用目前为止看到的 y (
self._y
),特别是如果之前只调用了一次
fit
,则产生样本内残差如果
fit
需要fh
,则必须指向fit
中 y 的索引
- Xsktime 兼容格式的时间序列,可选(默认为 None)
用于更新和预测的外生时间序列。应与
fit
中的y
具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 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
。
- 参数:
- **fh**int, list, 可强制转换为 pd.Index,或 `ForecastingHorizon`,默认=None
编码要预测时间戳的预测范围。如果在
fit
中已传入,则不应再次传入。如果在 fit 中未传入,则必须传入,非可选如果
fh
不是 None 且不是ForecastingHorizon
类型,它将在内部被强制转换为ForecastingHorizon
(通过_check_fh
)。如果
fh
是int
或int
数组类型,则被解释为相对预测期,并强制转换为相对ForecastingHorizon(fh, is_relative=True)
。如果
fh
是pd.Index
类型,则被解释为绝对预测期,并强制转换为绝对ForecastingHorizon(fh, is_relative=False)
。
- X`sktime` 兼容格式的时间序列,可选(默认为 None)
用于预测的外生时间序列。应与
fit
中的y
具有相同的 scitype(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 是 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]#
将序列化的自身保存到字节类对象或 (.zip) 文件。
行为:如果
path
是 None,返回一个内存中的序列化 self;如果path
是文件位置,则将 self 存储在该位置为 zip 文件。保存的文件是 zip 文件,内容如下: _metadata - 包含 self 的类,即 type(self) _obj - 序列化后的 self。此类使用默认的序列化方式 (pickle)。
- 参数:
- pathNone 或文件位置(str 或 Path)
如果为 None,则 self 被保存到内存对象;如果是文件位置,则 self 被保存到该文件位置。如果
path=”estimator”,则将在当前工作目录创建 zip 文件
estimator.zip
。path=”/home/stored/estimator”,则 zip 文件
estimator.zip
将被
存储在
/home/stored/
中。- serialization_format: str, 默认为 “pickle”
用于序列化的模块。可用选项是“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
path
是 None - 内存中的序列化 self - 如果
path
是文件位置 - 引用该文件的 ZipFile
- 如果
- score(y, X=None, fh=None)[source]#
使用 MAPE(非对称)根据真实值对预测进行评分。
- 参数:
- ypd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D)
要评分的时间序列
- **fh**int, 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。
- 返回:
- scorefloat
self.predict(fh, X)
相对于 y_test 的 MAPE 损失。
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- **config_dict**dict
配置名称 : 配置值对的字典。有效的配置项、值及其含义如下所示
- displaystr 类型,“diagram”(默认)或“text”
jupyter 内核如何显示 self 的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool 类型,默认为 True
打印 self 时是仅列出与默认值不同的 self 参数 (True),还是列出所有参数名称和值 (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_databool 类型,默认为 True
self._X 和 self._y 是否在
fit
中存储并在update
中更新。如果为 True,则self._X
和self._y
被存储和更新。如果为 False,则self._X
和self._y
不被存储和更新。这在使用 save 时会减小序列化大小,但 update 将默认为“不执行任何操作”,而不是“重新拟合所有已见数据”。
- 返回:
- self对 self 的引用。
注意事项
改变对象状态,将 config_dict 中的配置复制到
self._config_dynamic
。
- set_params(**params)[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,默认为 None
伪随机数生成器,用于控制随机整数的生成。传递 int 可在多次函数调用中获得可重现的输出。
- **deep**布尔值,默认=True
是否在 skbase 对象值的参数中设置随机状态,即组件估计器。
如果为 False,则仅设置
self
的random_state
参数(如果存在)。如果为 True,则也会设置组件对象中的
random_state
参数。
- self_policystr 类型,可选值之一 {“copy”, “keep”, “new”},默认为“copy”
“copy”:
self.random_state
设置为输入的random_state
“keep”:
self.random_state
保持原样“new”:
self.random_state
设置为一个新的随机状态,
派生自输入的
random_state
,通常与之不同
- 返回:
- self对 self 的引用
- set_tags(**tag_dict)[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
:仅更新截止点并记住数据
- 所需状态
要求状态为“已拟合”,即
self.is_fitted=True
。
在 self 中访问
以“_”结尾的已拟合模型属性。
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` `(实例, 时间)` 的 `pd.DataFrame`,`3D np.ndarray` `(实例, 变量, 时间)`,`Series` 类型的 `pd.DataFrame` 列表
`Hierarchical` scitype = 分层集合,用于分层预测。带有 3 级或更多级行 `MultiIndex` `(层级_1, ..., 层级_n, 时间)` 的 `pd.DataFrame`
有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅预测教程 `examples/01_forecasting.ipynb`
- **X**采用 `sktime` 兼容格式的时间序列,可选 (默认=None)。
用于更新模型拟合的外生时间序列。应与
y
具有相同的 scitype(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
为 True,则X.index
必须包含y.index
。- update_paramsbool 类型,可选(默认为 True)
是否应更新模型参数。如果为
False
,则仅更新截止点,模型参数(例如系数)不更新。
- 返回:
- 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
:仅更新截止点并记住数据
- 所需状态
要求状态为“已拟合”,即
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 = 时间序列集合,全局/面板预测。带有 2 级行 `MultiIndex` `(实例, 时间)` 的 `pd.DataFrame`,`3D np.ndarray` `(实例, 变量, 时间)`,`Series` 类型的 `pd.DataFrame` 列表
`Hierarchical` scitype = 分层集合,用于分层预测。带有 3 级或更多级行 `MultiIndex` `(层级_1, ..., 层级_n, 时间)` 的 `pd.DataFrame`
有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅预测教程 `examples/01_forecasting.ipynb`
- cv继承自 BaseSplitter 的时间序列交叉验证生成器,可选
例如,
SlidingWindowSplitter
或ExpandingWindowSplitter
;默认为initial_window=1
的 ExpandingWindowSplitter,并且默认情况下,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
,则仅更新截止点,模型参数(例如系数)不更新。- reset_forecasterbool 类型,可选(默认为 True)
如果为 True,将不改变预测器的状态,即 update/predict 序列使用副本运行,self 的截止点、模型参数、数据内存不变
如果为 False,则在运行 update/predict 序列时会更新 self,就像直接调用 update/predict 一样
- 返回:
- y_pred汇总来自多个分割批次的点预测的对象
格式取决于预测整体的(截止点,绝对预测期)对
如果绝对预测期点的集合是唯一的:类型是 sktime 兼容数据容器格式的时间序列,输出中抑制截止点,与最近传入的 y 具有相同类型:Series, Panel, Hierarchical scitype,格式相同(见上文)。
如果绝对预测期点的集合不唯一:类型是一个 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
,则是以“_”结尾的模型属性。- 写入自身
通过追加行,用
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` `(实例, 时间)` 的 `pd.DataFrame`,`3D np.ndarray` `(实例, 变量, 时间)`,`Series` 类型的 `pd.DataFrame` 列表
`Hierarchical` scitype = 分层集合,用于分层预测。带有 3 级或更多级行 `MultiIndex` `(层级_1, ..., 层级_n, 时间)` 的 `pd.DataFrame`
有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅预测教程 `examples/01_forecasting.ipynb`
- **fh**int, list, 可强制转换为 pd.Index,或 `ForecastingHorizon`,默认=None
编码要预测时间戳的预测范围。如果在
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
,则仅更新截止点,模型参数(例如系数)不更新。
- 返回:
- **y_pred**sktime 兼容数据容器格式的时间序列
在 `fh` 处的点预测,与 `fh` 具有相同的索引。`y_pred` 与最近传递的 `y` 具有相同的类型:`Series`、`Panel`、`Hierarchical` scitype,相同格式(见上文)