MultiplexForecaster#

class MultiplexForecaster(forecasters: list, selected_forecaster=None)[源]#

用于在不同模型之间进行选择的 MultiplexForecaster。

MultiplexForecaster 提供了一个框架，用于在不同的模型类之间执行模型选择过程。应与 ForecastingGridSearchCV 结合使用以充分利用其功能。它可以用于单变量和多变量预测器。

MultiplexForecaster 通过一个（命名）预测器列表和一个 selected_forecaster 超参数指定，该超参数是预测器名称之一。然后，MultiplexForecaster 的行为将与名称为 selected_forecaster 的预测器完全一致，忽略其他预测器中的功能。

与 ForecastingGridSearchCV 结合使用时，MultiplexForecaster 通过调整 selected_forecaster 超参数，提供了跨多个估计器进行调优的能力，即执行 AutoML。这种组合将通过调优算法选择所传入的预测器之一。

参数：
forecasters sktime 预测器列表，或

sktime 预测器的元组列表 (str, estimator) MultiplexForecaster 可以在这些预测器之间切换（“多路复用”）。这些是“蓝图”预测器，在调用 fit 时其状态不会改变。

selected_forecaster: str 或 None，可选，默认值=None。
如果是 str，则必须是预测器名称之一。

如果未提供名称，则必须与自动生成的名称字符串一致。要检查自动生成的名称字符串，请调用 get_params。

如果是 None，则其行为如同选择了列表中的第一个预测器。选择 MultiplexForecaster 的行为所依据的预测器。

属性：
forecaster_ sktime 预测器

用于拟合和预测的所选预测器的克隆。

_forecasters (str, forecaster) 元组列表

转换为名称/估计器元组的预测器。

示例

>>> from sktime.forecasting.ets import AutoETS
>>> from sktime.forecasting.model_selection import ForecastingGridSearchCV
>>> from sktime.split import ExpandingWindowSplitter
>>> from sktime.forecasting.compose import MultiplexForecaster
>>> from sktime.forecasting.naive import NaiveForecaster
>>> from sktime.forecasting.theta import ThetaForecaster
>>> from sktime.forecasting.model_evaluation import evaluate
>>> from sktime.datasets import load_shampoo_sales
>>> y = load_shampoo_sales()
>>> forecaster = MultiplexForecaster(forecasters=[
...     ("ets", AutoETS()),
...     ("theta", ThetaForecaster()),
...     ("naive", NaiveForecaster())])  
>>> cv = ExpandingWindowSplitter(step_length=12)  
>>> gscv = ForecastingGridSearchCV(
...     cv=cv,
...     param_grid={"selected_forecaster":["ets", "theta", "naive"]},
...     forecaster=forecaster)  
>>> gscv.fit(y)  
ForecastingGridSearchCV(...)

方法

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

检查对象是否是复合对象。

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

设置估计器的参数。

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

用新数据更新模型并进行预测。
check_is_fitted(method_name=None)[源]#

检查估计器是否已拟合。

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

如果不是，则会引发 NotFittedError。

参数：
method_name str，可选

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

引发：
NotFittedError

如果估计器尚未拟合。

clone()[源]#

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

克隆是一个没有共享引用的不同对象，处于初始化后状态。此函数等同于返回 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)[源]#

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

每个 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_names str 或 str 列表，默认值 = None

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

返回：
自身

self 的引用。

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

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

参数：
parameter_set str，默认值=”default”

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

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

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

参数：
parameter_set str，默认值=”default”

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

返回：
objs cls 实例列表

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

names str 列表，与 objs 长度相同

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

property cutoff[源]#

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

返回：
cutoff pandas 兼容的索引元素，或 None

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

property fh[源]#

已传入的预测范围。

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

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

状态更改

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

写入自身

  • 设置以“_”结尾的已拟合模型属性，已拟合属性可通过 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), Series 类型 pd.DataFrame 的 list

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

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

fh int, list, 可强制转换为 pd.Index，或 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 自身引用。
fit_predict(y, X=None, fh=None, X_pred=None)[源]#

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

与 fit(y, X, fh).predict(X_pred) 相同。如果未传入 X_pred，则与 fit(y, fh, X).predict(X) 相同。

状态更改

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

写入自身

  • 设置以“_”结尾的已拟合模型属性，已拟合属性可通过 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), Series 类型 pd.DataFrame 的 list

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

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

fh int, list, 可强制转换为 pd.Index，或 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_pred sktime 兼容格式的时间序列，可选（默认值=None）

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

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

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

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

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

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

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

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

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

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

按继承顺序。

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

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

参数：
tag_name str

标签值的名称。

tag_value_default 任意类型

如果未找到标签，则为默认/回退值。

返回：
tag_value

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

classmethod get_class_tags()[源]#

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

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

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

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

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

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

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

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

按继承顺序。

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

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

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

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

collected_tagsdict

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

get_config()[源]#

获取自身的配置标志。

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

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

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

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

返回：
config_dictdict

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

get_fitted_params(deep=True)[源]#

获取已拟合参数。

所需状态

需要状态为“已拟合”。

参数：
deep bool，默认值=True

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

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

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

返回：
fitted_paramsdict，键为 str 类型

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

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

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

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

classmethod get_param_defaults()[源]#

获取对象的参数默认值。

返回：
default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)[源]#

获取对象的参数名称。

参数：
sort bool，默认值=True

是按字母顺序返回参数名称（True），还是按它们在类 __init__ 中出现的顺序返回（False）。

返回：
param_names: list[str]

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

get_params(deep=True)[源]#

获取估计器的参数。

参数：
deep boolean，可选

如果为 True，将返回此估计器及其包含的作为估计器的子对象的参数。

返回：
paramsstring 到任意类型的映射

参数名称映射到它们的值。

get_tag(tag_name, tag_value_default=None, raise_error=True)[源]#

从实例获取标签值，包括标签级别继承和覆盖。

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

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

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

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

在实例构造时。

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

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

按继承顺序。

参数：
tag_name str

要检索的标签名称

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

从实例获取标签，包括标签级别继承和覆盖。

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

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

get_tags 方法返回一个标签字典，其键是类或其任何父类中设置的任何 _tags 属性的键，或通过 set_tags 或 clone_tags 设置的标签。

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

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

在实例构造时。

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

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

按继承顺序。

返回：
collected_tagsdict

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

classmethod get_test_params(parameter_set='default')[源]#

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

参数：
parameter_set str，默认值=”default”

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

返回：
paramsdict 或 dict 列表
is_composite()[源]#

检查对象是否是复合对象。

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

返回：
composite: bool，自身是否包含一个作为 BaseObject 的参数
property is_fitted[源]#

是否已调用 fit。

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

返回：
bool

估计器是否已 fit。

classmethod load_from_path(serial)[源]#

从文件位置加载对象。

参数：
serialZipFile(path).open(“object) 的结果
返回：
反序列化的自身，产生位于 path 的输出，该输出由 cls.save(path) 生成
classmethod load_from_serial(serial)[源]#

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

参数：
serialcls.save(None) 输出的第一个元素
返回：
反序列化的自身，产生输出 serial，该输出由 cls.save(None) 生成
predict(fh=None, X=None)[源]#

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

所需状态

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

访问自身

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

  • self.cutoff, self.is_fitted

写入自身

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

参数：
fh int, 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_pred sktime 兼容数据容器格式的时间序列

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

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

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

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

所需状态

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

访问自身

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

  • self.cutoff, self.is_fitted

写入自身

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

参数：
fh int, 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）

预测区间(s) 的名义覆盖率

返回：
pred_intpd.DataFrame
列具有多重索引：第一层是拟合时 y 中的变量名，
第二层是计算区间的覆盖率分数。

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

第三层是字符串“lower”或“upper”，表示区间的下限/上限。

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

来自拟合时看到的 y，如果拟合时看到的 y 是 Panel 或 Hierarchical 类型。

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

对应列索引中的变量，第二层列索引中的名义覆盖率，取决于第三层列索引的下限/上限，针对行索引。上限/下限区间预测值等同于在 alpha = 0.5 - c/2, 0.5 + c/2 处计算的分位数预测值，其中 c 是覆盖率。

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

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

注意

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

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

所需状态

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

访问自身

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

  • self.cutoff, self.is_fitted

写入自身

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

参数：
fh int, 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 索引引用。

marginal布尔值, 可选的 (默认值=True)

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

返回：
pred_distskpro BaseDistribution

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

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

计算/返回分位数预测。

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

所需状态

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

访问自身

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

  • self.cutoff, self.is_fitted

写入自身

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

参数：
fh int, 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 索引引用。

alpha浮点数 或 唯一值的浮点数列表, 可选的 (默认值=[0.05, 0.95])

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

返回：
quantilespd.DataFrame
列具有多重索引：第一层是拟合时 y 中的变量名，

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

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

来自拟合时看到的 y，如果拟合时看到的 y 是 Panel 或 Hierarchical 类型。

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

第二层列索引中的分位数概率，针对行索引。

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

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

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

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

所需状态

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

访问自身

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

写入自身

无。

参数：
y sktime 兼容数据容器格式的时间序列

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

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

  • 如果之前只进行了一次拟合调用，则会产生样本内残差。

  • 如果拟合需要 fh，则它必须指向拟合时 y 的索引。

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

用于更新和预测的外生时间序列。应与拟合时 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.cutoff, self.is_fitted

写入自身

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

参数：
fh int, 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 索引引用。

cov布尔值, 可选的 (默认值=False)

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

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

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

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

来自拟合时看到的 y，如果拟合时看到的 y 是 Panel 或 Hierarchical 类型。

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

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

如果 cov=True
列索引是一个多重索引：第一层是变量名（同上）

第二层是 fh。

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

来自拟合时看到的 y，如果拟合时看到的 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))`` 后获得的对象相同。

返回：
自身

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

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”，则将在 /home/stored/ 中生成一个 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)

要评分的时间序列

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

用于编码预测时间戳的预测范围。

Xpd.DataFrame, 或 2D np.array, 可选的 (默认值=None)

用于评分的外生时间序列。如果 self.get_tag(“X-y-must-have-same-index”) 为真，则 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

配置名称 : 配置值 对的字典。下面列出了有效的配置、值及其含义。

display字符串, “diagram” (默认值), 或 “text”

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_only布尔值, 默认值=True

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

warnings字符串, “on” (默认值), 或 “off”

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

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

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

backend:parallel字符串, 可选的, 默认值=”None”

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

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

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

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

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

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

backend:parallel:params字典, 可选的, 默认值={} (未传递参数)

作为配置传递给并行化后端的额外参数。有效的键取决于 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”：字符串，默认值=“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(**kwargs)[source]#

设置估计器的参数。

有效的参数键可以通过 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_state整数, RandomState 实例 或 None, 默认值=None

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

deep bool，默认值=True

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

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

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

self_policy字符串, 以下之一 {“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_dict字典

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

返回：
Self

对 self 的引用。

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

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

如果没有实现针对特定估计器的 update 方法，默认回退如下

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

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

所需状态

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

访问自身

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

  • self.cutoff, self.is_fitted

写入自身

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

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

参数：
y sktime 兼容数据容器格式的时间序列。

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

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

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

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

  • 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") 为真，则 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 非默认值）

  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：仅更新 cutoff 并记住数据

所需状态

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

访问自身

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

  • self.cutoff, self.is_fitted

写入 self（除非 reset_forecaster=True）

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

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

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

参数：
y sktime 兼容数据容器格式的时间序列。

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

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

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

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

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

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

用于更新和预测的外生时间序列。应与拟合时 y 的 scitype (Series, Panel, 或 Hierarchical) 相同。如果 self.get_tag("X-y-must-have-same-index") 为真，则 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, absolute horizon) 对。

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

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

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

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

此方法对于在一个步骤中进行更新和预测非常有用。

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

所需状态

需要状态为“已拟合”。

访问自身

以“_”结尾的已拟合模型属性。指向已见数据的指针，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，

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

参数：
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), Series 类型 pd.DataFrame 的 list

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

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

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

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

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

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

update_params布尔值, 可选的 (默认值=True)

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

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

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