Croston#

class Croston(smoothing=0.1)[source]#

Croston 方法，用于间歇性时间序列预测。

实现了 Croston 在 [1] 中提出并在 [2] 中描述的方法。

Croston 方法是对（普通）指数平滑法的修改，用于处理间歇性时间序列。如果一个时间序列的许多值为零且非零项之间的间隔不具有周期性，则认为该时间序列是间歇性的。

Croston 方法将预测所有未来时间的常数值，因此 Croston 方法本质上为时间序列的平均值提供了另一种概念。

该方法（等同于）如下：

  • 令 \(v_0,\ldots,v_n\) 为时间序列的非零值。

  • 令 \(v\) 为 \(v_0,\ldots,v_n\) 的指数平滑平均值。

  • 令 \(z_0,\ldots,z_n\) 为原始时间序列中 \(v_i\) 之间连续零的个数加 1。

  • 令 \(z\) 为 \(z_0,\ldots,z_n\) 的指数平滑平均值。

  • 则预测值为 \(\frac{v}{z}\)

直观上，\(v\) 是非零时间序列值的加权平均值，而 \(\frac{1}{z}\) 估计了获得非零值的概率。

说明 \(v\) 和 \(z\) 符号的示例。

  • 如果原始时间序列是 \(0,0,2,7,0,0,0,-5\)，则：

    • \(v\) 值为 \(2,7,-5\)

    • \(z\) 值为 \(3,1,4\)

参数:
smoothingfloat, 默认值 = 0.1

指数平滑中的平滑参数。

属性:
cutoff

Cut-off = 预测器的“当前时间”状态。

fh

已传递的预测期。

is_fitted

是否已调用 fit。

参见

ExponentialSmoothing

参考文献

[1]

J. D. Croston. Forecasting and stock control for intermittent demands. Operational Research Quarterly (1970-1977), 23(3):pp. 289-303, 1972.

[2]

  1. Vandeput. Forecasting Intermittent Demand with the Croston Model.

https://towardsdatascience.com/croston-forecast-model-for-intermittent-demand-360287a17f5f

示例

>>> from sktime.forecasting.croston import Croston
>>> from sktime.datasets import load_PBS_dataset
>>> y = load_PBS_dataset()
>>> forecaster = Croston(smoothing=0.1)
>>> forecaster.fit(y)
Croston(...)
>>> y_pred = forecaster.predict(fh=[1,2,3])

方法

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

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

参数:
parameter_setstr, 默认值=”default”

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

返回:
paramsdict 或 list of dict
check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:
method_namestr, 可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

克隆是初始化后状态下没有共享引用的不同对象。此函数等同于返回 self 的 sklearn.clone。

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

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

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

引发:
如果克隆因 __init__ 错误而不合规，则引发 RuntimeError。
clone_tags(estimator, tag_names=None)[source]#

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

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

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

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

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

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

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

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

参数:
estimator:class:BaseObject 的实例或派生类
tag_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])

nameslist of str，与 objs 长度相同

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

property cutoff[source]#

Cut-off = 预测器的“当前时间”状态。

返回:
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 = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，或 list 类型的 Series 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对 self 的引用。
fit_predict(y, X=None, fh=None, X_pred=None)[source]#

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

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

状态更改

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

写入自身

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

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

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

  • 将 fh 存储到 self.fh。

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

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

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

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

  • Panel scitype = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，或 list 类型的 Series 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 的标签值，考虑标签覆盖，按以下优先级降序排列：

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

  2. 在父类的 _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 属性的键。

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

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

  2. 在父类的 _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 值键的 dict

拟合参数字典，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，将返回此对象的参数名称 : 值 dict，包括组件的参数 (= BaseObject 值参数)。

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

返回:
params带有 str 值键的 dict

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

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

在实例构造时。

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

  2. 在父类的 _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 设置的标签。

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

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

在实例构造时。

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

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

按继承顺序。

返回:
collected_tagsdict

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

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，其输出位于 path，即 cls.save(path) 的结果
classmethod load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第 1 个元素
返回:
反序列化的 self，其输出为 serial，即 cls.save(None) 的结果
predict(fh=None, X=None)[source]#

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

所需状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入自身

如果传递了 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

写入自身

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

参数:
fhint, list, pd.Index 可强制转换类型, 或 ForecastingHorizon, 默认值=None

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

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

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

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

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

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

coveragefloat 或 list of float (唯一值), 可选 (默认值=0.90)

预测区间的名义覆盖率。

返回:
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 中) 时的分位数预测。

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

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

注意

  • 当前仅对 Series (非面板、非分层) 类型的 y 实现。

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

所需状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入自身

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

参数:
fhint, list, pd.Index 可强制转换类型, 或 ForecastingHorizon, 默认值=None

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

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

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

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

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

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

marginalbool, 可选 (默认值=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 且之前未传递过，则将其存储到 self.fh。

参数:
fhint, list, pd.Index 可强制转换类型, 或 ForecastingHorizon, 默认值=None

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

所需状态

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

在 self 中访问

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

写入自身

无。

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

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

如果为 None，则使用目前为止已见到的 y（self._y），特别是

  • 如果之前仅调用过一次 fit，则会产生样本内残差

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

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

用于更新和预测的外生时间序列。应与 fit 中 y 的科学类型（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)[source]#

计算/返回方差预测。

所需状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入自身

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

参数:
fhint, list, pd.Index 可强制转换类型, 或 ForecastingHorizon, 默认值=None

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

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

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

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

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

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

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

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

返回:
pred_varpd.DataFrame，格式取决于 cov 变量
如果 cov=False
列名与在 fit/update 中传递的 y 的列名完全一致。

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

行索引是 fh，附加级别等于实例级别，

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

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

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

如果 cov=True
列索引是 MultiIndex：第一层级是变量名（如上所述）

第二层级是 fh。

行索引是 fh，附加级别等于实例级别，

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

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

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

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

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

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

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”，则将在当前工作目录 (cwd) 中创建一个 estimator.zip 文件。

  • path=”/home/stored/estimator”，则将创建一个 estimator.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”) 为 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)[source]#

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

参数:
config_dictdict

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

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

jupyter 内核如何显示 self 实例

  • “diagram” = html 框图表示

  • “text” = 字符串输出

print_changed_only布尔值，默认为 True

打印 self 时是否只列出与默认值不同的参数 (设置为 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

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

设置此对象的参数。

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

参数:
**paramsdict

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

返回:
self对 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

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

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

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

每个兼容 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)[source]#

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

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

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

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

所需状态

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

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入自身

  • 将 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 类型的 Series pd.DataFrame

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

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

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

用于更新模型拟合的外生时间序列。应与 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)[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：仅更新截止点并记住数据

所需状态

要求状态为“已拟合”，即 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 类型的 Series pd.DataFrame

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

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

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

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

此方法有助于在一个步骤中进行更新和预测。

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

所需状态

要求状态为“已拟合”。

在 self 中访问

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

写入自身

通过追加行来使用 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 类型的 Series 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 的科学类型（Series、Panel 或 Hierarchical）相同。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。

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

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

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

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