MultioutputTimeSeriesRegressionForecaster#

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

从预测到时间序列回归的多输出归约。

对于多输出策略，使用一个能够处理多输出目标的估计器，对预测期内的所有未来步长进行拟合。

参数:
estimatorEstimator

sktime 提供的时序回归估计器。

window_lengthint, optional (default=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()

获取 self 的配置标志。

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

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

score(y[, X, fh])

使用 MAPE（非对称）对预测与真实值进行评分。

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

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

为 self 设置 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。在调用对象的 fit 方法时，应将 is_fitted 属性设置为 True。

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

参数:
method_namestr, optional

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

引发:
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 兼容对象都有一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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

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

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

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

estimatorAn instance of :class:BaseObject or derived class

参数:
tag_namesstr or list of str, default = None
要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回:

self
对 self 的引用。

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

parameter_setstr, default=”default”

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

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

instanceinstance of the class with default parameters

self
classmethod create_test_instances_and_names(parameter_set='default')[source]#
objslist of instances of cls

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

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

instanceinstance of the class with default parameters

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

nameslist of str, same length as objs

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

property cutoff[source]#

cutoffpandas compatible index element, or None

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

self
如果已设置 cutoff，则为 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 or 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

fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

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

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

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

self对 self 的引用。

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) 相同。

在未来预测期拟合和预测时间序列。

将 fh 存储到 self.fh。

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

写入 self

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

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

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

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

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

参数:
fhint, list, pd.Index coercible, or ForecastingHorizon (not optional)

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

Series scitype = 独立时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D or 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

fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

编码预测时间戳的预测期。

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

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

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

self对 self 的引用。

用于预测的外生时间序列。如果传递，将在 predict 中使用而不是 X。应与 fit 中的 y 具有相同的 scitype (Series, Panel, or Hierarchical)。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 fh 索引引用。

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

self
在 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 属性中设置的标签。

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

  2. 按照继承顺序。

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

要检索可能带有实例覆盖的标签值，请改用 get_tag 方法。

tag_namestr

参数:
标签值的名称。

tag_value_defaultany type

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

tag_value

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

classmethod get_class_tags()[source]#

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

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

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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

值是相应的标签值，按照以下优先级顺序覆盖（优先级递减）：

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

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

  2. 按照继承顺序。

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

要检索可能带有实例覆盖的标签，请改用 get_tags 方法。

对于包含动态标签的覆盖，请使用 get_tags。

要检索可能带有实例覆盖的标签值，请改用 get_tag 方法。

collected_tagsdict

标签名称 : 标签值对的字典。通过嵌套继承从 _tags 类属性收集。不会被 set_tags 或 clone_tags 设置的动态标签覆盖。

get_config()[source]#

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

获取 self 的配置标志。

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

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

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

config_dictdict

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

get_fitted_params(deep=True)[source]#

所需状态

获取拟合参数。

需要状态为“已拟合”。

deepbool, default=True

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

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

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

  • fitted_paramsdict with str-valued keys

self
拟合参数字典，paramname : paramvalue 键值对包括：

always: 此对象的所有拟合参数，如同通过 get_param_names 获取一样，值是该键的拟合参数值，属于此对象。

  • if deep=True，还包含组件参数的键/值对，组件参数索引为 [componentname]__[paramname]，componentname 的所有参数都以 paramname 形式出现，及其值。

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

  • classmethod get_param_defaults()[source]#

获取对象的参数默认值。

default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

sortbool, default=True

参数:
是否按字母顺序排序返回参数名称 (True)，或者按它们在类 __init__ 中出现的顺序返回 (False)。

param_names: list[str]

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

get_params(deep=True)[source]#

是否返回组件的参数。

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

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

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

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

  • paramsdict with str-valued keys

self
参数字典，paramname : paramvalue 键值对包括：

always: 此对象的所有参数，如同通过 get_param_names 获取一样，值是该键的参数值，属于此对象，值始终与构造时传递的值相同。

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

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

  • classmethod get_param_defaults()[source]#

get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，按照以下优先级顺序考虑标签覆盖（优先级递减）：

从实例获取标签值，包含标签级别继承和覆盖。

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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

  1. 在实例构造时。

要检索的标签名称

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

  2. 按照继承顺序。

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

参数:
标签值的名称。

tag_value_defaultany type, optional; default=None

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

raise_errorbool

未找到标签时是否引发 ValueError

tag_valueAny

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

ValueError, if raise_error is True.

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

get_tags()[source]#

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

从实例获取标签，包含标签级别继承和覆盖。

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

collected_tagsdict

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

  1. 在实例构造时。

要检索的标签名称

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

  2. 按照继承顺序。

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

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

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

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

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

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

paramsdict or list of dict, default = {}

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

is_composite()[source]#

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

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

composite: bool

self
对象是否具有其值是 BaseObject 后代实例的任何参数。

property is_fitted[source]#

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

是否已调用 fit。

bool

self
估计器是否已 fit。

classmethod load_from_path(serial)[source]#

serialresult of ZipFile(path).open(“object)

从文件位置加载对象。

参数:
反序列化 self，其结果是位于 path 处、通过 cls.save(path) 保存的输出。
self
classmethod load_from_serial(serial)[source]#
serial1st element of output of cls.save(None)

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

参数:
反序列化 self，其结果是序列化输出 serial，通过 cls.save(None) 保存的。
self
predict(fh=None, X=None)[source]#
要求状态为“已拟合”，即 self.is_fitted=True。

在未来预测期预测时间序列。

需要状态为“已拟合”。

在 self 中访问

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

  • self.cutoff, self.is_fitted

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

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

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

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

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

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

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

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

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

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

注意

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

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

需要状态为“已拟合”。

在 self 中访问

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

  • self.cutoff, self.is_fitted

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

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

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

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

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

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

  • 如果 fh 是 int 或 int 的类数组，则解释为相对预测期，并强制转换为相对 ForecastingHorizon(fh, is_relative=True)。

  • 如果 fh 是 pd.Index 类型，则解释为绝对预测期，并强制转换为绝对 ForecastingHorizon(fh, is_relative=False)。

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

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

coveragefloat or list of float of unique values, optional (default=0.90)

预测区间的名义覆盖率

self
pred_intpd.DataFrame
列具有多级索引：第一级是 fit 中 y 的变量名，
第二级是计算区间的覆盖率。

与输入 coverage 中的顺序相同。

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

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

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

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

对于列索引中的变量，在第二列索引的名义覆盖率处，取决于第三列索引的 lower/upper，对应于行索引。区间上限/下限预测等同于在 alpha = 0.5 - c/2, 0.5 + c/2 处的分位数预测，其中 c 是 coverage 中的值。

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

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

注意

  • 目前仅针对 Series（非面板、非分层）y 实现。

  • 返回的分布对象需要安装 skpro。

需要状态为“已拟合”。

在 self 中访问

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

  • self.cutoff, self.is_fitted

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

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

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

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

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

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

  • 如果 fh 是 int 或 int 的类数组，则解释为相对预测期，并强制转换为相对 ForecastingHorizon(fh, is_relative=True)。

  • 如果 fh 是 pd.Index 类型，则解释为绝对预测期，并强制转换为绝对 ForecastingHorizon(fh, is_relative=False)。

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

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

marginalbool, optional (default=True)

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

self
pred_distskpro BaseDistribution

预测分布。如果 marginal=True，将是按时间点的边际分布；如果 marginal=False 且由方法实现，将是联合分布。

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

计算/返回分位数预测。

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

需要状态为“已拟合”。

在 self 中访问

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

  • self.cutoff, self.is_fitted

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

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

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

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

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

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

  • 如果 fh 是 int 或 int 的类数组，则解释为相对预测期，并强制转换为相对 ForecastingHorizon(fh, is_relative=True)。

  • 如果 fh 是 pd.Index 类型，则解释为绝对预测期，并强制转换为绝对 ForecastingHorizon(fh, is_relative=False)。

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

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

alpha浮点数或浮点数唯一值列表，可选 (默认为 [0.05, 0.95])

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

self
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.cutoff, self._is_fitted

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

无。

参数:
fhint, list, pd.Index coercible, or ForecastingHorizon (not optional)

包含地面真实观测值的时间序列，用于计算残差。必须具有与 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。

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

在 fh`, 与 ``fh`` 具有相同的索引处的预测残差。y_res 与最近传递的 y 具有相同的类型：Series, Panel, Hierarchical scitype，相同的格式（参见上文）。

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

计算/返回方差预测。

需要状态为“已拟合”。

在 self 中访问

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

  • self.cutoff, self.is_fitted

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

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

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

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

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

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

  • 如果 fh 是 int 或 int 的类数组，则解释为相对预测期，并强制转换为相对 ForecastingHorizon(fh, is_relative=True)。

  • 如果 fh 是 pd.Index 类型，则解释为绝对预测期，并强制转换为绝对 ForecastingHorizon(fh, is_relative=False)。

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

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

cov布尔值，可选 (默认为 False)

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

self
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 调用会删除任何对象属性，除了

  • 超参数 = 写入 self 的 __init__ 参数，例如 self.paramname，其中 paramname 是 __init__ 的一个参数

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

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

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

等同于 clone，不同之处在于 reset 修改 self 而不是返回新对象。

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

self
对 self 的引用。

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

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

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

行为：如果 path 为 None，则返回一个内存中的序列化 self；如果 path 是文件位置，则将 self 作为 zip 文件存储在该位置

保存的文件是 zip 文件，内容如下：_metadata - 包含 self 的类，即 type(self) _obj - 序列化的 self。此类使用默认序列化方式 (pickle)。

参数:
pathNone 或文件位置 (str 或 Path)

如果为 None，self 会保存到内存对象；如果是文件位置，self 会保存到该文件位置。如果

  • path=”estimator” 则将在当前工作目录创建 zip 文件 estimator.zip。

  • path=”/home/stored/estimator” 则 zip 文件 estimator.zip 将被

存储在 /home/stored/ 中。

serialization_format: str, 默认为 “pickle”

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

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

使用 MAPE（非对称）对预测与真实值进行评分。

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

要评分的时间序列

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

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

Xpd.DataFrame 或 2D np.array，可选 (默认为 None)

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

self
score浮点数

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

另请参阅

sktime.performance_metrics.forecasting.mean_absolute_percentage_error
set_config(**config_dict)[source]#

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

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

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

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

jupyter 内核如何显示 self 的实例

  • “diagram” = html 盒图表示

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

print_changed_only布尔值，默认为 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”：布尔值，默认为 True；False 防止 ray

      在并行化后关闭。

    • “logger_name”：str，默认为“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对 self 的引用。

注意事项

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

set_params(**params)[source]#

设置此对象的参数。

该方法适用于简单的 skbase 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象，即包含其他对象的对象，以访问组件 <component> 中的 <parameter>。如果引用是明确的，也可以使用不带 <component>__ 的字符串 <parameter>，例如，没有两个组件参数同名 <parameter>。

参数:
**params字典

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

self
self对 self 的引用（设置参数后）
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

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

通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 派生的整数。这些整数通过 sample_dependent_seed 从链式哈希中采样，并保证种子随机生成器之间的伪随机独立性。

应用于 self 中的 random_state 参数（取决于 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 对象值的参数（即组件估计器）中设置随机状态。

  • 如果为 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对 self 的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

estimatorAn instance of :class:BaseObject or derived class

参数:
**tag_dict字典

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

self
Self

对 self 的引用。

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

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

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

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

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

需要状态为“已拟合”。

在 self 中访问

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

  • self.cutoff, self.is_fitted

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

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

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

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

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

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

Series scitype = 独立时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D or 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

fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

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

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

update_params布尔值，可选 (默认为 True)

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

self
self对 self 的引用
update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#

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

用于执行多个 update / predict 链式操作的简写，数据回放基于时间分割器 cv。

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

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

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

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

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

  5. 等等

  6. 返回所有记住的预测

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

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

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

需要状态为“已拟合”。

在 self 中访问

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

  • self.cutoff, self.is_fitted

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

写入 self（除非 reset_forecaster=True）

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

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

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

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

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

Series scitype = 独立时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D or 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

fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

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")，则 X.index 必须包含 fh 索引引用。

update_params布尔值，可选 (默认为 True)

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

reset_forecaster布尔值，可选 (默认为 True)

  • 如果为 True，不会改变预测器的状态，即 update/predict 序列使用副本运行，self 的 cutoff、模型参数、数据内存不会改变

  • 如果为 False，当 update/predict 序列运行时，会更新 self，如同直接调用 update/predict

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

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

  • 如果 absolute horizon 点的集合是唯一的：类型是 sktime 兼容数据容器格式的时间序列，输出中抑制了 cutoff，与最近传递的 y 具有相同的类型：Series, Panel, Hierarchical scitype，格式相同（参见上文）

  • 如果 absolute horizon 点的集合不唯一：类型是 pandas DataFrame，行和列索引是时间戳，行索引对应于从中预测的 cutoffs，列索引对应于预测的 absolute horizons，条目是根据行索引预测的列索引的点预测，如果在该 (cutoff, horizon) 对处没有预测，则条目为 nan

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

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

此方法用于在一步中更新和进行预测。

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

需要状态为“已拟合”。

deepbool, default=True

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

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

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

通过追加行，使用 y 和 X 更新 self._y 和 self._X。将 self.cutoff 和 self._cutoff 更新为在 y 中看到的最后一个索引。如果 update_params=True，

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

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

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

Series scitype = 独立时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D or 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

fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

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

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

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

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

update_params布尔值，可选 (默认为 True)

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

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

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

在此页上