RBFForecaster#

class RBFForecaster(window_length=10, hidden_size=32, batch_size=32, centers=None, gamma=1.0, rbf_type='gaussian', hidden_layers=[64, 32], optimizer='adam', lr=0.01, epochs=100, stride=1, criterion='mse', device='cpu', mode='ar', activation='relu', dropout_rate=0.1)[source]#

使用 RBF 转换和“NN”层的时间序列预测模型。

此预测器使用 RBF 层将输入时间序列数据转换为更高维度的空间，然后由神经网络层用于预测。

参数:

window_lengthint, 可选 (default=10)

每个滑动窗口的输入序列长度。

hidden_sizeint, 可选 (default=32)

RBF 层中的单元数量。

batch_sizeint, 可选 (default=32)

训练的迷你批次大小。

centersarray-like, 可选 (default=None)

RBF 转换的中心点。

gammafloat, 可选 (default=1.0)

控制 RBF 扩散的缩放因子。

rbf_typestr, 可选 (default=”gaussian”)

要应用的 RBF 核函数类型。

“gaussian”: \(\exp(-\gamma (t - c)^2)\)
“multiquadric”: \(\sqrt{1 + \gamma (t - c)^2}\)
“inverse_multiquadric”: \(\frac{1}{\sqrt{1 + \gamma (t - c)^2}}\)

hidden_layerslist of int, 可选 (default=[64, 32])

RBF 层之后的线性层的大小。

optimizer{“adam”, “sgd”, “rmsprop”}, 可选 (default=”adam”)

要使用的优化器类型。

lrfloat, 可选 (default=0.01)

优化器的学习率。

epochsint, 可选 (default=100)

训练轮次数量。

strideint, 可选 (default=1)

窗口之间的步长。

criterionstr, 可选 (default=”mse”)

训练期间使用的损失函数。

devicestr, 可选 (default=”cpu”)

用于训练和计算的设备。选项为“cpu”或“cuda”（如果可用）用于 GPU 计算。

mode{“ar”, “direct”}, 可选 (default=”ar”)

预测模式

“ar”: 用于一步向前预测的自回归模式。
“direct”: 用于多步向前预测的直接模式。

activationstr, 可选 (default=”relu”)

应用于每个线性层后的激活函数。支持的值为：“relu”、“leaky_relu”、“elu”、“selu”、“tanh”、“sigmoid”、“gelu”。

dropout_ratefloat, 可选 (default=0.1)

应用于每个隐藏层后的 dropout 率。值为 0 会禁用 dropout。

属性:

cutoff: 截止点 = 预测器的“当前时间”状态。
fh: 已传递的预测范围。
is_fitted: 是否已调用 fit。

方法

`build_pytorch_pred_dataloader`(y, fh)	构建用于预测的 PyTorch DataLoader。
`build_pytorch_train_dataloader`(y)	构建用于训练的 PyTorch DataLoader。
`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`()	返回估计器的测试参数设置。
`get_y_true`(y)	获取用于验证的 y_true 值。
`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()[source]#

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

提供用于单元测试或实验的示例参数。

返回:

paramsdict or list of dict

build_pytorch_pred_dataloader(y, fh)[source]#: 构建用于预测的 PyTorch DataLoader。

build_pytorch_train_dataloader(y)[source]#: 构建用于训练的 PyTorch DataLoader。

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。在调用对象的 fit 方法时，is_fitted 属性应设置为 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 进行检查。

参数:

estimatorAn instance of :class:BaseObject or derived class
tag_namesstr or list of str, default = None: 要克隆的标签名称。默认值 (None) 克隆来自 estimator 的所有标签。

返回:

self: 对 self 的引用。

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

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

参数:

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

返回:

instanceinstance of the class with default parameters

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

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

参数:

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

property cutoff[source]#

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

返回:

cutoffpandas compatible index element, or None: pandas 兼容的索引元素，如果已设置 cutoff；否则为 None。

property fh[source]#: 已传递的预测范围。

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

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

状态更改: 将状态更改为“fitted”。

写入 self

设置以“_”结尾的拟合模型属性，拟合属性可通过 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, 默认=None

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

X符合 sktime 格式的时间序列，可选 (默认=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)，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 格式的时间序列，可选 (默认=None)。

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

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

用于预测的外生时间序列。如果传递，将代替 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 的标签值，考虑标签覆盖，优先级从高到低如下：

在类的 _tags 属性中设置的标签。
在父类的 _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()[source]#

从类中获取类标签，具有来自父类的标签级别继承。

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

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

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

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

值是相应的标签值，优先级从高到低如下：

在类的 _tags 属性中设置的标签。
在父类的 _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]#

获取拟合参数。

所需状态: 需要状态为“fitted”。

参数:

deepbool, default=True

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

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

返回:

fitted_params带有 str 值的键的 dict

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

始终：此对象的所有拟合参数，如通过 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, default=True: 是否按字母顺序 (True) 返回参数名称，或按它们在类 __init__ 中出现的顺序 (False) 返回。

返回:

param_names: list[str]: cls 的参数名称列表。如果 sort=False，则与它们在类 __init__ 中出现的顺序相同。如果 sort=True，则按字母顺序排序。

get_params(deep=True)[source]#

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

参数:

deepbool, default=True

是否返回组件的参数。

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

返回:

params带有 str 值的键的 dict

参数字典，参数名 : 参数值键值对包括

始终：此对象的所有参数，如通过 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 的单个标签的值，考虑标签覆盖，优先级从高到低如下：

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

在实例构造时。

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

按照继承顺序。

参数:

tag_namestr: 要检索的标签名称
tag_value_defaultany type, 可选; 默认=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 设置的标签。

值是相应的标签值，优先级从高到低如下：

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

在实例构造时。

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

按照继承顺序。

返回:

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

get_y_true(y)[source]#: 获取用于验证的 y_true 值。

获取用于验证的 y_true 值。

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

is_composite()[source]#

返回:

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

对象是否包含任何参数，其值是 BaseObject 的后代实例。

是否已调用 fit。

property is_fitted[source]#

返回:

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

估计器是否已 fit。

从文件位置加载对象。

参数:

classmethod load_from_path(serial)[source]#

返回:

serialZipFile(path).open(“object) 的结果

在 path 生成输出的序列化 self，来自 cls.save(path)

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

参数:

classmethod load_from_serial(serial)[source]#

返回:

serialcls.save(None) 输出的第一个元素

生成输出 serial 的序列化 self，来自 cls.save(None)

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

所需状态: predict(fh=None, X=None)[source]#

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

访问 self

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

写入 self: self.cutoff, self.is_fitted

参数:

fhint, list, pd.Index coercible, 或 ForecastingHorizon, 默认=None

如果传递了 fh 并且之前未传递过，则将其存储到 self.fh。编码要预测的时间戳的预测范围。如果已在 fit 中传递，则不应再传递。如果未在 fit 中传递，则必须传递，不可选。

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

X符合 sktime 格式的时间序列，可选 (默认=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 是可迭代的，将计算多个区间。

所需状态: predict(fh=None, X=None)[source]#

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

访问 self

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

写入 self: self.cutoff, self.is_fitted

参数:

fhint, list, pd.Index coercible, 或 ForecastingHorizon, 默认=None

如果传递了 fh 并且之前未传递过，则将其存储到 self.fh。编码要预测的时间戳的预测范围。如果已在 fit 中传递，则不应再传递。如果未在 fit 中传递，则必须传递，不可选。

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

如果 fh 是 int 或类似 int 的数组，则将其解释为相对预测范围，并强制转换为相对 ForecastingHorizon(fh, is_relative=True)。
如果 fh 的类型是 pd.Index，则将其解释为绝对预测范围，并强制转换为绝对 ForecastingHorizon(fh, is_relative=False)。

X符合 sktime 格式的时间序列，可选 (默认=None)

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

coverage浮点数或包含唯一浮点数的列表，可选（默认值=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 (非 Panel, 非 Hierarchical) y 实现。
返回的分布对象需要安装 skpro。

所需状态: predict(fh=None, X=None)[source]#

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

访问 self

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

写入 self: self.cutoff, self.is_fitted

参数:

fhint, list, pd.Index coercible, 或 ForecastingHorizon, 默认=None

如果传递了 fh 并且之前未传递过，则将其存储到 self.fh。编码要预测的时间戳的预测范围。如果已在 fit 中传递，则不应再传递。如果未在 fit 中传递，则必须传递，不可选。

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

如果 fh 是 int 或类似 int 的数组，则将其解释为相对预测范围，并强制转换为相对 ForecastingHorizon(fh, is_relative=True)。
如果 fh 的类型是 pd.Index，则将其解释为绝对预测范围，并强制转换为绝对 ForecastingHorizon(fh, is_relative=False)。

X符合 sktime 格式的时间序列，可选 (默认=None)

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

marginal布尔值，可选（默认值=True）

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

返回:

pred_distskpro BaseDistribution: 如果 marginal=True，则为预测分布；如果 marginal=False 且由方法实现，则为按时间点的边际分布；否则为联合分布。

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

计算/返回分位数预测。

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

所需状态: predict(fh=None, X=None)[source]#

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

访问 self

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

写入 self: self.cutoff, self.is_fitted

参数:

fhint, list, pd.Index coercible, 或 ForecastingHorizon, 默认=None

如果传递了 fh 并且之前未传递过，则将其存储到 self.fh。编码要预测的时间戳的预测范围。如果已在 fit 中传递，则不应再传递。如果未在 fit 中传递，则必须传递，不可选。

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

如果 fh 是 int 或类似 int 的数组，则将其解释为相对预测范围，并强制转换为相对 ForecastingHorizon(fh, is_relative=True)。
如果 fh 的类型是 pd.Index，则将其解释为绝对预测范围，并强制转换为绝对 ForecastingHorizon(fh, is_relative=False)。

X符合 sktime 格式的时间序列，可选 (默认=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)[source]#

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

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

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

所需状态: 要求状态为“fitted”（已拟合）。如果设置了 fh，则必须与 y 的索引（pandas 或整数）一致
需要状态为“fitted”，即 self.is_fitted=True。: 已拟合模型的属性以“_”结尾。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]#

计算/返回方差预测。

所需状态: predict(fh=None, X=None)[source]#

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

访问 self

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

写入 self: self.cutoff, self.is_fitted

参数:

fhint, list, pd.Index coercible, 或 ForecastingHorizon, 默认=None

如果传递了 fh 并且之前未传递过，则将其存储到 self.fh。编码要预测的时间戳的预测范围。如果已在 fit 中传递，则不应再传递。如果未在 fit 中传递，则必须传递，不可选。

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

如果 fh 是 int 或类似 int 的数组，则将其解释为相对预测范围，并强制转换为相对 ForecastingHorizon(fh, is_relative=True)。
如果 fh 的类型是 pd.Index，则将其解释为绝对预测范围，并强制转换为绝对 ForecastingHorizon(fh, is_relative=False)。

X符合 sktime 格式的时间序列，可选 (默认=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

列索引是多级索引：第一级是变量名（如上所述）: 第二级是 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) 创建一个 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 coercible, 或 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 时是只列出与默认值不同的参数 (True)，还是列出所有参数名称和值 (False)。不进行嵌套，即仅影响 self，不影响组件估计器。

warningsstr, “on”（默认值）, 或 “off”

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

“on” = 将触发来自 sktime 的警告
“off” = 不触发来自 sktime 的警告

backend:parallelstr, 可选，默认值=”None”

广播/向量化时用于并行化的后端，选项包括

“None”: 顺序执行循环，简单的列表推导式
“loky”, “multiprocessing” 和 “threading”: 使用 joblib.Parallel
“joblib”: 定制和第三方 joblib 后端，例如 spark
“dask”: 使用 dask，需要在环境中安装 dask 包
“ray”: 使用 ray，需要在环境中安装 ray 包

backend:parallel:paramsdict, 可选，默认值={}（不传递参数）

作为配置传递给并行化后端的附加参数。有效键取决于 backend:parallel 的值

“None”: 无附加参数，忽略 backend_params
“loky”, “multiprocessing” 和 “threading”: 默认的 joblib 后端，可以传入 joblib.Parallel 的任何有效键，例如 n_jobs，但 backend 除外，它直接由 backend 控制。如果未传入 n_jobs，则默认为 -1，其他参数将采用 joblib 的默认值。
“joblib”: 定制和第三方 joblib 后端，例如 spark。可以传入 joblib.Parallel 的任何有效键，例如 n_jobs，在这种情况下，必须将 backend 作为 backend_params 的键传入。如果未传入 n_jobs，则默认为 -1，其他参数将采用 joblib 的默认值。
“dask”: 可以传入 dask.compute 的任何有效键，例如 scheduler
“ray”: 可以传入以下键
- “ray_remote_args”: ray.init 的有效键字典
- “shutdown_ray”: 布尔值，默认值=True；False 会阻止 ray 在
  并行化后关闭。
- “logger_name”: str, 默认值=”ray”；要使用的日志记录器名称。
- “mute_warnings”: 布尔值，默认值=False；如果为 True，则抑制警告

remember_data布尔值，默认值=True

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

返回:

self对 self 的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

此方法适用于简单的 skbase 对象和复合对象。对于复合对象（即包含其他对象的对象），可以使用参数键字符串 <component>__<parameter> 来访问组件 <component> 中的 <parameter>。如果不带 <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

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

deepbool, default=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: 仅更新 cutoff 并记住数据

所需状态: predict(fh=None, X=None)[source]#

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

访问 self

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

写入 self

将 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 格式的时间序列，可选 (默认=None)。

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

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

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

返回:

self对 self 的引用

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

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

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

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

self.update(y=cv.split_series(y)[0][0])
记住 self.predict() （稍后在单个批次中返回）
self.update(y=cv.split_series(y)[1][0])
记住 self.predict() （稍后在单个批次中返回）
等等
返回所有记住的预测

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

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

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

所需状态: predict(fh=None, X=None)[source]#

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

访问 self

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

写入 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

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

例如，SlidingWindowSplitter 或 ExpandingWindowSplitter；默认值 = 使用 initial_window=1 的 ExpandingWindowSplitter，且默认情况下，y/X 中的单个数据点会逐个添加并预测，initial_window = 1，step_length = 1，fh = 1

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

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

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

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

reset_forecaster布尔值，可选（默认值=True）

如果为 True，则不会改变预测器的状态，即，update/predict 序列使用一个副本运行，并且 self 的 cutoff、模型参数、数据内存不会改变。
如果为 False，则在运行 update/predict 序列时，会像直接调用 update/predict 一样更新 self。

返回:

y_pred对多个分割批次的点预测进行制表的对象

格式取决于总体预测的 (cutoff, 绝对预测范围) 对

如果绝对预测范围点的集合是唯一的：类型为 sktime 兼容数据容器格式的时间序列，输出中省略 cutoff，其类型与最近传入的 y 相同：Series, Panel, Hierarchical scitype，格式相同（见上文）
如果绝对预测范围点的集合不唯一：类型为 pandas DataFrame，行和列索引为时间戳；行索引对应于进行预测的 cutoff；列索引对应于预测的绝对预测范围；条目是从行索引对应的 cutoff 预测列索引对应的绝对预测范围的点预测值；如果该 (cutoff, horizon) 对没有进行预测，则条目为 nan。

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

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

此方法适用于在一个步骤中完成更新和预测。

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

所需状态: 需要状态为“fitted”。
需要状态为“fitted”，即 self.is_fitted=True。: 以“_”结尾的已拟合模型属性。已见数据的指针，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，

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

参数:

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, 默认=None

如果传递了 fh 并且之前未传递过，则将其存储到 self.fh。编码要预测的时间戳的预测范围。如果已在 fit 中传递，则不应再传递。如果未在 fit 中传递，则必须传递，不可选。

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

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

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

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

返回:

y_predsktime 兼容数据容器格式的时间序列: 在 fh 处的点预测，具有与 fh 相同的索引。y_pred 与最近传递的 y 类型相同：Series, Panel, Hierarchical scitype，格式相同（见上文）