TransformSelectForecaster#

class TransformSelectForecaster(forecasters, transformer=None, fallback_forecaster=None)[源代码]#

根据时间序列的类别或聚类选择预测器。

对“先聚类再应用预测器”方法，或 Syntetos/Boylan 启发式方法（按平滑、不稳定、间歇性、波动性类别应用预测器）的程序化泛化。

对给定的时间序列应用一个序列到基本类型（primitives）的变换器。基于变换器生成的值，从用户提供的字典形式的多个预测器（键 => 类别，值 => 预测器）中选择一个。最后，选择的预测器将用于对数据进行拟合以进行未来预测。

要为每个类别应用全局预测器，请改用 GroupbyCategoryForecaster 组合器。

参数:
forecastersdict[sktime 预测器]

预测器字典，键对应于给定变换器生成的类别，值对应于一个 sktime 预测器。

transformersktime 变换器或聚类器，默认值 = ADICVTransformer()

一个时间序列到基本类型（primitives）的 sktime 变换器，它生成一个值，该值可用于量化时间序列预测器的选择。

如果使用聚类器，它必须支持聚类分配，即具有 capability:predict 标签。

注意：为确保功能正确，变换器必须在调用 transform() 或 fit_transform() 函数时将生成的类别存储在返回值的第一列中。

fallback_forecastersktime 预测器 | None, 可选

一个备用预测器，当变换器生成的类别与给定预测器中的任何一个都不匹配时将使用它。

poolingstr, 可选, 默认值 = “local”, {“local”, “global”} 之一

用于预测器的池化策略。如果为“local”，则预测器针对每个类别独立地进行拟合和预测。如果为“global”，则预测器对整个数据集进行拟合和预测。

属性:
cutoff

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

fh

传递的预测范围。

is_fitted

是否已调用 fit。

steps_
引发:
AssertionError: 如果传递的变换器无效 (不是 BaseTransformer 的实例)
或者给定的预测器无效 (不是 BaseForecaster 的实例)。

示例

此示例展示了如何利用 TransformSelectForecaster 根据 ADICVTransformer 确定的时间序列类别选择合适的预测器！

>>> from sktime.forecasting.compose._transform_select_forecaster import (
...    TransformSelectForecaster)
>>> from sktime.forecasting.croston import Croston
>>> from sktime.forecasting.trend import PolynomialTrendForecaster
>>> from sktime.forecasting.naive import NaiveForecaster
>>> from sktime.transformations.series.adi_cv import ADICVTransformer

# 导入可根据其方差和平均需求间隔生成特定类别数据的方法。

>>> from sktime.transformations.series.tests.test_adi_cv import (
...     _generate_erratic_series)

# 定义预测器，它接受预测器字典、变换器以及可选的 fallback_forecaster

>>> group_forecaster = TransformSelectForecaster(
...     forecasters =
...         {"smooth": NaiveForecaster(),
...         "erratic": Croston(),
...         "intermittent": PolynomialTrendForecaster()},
...     transformer=ADICVTransformer(features=["class"]))

>>> generated_data = _generate_erratic_series()

# fit 函数首先将数据通过给定的变换器 # 以生成给定的类别。该类别可通过变量 # self.category_ 查看。

>>> group_forecaster = group_forecaster.fit(generated_data, fh=50)
>>> #print(f"The chosen category is: {group_forecaster.category}")

>>> # Print out the predicted value over the given forecasting horizon!
>>> # print(group_forecaster.predict(fh=50, X=None))

方法

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

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

计算/返回方差预测。

reset()

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

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')[源代码]#

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

参数:
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。is_fitted 属性应在调用对象的 fit 方法时设置为 True。

如果不是，则引发 NotFittedError。

参数:
method_namestr, 可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[源代码]#

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

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

等效于使用 self 的参数构造 type(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 个元素是测试中 obj 第 i 个实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

property cutoff[源代码]#

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

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

如果已设置 cutoff，则为 pandas 兼容的索引元素；否则为 None

property fh[源代码]#

传递的预测范围。

fit(y, X=None, fh=None)[源代码]#

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

状态变化

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

写入 self

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

  • 将 self.is_fitted 标志设置为 True。

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

  • 如果传递了 fh，则将其存储到 self.fh。

参数:
ysktime 兼容数据容器格式的时间序列。

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

sktime 中的单个数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

  • Series scitype = 单个时间序列，香草（vanilla）预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 的 Series 类型 pd.DataFrame

  • Hierarchical scitype = 分层集合，用于分层预测。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 具有相同的 scitype (Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 y.index。

返回:
self对 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) 相同。

状态变化

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

写入 self

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

  • 将 self.is_fitted 标志设置为 True。

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

  • 将 fh 存储到 self.fh。

参数:
ysktime 兼容数据容器格式的时间序列

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

sktime 中的单个数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

  • Series scitype = 单个时间序列，香草（vanilla）预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 的 Series 类型 pd.DataFrame

  • Hierarchical scitype = 分层集合，用于分层预测。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 具有相同的 scitype (Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 y.index。

X_predsktime 兼容格式的时间序列，可选 (默认值=None)

用于预测的外生时间序列。如果传递，将在 predict 中使用，而不是 X。应与 fit 中 y 具有相同的 scitype (Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 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 的标签值，并考虑标签覆盖，优先级降序排列如下

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

  2. 在父类的 _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 任何属性的键。

值是相应的标签值，覆盖顺序如下（优先级降序排列）

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

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

按继承顺序。

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

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

不考虑实例上的动态标签覆盖，即通过 set_tags 或 clone_tags 设置的、在实例上定义的标签。

要包含动态标签的覆盖，请使用 get_tags。

collected_tagsdict

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

get_config()[源代码]#

获取 self 的配置标志。

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

拟合参数字典，参数名称: 参数值 键值对包括

  • 总是：此对象的所有拟合参数，如通过 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，将返回此对象的参数名称: 值 dict，包括组件 (= BaseObject 值的参数) 的参数。

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

返回:
params键为 str 值的 dict

参数字典，参数名称: 参数值 键值对包括

  • 总是：此对象的所有参数，如通过 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 的单个标签值，并考虑标签覆盖，优先级降序排列如下

  1. 通过 set_tags 或 clone_tags 在实例上设置的标签，

在实例构造时。

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

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

按继承顺序。

参数:
tag_namestr

要检索的标签名称

tag_value_default任意类型，可选；默认值=None

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

raise_errorbool

标签未找到时是否引发 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()[源代码]#

从实例获取标签，并应用标签级别的继承和覆盖。

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

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

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

值是相应的标签值，覆盖顺序如下（优先级降序排列）

  1. 通过 set_tags 或 clone_tags 在实例上设置的标签，

在实例构造时。

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

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

按继承顺序。

返回:
collected_tagsdict

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

is_composite()[源代码]#

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

复合对象是包含其他对象作为参数的对象。在实例上调用，因为不同实例可能有所不同。

返回:
composite: bool

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

property is_fitted[源代码]#

是否已调用 fit。

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

返回:
bool

估计器是否已 fit。

classmethod load_from_path(serial)[源代码]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回:
反序列化的 self，结果输出到 path，来自 cls.save(path)
classmethod load_from_serial(serial)[源代码]#

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

参数:
serialcls.save(None) 输出的第 1 个元素
返回:
反序列化的 self，结果输出为 serial，来自 cls.save(None)
predict(fh=None, X=None)[源代码]#

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

所需状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入 self

如果传递了 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 兼容格式的时间序列，可选 (默认值=None)

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

返回:
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 中访问

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

  • self.cutoff, self.is_fitted

写入 self

如果传递了 fh 且之前未传递过，则将其存储到 self.fh。

参数:
fhint, 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)。

Xsktime 兼容格式的时间序列，可选 (默认值=None)

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

coveragefloat 或唯一值的 float 列表，可选（默认为 0.90）

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

返回:
pred_intpd.DataFrame
列具有多重索引：第一级是在 `fit` 中 `y` 的变量名，
第二级是计算区间的覆盖率分数。

顺序与输入 coverage 中的相同。

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

行索引是 `fh`，附加的（上层）级别等于实例级别，

来自在 `fit` 中看到的 `y`，如果 `fit` 中看到的 `y` 是 Panel 或 Hierarchical。

条目是下限/上限区间的预测，

对应列索引中的变量，在第二列索引中的名义覆盖率下，取决于第三列索引是下限还是上限，对于行索引。对于覆盖率 `c`，上限/下限区间的预测等同于 alpha = 0.5 - c/2, 0.5 + c/2 处的分位数预测。

predict_proba(fh=None, X=None, marginal=True)[源代码]#

计算/返回完全概率预测。

注意

  • 目前仅为 Series（非 Panel，非 Hierarchical）`y` 实现。

  • 需要安装 skpro 才能返回分布对象。

所需状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入 self

如果传递了 fh 且之前未传递过，则将其存储到 self.fh。

参数:
fhint, 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)。

Xsktime 兼容格式的时间序列，可选 (默认值=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)[源代码]#

计算/返回分位数预测。

如果 alpha 是可迭代的，将计算多个分位数。

所需状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入 self

如果传递了 fh 且之前未传递过，则将其存储到 self.fh。

参数:
fhint, 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)。

Xsktime 兼容格式的时间序列，可选 (默认值=None)

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

alphafloat 或唯一值的 float 列表，可选（默认为 [0.05, 0.95]）

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

返回:
quantilespd.DataFrame
列具有多重索引：第一级是在 `fit` 中 `y` 的变量名，

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

行索引是 `fh`，附加的（上层）级别等于实例级别，

来自在 `fit` 中看到的 `y`，如果 `fit` 中看到的 `y` 是 Panel 或 Hierarchical。

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

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

predict_residuals(y=None, X=None)[源代码]#

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

残差将根据 `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`

写入 self

无。

参数:
ysktime 兼容数据容器格式的时间序列

带有真实观测值的时间序列，用于计算残差。必须与 `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") 为真，则 X.index 必须包含 fh 索引参考和 y.index。

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

在 fh`, 处的预测残差，索引与 ``fh 相同。y_res 的类型与最近传递的 y 类型相同：Series、Panel、Hierarchical scitype，格式相同（见上文）

predict_var(fh=None, X=None, cov=False)[源代码]#

计算/返回方差预测。

所需状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入 self

如果传递了 fh 且之前未传递过，则将其存储到 self.fh。

参数:
fhint, 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)。

Xsktime 兼容格式的时间序列，可选 (默认值=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。

条目是（协）方差预测，对应列索引中的变量，以及

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

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

reset()[源代码]#

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

结果是将 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))``获得的对象。

返回:
self

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

save(path=None, serialization_format='pickle')[源代码]#

将序列化的 self 保存到字节类对象或 (.zip) 文件。

行为：如果 path 为 None，返回一个内存中的序列化 `self`；如果 path 是文件位置，则将 `self` 作为 zip 文件存储在该位置。

保存的文件是 zip 文件，包含以下内容：`_metadata` - 包含 `self` 的类，即 `type(self)`；`_obj` - 序列化的 `self`。此类使用默认序列化方式（pickle）。

参数:
pathNone 或文件位置（str 或 Path）

如果为 None，`self` 将保存到内存对象中；如果为文件位置，`self` 将保存到该文件位置。如果

  • path=”estimator”，则会在当前工作目录创建 estimator.zip 文件。

  • path=”/home/stored/estimator”，则会在 /home/stored/ 目录创建 estimator.zip 文件。

存储在 /home/stored/ 中。

serialization_format: str, 默认为 “pickle”

用于序列化的模块。可用选项有 “pickle” 和 “cloudpickle”。请注意，非默认格式可能需要安装其他软依赖项。

返回:
如果 path 为 None - 内存中的序列化 `self`
如果 path 为文件位置 - 引用该文件的 ZipFile
score(y, X=None, fh=None)[源代码]#

使用 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") 为真，则 X.index 必须包含 y.index

返回:
scorefloat

self.predict(fh, X) 相对于 y_test 的 MAPE 损失。

另请参阅

sktime.performance_metrics.forecasting.mean_absolute_percentage_error
set_config(**config_dict)[源代码]#

将配置标志设置为给定值。

参数:
config_dictdict

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

displaystr，“diagram”（默认）或 “text”

jupyter kernel 如何显示 `self` 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool，默认为 True

打印 `self` 时是仅列出自默认值不同的参数（False）还是列出所有参数名称和值（False）。不进行嵌套，即仅影响 `self` 而不影响组件估计器。

warningsstr，“on”（默认）或 “off”

是否引发警告，仅影响来自 sktime 的警告

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

  • “off” = 不会引发来自 sktime 的警告

backend:parallelstr，可选，默认为 “None”

广播/向量化时用于并行化的后端，以下之一：

  • “None”：按顺序执行循环，简单的列表推导

  • “loky”、“multiprocessing” 和 “threading”：使用 joblib.Parallel

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

  • “dask”：使用 dask，需要环境中安装 dask 包

  • “ray”：使用 ray，需要环境中安装 ray 包

backend:parallel:paramsdict，可选，默认为 {}（不传递参数）

作为配置传递给并行化后端的附加参数。有效键取决于 backend:parallel 的值

  • “None”：无附加参数，backend_params 被忽略

  • “loky”、“multiprocessing” 和 “threading”：默认的 joblib 后端。此处可以传递 joblib.Parallel 的任何有效键，例如 n_jobs，但 backend 除外，它由 backend 直接控制。如果未传递 n_jobs，它将默认为 -1，其他参数将默认为 joblib 默认值。

  • “joblib”：自定义和第三方 joblib 后端，例如 spark。此处可以传递 joblib.Parallel 的任何有效键，例如 n_jobs。backend 在这种情况下必须作为 backend_params 的一个键传递。如果未传递 n_jobs，它将默认为 -1，其他参数将默认为 joblib 默认值。

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

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

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

    • “shutdown_ray”：bool，默认为 True；False 防止 ray 在并行化后

      关闭。

    • “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)[源代码]#

设置此对象的参数。

该方法适用于简单的 `skbase` 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象（即包含其他对象的对象），以访问组件 <component> 中的 <parameter>。如果引用没有歧义，例如没有两个组件参数具有相同的名称 <parameter>，也可以使用不带 <component>__ 的字符串 <parameter>。

参数:
**paramsdict

BaseObject 参数，键必须是 <component>__<parameter> 字符串。如果 get_params 键中唯一，__ 后缀可以作为完整字符串的别名。

返回:
self对 `self` 的引用（设置参数后）
set_random_state(random_state=None, deep=True, self_policy='copy')[源代码]#

设置 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 以在多次函数调用中获得可重现的输出。

deepbool, 默认值=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)[源代码]#

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

每个 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)[源代码]#

更新截止值，并可选地更新拟合参数。

如果未实现特定于估计器的更新方法，则默认回退如下：

  • update_params=True：拟合迄今为止所有观测到的数据

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

所需状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入 self

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

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

参数:
ysktime 兼容数据容器格式的时间序列。

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

sktime 中的单个数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

  • Series scitype = 单个时间序列，香草（vanilla）预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 的 Series 类型 pd.DataFrame

  • Hierarchical scitype = 分层集合，用于分层预测。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") 为真，则 X.index 必须包含 y.index。

update_paramsbool，可选（默认为 True）

是否应更新模型参数。如果为 False，则仅更新截止点，模型参数（例如，系数）不更新。

返回:
self对 `self` 的引用
update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[源代码]#

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

用于执行多次 update / predict 链式操作的简写方式，数据回放基于时间分割器 cv。

与以下内容相同（如果只有 y、cv 不是默认值）

  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_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，则不更新状态。

参数:
ysktime 兼容数据容器格式的时间序列。

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

sktime 中的单个数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

  • Series scitype = 单个时间序列，香草（vanilla）预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 的 Series 类型 pd.DataFrame

  • Hierarchical scitype = 分层集合，用于分层预测。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") 为真，则 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)[源代码]#

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

此方法对于一步完成更新和预测非常有用。

如果未实现特定于估计器的更新方法，则默认回退是先更新，然后预测。

所需状态

要求状态为“已拟合”。

在 self 中访问

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

写入 self

通过附加行来用 y 和 X 更新 self._y 和 self._X。将 self.cutoff 和 self._cutoff 更新为在 y 中看到的最后一个索引。如果 update_params=True，

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

参数:
ysktime 兼容数据容器格式的时间序列。

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

sktime 中的单个数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

  • Series scitype = 单个时间序列，香草（vanilla）预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 的 Series 类型 pd.DataFrame

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

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

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

预测范围，编码要进行预测的时间戳。如果在 fit 中已传递，则不应再次传递。如果在 fit 中未传递，则必须传递，不可选。

Xsktime 兼容格式的时间序列，可选（默认为 None）

用于更新和预测的外部时间序列。应与 fit 中 y 的 scitype（Series、Panel 或 Hierarchical）相同。如果 self.get_tag("X-y-must-have-same-index") 为真，则 X.index 必须包含 fh 索引参考。

update_paramsbool，可选（默认为 True）

是否应更新模型参数。如果为 False，则仅更新截止点，模型参数（例如，系数）不更新。

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

在 fh 处的点预测，与 fh 具有相同的索引。y_pred 与最近传递的 y 具有相同的类型：Series, Panel, Hierarchical scitype，格式相同（见上文）

在此页上