DirectTabularRegressionForecaster#

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

将预测直接还原为表格回归。

对于直接还原策略，需要为预测范围内的每个提前步长拟合一个独立的预测器。

参数:

estimator估计器: 由 scikit-learn 提供的表格回归估计器。
window_lengthint，可选（默认为 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`()	检查对象是否由其他 BaseObjects 组成。
`load_from_path`(serial)	从文件位置加载对象。
`load_from_serial`(serial)	从序列化内存容器加载对象。
`predict`([fh, X])	在未来范围预测时间序列。
`predict_interval`([fh, X, coverage])	计算/返回预测区间预测。
`predict_proba`([fh, X, marginal])	计算/返回全概率预测。
`predict_quantiles`([fh, X, alpha])	计算/返回分位数预测。
`predict_residuals`([y, X])	返回时间序列预测的残差。
`predict_var`([fh, X, cov])	计算/返回方差预测。
`reset`()	将对象重置为初始化后的干净状态。
`save`([path, serialization_format])	将序列化后的对象保存到字节类对象或到 (.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)。

等同于使用 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])
names字符串列表，长度与 objs 相同: 第 i 个元素是 tests 中 obj 的第 i 个实例的名称。如果实例多于一个，命名约定是 {cls.__name__}-{i}，否则是 {cls.__name__}

property cutoff[source]#

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

返回:

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

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

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

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

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

写入 self

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

将 self.is_fitted 标志设置为 True。

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

如果传入了 fh，则将 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)，或 list 类型的 pd.DataFrame 列表
Hierarchical scitype = 分层集合，用于分层预测。具有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

有关数据格式的更多详细信息，请参阅 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 = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，或 list 类型的 pd.DataFrame 列表
Hierarchical scitype = 分层集合，用于分层预测。具有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

有关数据格式的更多详细信息，请参阅 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）

用于预测的外生时间序列。如果传入，将在 predict 中使用，而不是 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 的标签值，考虑标签覆盖，按以下降序优先级排列

在类的 _tags 属性中设置的标签。
在父类的 _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 属性的任何键。

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

在类的 _tags 属性中设置的标签。
在父类的 _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，将返回此对象的参数名称 : 值字典，包括组件（= BaseObject 值参数）的参数。
如果为 False，将返回此对象的参数名称 : 值字典，但不包含组件的参数。

返回:

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

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

在实例构建时。

在类的 _tags 属性中设置的标签。
在父类的 _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 设置的标签。

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

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

在实例构建时。

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

按继承顺序。

返回:

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

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

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

参数:

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

返回:

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

is_composite()[source]#

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

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

返回:

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) 的结果

返回:

反序列化 self 得到 cls.save(path) 在 path 的输出

classmethod load_from_serial(serial)[source]#

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

参数:

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

返回:

反序列化 self 得到 cls.save(None) 的输出 serial

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

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

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

在 self 中访问

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

self.cutoff, self.is_fitted

写入 self: 如果传入了 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）

用于预测的外生时间序列。应与 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 且之前未传入过，则将 fh 存储到 self.fh。

参数:

fhint、list、pd.Index 可强制转换，或 ForecastingHorizon，默认=None

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

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

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

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

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

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

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

返回:

pred_intpd.DataFrame

列具有多级索引：第一级是 fit 中 y 的变量名，

第二级是计算区间的覆盖率。: 与输入 coverage 的顺序相同。

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

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

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

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

对于列索引中的 var，在第二列索引中的名义覆盖率，根据第三列索引决定下限/上限，对于行索引。区间上限/下限预测等同于在 alpha = 0.5 - c/2, 0.5 + c/2 (c 为 coverage 中的值) 处的 ADVISED 分位数预测。

predict_proba(fh=None, X=None, marginal=True)[source]#

计算/返回全概率预测。

注意

当前仅为 Series (非面板、非分层) y 实现。
返回的分布对象需要安装 skpro。

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

在 self 中访问

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

self.cutoff, self.is_fitted

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

参数:

fhint、list、pd.Index 可强制转换，或 ForecastingHorizon，默认=None

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

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

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

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

用于预测的外生时间序列。应与 fit 中的 y 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index")，则 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 且之前未传入过，则将 fh 存储到 self.fh。

参数:

fhint、list、pd.Index 可强制转换，或 ForecastingHorizon，默认=None

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

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

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

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

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

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

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

返回:

quantilespd.DataFrame

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

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 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须同时包含 fh 索引引用和 y.index。

返回:

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

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

计算/返回方差预测。

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

在 self 中访问

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

self.cutoff, self.is_fitted

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

参数:

fhint、list、pd.Index 可强制转换，或 ForecastingHorizon，默认=None

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

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

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

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

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

covbool，可选（默认=False）

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

返回:

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

如果 cov=False

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

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

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

如果 cov=True

列索引是多级索引：第一级是变量名（如上）: 第二级是 fh。
行索引是 fh，附加级别等于实例级别，: 来自 fit 中看到的 y，如果 fit 中看到的 y 是 Panel 或 Hierarchical。
条目是（协）方差预测，对于列索引中的 var，以及: 行和列中的时间索引之间的协方差。

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

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: 类实例重置为干净的初始化后状态，但保留当前的超参数值。

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”，则将在当前工作目录创建 estimator.zip zip 文件。
path=”/home/stored/estimator”，则 estimator.zip 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”)，则 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 参数 (True)，还是列出所有参数名称和值 (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 中存储 self._X 和 self._y 并在 update 中更新。如果为 True，则存储并更新 self._X 和 self._y。如果为 False，则不存储也不更新 self._X 和 self._y。这在使用 save 时减小了序列化大小，但 update 将默认为“不执行任何操作”，而不是“重新拟合所有已见数据”。

返回:

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对自身的引用（设置参数后）

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，则仅设置 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对自身的引用

set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:

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

返回:

Self: 对自身的引用。

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

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

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

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

update_params=False：仅更新 cutoff 并记住数据

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

在 self 中访问

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

self.cutoff, self.is_fitted

写入 self

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

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

参数:

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

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

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

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

update_paramsbool，可选（默认=True）

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

返回:

self对自身的引用

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

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

用于执行多个 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：仅更新 cutoff 并记住数据

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

在 self 中访问

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

self.cutoff, self.is_fitted

写入 self（除非 reset_forecaster=True）

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

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

参数:

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

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

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

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

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

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

例如，SlidingWindowSplitter 或 ExpandingWindowSplitter；默认 = ExpandingWindowSplitter，initial_window=1，且默认设置是 y/X 中的单个数据点逐个添加和预测，initial_window = 1，step_length = 1，fh = 1

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

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

update_paramsbool，可选（默认=True）

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

reset_forecasterbool，可选（默认=True）

如果为 True，将不改变预测器的状态，即 update/predict 序列将使用副本运行，并且 self 的 cutoff、模型参数、数据内存不改变
如果为 False，则在运行 update/predict 序列时会更新 self，就像直接调用 update/predict 一样

返回:

y_pred从多个分割批次中制表点预测的对象

格式取决于总体预测的 (cutoff, absolute horizon) 对

如果绝对预测范围点集合是唯一的：类型是 sktime 兼容数据容器格式的时间序列，输出中抑制 cutoff，类型与最近传入的 y 相同：Series, Panel, Hierarchical scitype，格式相同（见上文）
如果绝对预测范围点集合不是唯一的：类型是 pandas DataFrame，行和列索引是时间戳，行索引对应于预测的 cutoff，列索引对应于预测的绝对预测范围，条目是根据行索引预测的列索引的点预测，如果在该 (cutoff, horizon) 对处没有进行预测，则条目为 nan

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

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

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

如果未实现特定于估计器的 update 方法，则默认回退为先 update，然后 predict。

所需状态: 要求状态为“已拟合”。
在 self 中访问: 以“_”结尾的拟合模型属性。指向已见数据的指针，self._y 和 self.X。self.cutoff, self._is_fitted。如果 update_params=True，则更新以“_”结尾的模型属性。
写入 self: 通过追加行来使用 y 和 X 更新 self._y 和 self._X。将 self.cutoff 和 self._cutoff 更新为在 y 中看到的最后一个索引。如果 update_params=True，

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

参数:

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

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

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

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

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

fhint、list、pd.Index 可强制转换，或 ForecastingHorizon，默认=None

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

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

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

update_paramsbool，可选（默认=True）

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

返回:

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