BoxCoxBiasAdjustedForecaster#

class BoxCoxBiasAdjustedForecaster(forecaster, lambda_fixed=None)[源代码]#

Box-Cox 偏差调整预测器。

此模块实现了一个预测器，该预测器对包装的预测器的预测应用 Box-Cox 变换和偏差调整。

使用逆 Box-Cox 变换的偏差校正公式，偏差调整应用于点预测和预测区间

\[y_t = \text{inv\_boxcox}(w_t, \lambda) \cdot [1 + \sigma_t^2(1-\lambda)/ (2(\lambda w_t + 1)^2)]\]

其中： - \(y_t\) 是时间 t 的逆变换预测值 - \(w_t\) 是时间 t 的变换数据 - \(\lambda\) 是 Box-Cox 参数 - \(\sigma_t^2\) 是时间 t 在变换尺度上的预测方差

参数:
forecasterBaseForecaster

要应用 Box-Cox 变换和偏差调整的包装预测器。

lambda_fixedfloat, optional (default=None)

Box-Cox 变换参数。如果为 None，则将进行估计。

属性:
cutoff

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

fh

传递的预测范围。

is_fitted

是否已调用 fit。

注意

此预测器仅适用于单变量、非分层的内部预测器。

参考文献

[1]

Hyndman, R.J., & Athanasopoulos, G. (2018) “Forecasting: principles and practice”, 2nd edition, Section 2.7 - Box-Cox Transformations, OTexts: Melbourne, Australia. OTexts.com/fpp2

方法

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

使用新数据更新模型并进行预测。
classmethod get_test_params(parameter_set='default')[源代码]#

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

参数:
parameter_setstr, default=”default”

要返回的测试参数集的名称。

返回:
paramsdict or list of dict

用于创建类的测试实例的参数。

check_is_fitted(method_name=None)[源代码]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:
method_namestr, optional

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[源代码]#

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

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

等效于构造一个新的 type(self) 实例，使用 self 的参数，即 type(self)(**self.get_params(deep=False))。

如果在 self 上设置了配置，克隆也将具有与原始对象相同的配置，等效于调用 cloned_self.set_config(**self.get_config())。

其值也等效于调用 self.reset，不同之处在于 clone 返回一个新对象，而不是像 reset 那样改变 self。

引发:
如果由于错误的 __init__ 导致克隆不符合规范，则引发 RuntimeError。
clone_tags(estimator, tag_names=None)[源代码]#

从另一个对象克隆标签作为动态覆盖。

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

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

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

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

动态标签被设置为 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')[源代码]#

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

参数:
parameter_setstr, default=”default”

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

返回:
instanceinstance of the class with default parameters
classmethod create_test_instances_and_names(parameter_set='default')[源代码]#

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

参数:
parameter_setstr, default=”default”

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

返回:
objslist of instances of cls

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

nameslist of str, same length as objs

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

property cutoff[源代码]#

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

返回:
cutoffpandas compatible index element, or None

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

property fh[源代码]#

传递的预测范围。

fit(y, X=None, fh=None)[源代码]#

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

状态变更

将状态更改为“fitted”。

写入自身

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

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

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

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

参数:
y采用与 sktime 兼容的数据容器格式的时间序列。

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

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

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

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

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

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

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

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

X采用与 sktime 兼容的格式的时间序列，可选 (default=None)。

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

返回:
selfReference to self.
fit_predict(y, X=None, fh=None, X_pred=None)[源代码]#

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

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

状态变更

将状态更改为“fitted”。

写入自身

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

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

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

  • 将 fh 存储到 self.fh。

参数:
y采用 sktime 兼容数据容器格式的时间序列

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

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

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

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

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

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

fhint, list, pd.Index coercible, 或 ForecastingHorizon (非可选)

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

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

X采用与 sktime 兼容的格式的时间序列，可选 (default=None)。

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

X_pred采用 sktime 兼容格式的时间序列，可选 (default=None)

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

返回:
y_pred采用 sktime 兼容数据容器格式的时间序列

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

classmethod get_class_tag(tag_name, tag_value_default=None)[源代码]#

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

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

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

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

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

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

按继承顺序。

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

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

参数:
tag_namestr

标签值的名称。

tag_value_defaultany type

如果未找到标签的默认/备用值。

返回:
tag_value

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

classmethod get_class_tags()[源代码]#

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

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

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

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

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

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

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

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

按继承顺序。

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

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

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

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

collected_tagsdict

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

get_config()[源代码]#

获取自身的配置标志。

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

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

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

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

返回:
config_dictdict

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

get_fitted_params(deep=True)[源代码]#

获取已拟合参数。

所需状态

需要状态为“fitted”。

参数:
deepbool, default=True

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

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

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

返回:
fitted_paramsdict with str-valued keys

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

  • 始终：此对象的所有拟合参数，如通过 get_param_names，值是此对象该键的拟合参数值

  • 如果 deep=True，还包含组件参数的键/值对，组件的参数索引为 [componentname]__[paramname]，componentname 的所有参数以 paramname 及其值显示

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

classmethod get_param_defaults()[源代码]#

获取对象的参数默认值。

返回:
default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)[源代码]#

获取对象的参数名称。

参数:
sortbool, default=True

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

返回:
param_names: list[str]

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

get_params(deep=True)[源代码]#

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

参数:
deepbool, default=True

是否返回组件的参数。

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

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

返回:
paramsdict with str-valued keys

参数字典，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)[源代码]#

从实例获取标签值，具有标签级别的继承和覆盖。

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

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

get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，考虑标签覆盖，优先级按以下降序排列

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

在实例构造时。

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

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

按继承顺序。

参数:
tag_namestr

要检索的标签的名称

tag_value_defaultany type, optional; 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()[源代码]#

从实例获取标签，具有标签级别的继承和覆盖。

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

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

The get_tags method returns a dictionary of tags, with keys being keys of any attribute of _tags set in the class or any of its parent classes, or tags set via set_tags or clone_tags.

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

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

在实例构造时。

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

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

按继承顺序。

返回:
collected_tagsdict

Dictionary of tag name : tag value pairs. Collected from _tags class attribute via nested inheritance and then any overrides and new tags from _tags_dynamic object attribute.

is_composite()[源代码]#

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

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

返回:
composite: bool

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

property is_fitted[source]#

是否已调用 fit。

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

返回:
bool

估计器是否已 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialresult of ZipFile(path).open(“object)
返回:
在 path 处反序列化的 self，结果是 cls.save(path) 的输出
classmethod load_from_serial(serial)[source]#

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

参数:
serial1st element of output of cls.save(None)
返回:
将 self 反序列化到 serial 输出中，结果是 cls.save(None)
predict(fh=None, X=None)[源代码]#

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

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入自身

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

参数:
fhint, list, pd.Index coercible, 或 ForecastingHorizon, default=None

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

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

Xtime series in sktime compatible format, optional (default=None)

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

返回:
y_pred采用 sktime 兼容数据容器格式的时间序列

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

predict_interval(fh=None, X=None, coverage=0.9)[源代码]#

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

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

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入自身

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

参数:
fhint, list, pd.Index coercible, 或 ForecastingHorizon, default=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)。

Xtime series in sktime compatible format, optional (default=None)

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

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

预测区间(s) 的标称覆盖率

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

顺序与输入 coverage 中的顺序相同。

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

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

从 fit 中看到的 y 获取实例级别。

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

对于列索引中的变量，在第二列索引中的标称覆盖率下，下/上取决于第三列索引，对于行索引。上/下区间端点预测值等同于对于 coverage 中的 c，alpha = 0.5 - c/2, 0.5 + c/2 处的分位数预测值。

predict_proba(fh=None, X=None, marginal=True)[源代码]#

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

注意

  • 目前仅对 Series (非 Panel, 非 Hierarchical) y 实现。

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

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入自身

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

参数:
fhint, list, pd.Index coercible, 或 ForecastingHorizon, default=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)。

Xtime series in sktime compatible format, optional (default=None)

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

marginalbool, optional (default=True)

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

返回:
pred_distskpro BaseDistribution

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

predict_quantiles(fh=None, X=None, alpha=None)[源代码]#

计算/返回分位数预测值。

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

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入自身

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

参数:
fhint, list, pd.Index coercible, 或 ForecastingHorizon, default=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)。

Xtime series in sktime compatible format, optional (default=None)

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

alphafloat or list of float of unique values, optional (default=[0.05, 0.95])

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

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

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

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

从 fit 中看到的 y 获取实例级别。

条目是分位数预测值，对于列索引中的变量，

在第二列索引中的分位数概率下，对于行索引。

predict_residuals(y=None, X=None)[源代码]#

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

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

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

所需状态

要求状态为“已拟合”。如果已设置 fh，则必须与 y 的索引（pandas 或整数）对应。

访问 self 中的属性

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

写入自身

无。

参数:
y采用 sktime 兼容数据容器格式的时间序列

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

如果为 None，则使用迄今为止看到的 y (self._y)，特别是

  • 如果仅 precede 单个 fit 调用，则生成样本内残差

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

Xtime series in sktime compatible format, optional (default=None)

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

返回:
y_restime series in sktime compatible data container format

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

predict_var(fh=None, X=None, cov=False)[源代码]#

计算/返回方差预测值。

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入自身

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

参数:
fhint, list, pd.Index coercible, 或 ForecastingHorizon, default=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)。

Xtime series in sktime compatible format, optional (default=None)

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

covbool, optional (default=False)

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

返回:
pred_varpd.DataFrame, format dependent on cov variable
如果 cov=False
列名与在 fit/update 中传递的 y 的列名完全相同。

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

行索引是 fh，如果 fit 中看到的 y 是 Panel 或 Hierarchical，则额外级别等于实例级别。

从 fit 中看到的 y 获取实例级别。

条目是方差预测，针对列索引中的变量。给定变量和 fh 索引的方差预测是该变量和索引的预测方差，基于观测数据。

variance for that variable and index, given observed data.

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

第二级是 fh。

行索引是 fh，如果 fit 中看到的 y 是 Panel 或 Hierarchical，则额外级别等于实例级别。

从 fit 中看到的 y 获取实例级别。

条目是（协）方差预测，针对列索引中的变量，以及

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

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

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 or file location (str or Path)

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

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

  • 如果 path="/home/stored/estimator"，则将在

/home/stored/ 中存储 zip 文件 estimator.zip。

serialization_format: str, 默认 = “pickle”

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

返回:
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 包含文件引用的 ZipFile
score(y, X=None, fh=None)[源代码]#

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

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

要评分的时间序列

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

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

Xpd.DataFrame, or 2D np.array, optional (default=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)[源代码]#

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

参数:
config_dictdict

config name : config value 对的字典。下文列出了有效的 config、值及其含义

displaystr, “diagram” (default), or “text”

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, default=True

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

warningsstr, “on” (default), or “off”

是否发出警告，仅影响来自 sktime 的警告

  • “on” = 将发出来自 sktime 的警告

  • “off” = 将不发出来自 sktime 的警告

backend:parallelstr, optional, default=”None”

广播/向量化时用于并行化的后端之一

  • “None”: 顺序执行循环，简单的列表推导式

  • “loky”, “multiprocessing” 和 “threading”: 使用 joblib.Parallel

  • “joblib”: 自定义和第三方 joblib 后端，例如 spark

  • “dask”: 使用 dask，需要在环境中安装 dask 包

  • “ray”: 使用 ray，需要在环境中安装 ray 包

backend:parallel:paramsdict, optional, default={} (no parameters passed)

作为 config 传递给并行化后端的附加参数。有效键取决于 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”; 要使用的日志记录器的名称。

    • “mute_warnings”: bool, 默认=False; 如果为 True，则抑制警告。

remember_databool, default=True

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

返回:
selfreference to self.

注意

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

set_params(**params)[源代码]#

设置此对象的参数。

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

参数:
**paramsdict

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

返回:
selfreference to self (after parameters have been set)
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_stateint, RandomState instance or None, default=None

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

deepbool, default=True

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

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

  • 如果为 True，则同时设置组件对象中的 random_state 参数。

self_policystr, one of {“copy”, “keep”, “new”}, default=”copy”

  • “copy” : self.random_state 设置为输入 random_state

  • “keep” : self.random_state 保持原样

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

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

返回:
selfreference to self
set_tags(**tag_dict)[源代码]#

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

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

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

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

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

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

参数:
**tag_dictdict

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

返回:
Self

对 self 的引用。

update(y, X=None, update_params=True)[源代码]#

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

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

  • update_params=True: 对迄今为止观测到的所有数据进行拟合

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

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入自身

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

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

参数:
y采用与 sktime 兼容的数据容器格式的时间序列。

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

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

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

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

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

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

X采用与 sktime 兼容的格式的时间序列，可选 (default=None)。

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

update_paramsbool, optional (default=True)

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

返回:
selfreference to self
update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[源代码]#

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

执行多个 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_params=True: 对迄今为止观测到的所有数据进行拟合

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

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入 self（除非 reset_forecaster=True）

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

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

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

参数:
y采用与 sktime 兼容的数据容器格式的时间序列。

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

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

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

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

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

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

cvtemporal cross-validation generator inheriting from BaseSplitter, optional

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

Xtime series in sktime compatible format, optional (default=None)

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

update_paramsbool, optional (default=True)

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

reset_forecasterbool, optional (default=True)

  • 如果为 True，将不更改预测器的状态，即更新/预测序列使用副本运行，self 的截止点、模型参数、数据内存不改变

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

返回:
y_predobject that tabulates point forecasts from multiple split batches

格式取决于整体预测的（截止点，绝对预测范围）对

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

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

update_predict_single(y=None, fh=None, X=None, update_params=True)[源代码]#

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

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

如果未实现特定于估计器的更新方法，则默认回退是先更新，然后预测。

所需状态

需要状态为“fitted”。

访问 self 中的属性

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

写入自身

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

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

参数:
y采用与 sktime 兼容的数据容器格式的时间序列。

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

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

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

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

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

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

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

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

Xtime series in sktime compatible format, optional (default=None)

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

update_paramsbool, optional (default=True)

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

返回:
y_pred采用 sktime 兼容数据容器格式的时间序列

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

在此页面上