MultioutputTabularRegressionForecaster#

class MultioutputTabularRegressionForecaster(estimator, window_length=10, transformers=None, pooling='local')[source]#

从预测到表格回归的多输出归约。

对于多输出策略，单个能够处理多输出目标的估计器被拟合到预测范围内的所有未来步长上。

参数:
estimator估计器

由 scikit-learn 提供的表格回归估计器。

window_lengthint，可选（默认值=10）

用于将时间序列转换为表格矩阵的滑动窗口长度。

属性:
截止点

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

预测范围

已传递的预测范围。

是否已拟合

是否已调用 fit 方法。

方法

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

计算/返回方差预测。

重置()

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

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

使用新数据更新模型并进行预测。
check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

检查估计器是否已拟合。在调用对象的 fit 方法时，应将 _is_fitted 属性设置为 True。然后 is_fitted 属性检查 _is_fitted 属性是否存在且为 True。

如果未拟合，则引发 NotFittedError 异常。

参数:
method_namestr，可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

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

等效于构建 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 设置动态标签覆盖。

应仅在对象的 __init__ 方法中（在构建过程中）或直接在 __init__ 之后调用 clone_tags 方法。

动态标签被设置为 estimator 中名称在 tag_names 中指定的标签的值。

tag_names 的默认值将 estimator 中的所有标签写入 self。

当前标签值可以通过 get_tags 或 get_tag 查看。

参数:
estimator:class:BaseObject 或派生类的实例
tag_namesstr 或 list of str，默认值=None

要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回:
self

对 self 的引用。

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

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

参数:
parameter_setstr，默认值=”default”

要返回的测试参数集名称，用于测试。如果某个值没有定义特殊参数，将返回 “default” 集。

返回:
instance使用默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[source]#

创建所有测试实例列表及其名称列表。

参数:
parameter_setstr，默认值=”default”

要返回的测试参数集名称，用于测试。如果某个值没有定义特殊参数，将返回 “default” 集。

返回:
objscls 实例列表

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

namesstr 列表，长度与 objs 相同

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

property cutoff[source]#

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

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

如果已设置截止点，则为 pandas 兼容索引元素；否则为 None

property fh[source]#

已传递的预测范围。

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

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

状态更改

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

写入 self

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

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

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

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

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

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

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

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

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list of 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")，则 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)。

状态更改

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

写入 self

  • 设置以“_”结尾的拟合模型属性，拟合属性可通过 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 = 时间序列集合，全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list of 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")，则 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)[source]#

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

每个 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()[source]#

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

每个 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()[source]#

获取自身的配置标志。

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

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

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

配置在 clone 或 reset 调用下保留。

返回:
config_dictdict

配置名称 : 配置值 对的字典。通过嵌套继承从 _config 类属性收集，然后应用来自 _onfig_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]#

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

参数:
deepbool，默认值=True

是否返回组件的参数。

  • 如果为 True，将返回此对象的参数名称 : 值 dict，包括组件（= BaseObject 值参数）的参数。

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

返回:
params键为 str 值的字典

参数字典，paramname : paramvalue 键值对包含

  • 始终：此对象的所有参数，通过 get_param_names 获取的值是此对象的该键对应的参数值，值始终与构造时传递的值相同

  • 如果 deep=True，也包含组件参数的键/值对，组件参数以 [componentname]__[paramname] 索引，所有 componentname 的参数作为 paramname 出现，并带有其值

  • 如果 deep=True，也包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

从实例中获取标签值，并考虑标签级别继承和覆盖。

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

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

get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，并考虑标签覆盖，优先级从高到低如下：

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

在实例构造时设置的标签。

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

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

按继承顺序排列。

参数:
tag_namestr

要检索的标签名称

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

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

raise_errorbool

未找到标签时是否引发 ValueError

返回:
tag_valueAny

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

引发:
ValueError，如果 raise_error 为 True。

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

get_tags()[source]#

从实例中获取标签，并考虑标签级别继承和覆盖。

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

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

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

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

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

在实例构造时设置的标签。

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

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

按继承顺序排列。

返回:
collected_tagsdict

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

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

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

参数:
parameter_setstr，默认值=”default”

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

返回:
paramsdict 或 list of dict，默认值 = {}

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

is_composite()[source]#

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

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

返回:
composite: bool

对象是否具有任何参数，其值为 BaseObject 的派生实例。

property is_fitted[source]#

是否已调用 fit 方法。

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

返回:
bool

估计器是否已 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回:
在 path 处得到的反序列化 self，通过 cls.save(path) 生成
classmethod load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
产生输出 serial 的反序列化 self，通过 cls.save(None) 生成
predict(fh=None, X=None)[source]#

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

所需状态

需要状态为“已拟合”，即 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")，则 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

写入 self

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

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

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

如果 fh 非 None 且非 ForecastingHorizon 类型，它将在内部（通过 _check_fh）被强制转换为 ForecastingHorizon。

  • 如果 fh 是 int 或 array-like of 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")，则 X.index 必须包含 fh 索引引用。

coveragefloat 或 list of float 的唯一值，可选（默认值=0.90）

预测区间的名义覆盖率

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

与输入 coverage 的顺序相同。

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

行索引是 fh，如果 fit 中看到的 y 是 Panel 或 Hierarchical，则具有额外的（上级）与实例级别相同的级别。

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

对于列索引中的变量，在第二级列索引中的名义覆盖率下，根据第三级列索引是下限/上限，对应于行索引。

上限/下限区间预测等同于 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

写入 self

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

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

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

如果 fh 非 None 且非 ForecastingHorizon 类型，它将在内部（通过 _check_fh）被强制转换为 ForecastingHorizon。

  • 如果 fh 是 int 或 array-like of 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")，则 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

写入 self

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

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

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

如果 fh 非 None 且非 ForecastingHorizon 类型，它将在内部（通过 _check_fh）被强制转换为 ForecastingHorizon。

  • 如果 fh 是 int 或 array-like of 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")，则 X.index 必须包含 fh 索引引用。

alphafloat 或 list of float 的唯一值，可选（默认值=[0.05, 0.95]）

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

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

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

行索引是 fh，如果 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 中的属性

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

写入 self

无。

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

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

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

  • 如果前面只有一个 fit 调用，则生成样本内残差

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

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

用于更新和预测的外生时间序列。应该具有与 fit 中的 y 相同的科学类型（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 科学类型，相同格式（参见上文）

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

计算/返回方差预测。

所需状态

需要状态为“已拟合”，即 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 是 int 或 array-like of 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")，则 X.index 必须包含 fh 索引引用。

cov布尔值，可选（默认=False）

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

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

对于无名格式，列索引将是一个 RangeIndex。

行索引是 fh，附加级别等于实例级别，

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

条目是方差预测，对应于列索引中的 var。给定变量和 fh 索引的方差预测是预测的

在给定观测数据的情况下，该变量和索引的方差。

如果 cov=True
列索引是一个多重索引：第1级是变量名（如上所述）

第2级是 fh。

行索引是 fh，附加级别等于实例级别，

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

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

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

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

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"，则会在当前工作目录 (cwd) 下创建一个 zip 文件 estimator.zip。

  • path="/home/stored/estimator"，则会创建一个 zip 文件 estimator.zip，

存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

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

返回:
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 指向该文件的 ZipFile 对象
score(y, X=None, fh=None)[source]#

使用 MAPE（非对称）评估预测与真实值之间的得分。

参数:
ypd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D)

用于评分的时间序列

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

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

Xpd.DataFrame, 或 2D np.array, 可选（默认=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)[source]#

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

参数:
config_dictdict

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

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

jupyter kernel 如何显示 self 的实例

  • “diagram” = HTML 框图表示

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

print_changed_onlybool，默认=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，可选，默认={}（不传递参数）

作为配置传递给并行化后端的附加参数。有效的键取决于 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”；要使用的 logger 名称。

    • “mute_warnings”：bool，默认=False；如果为 True，则抑制警告

    • remember_databool，默认=True

在 fit 中是否存储并在 update 中更新 self._X 和 self._y。如果为 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>。字符串 <parameter>，不带 <component>__ 前缀，也可以使用，如果这使得引用清晰无歧义，例如，没有两个组件的参数具有相同的名称 <parameter>。

设置此对象的参数。

**paramsdict

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

self对 self 的引用（参数设置后）

返回:
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#
通过 self.get_params 找到名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 派生的整数。这些整数通过 sample_dependent_seed 从链式哈希中采样，并保证种子随机生成器的伪随机独立性。

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

应用于 random_state 参数在 self 中，具体取决于 self_policy，并且仅当 deep=True 时，应用于剩余的组件对象。

注意：即使 self 没有 random_state 参数，或者没有任何组件有 random_state 参数，也会调用 set_params。因此，set_random_state 将重置任何 scikit-base 对象，即使是那些没有 random_state 参数的对象。

random_stateint, RandomState 实例 或 None, 默认=None

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

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

deepbool，默认值=True

如果为 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]#
标签是特定于实例 self 的键值对，它们是对象构造后不会改变的静态标志。它们可用于元数据检查，或用于控制对象的行为。

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

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

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

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

**tag_dictdict

当前标签值可以通过 get_tags 或 get_tag 查看。

参数:
标签名：标签值对的字典。

返回值

返回:
对 self 的引用。

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

如果没有实现估计器特定的 update 方法，默认回退行为如下

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

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

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

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

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入 self

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

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

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

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

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

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

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

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

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

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

update_params布尔值，可选（默认=True）

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

update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#

返回:
set_tags(**tag_dict)[source]#
执行多次 update / predict 调用链的简写，数据回放基于时间分割器 cv。

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

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

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

  1. 记住 self.predict() 的结果（稍后在一个批次中返回）

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

  3. 等等

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

  5. 返回所有记住的预测

  6. 写入 self (自身)（除非 reset_forecaster=True）

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

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

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

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

如果 reset_forecaster=True，则不更新状态。

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

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

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

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

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

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

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

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

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

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

例如，SlidingWindowSplitter 或 ExpandingWindowSplitter；默认 = 具有 initial_window=1 的 ExpandingWindowSplitter，且默认情况下 y/X 中的单个数据点被逐个添加和预测，initial_window = 1, step_length = 1 和 fh = 1

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

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

reset_forecaster布尔值，可选（默认=True）

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

update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#

如果为 True，将不会改变预测器的状态，也就是说，update/predict 序列是使用一个副本运行的，并且 self 的截止点、模型参数、数据内存不会改变

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

  • y_pred一个对象，它将来自多个分割批次的点预测制成表格

返回:
格式取决于总体预测的（截止点，绝对预测范围）对

如果绝对预测范围点集合是唯一的：类型是 sktime 兼容数据容器格式的时间序列，输出中隐藏了截止点，具有与最近传入的 y 相同的类型：Series, Panel, Hierarchical 科学类型，相同格式（参见上文）

  • 如果绝对预测范围点集合不唯一：类型是一个 pandas DataFrame，其行索引和列索引是时间戳；行索引对应于预测的截止点；列索引对应于预测的绝对预测范围；条目是根据行索引预测的列索引处的点预测；如果在该（截止点，预测范围）对处没有进行预测，则条目为 nan

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

此方法用于一步完成更新和进行预测。

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

如果没有实现估计器特定的 update 方法，默认回退行为是先 update，然后 predict。

以“_”结尾的已拟合模型属性：指向已见数据的指针（self._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，

写入 self

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

在此页面上

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

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

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

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

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list of 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）

reset_forecaster布尔值，可选（默认=True）

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

update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#

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

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

MultioutputTabularRegressionForecaster.check_is_fitted