UpdateRefitsEvery#

class UpdateRefitsEvery(forecaster, refit_interval=0, refit_window_size=None, refit_window_lag=0)[source]#

调用 update 时定期重新拟合。

如果调用 update 时 update_params=True，并且自上次拟合以来已经过 refit_interval 或更长时间，
则改为重新拟合预测器（调用 fit）。

重新拟合是在（可能）迄今为止看到的所有数据上进行的。

refit_window 控制重新拟合的回溯窗口

重新拟合的数据范围是从 cutoff（包含）到 cutoff 减去 refit_window（不包含）

参数:
refit_intervalsktime 时间索引的差值（int 或 timedelta），可选

需要经过的时间间隔，在此之后第一次更新默认为拟合 默认值 = 0，即总是重新拟合，从不更新 如果在拟合中看到的 y 的索引是整数或 y 是无索引的容器类型，

refit_interval 必须是 int，并解释为整数位置的差值

如果在拟合中看到的 y 的索引是时间戳，必须是 int 或 pd.Timedelta

如果是 pd.Timedelta，则解释为自上次重新拟合以来经过的时间 如果是 int，则解释为自上次重新拟合以来看到的时间戳数量

refit_window_sizesktime 时间索引的差值（int 或 timedelta），可选

如果 update 调用 fit，则重新拟合的数据窗口长度 默认值 = inf，即重新拟合迄今为止看到的所有训练数据

refit_window_lagsktime 索引的差值（int 或 timedelta），可选

如果 update 调用 fit，则重新拟合的数据窗口相对于 cutoff 的滞后 默认值 = 0，即重新拟合窗口以 cutoff 结束并包含 cutoff

属性:
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()

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

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

使用新数据更新模型并进行预测。
classmethod get_test_params()[source]#

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

返回:
paramsdict 或 dict 列表，默认为 {}

用于创建类的测试实例的参数 每个 dict 都是构造“有趣”测试实例的参数，即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 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 或 str 列表，默认为 None

要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回:
self

对 self 的引用。

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

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

参数:
parameter_setstr，默认为“default”

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

返回:
instance具有默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[source]#

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

参数:
parameter_setstr，默认为“default”

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

返回:
objscls 实例列表

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

namesstr 列表，与 objs 长度相同

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

property cutoff[source]#

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

返回:
cutoffpandas 兼容的索引元素，或 None

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

property fh[source]#

传入的预测范围。

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

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

状态变化

将状态更改为“fitted”。

写入 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 = 时间序列集合，全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex (instance, time)、3D np.ndarray (instance, variable, time)、Series 类型 pd.DataFrame 的 list

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

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

状态变化

将状态更改为“fitted”。

写入 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 = 时间序列集合，全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex (instance, time)、3D np.ndarray (instance, variable, time)、Series 类型 pd.DataFrame 的 list

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

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

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

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

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

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

返回:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态

要求状态为“fitted”。

参数:
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，生成 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]#

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

所需状态

要求状态为“fitted”，即 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 是可迭代的，将计算多个区间。

所需状态

要求状态为“fitted”，即 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）

预测区间名义覆盖率

返回:
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。

所需状态

要求状态为“fitted”，即 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 是可迭代的，将计算多个分位数。

所需状态

要求状态为“fitted”，即 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。

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

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

predict_residuals(y=None, X=None)[source]#

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

将计算 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

写入 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") 为 True，则 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]#

计算/返回方差预测。

所需状态

要求状态为“fitted”，即 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。

条目是方差预测，适用于列索引中的变量，

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

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

第二层是 fh。

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

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

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

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

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

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

将序列化的 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"，则会在 /home/stored/ 目录中存储 zip 文件 estimator.zip。

存储在 /home/stored/ 中。

serialization_format: str, default = “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

返回:
scorefloat

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

另请参阅

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

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

参数:
config_dictdict

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

displaystr, “diagram” (默认) 或 “text”

jupyter kernels 如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, 默认=True

打印 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, 可选, 默认={} (未传递参数)

作为 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_data布尔值, 默认 True

remember_databool, 默认=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>。如果引用明确，例如组件参数中没有两个同名 <parameter>，也可以使用不带 <component>__ 的字符串 <parameter>。

**paramsdict

返回:
BaseObject 参数，键必须是 <component>__<parameter> 字符串。__ 后缀可以是完整字符串的别名，如果它们在 get_params 键中唯一。
self对 self 的引用（参数已设置后）

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

set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

通过 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

伪随机数生成器，用于控制随机整数的生成。传递 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 派生，通常与输入不同

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

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

self对 self 的引用

set_tags(**tag_dict)[source]#

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

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

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

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

返回:
**tag_dictdict

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

Self

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

对 self 的引用。

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

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

所需状态

要求状态为“fitted”，即 self.is_fitted=True。

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入 self

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

  • update_params=False：仅更新截止时间和记住数据

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

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

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)、Series 类型 pd.DataFrame 的 list

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

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

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

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

ysktime 兼容格式的时间序列

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

返回:
“new” : self.random_state 设置为新的随机状态，
Xsktime 兼容格式的时间序列, 可选 (默认=None)

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

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

update_paramsbool, 可选 (默认=True)

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

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

  3. 用于在一个步骤中执行多个 update / predict 执行序列的简写，数据回放基于时间分割器 cv。

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

  5. 与以下代码等效（如果仅 y, cv 非默认）

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

对 self 的引用。

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

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

所需状态

要求状态为“fitted”，即 self.is_fitted=True。

在 self 中访问

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

  • self.cutoff, self.is_fitted

记住 self.predict() (稍后在一个批次中返回)

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

  • update_params=False：仅更新截止时间和记住数据

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

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

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

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)、Series 类型 pd.DataFrame 的 list

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

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

等等

返回所有记住的预测

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

写入 self（除非 reset_forecaster=True）

ysktime 兼容格式的时间序列

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

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

  • ysktime 兼容格式的时间序列

  • 用于更新和预测的时间序列

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

update_paramsbool, 可选 (默认=True)

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

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

reset_forecasterbool, 可选 (默认=True)

所需状态

要求状态为“fitted”。

在 self 中访问

如果为 True，将不改变预测器的状态，即 update/predict 序列以副本运行，且 self 的截止时间、模型参数、数据内存不变

写入 self

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

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

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

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

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)、Series 类型 pd.DataFrame 的 list

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

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

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

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

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

写入 self（除非 reset_forecaster=True）

ysktime 兼容格式的时间序列

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

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

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

格式取决于总体预测的（截止时间，绝对视野）对