DirRecTabularRegressionForecaster#

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

从预测到表格回归的直接-递归（Dir-rec）归约。

对于混合的直接-递归策略，针对预测视野中的每个未来步长，都会拟合一个单独的预测器；然后根据递归策略，将前一个预测视野作为输入添加到训练下一个预测器的数据中。

参数:

estimatorsklearn 估计器对象: 表格回归器。
window_length整数，可选 (默认值=10): 用于将时间序列转换为表格矩阵的滑动窗口长度

属性:

cutoff: 截止点 = 预测器的“当前时间”状态。
fh: 已传递的预测视野。
is_fitted: 是否已调用 fit 方法。

方法

`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])	返回估计器的测试参数设置。
`is_composite`()	检查对象是否由其他 BaseObject 组成。
`load_from_path`(serial)	从文件位置加载对象。
`load_from_serial`(serial)	从序列化的内存容器加载对象。
`predict`([fh, X])	在未来视野上预测时间序列。
`predict_interval`([fh, X, coverage])	计算/返回预测区间预测结果。
`predict_proba`([fh, X, marginal])	计算/返回完全概率预测结果。
`predict_quantiles`([fh, X, alpha])	计算/返回分位数预测结果。
`predict_residuals`([y, X])	返回时间序列预测的残差。
`predict_var`([fh, X, cov])	计算/返回方差预测结果。
`reset`()	将对象重置为干净的初始化后状态。
`save`([path, serialization_format])	将序列化的自身保存到字节类对象或 (.zip) 文件。
`score`(y[, X, fh])	根据真实值评估预测结果，使用 MAPE（非对称）。
`set_config`(**config_dict)	将配置标志设置为给定值。
`set_params`(**params)	设置此对象的参数。
`set_random_state`([random_state, deep, ...])	为自身设置 random_state 伪随机种子参数。
`set_tags`(**tag_dict)	将实例级别标签覆盖设置为给定值。
`update`(y[, X, update_params])	更新截止点值，以及可选的已拟合参数。
`update_predict`(y[, cv, X, update_params, ...])	进行预测并在测试集上迭代更新模型。
`update_predict_single`([y, fh, X, update_params])	用新数据更新模型并进行预测。

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则会引发 NotFittedError 异常。

参数:

method_name字符串，可选: 调用此函数的方法的名称。如果提供，错误消息将包含此信息。

引发:

NotFittedError: 如果估计器尚未拟合。

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字符串或字符串列表，默认值 = None: 要克隆的标签名称。默认值 (None) 将克隆 estimator 中的所有标签。

返回:

self: 对 self 的引用。

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

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

参数:

parameter_set字符串，默认值=”default”: 要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，将返回 “default” 集。

返回:

instance具有默认参数的类的实例

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

创建所有测试实例列表和它们的名称列表。

参数:

parameter_set字符串，默认值=”default”: 要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，将返回 “default” 集。

返回:

objs类 cls 的实例列表: 第 i 个实例是 cls(**cls.get_test_params()[i])
names字符串列表，长度与 objs 相同: 第 i 个元素是测试中对象第 i 个实例的名称。如果有多个实例，命名约定是 {cls.__name__}-{i}，否则是 {cls.__name__}

property cutoff[source]#

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

返回:

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

property fh[source]#: 已传递的预测视野。

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 (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型 pd.DataFrame 的 list
Hierarchical scitype = 分层集合，用于分层预测。具有 3 级或更多行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

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

fh整数、列表、可强制转换为 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") 为 True，则 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.Series 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型 pd.DataFrame 的 list
Hierarchical scitype = 分层集合，用于分层预测。具有 3 级或更多行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

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

fh整数、列表、可强制转换为 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") 为 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)[source]#

从类中获取类标签值，具有来自父类的标签级继承。

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

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

它从对象中返回名称为 tag_name 的标签的值，考虑标签覆盖，按以下降序优先级：

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

按继承顺序。

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

要检索具有潜在实例覆盖的标签值，请改用 get_tag 方法。

参数:

tag_name字符串: 标签值的名称。
tag_value_default任何类型，可选；默认值=None: 如果未找到标签时的默认/备用值。

返回:

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_tags字典: 标签名称：标签值对的字典。通过嵌套继承从 _tags 类属性收集。不被通过 set_tags 或 clone_tags 设置的动态标签覆盖。

get_config()[source]#

获取自身的配置标志。

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

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

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

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

返回:

config_dict字典: 配置名称：配置值对的字典。通过嵌套继承从 _config 类属性收集，然后收集来自 _onfig_dynamic 对象属性的任何覆盖和新标签。

get_fitted_params(deep=True)[source]#

获取已拟合的参数。

所需状态: 要求状态为“已拟合”。

参数:

deep布尔值，默认值=True

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

如果为 True，将返回此对象的参数名称：值字典，包括可拟合组件的已拟合参数（= BaseEstimator 类型参数）。
如果为 False，将返回此对象的参数名称：值字典，但不包括组件的已拟合参数。

返回:

fitted_params键为字符串的字典

已拟合参数的字典，paramname：paramvalue 键值对包括：

总是：此对象的所有已拟合参数，如通过 get_param_names 获取。值是该键对应的此对象的已拟合参数值。
如果 deep=True，还包含组件参数的键值对，组件的参数索引为 [componentname]__[paramname]，componentname 的所有参数都以 paramname 及其值的形式出现。
如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等。

classmethod get_param_defaults()[source]#

获取对象的参数默认值。

返回:

default_dict: 字典[str, Any]: 键是 cls 中在 __init__ 中定义了默认值的所有参数。值是在 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数:

sort布尔值，默认值=True: 是按字母顺序返回参数名称 (True)，还是按它们在类 __init__ 中出现的顺序返回 (False)。

返回:

param_names: 列表[str]: cls 的参数名称列表。如果 sort=False，则按它们在类 __init__ 中出现的顺序；如果 sort=True，则按字母顺序排列。

get_params(deep=True)[source]#

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

参数:

deep布尔值，默认值=True

是否返回组件的参数。

如果为 True，将返回此对象的参数名称：值 dict，包括组件的参数（= BaseObject 类型参数）。
如果为 False，将返回此对象的参数名称：值 dict，但不包括组件的参数。

返回:

params键为字符串的字典

参数字典，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 的单个标签的值，考虑到标签覆盖，优先级按以下降序排列

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

在实例构建时。

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

按继承顺序。

参数:

tag_name字符串: 要检索的标签名称
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 的键值对，它们是对象构造后不会更改的静态标志。

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

值是相应的标签值，覆盖优先级按以下降序：

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

在实例构建时。

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

按继承顺序。

返回:

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

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

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

参数:

parameter_set字符串，默认值=”default”: 要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，则会返回 "default" 集。

返回:

params字典或字典列表，默认值 = {}: 用于创建类测试实例的参数。每个字典都是用于构建“有趣”测试实例的参数，即 MyClass(**params) 或 MyClass(**params[i]) 会创建一个有效的测试实例。 create_test_instance 使用 params 中的第一个（或唯一一个）字典

is_composite()[source]#

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

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

返回:

composite: 布尔值: 对象是否有任何参数的值是 BaseObject 的子类实例。

property is_fitted[source]#

是否已调用 fit 方法。

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

返回:

布尔值: 估计器是否已被 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) 的结果

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

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

所需状态: 要求状态为“已拟合（fitted）”，即 self.is_fitted=True。

在 self 中访问

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

self.cutoff, self.is_fitted

写入自身: 如果传入 fh 且之前未传入过，则将 fh 存储到 self.fh。

参数:

fh整数、列表、可强制转换为 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)[source]#

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

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

所需状态: 要求状态为“已拟合（fitted）”，即 self.is_fitted=True。

在 self 中访问

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

self.cutoff, self.is_fitted

写入自身: 如果传入 fh 且之前未传入过，则将 fh 存储到 self.fh。

参数:

fh整数、列表、可强制转换为 pd.Index，或 ForecastingHorizon，默认值=None

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

如果 fh 非 None 且不是 ForecastingHorizon 类型，则会在内部（通过 _check_fh）强制转换为 ForecastingHorizon。

如果 fh 是 int 或类似 int 的数组，则被解释为相对预测范围，并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)。
如果 fh 类型为 pd.Index，则被解释为绝对预测范围，并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

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

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

coverage浮点数或唯一浮点数的列表，可选（默认值=0.90）

预测区间的名义覆盖度

返回:

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

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

注意

目前仅为 Series（非面板、非层次）y 实现。
返回的分布对象需要安装 skpro。

所需状态: 要求状态为“已拟合（fitted）”，即 self.is_fitted=True。

在 self 中访问

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

self.cutoff, self.is_fitted

写入自身: 如果传入 fh 且之前未传入过，则将 fh 存储到 self.fh。

参数:

fh整数、列表、可强制转换为 pd.Index，或 ForecastingHorizon，默认值=None

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

如果 fh 非 None 且不是 ForecastingHorizon 类型，则会在内部（通过 _check_fh）强制转换为 ForecastingHorizon。

如果 fh 是 int 或类似 int 的数组，则被解释为相对预测范围，并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)。
如果 fh 类型为 pd.Index，则被解释为绝对预测范围，并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

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

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

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

返回的分布是否按时间索引是边际分布

返回:

pred_distskpro BaseDistribution: 如果 marginal=True，则为预测分布；如果 marginal=False 且方法已实现，则为按时间点的边际分布；否则为联合分布

predict_quantiles(fh=None, X=None, alpha=None)[source]#

计算/返回分位数预测结果。

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

所需状态: 要求状态为“已拟合（fitted）”，即 self.is_fitted=True。

在 self 中访问

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

self.cutoff, self.is_fitted

写入自身: 如果传入 fh 且之前未传入过，则将 fh 存储到 self.fh。

参数:

fh整数、列表、可强制转换为 pd.Index，或 ForecastingHorizon，默认值=None

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

如果 fh 非 None 且不是 ForecastingHorizon 类型，则会在内部（通过 _check_fh）强制转换为 ForecastingHorizon。

如果 fh 是 int 或类似 int 的数组，则被解释为相对预测范围，并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)。
如果 fh 类型为 pd.Index，则被解释为绝对预测范围，并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

Xsktime 兼容格式的时间序列，可选（默认值=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，则将在 range(len(y.shape[0])) 的 fh 处计算残差。

所需状态: 要求状态为“已拟合（fitted）”。如果已设置 fh，则必须对应于 y 的索引（pandas 或整数）。
在 self 中访问: 以“_”结尾的已拟合模型属性。self.cutoff, self._is_fitted
写入自身: 无。

参数:

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") 为 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]#

计算/返回方差预测结果。

所需状态: 要求状态为“已拟合（fitted）”，即 self.is_fitted=True。

在 self 中访问

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

self.cutoff, self.is_fitted

写入自身: 如果传入 fh 且之前未传入过，则将 fh 存储到 self.fh。

参数:

fh整数、列表、可强制转换为 pd.Index，或 ForecastingHorizon，默认值=None

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

如果 fh 非 None 且不是 ForecastingHorizon 类型，则会在内部（通过 _check_fh）强制转换为 ForecastingHorizon。

如果 fh 是 int 或类似 int 的数组，则被解释为相对预测范围，并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)。
如果 fh 类型为 pd.Index，则被解释为绝对预测范围，并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

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

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

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

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

返回:

pred_varpd.DataFrame，格式取决于 cov 变量

如果 cov=False

列名与 fit/update 中传递的 y 完全相同。: 对于无名称格式，列索引将是 RangeIndex。
行索引是 fh，额外的级别等于实例级别，: 来自 fit 中看到的 y，如果 fit 中看到的 y 是 Panel 或 Hierarchical。

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

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

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

如果 cov=True: 列索引是多级索引：第一级是变量名（如上所述）
行索引是 fh，额外的级别等于实例级别，: 来自 fit 中看到的 y，如果 fit 中看到的 y 是 Panel 或 Hierarchical。
第二级是 fh。: 条目是（协）方差预测，对应于列索引中的变量，以及

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

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

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

reset()[source]#

结果是将 self 设置为构造函数调用后的状态，并保留相同的超参数。通过 set_config 设置的配置值也会保留。

一个 reset 调用会删除所有对象属性，除了
超参数 = __init__ 的参数，写入到 self 中，例如 self.paramname，其中 paramname 是 __init__ 的参数
包含双下划线的对象属性，即字符串“__”。例如，名为“__myattr”的属性会保留。

配置属性，配置会保留不变。也就是说，reset 前后 get_config 的结果相同。

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

等同于 clone，但 reset 修改的是 self，而不是返回一个新对象。

返回:

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

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

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

save(path=None, serialization_format='pickle')[source]#

行为：如果 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

根据真实值评估预测结果，使用 MAPE（非对称）。

参数:

score(y, X=None, fh=None)[source]#: ypd.Series, pd.DataFrame 或 np.ndarray (1D 或 2D)
fh整数、列表、可强制转换为 pd.Index，或 ForecastingHorizon，默认值=None: 编码要进行预测的时间戳的预测视野。
要评分的时间序列: Xpd.DataFrame 或 2D np.array，可选（默认值=None）

返回:

要评分的外生时间序列；如果 self.get_tag(“X-y-must-have-same-index”) 为 True，则 X.index 必须包含 y.index: score浮点数

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

另请参阅

sktime.performance_metrics.forecasting.mean_absolute_percentage_error

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

参数:

config_dict字典

set_config(**config_dict)[source]#

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

display字符串，“diagram”（默认值）或“text”

jupyter kernel 如何显示 self 的实例
“diagram” = html 框图表示

“text” = 字符串打印输出

print_changed_only布尔值，默认值=True

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

warnings字符串，“on”（默认值）或“off”

是否引发警告，仅影响来自 sktime 的警告
“on” = 将引发来自 sktime 的警告

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

backend:parallel字符串，可选，默认值=“None”

广播/向量化时用于并行的后端，可选值如下
“None”：顺序执行循环，简单的列表推导
“loky”、“multiprocessing”和“threading”：使用 joblib.Parallel
“joblib”：自定义和第三方 joblib 后端，例如 spark
“dask”：使用 dask，需要环境中安装 dask 包

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

backend:parallel:params字典，可选，默认值={}（未传递参数）

作为配置传递给并行化后端的附加参数。有效键取决于 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”：布尔值，默认值=True；False 阻止 ray 在并行化后
- 关闭。
- “logger_name”：字符串，默认值=“ray”；要使用的日志记录器名称。

“mute_warnings”：布尔值，默认值=False；如果为 True，则抑制警告

remember_data布尔值，默认值=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>。如果引用明确，例如没有两个组件参数同名 <parameter>，则也可以使用字符串 <parameter>，无需带 <component>__。: **params字典

返回:

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

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

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

set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

通过 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_state整数，RandomState 实例或 None，默认值=None

deep布尔值，默认值=True

伪随机数生成器，用于控制随机整数的生成。传递整数可在多次函数调用中获得可重现的输出。

deep布尔值，默认值=True
是否在值为 skbase 对象的参数（即组件估计器）中设置随机状态。

如果为 False，则仅设置 self 的 random_state 参数（如果存在）。

如果为 True，则也会设置组件对象中的 random_state 参数。
self_policy字符串，可选值为 {“copy”, “keep”, “new”} 之一，默认值=“copy”
“copy”：self.random_state 设置为输入的 random_state

“keep”：self.random_state 保持不变

返回:

“new”：self.random_state 设置为新的随机状态，

从输入的 random_state 派生，通常与它不同

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

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

self对 self 的引用

set_tags(**tag_dict)[source]#

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

当前标签值可以通过 get_tags 或 get_tag 进行检查。

参数:

set_tags 将动态标签覆盖设置为 tag_dict 中指定的值，其中键是标签名称，字典值是要将标签设置为何值。: set_tags 方法只能在对象的 __init__ 方法中，在构造期间或通过 __init__ 直接构造后调用。

返回:

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

Self

更新截止点值，以及可选的已拟合参数。

对 self 的引用。

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

如果未实现估计器特定的 update 方法，默认回退如下

所需状态: 要求状态为“已拟合（fitted）”，即 self.is_fitted=True。

在 self 中访问

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

self.cutoff, self.is_fitted

写入自身

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

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

参数:

y时间序列，以 sktime 兼容的数据容器格式表示。

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

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

Series scitype = 单个时间序列，普通预测。pd.DataFrame, pd.Series 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型 pd.DataFrame 的 list
Hierarchical scitype = 分层集合，用于分层预测。具有 3 级或更多行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

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

X时间序列，以 sktime 兼容格式表示，可选 (默认值=None)。

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

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

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

返回:

“new”：self.random_state 设置为新的随机状态，

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

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

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

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

是否应更新模型参数。如果为 False，则仅更新截止点，模型参数（例如系数）不更新。
update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#
执行多个 update / predict 的简写方式，数据回放基于时间分割器 cv。
update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#
与以下操作相同（如果只有 y、cv 不是默认值）
self.update(y=cv.split_series(y)[0][0])

对 self 的引用。

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

如果未实现估计器特定的 update 方法，默认回退如下

所需状态: 要求状态为“已拟合（fitted）”，即 self.is_fitted=True。

在 self 中访问

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

self.cutoff, self.is_fitted

记住 self.predict() （稍后在单个批次中返回）

update_params=True：拟合所有迄今为止观测到的数据
update_params=False：仅更新截止点并记住数据

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

参数:

y时间序列，以 sktime 兼容的数据容器格式表示。

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

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

Series scitype = 单个时间序列，普通预测。pd.DataFrame, pd.Series 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型 pd.DataFrame 的 list
Hierarchical scitype = 分层集合，用于分层预测。具有 3 级或更多行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

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

等等

返回所有记住的预测结果

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

写入 self（除非 reset_forecaster=True）

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

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

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

ypd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D)
用于更新和预测的时间序列。

返回:

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_params布尔值，可选（默认值=True）

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

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

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

所需状态: 要求状态为“已拟合”。
在 self 中访问: 如果为 True，则不会改变预测器的状态，即 update/predict 序列使用副本运行，并且 self 的截止点、模型参数、数据内存都不会改变
写入自身: 如果为 False，则在运行 update/predict 序列时会更新 self，就像直接调用 update/predict 一样

y_pred汇总来自多个分割批次的点预测结果的对象

参数:

y时间序列，以 sktime 兼容的数据容器格式表示。

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

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

Series scitype = 单个时间序列，普通预测。pd.DataFrame, pd.Series 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型 pd.DataFrame 的 list
Hierarchical scitype = 分层集合，用于分层预测。具有 3 级或更多行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

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

fh整数、列表、可强制转换为 pd.Index，或 ForecastingHorizon，默认值=None

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

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

写入 self（除非 reset_forecaster=True）

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

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

返回:

y_predsktime 兼容数据容器格式的时间序列: 在 fh 处的点预测，与 fh 具有相同的索引。y_pred 的类型与最近传递的 y 相同：Series, Panel, Hierarchical scitype，格式相同（见上文）。