RecursiveTabularRegressionForecaster#

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

从预测到表格回归的递归归约方法。

对于递归策略，首先拟合一个估计器用于一步向前预测，然后迭代调用该估计器以预测多个未来时间步。

参数:

estimator估计器: scikit-learn 提供的表格回归估计器。
window_lengthint，可选（默认值=10）: 用于将时间序列转换为表格矩阵的滑动窗口长度。
transformers: 转换器列表（默认值 = None）: 适用于与 make_reduction 一起使用整体（en-bloc）方法的转换器列表。这意味着，不再使用窗口长度内的 y 的原始过去观测值，而是直接从过去的原始观测值中生成合适的特征。目前仅支持 WindowSummarizer（或 WindowSummarizer 列表）来生成特征，例如过去 7 个观测值的平均值。
pooling: str {“local”, “global”}，可选: 指定是在每个实例级别（“local”）拟合单独的模型，还是拟合一个模型用于所有实例（“global”）。

属性:

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_namestr，可选: 调用此方法的函数名称。如果提供，错误消息将包含此信息。

引发:

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

clone()[source]#

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

克隆是一个没有共享引用的不同对象，处于初始化后状态。此函数等效于返回 sklearn.clone(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)[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_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 个对象实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

property cutoff[source]#

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

返回:

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

property fh[source]#: 传递的预测范围。

传递的预测范围。

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

fit(y, X=None, fh=None)[source]#: 状态变更

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

写入自身

设置以“_”结尾的已拟合模型属性，已拟合属性可通过 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 (实例, 时间)，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 中传递，不可选

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=None, fh=None)[source]#: 状态变更

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

写入自身

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

将 self.is_fitted 标志设置为 True。

等同于 fit(y, X, fh).predict(X_pred)。如果未传递 X_pred，则等同于 fit(y, fh, X).predict(X)。

参数:

将 fh 存储到 self.fh。

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

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

sktime 中的个体数据格式是所谓的 mtype 规范，每个 mtype 都实现一个抽象的 scitype。
Series scitype = 单个时间序列，标准预测。pd.DataFrame、pd.Series 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，Series 类型的 pd.DataFrame list

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

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

fhint, list, pd.Index 可强制转换类型, 或 ForecastingHorizon（不可选）

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

编码要预测的时间戳的预测范围。如果 self.get_tag("requires-fh-in-fit") 为 True，则必须在 fit 中传递，不可选

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

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

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, raise_error=True)[source]#

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

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

它从对象中返回名称为 tag_name 的标签值，考虑标签覆盖，优先级从高到低顺序如下：
设置在类的 _tags 属性中的标签。

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

按继承顺序。

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

参数:

要检索可能包含实例覆盖的标签值，请改用 get_tag 方法。: tag_namestr
标签值的名称。: tag_value_default任意类型

返回:

如果未找到标签，则为默认/回退值。: tag_value

self 中名称为 tag_name 的标签值。如果未找到，则返回 tag_value_default。

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

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

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

classmethod get_class_tags()[source]#

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

它返回一个字典，其键是类或其任何父类中设置的 _tags 的任何属性的键。

它从对象中返回名称为 tag_name 的标签值，考虑标签覆盖，优先级从高到低顺序如下：
设置在类的 _tags 属性中的标签。

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

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

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

按继承顺序。

要检索可能包含实例覆盖的标签，请改用 get_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 类型的 dict

已拟合参数的字典，参数名 : 参数值键值对包括
始终：此对象的所有已拟合参数，如通过 get_param_names 获取的值是此对象该键的已拟合参数值
如果 deep=True，还包含组件参数的键/值对，组件参数以 [组件名]__[参数名] 方式索引，组件名 的所有参数以 参数名 及其值出现

如果 deep=True，还包含任意级别的组件递归，例如 [组件名]__[子组件名]__[参数名] 等

classmethod get_param_defaults()[source]#

返回:

获取对象的参数默认值。: default_dict: dict[str, Any]

键是 cls 中所有在 __init__ 中定义了默认值的参数。值是在 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)[source]#

参数:

获取对象的参数名称。: sortbool，默认值=True

返回:

是否按字母顺序返回参数名称（True），或按它们在类 __init__ 中出现的顺序返回（False）。: param_names: list[str]

cls 的参数名称列表。如果 sort=False，则按它们在类 __init__ 中出现的相同顺序。如果 sort=True，则按字母顺序排序。

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

参数:

要求状态为“已拟合”。

get_params(deep=True)[source]#

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

返回:

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

params键为 str 类型的 dict

参数字典，参数名 : 参数值键值对包括
始终：此对象的所有已拟合参数，如通过 get_param_names 获取的值是此对象该键的已拟合参数值
如果 deep=True，还包含组件参数的键/值对，组件参数以 [组件名]__[参数名] 方式索引，组件名 的所有参数以 参数名 及其值出现

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

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

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

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

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

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

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

它从对象中返回名称为 tag_name 的标签值，考虑标签覆盖，优先级从高到低顺序如下：
设置在类的 _tags 属性中的标签。

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

参数:

要检索可能包含实例覆盖的标签值，请改用 get_tag 方法。: 在实例构造时。
要检索的标签名称: 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。

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

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

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

get_tags()[source]#

它返回一个字典，其键是类或其任何父类中设置的 _tags 的任何属性的键。

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

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

它从对象中返回名称为 tag_name 的标签值，考虑标签覆盖，优先级从高到低顺序如下：
设置在类的 _tags 属性中的标签。

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

返回:

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

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

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

参数:

parameter_setstr，默认值=”default”: classmethod get_test_params(parameter_set='default')[source]#

返回:

要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，则将返回 "default" 集。: paramsdict 或 list of dict，默认值 = {}

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

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

is_composite()[source]#

返回:

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

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

是否已调用 fit 方法。

property is_fitted[source]#

返回:

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

估计器是否已 fit。

从文件位置加载对象。

参数:

classmethod load_from_path(serial)[source]#

返回:

serialZipFile(path).open(“object) 的结果

解序列化自身，结果输出到 path，即 cls.save(path) 的输出

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

参数:

classmethod load_from_serial(serial)[source]#

返回:

serialcls.save(None) 输出的第一个元素

解序列化自身，结果输出为 serial，即 cls.save(None) 的输出

预测未来时间序列。

get_fitted_params(deep=True)[source]#: predict(fh=None, X=None)[source]#

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

访问自身中的属性

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

将状态变更为“已拟合”。: self.cutoff, self.is_fitted

参数:

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

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

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

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

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

返回:

用于预测的外生时间序列。如果传递，将在 predict 中使用，而不是 X。应与 fit 中的 y 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。: y_predsktime 兼容数据容器格式的时间序列

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

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

predict_interval(fh=None, X=None, coverage=0.9)[source]#

get_fitted_params(deep=True)[source]#: predict(fh=None, X=None)[source]#

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

访问自身中的属性

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

将状态变更为“已拟合”。: self.cutoff, self.is_fitted

参数:

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

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

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

如果 fh 不为 None 且不是 ForecastingHorizon 类型，它在内部（通过 _check_fh）会被强制转换为 ForecastingHorizon。
如果 fh 的类型是 pd.Index，则它被解释为绝对预测范围，并被强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

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

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

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)[源文件]#

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

注意

目前仅对 Series (非面板, 非层级) 类型的 y 实现。
返回的分布对象需要安装 skpro。

get_fitted_params(deep=True)[source]#: predict(fh=None, X=None)[source]#

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

访问自身中的属性

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

将状态变更为“已拟合”。: self.cutoff, self.is_fitted

参数:

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

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

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

如果 fh 不为 None 且不是 ForecastingHorizon 类型，它在内部（通过 _check_fh）会被强制转换为 ForecastingHorizon。
如果 fh 的类型是 pd.Index，则它被解释为绝对预测范围，并被强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

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

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

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

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

返回:

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

predict_quantiles(fh=None, X=None, alpha=None)[源文件]#

计算/返回分位数预测。

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

get_fitted_params(deep=True)[source]#: predict(fh=None, X=None)[source]#

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

访问自身中的属性

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

将状态变更为“已拟合”。: self.cutoff, self.is_fitted

参数:

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

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

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

如果 fh 不为 None 且不是 ForecastingHorizon 类型，它在内部（通过 _check_fh）会被强制转换为 ForecastingHorizon。
如果 fh 的类型是 pd.Index，则它被解释为绝对预测范围，并被强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

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

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

alpha浮点数或唯一浮点数的列表，可选（默认=[0.05, 0.95]）

一个或多个概率，用于计算分位数预测。

返回:

quantilespd.DataFrame

列具有多级索引：第一级是fit中y的变量名，: 第二级是传递给函数的 alpha 值。
行索引是 fh，附加（上层）级别等于实例级别，: 来自fit中看到的y，如果fit中看到的y是Panel或Hierarchical类型。
条目是分位数预测，对于列索引中的变量，: 在第二列索引中的分位数概率下，对应行索引。

predict_residuals(y=None, X=None)[源文件]#

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

将计算在 y.index 上的预测的残差。

如果 fh 必须在 fit 中传递，则必须与 y.index 一致。如果 y 是 np.ndarray 且在 fit 中未传递 fh，则将在 fh 为 range(len(y.shape[0])) 处计算残差。

get_fitted_params(deep=True)[source]#: 要求状态为“已拟合”（fitted）。如果已设置 fh，则必须对应 y 的索引（pandas 或整数）。
要求状态为“已拟合”，即 self.is_fitted=True。: 已拟合模型属性以“_”结尾。self.cutoff, self._is_fitted
将状态变更为“已拟合”。: 无。

参数:

将 fh 存储到 self.fh。

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

返回:

y_ressktime 兼容数据容器格式的时间序列: 在 fh 处的预测残差，与 fh 具有相同的索引。y_res 与最近传递的 y 具有相同的类型：Series、Panel、Hierarchical 科研类型，格式相同（见上文）。

predict_var(fh=None, X=None, cov=False)[源文件]#

计算/返回方差预测。

get_fitted_params(deep=True)[source]#: predict(fh=None, X=None)[source]#

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

访问自身中的属性

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

将状态变更为“已拟合”。: self.cutoff, self.is_fitted

参数:

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

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

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

如果 fh 不为 None 且不是 ForecastingHorizon 类型，它在内部（通过 _check_fh）会被强制转换为 ForecastingHorizon。
如果 fh 的类型是 pd.Index，则它被解释为绝对预测范围，并被强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

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

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

cov布尔型，可选（默认=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')[源文件]#

将序列化的自身保存到字节状对象或到 (.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，默认 = “pickle”

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

返回:

如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 引用该文件的 ZipFile

score(y, X=None, fh=None)[源文件]#

使用 MAPE（非对称）对照真实值评估预测。

参数:

ypd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D): 用于评分的时间序列
有关数据格式的更多详细信息，请参阅 mtype 的术语表。有关用法，请参阅预测教程 examples/01_forecasting.ipynb: fhint, list, pd.Index 可强制转换类型, 或 ForecastingHorizon（不可选）
Xpd.DataFrame 或二维 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

set_config(**config_dict)[源文件]#

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

参数:

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

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

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

在 fit 中是否存储 self._X 和 self._y，并在 update 中更新。如果为 True，则存储并更新 self._X 和 self._y。如果为 False，则不存储和更新 self._X 和 self._y。这在使用 save 时减少了序列化大小，但 update 将默认为“不执行任何操作”，而不是“重新拟合所有已见数据”。

返回:

self对 self 的引用。

注意

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

set_params(**params)[源文件]#

设置此对象的参数。

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

参数:

**params字典: BaseObject 参数，键必须是 `__` 字符串。如果 `__` 后缀在 get_params 键中唯一，则可以作为完整字符串的别名。

返回:

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

set_random_state(random_state=None, deep=True, self_policy='copy')[源文件]#

设置自身的 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_state整型，RandomState 实例或 None，默认=None

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

要求状态为“已拟合”。

是否在 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 派生，通常与输入值不同

返回:

self对 self 的引用

set_tags(**tag_dict)[源文件]#

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

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

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

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

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

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

参数:

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

返回:

Self: 对 self 的引用。

update(y, X=None, update_params=True)[源文件]#

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

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

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

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

get_fitted_params(deep=True)[source]#: predict(fh=None, X=None)[source]#

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

访问自身中的属性

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

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

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

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

参数:

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

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

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

sktime 中的个体数据格式是所谓的 mtype 规范，每个 mtype 都实现一个抽象的 scitype。
Series scitype = 单个时间序列，标准预测。pd.DataFrame、pd.Series 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，Series 类型的 pd.DataFrame list

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

编码要预测的时间戳的预测范围。如果 self.get_tag("requires-fh-in-fit") 为 True，则必须在 fit 中传递，不可选

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

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

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

返回:

self对 self 的引用

update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[源文件]#

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

此方法是执行多个 update / predict 调用链的简写，数据回放基于时间分割器 cv。

与以下操作相同（如果仅 y 和 cv 非默认）：

self.update(y=cv.split_series(y)[0][0])
记忆 self.predict()（稍后在单个批次中返回）
self.update(y=cv.split_series(y)[1][0])
记忆 self.predict()（稍后在单个批次中返回）
等等
返回所有记忆的预测

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

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

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

get_fitted_params(deep=True)[source]#: predict(fh=None, X=None)[source]#

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

访问自身中的属性

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

写入 self（除非 reset_forecaster=True）

将 self.cutoff 更新为 y 中看到的最新索引。
如果 update_params=True，则更新以“_”结尾的已拟合模型属性。

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

参数:

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

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

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

sktime 中的个体数据格式是所谓的 mtype 规范，每个 mtype 都实现一个抽象的 scitype。
Series scitype = 单个时间序列，标准预测。pd.DataFrame、pd.Series 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，Series 类型的 pd.DataFrame list

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

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

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

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

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

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

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

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

如果为 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)[源文件]#

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

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

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

get_fitted_params(deep=True)[source]#: 所需状态
要求状态为“已拟合”，即 self.is_fitted=True。: 以“_”结尾的已拟合模型属性。指向已见数据的指针，self._y 和 self.X。self.cutoff, self._is_fitted。如果 update_params=True，则更新以“_”结尾的模型属性。
将状态变更为“已拟合”。: 通过追加行来更新 self._y 和 self._X。将 self.cutoff 和 self._cutoff 更新为 y 中看到的最后一个索引。如果 update_params=True，

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

参数:

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

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

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

sktime 中的个体数据格式是所谓的 mtype 规范，每个 mtype 都实现一个抽象的 scitype。
Series scitype = 单个时间序列，标准预测。pd.DataFrame、pd.Series 或 np.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

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

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

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

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

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

返回:

用于预测的外生时间序列。如果传递，将在 predict 中使用，而不是 X。应与 fit 中的 y 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。: y_predsktime 兼容数据容器格式的时间序列