TransformedTargetForecaster#

class TransformedTargetForecaster(steps)[源代码]#

用于预测变换后的时间序列的元估计器。

管道功能,用于对内生时间序列 y 应用变换器。外生数据 X 不会被变换。要变换 X,可以使用 ForecastingPipeline

对于列表 t1, t2, …, tN, f, tp1, tp2, …, tpM,

其中 t[i]tp[i] 是变换器(t 用于预处理,tp 用于后处理),f 是 sktime 预测器,该管道的行为如下:

fit(y, X, fh) - 通过运行 t1.fit_transform 改变状态

其中 X=yy=X,然后对 X= t1.fit_transform 的输出应用 t2.fit_transformy=X,以此类推,t[i] 接收 t[i-1] 的输出作为 X,然后运行 f.fit,其中 yt[N] 的输出,X=X,然后顺序运行 tp1.fit_transform,其中 X=yy=X,然后对 X= tp1.fit_transform 的输出应用 tp2.fit_transform,以此类推,tp[i] 接收 tp[i-1] 的输出。返回 tpM 的输出,如果 M=0 则返回 t1.inverse_transform 的输出。

predict(X, fh) - 结果是通过执行 f.predict 获得,其中 X=Xfh=fh

然后运行 tN.inverse_transform,其中 X= f 的输出,y=X,然后对 X= t1.inverse_transform 的输出应用 t2.inverse_transform,以此类推,t[i-1] 接收 t[i] 的输出作为 X,然后运行 tp1.transform,其中 X= t1 的输出,y=X,然后对 X= tp1.transform 的输出应用 tp2.transform,以此类推,tp[i] 接收 tp[i-1] 的输出。返回 tpM 的输出,如果 M=0 则返回 t1.inverse_transform 的输出。

predict_interval(X, fh), predict_quantiles(X, fh) - 与 predict(X, fh) 类似,

predict 替换为 predict_intervalpredict_quantiles

predict_var, predict_proba - 使用基类默认方法从以下项获取粗略正态估计:

predict_quantiles

get_params, set_params 使用 sklearn 兼容的嵌套接口

  • 如果列表未命名,则名称将按类名生成

  • 如果名称不唯一,则会在每个名称字符串后面附加 f"_{str(i)}",其中 i 是列表中不唯一字符串在它之前(包括自身)的总出现次数

TransformedTargetForecaster 也可以通过使用魔术方法创建

对任何预测器进行乘法运算,即,如果 my_forecaster 继承自 BaseForecaster,并且 my_t1, my_t2, my_tp 继承自 BaseTransformer,那么,例如,my_t1 * my_t2 * my_forecaster * my_tp 将产生与构造函数 TransformedTargetForecaster([my_t1, my_t2, my_forecaster, my_tp]) 获得的相同对象。魔术乘法也可用于 (str, transformer) 对,只要链中有一个元素是变换器。

参数:
stepssktime 变换器和预测器列表,或

sktime 变换器或预测器的元组列表 (str, estimator)。列表中必须包含且仅包含一个预测器。这些是“蓝图”变换器或预测器,当调用 fit 时,预测器/变换器的状态不会改变。

属性:
steps_sktime 变换器或预测器的元组列表 (str, estimator)

管道中拟合的 steps 中的估计器克隆始终采用 (str, estimator) 格式,即使 steps 只是一个字符串列表。未在 steps 中传递的字符串将替换为唯一生成的字符串。steps_ 中的第 i 个变换器是 steps 中第 i 个变换器的克隆

forecaster_估计器,引用 steps_ 中唯一的预测器

返回管道中预测器的引用。

transformers_pre_sktime 变换器的元组列表 (str, transformer)

返回预测前变换器列表的引用。

transformers_post_sktime 变换器的元组列表 (str, transformer)

返回预测后变换器列表的引用。

示例

>>> from sktime.datasets import load_airline
>>> from sktime.forecasting.naive import NaiveForecaster
>>> from sktime.forecasting.compose import TransformedTargetForecaster
>>> from sktime.transformations.series.impute import Imputer
>>> from sktime.transformations.series.detrend import Detrender
>>> from sktime.transformations.series.exponent import ExponentTransformer
>>> y = load_airline()

示例 1:字符串/估计器对

>>> pipe = TransformedTargetForecaster(steps=[
...     ("imputer", Imputer(method="mean")),
...     ("detrender", Detrender()),
...     ("forecaster", NaiveForecaster(strategy="drift")),
... ])
>>> pipe.fit(y)
TransformedTargetForecaster(...)
>>> y_pred = pipe.predict(fh=[1,2,3])

示例 2:不带字符串

>>> pipe = TransformedTargetForecaster([
...     Imputer(method="mean"),
...     Detrender(),
...     NaiveForecaster(strategy="drift"),
...     ExponentTransformer(),
... ])

示例 3:使用双下划线方法

>>> forecaster = NaiveForecaster(strategy="drift")
>>> imputer = Imputer(method="mean")
>>> pipe = imputer * Detrender() * forecaster * ExponentTransformer()

方法

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

获取自身的配置标志。

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

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

inverse_transform(Z[, X])

对输入序列 Z 进行逆变换。

is_composite()

检查对象是否是组合对象。

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

设置估计器的参数。

set_random_state([random_state, deep, ...])

为自身设置 random_state 伪随机种子参数。

set_tags(**tag_dict)

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

transform(Z[, X])

返回输入序列 Z 的变换版本。

update(y[, X, update_params])

更新截止值,并可选择更新拟合参数。

update_predict(y[, cv, X, update_params, ...])

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

update_predict_single([y, fh, X, update_params])

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

属性 forecaster_[源代码]#

返回管道中预测器的引用。

返回:
sktime 预测器

steps_ 中唯一预测器的引用(不带名称)

属性 transformers_pre_[源代码]#

返回预测前变换器列表的引用。

返回:
sktime 变换器的元组列表 (str, estimator)

steps_ 中唯一 (str, forecaster) 之前的元组的引用

属性 transformers_post_[源代码]#

返回预测后变换器列表的引用。

返回:
sktime 变换器的元组列表 (str, estimator)

steps_ 中唯一 (str, forecaster) 之后的元组的引用

transform(Z, X=None)[源代码]#

返回输入序列 Z 的变换版本。

参数:
Zpd.Series 或 pd.DataFrame

要应用变换的时间序列。

Xpd.DataFrame,默认为 None

用于变换的外生数据。

返回:
Ztpd.Series 或 pd.DataFrame

输入序列 Z 的变换版本。

inverse_transform(Z, X=None)[源代码]#

对输入序列 Z 进行逆变换。

参数:
Zpd.Series 或 pd.DataFrame

要对其进行逆变换的时间序列。

Xpd.DataFrame,默认为 None

用于变换的外生数据。

返回:
Z_invpd.Series 或 pd.DataFrame

逆变换后重建的时间序列。

check_is_fitted(method_name=None)[源代码]#

检查估计器是否已拟合。

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

如果不是,则抛出 NotFittedError

参数:
method_namestr,可选

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

抛出:
未拟合错误

如果估计器尚未拟合。

clone()[源代码]#

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

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

等同于构造一个 type(self) 的新实例,使用 self 的参数,即 type(self)(**self.get_params(deep=False))

如果在 self 上设置了配置,克隆也将具有与原始对象相同的配置,等同于调用 cloned_self.set_config(**self.get_config())

在值上也等同于调用 self.reset,不同之处在于 clone 返回一个新对象,而不是像 reset 那样改变 self

抛出:
如果克隆不符合规范,则会发生 RuntimeError,原因可能是 __init__ 存在缺陷。
clone_tags(estimator, tag_names=None)[源代码]#

从另一个对象克隆标签作为动态覆盖。

每个兼容 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 的引用。

类方法 create_test_instance(parameter_set='default')[源代码]#

使用第一个测试参数集构造类的实例。

参数:
parameter_setstr,默认为“default”

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

返回:
instance具有默认参数的类实例
类方法 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__}

属性 cutoff[源代码]#

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

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

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

属性 fh[源代码]#

传递的预测视野。

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

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

状态改变

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

写入自身

  • 设置以“_”结尾的拟合模型属性,可通过 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.Seriesnp.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合,全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型的 pd.DataFrame list

  • Hierarchical scitype = 分层集合,用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

有关数据格式的更多详细信息,请参阅 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对自身的引用。
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

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

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

sktime 中的独立数据格式是所谓的 mtype 规范,每个 mtype 都实现了抽象的 scitype

  • Series scitype = 单个时间序列,普通预测。pd.DataFrame, pd.Seriesnp.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合,全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型的 pd.DataFrame list

  • Hierarchical scitype = 分层集合,用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

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

fhint, list, pd.Index coercible, 或 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_predsktime兼容格式的时间序列,可选 (默认=None)

用于预测的外部时间序列。如果传递,将在predict中使用而非X。应与 fity 具有相同的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)[source]#

从类中获取类标签值,并从父类继承标签级别。

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

get_class_tag 方法是一个类方法,仅考虑类级别的标签值和覆盖来检索标签值。

它返回具有名称 tag_name 的标签值,并考虑标签覆盖,优先级降序排列如下:

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

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

按照继承顺序。

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

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

参数:
tag_namestr

标签值的名称。

tag_value_default任意类型

如果未找到标签,则返回的默认/回退值。

返回:
tag_value

selftag_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 的键值对,通常用作控制行为的临时标志。

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

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

配置在 clonereset 调用后保留。

返回:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取拟合的参数。

所需状态

要求状态为“已拟合”。

参数:
deepbool, 默认=True

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

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

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

返回:
fitted_params键为str的字典

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

获取估计器的参数。

参数:
deep布尔值, 可选

如果为True,将返回此估计器及其包含的子对象(如果它们也是估计器)的参数。

返回:
params字符串到任意类型的映射

参数名称映射到它们的值。

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

selftag_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 对象属性中的任何覆盖和新标签。

classmethod get_test_params(parameter_set='default')[source]#

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

参数:
parameter_setstr,默认为“default”

返回用于测试的测试参数集的名称。如果某个值没有定义特殊参数,则返回 "default" 集。

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

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

is_composite()[source]#

检查对象是否是组合对象。

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

返回:
composite: bool, self是否包含一个类型为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) 输出的第一个元素
返回:
反序列化的self,结果为 serial,是 cls.save(None) 的输出。
property named_steps[source]#

将步骤映射到字典。

predict(fh=None, X=None)[source]#

在未来视野上预测时间序列。

所需状态

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

在self中访问

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

  • self.cutoff, self.is_fitted

写入自身

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

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

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

如果fh非None且类型不是ForecastingHorizon,则通过调用_check_fh强制转换为ForecastingHorizon。特别是,如果fh类型为pd.Index,则通过ForecastingHorizon(fh, is_relative=False)强制转换。

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

用于预测的外部时间序列。应与 fity 具有相同的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)[source]#

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

如果 coverage 是可迭代的,将计算多个区间。

所需状态

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

在self中访问

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

  • self.cutoff, self.is_fitted

写入自身

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

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

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

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

  • 如果 fhint 或类似int数组,则解释为相对范围,并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fh 类型为 pd.Index,则解释为绝对范围,并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)

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

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

coveragefloat 或 唯一值的float列表, 可选 (默认=0.90)

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

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

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

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

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

来自fit中看到的y。

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

对于列索引中的变量,在第二列索引中的名义覆盖率下,取决于第三列索引是下限/上限,对应于行索引。上限/下限区间预测等效于对于覆盖率中的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

写入自身

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

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

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

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

  • 如果 fhint 或类似int数组,则解释为相对范围,并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fh 类型为 pd.Index,则解释为绝对范围,并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)

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

用于预测的外部时间序列。应与 fity 具有相同的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

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

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

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

  • 如果 fhint 或类似int数组,则解释为相对范围,并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fh 类型为 pd.Index,则解释为绝对范围,并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)

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

用于预测的外部时间序列。应与 fity 具有相同的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是Panel或Hierarchical,则附加(上层)级别等于实例级别。

来自fit中看到的y。

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

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

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或integer)的索引对应。

在self中访问

以“_”结尾的已拟合模型属性。self.cutoff, self._is_fitted

写入自身

无。

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

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

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

  • 如果紧随一个fit调用,则产生样本内残差

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

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

用于更新和预测的外部时间序列。应与 y 具有相同的scitype (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 scitype,格式相同(见上文)。

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

计算/返回方差预测。

所需状态

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

在self中访问

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

  • self.cutoff, self.is_fitted

写入自身

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

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

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

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

  • 如果 fhint 或类似int数组,则解释为相对范围,并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fh 类型为 pd.Index,则解释为绝对范围,并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)

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

用于预测的外部时间序列。应与 fity 具有相同的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来自Panel或Hierarchical,则附加级别等于实例级别,

来自fit中看到的y。

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

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

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

第二级是fh。

行索引是fh,如果fit中看到的y来自Panel或Hierarchical,则附加级别等于实例级别,

来自fit中看到的y。

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

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

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

reset()[source]#

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

结果是将 self 设置为其在构造函数调用后立即具有的状态,使用相同的超参数。通过 set_config 设置的配置值也会保留。

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

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

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

  • 配置属性,配置保持不变。也就是说,reset 调用前后的 get_config 结果相等。

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

等同于 clone,但 reset 会修改 self,而不是返回新对象。

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

返回:
self

重置为干净的 post-init 状态,但保留当前超参数值的类实例。

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)

用于评分的时间序列

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

编码预测时间戳的预测范围。

Xpd.DataFrame, 或 2D np.array, 可选 (默认=None)

用于评分的外部时间序列。如果 self.get_tag(“X-y-must-have-same-index”) 为 True,则 X.index 必须包含 y.index。

返回:
scorefloat

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

set_config(**config_dict)[source]#

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

参数:
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 将默认为“不执行任何操作”而非“重新拟合所有已见数据”。

返回:
selfself 的引用。

注意

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

set_params(**kwargs)[source]#

设置估计器的参数。

有效参数键可以通过 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 可在多次函数调用中获得可重现的输出。

deepbool, 默认=True

是否在类型为 skbase 对象参数(即组件估计器)中设置随机状态。

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

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

self_policystr, 以下之一 {"copy", "keep", "new"}, 默认="copy"
  • “copy”: self.random_state 设置为输入 random_state

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

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

派生自输入 random_state,通常与输入不同。

返回:
selfself 的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:
**tag_dictdict

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

返回:
Self

self 的引用。

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

更新截止值,并可选择更新拟合参数。

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

  • 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.Seriesnp.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合,全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型的 pd.DataFrame list

  • Hierarchical scitype = 分层集合,用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

有关数据格式的更多详细信息,请参阅 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,则仅更新截止点,模型参数(例如系数)不更新。

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

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

用于执行多个 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,则不更新状态。

参数:
y符合 sktime 数据容器格式的时间序列。

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

sktime 中的独立数据格式是所谓的 mtype 规范,每个 mtype 都实现了抽象的 scitype

  • Series scitype = 单个时间序列,普通预测。pd.DataFrame, pd.Seriesnp.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合,全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型的 pd.DataFrame list

  • Hierarchical scitype = 分层集合,用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

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

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

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

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

用于更新和预测的外部时间序列。应与 fity 具有相同的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]#

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

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

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

所需状态

要求状态为“已拟合”。

在self中访问

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

写入自身

通过追加行来更新 self._y 和 self._X,使其包含 yX。将 self.cutoff 和 self._cutoff 更新到 y 中看到的最后一个索引。如果 update_params=True,

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

参数:
y符合 sktime 数据容器格式的时间序列。

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

sktime 中的独立数据格式是所谓的 mtype 规范,每个 mtype 都实现了抽象的 scitype

  • Series scitype = 单个时间序列,普通预测。pd.DataFrame, pd.Seriesnp.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合,全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型的 pd.DataFrame list

  • Hierarchical scitype = 分层集合,用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

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

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

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

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

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

update_paramsbool, 可选 (默认=True)

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

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

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