PyKANForecaster#

class PyKANForecaster(hidden_layers=(1, 1), input_layer_size=2, grids=None, model_params=None, fit_params=None, val_size=0.5, device='cpu')[source]#

PyKANForecaster 使用 Kolmogorov Arnold Network [1] 预测时间序列数据。

此预测器使用 pykan 库创建一个 KAN 模型来预测时间序列数据。该模型在训练数据上进行训练，然后用于预测时间序列的未来值。注意 此预测器是实验性的，未来可能会更换用于实现 KAN 的库，以使用更稳定高效的库。

参数:
hidden_layerstuple，可选 (默认=(1, 1))

网络中的隐藏层数量。

input_layer_sizeint，可选 (默认=2)

输入层的大小。

kint，可选 (默认=3)

要考虑的最近邻居数量。

gridsnp.array，可选 (默认=np.array([2, 3]))

模型中使用的网格大小。

model_paramsdict，可选 (默认={“k”: 2})

传递给模型的参数。更多详情请参阅 pykan 文档。

fit_paramsdict，可选 (默认={“steps”: 1})

传递给 fit 方法的参数。更多详情请参阅 pykan 文档。

val_sizefloat，可选 (默认=0.5)

训练中使用的验证集大小。

devicestr，可选 (默认=”cpu”)

用于训练模型的设备。

属性:
cutoff

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

fh

传递的预测范围。

is_fitted

fit 是否已被调用。

参考文献

[1]

Liu, Ziming, et al. “KAN: Kolmogorov-Arnold Networks.” arXiv preprint arXiv:2404.19756 (2024).

方法

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

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

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，默认 = {}

用于创建类的测试实例的参数。每个 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]#

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

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

等同于构造一个具有 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

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

状态变更

状态变更为“已拟合”。

写入 self

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

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

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

  • 将 fh 存储到 self.fh。

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

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

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

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

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

  • 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 类型的字典

拟合参数的字典，包括 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 类型的字典

参数字典，包含 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]#

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

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

返回值:
composite: bool

对象是否有任何参数的值是 BaseObject 的派生实例。

property is_fitted[source]#

fit 是否已被调用。

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

返回值:
bool

估计器是否已 拟合。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回值:
反序列化的 self，其输出位于 path，即 cls.save(path) 的输出
classmethod load_from_serial(serial)[source]#

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

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

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

所需状态

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

访问 self 中的内容

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

  • self.cutoff，self.is_fitted

写入 self

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

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

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

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

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

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

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

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

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

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

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

所需状态

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

访问 self 中的内容

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

  • self.cutoff，self.is_fitted

写入 self

如果传入了 fh 且之前未传入过，则将其存储到 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。

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

对于列索引中的 var，在第二级列索引的名义覆盖率处，下限/上限取决于第三级列索引，对于行索引。区间上限/下限预测等同于在 alpha = 0.5 - c/2, 0.5 + c/2（对于 coverage 中的 c）处的分位数预测。

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

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

注意

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

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

所需状态

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

访问 self 中的内容

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

  • self.cutoff，self.is_fitted

写入 self

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

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

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

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

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

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

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

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

marginalbool, 可选 (默认值=True)

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

返回值:
pred_distskpro BaseDistribution

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

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

计算/返回分位数预测。

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

所需状态

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

访问 self 中的内容

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

  • self.cutoff，self.is_fitted

写入 self

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

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

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

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

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

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

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

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

alphafloat 或由唯一 float 值组成的列表，可选 (默认值=[0.05, 0.95])

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

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

第二级是传入函数的 alpha 值。

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

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

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

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

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

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

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

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

所需状态

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

访问 self 中的内容

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

写入 self

无。

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

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

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

  • 如果之前仅进行了一次 fit 调用，则生成样本内残差

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

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

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

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

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

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

计算/返回方差预测。

所需状态

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

访问 self 中的内容

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

  • self.cutoff，self.is_fitted

写入 self

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

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

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

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

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

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

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

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

covbool, 可选 (默认值=False)

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

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

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

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

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

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

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

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

第 2 级是 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

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

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

  • path=”/home/stored/estimator”，则 zip 文件 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”)，则 X.index 必须包含 y.index

返回值:
scorefloat

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

另请参阅

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

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

参数:
config_dictdict

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

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

jupyter 内核如何显示 self 的实例

  • “diagram” = html 盒图表示

  • “text” = 字符串输出

print_changed_onlybool, 默认值=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”: bool 类型，默认值为 True；False 会阻止 ray 在并行化后

      关闭。

    • “logger_name”: str 类型，默认值为 "ray"；要使用的 logger 名称。

    • “mute_warnings”: bool 类型，默认值为 False；如果为 True，则禁止显示警告

remember_databool 类型，默认值为 True

指示 self._X 和 self._y 是否在 fit 中存储并在 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 的引用（参数设置后）
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

设置自身的 random_state 伪随机种子参数。

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

根据 self_policy，应用于 self 中的 random_state 参数；并且仅当 deep=True 时，应用于其余组件对象。

注意：即使 self 没有 random_state 参数，或者任何组件都没有 random_state 参数，也会调用 set_params。因此，set_random_state 将重置任何 scikit-base 对象，即使是没有 random_state 参数的对象。

参数:
random_stateint, RandomState 实例或 None，默认值为 None

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

deepbool, 默认值=True

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

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

  • 如果为 True，则也会在组件对象中设置 random_state 参数。

self_policystr 类型，可选值为 {“copy”, “keep”, “new”} 之一，默认值为 “copy”

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

  • “keep” : 保留 self.random_state 现有值

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

派生自输入的 random_state，并且通常与输入值不同

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

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

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

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

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

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

update_paramsbool 类型，可选 (默认值为 True)

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

返回值:
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)，或 Series 类型的 pd.DataFrame 的 list

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

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

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

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

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

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

update_paramsbool 类型，可选 (默认值为 True)

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

reset_forecasterbool 类型，可选 (默认值为 True)

  • 如果为 True，则不会改变预测器的状态，即 update/predict 序列在副本上运行，self 的截止点、模型参数、数据内存均不改变

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

返回值:
y_pred对象，用于以表格形式展示来自多个分割批次的点预测结果

格式取决于整体预测的 (截止点, 绝对预测期) 对

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

  • 如果绝对预测点集合不唯一：类型为 pandas DataFrame，行和列索引均为时间戳。行索引对应于预测的截止点，列索引对应于预测的绝对预测期。条目是根据行索引预测的列索引的点预测结果。如果在该 (截止点, 预测期) 对没有预测结果，则条目为 nan。

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

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

此方法有助于一步完成更新和进行预测。

如果没有实现特定于估计器的 update 方法，默认的回退行为是先更新，然后预测。

所需状态

要求状态为“已拟合”。

访问 self 中的内容

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

写入 self

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

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

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

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

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

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

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

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

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

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

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

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

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

update_paramsbool 类型，可选 (默认值为 True)

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

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

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