AutoEnsembleForecaster#

class AutoEnsembleForecaster(forecasters, method='feature-importance', regressor=None, test_size=None, random_state=None, n_jobs=None)[source]#

自动为集成预测器寻找最优权重。

AutoEnsembleForecaster 使用给定的方法或元模型（回归器）为集成预测器寻找最优权重。该回归器必须类似于 sklearn，并且需要具有 feature_importances_ 或 coef_ 属性，因为这些属性被用作权重。回归器也可以是 sklearn.Pipeline。

参数:
forecasterslist of (str, estimator) tuples

应用于输入序列的估计器。

methodstr, optional, default=”feature-importance”

用于计算权重的策略。可选方法包括

  • feature-importance（特征重要性）

    使用给定 regressor 的 feature_importances_ 或 coef_ 作为最优权重。

  • inverse-variance（逆方差）

    使用预测误差的逆方差（基于内部训练-测试分割）来计算最优权重，给定的 regressor 将被忽略。

regressorsklearn-like regressor, optional, default=None.

用于从系数（线性模型）或特征重要性得分（基于决策树的模型）推断最优权重。如果为 None，则使用 GradientBoostingRegressor(max_depth=5)。回归器也可以是 sklearn.Pipeline()。

test_sizeint or float, optional, default=None

用于进行内部的 temporal_train_test_split()。test_size 数据将作为回归器的内生数据（即最近的数据）。回归器的外生数据是来自临时训练的集成模型的预测结果。如果为 None，则默认为 0.25。

random_stateint, RandomState instance or None, default=None

用于设置默认回归器的 random_state。

n_jobsint or None, optional, default=None

用于并行运行 fit 的作业数。None 表示 1，除非在 joblib.parallel_backend 上下文中。-1 表示使用所有处理器。

属性:
regressor_sklearn-like regressor

已拟合的回归器。

weights_np.array

基于 regressor.feature_importances_ 或 regressor.coef_ 值的权重。

另请参阅

EnsembleForecaster

示例

>>> from sktime.forecasting.compose import AutoEnsembleForecaster
>>> from sktime.forecasting.naive import NaiveForecaster
>>> from sktime.forecasting.trend import PolynomialTrendForecaster
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> forecasters = [
...     ("trend", PolynomialTrendForecaster()),
...     ("naive", NaiveForecaster()),
... ]
>>> forecaster = AutoEnsembleForecaster(forecasters=forecasters)
>>> forecaster.fit(y=y, fh=[1,2,3])
AutoEnsembleForecaster(...)
>>> y_pred = forecaster.predict()

方法

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

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

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

参数:
parameter_setstr, default=”default”

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

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

检查估计器是否已拟合。

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

否则，将引发 NotFittedError。

参数:
method_namestr, optional

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

引发:
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 兼容的对象都有一个标签字典。标签可用于存储有关对象的元数据，或控制对象的行为。

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

参数:
一个 :class:BaseObject 或派生类的实例。
tag_namesstr or list of str, default = None

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

返回:
self

对自身的引用。

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

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

参数:
parameter_setstr, default=”default”

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

返回:
instanceinstance of the class with default parameters
具有默认参数的类的实例。

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

参数:
parameter_setstr, default=”default”

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

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

objslist of instances of cls

cls 实例的列表。

i-th instance is cls(**cls.get_test_params()[i])

nameslist of str, same length as objs

字符串列表，长度与 objs 相同。

返回:
i-th element is name of i-th instance of obj in tests. The naming convention is {cls.__name__}-{i} if more than one instance, otherwise {cls.__name__}

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

property cutoff[source]#

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

cutoffpandas compatible index element, or None

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

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

pandas compatible index element, if cutoff has been set; None otherwise

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

  • property fh[source]#

  • 已传递的预测视野。

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

  • 状态变化

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

写入自身

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

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

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

  • 如果传递了 fh，则将 fh 存储到 self.fh。

ytime series in sktime compatible data container format.

符合 sktime 数据容器格式的时间序列。

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

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

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

pandas compatible index element, if cutoff has been set; None otherwise

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

  • property fh[source]#

  • 已传递的预测视野。

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

  • fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

参数:
整数、列表、可强制转换为 pd.Index 或 ForecastingHorizon，默认值为 None

写入自身

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

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

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

  • 如果传递了 fh，则将 fh 存储到 self.fh。

ytime series in sktime compatible data container format.

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

Xtime series in sktime compatible format, optional (default=None).

符合 sktime 格式的时间序列，可选（默认值为 None）。

sktime 中的个体数据格式称为 mtype 规范，每个 mtype 实现一个抽象的 scitype。

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

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

selfReference to 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) 相同。

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

将 fh 存储到 self.fh。

ytime series in sktime compatible data container format

符合 sktime 数据容器格式的时间序列

  1. fhint, list, pd.Index coercible, or ForecastingHorizon (not optional)

  2. 整数、列表、可强制转换为 pd.Index 或 ForecastingHorizon（不可选）

编码要预测的时间戳的预测视野。

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

X_predtime series in sktime compatible format, optional (default=None)

参数:
符合 sktime 格式的时间序列，可选（默认值为 None）

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

y_predtime series in sktime compatible data container format

符合 sktime 数据容器格式的时间序列

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

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

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

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

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

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

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

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

类 _tags 属性中设置的标签。

  1. fhint, list, pd.Index coercible, or ForecastingHorizon (not optional)

  2. 整数、列表、可强制转换为 pd.Index 或 ForecastingHorizon（不可选）

编码要预测的时间戳的预测视野。

父类 _tags 属性中设置的标签，按继承顺序排列。

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

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

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

tag_namestr

标签名称。

tag_value_defaultany type

获取自身的配置标志。

如果找不到标签，则使用的默认/回退值。

tag_value

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

classmethod get_class_tags()[source]#

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

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

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

获取已拟合参数。

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

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

参数:
For including overrides from dynamic tags, use get_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, default=True

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

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

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

fitted_paramsdict with str-valued keys

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

获取估计器的参数。

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

如果 deep=True，还包含组件参数的键/值对。组件的参数索引为 [componentname]__[paramname]。`componentname` 的所有参数显示为 paramname 及其值

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

classmethod get_param_defaults()[source]#

获取对象的默认参数。

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

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

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

default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)[source]#

  1. fhint, list, pd.Index coercible, or ForecastingHorizon (not optional)

  2. 整数、列表、可强制转换为 pd.Index 或 ForecastingHorizon（不可选）

编码要预测的时间戳的预测视野。

参数:
符合 sktime 格式的时间序列，可选（默认值为 None）

获取对象的参数名称。

sortbool, default=True

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

param_names: list[str]

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

返回:
get_params(deep=True)[source]#

deepboolean, optional

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

paramsmapping of string to any

参数名称映射到其值。

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

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

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

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

类 _tags 属性中设置的标签。

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

classmethod get_param_names(sort=True)[source]#

  1. fhint, list, pd.Index coercible, or ForecastingHorizon (not optional)

  2. 整数、列表、可强制转换为 pd.Index 或 ForecastingHorizon（不可选）

编码要预测的时间戳的预测视野。

返回:
get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，考虑标签覆盖，优先级降序排列如下

在实例构造时通过 set_tags 或 clone_tags 在实例上设置的标签。

要检索的标签名称

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

tag_value_defaultany type, optional; default=None

返回:
如果找不到标签，则使用的默认/回退值，可选；默认值为 None
raise_errorbool

如果找不到标签，是否引发 ValueError

tag_valueAny

返回:
在 self 中 tag_name 标签的值。如果找不到，如果 raise_error 为 True 则引发错误，否则返回 tag_value_default。

ValueError, if raise_error is True.

ValueError，如果 raise_error 为 True。

从文件位置加载对象。

参数:
如果 tag_name 不在 self.get_tags().keys() 中，则引发 ValueError。
返回:
get_tags()[source]#
get_tags 方法返回一个标签字典，其键是类或其任何父类中设置的任何 _tags 属性的键，或通过 set_tags 或 clone_tags 设置的标签。

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

参数:
collected_tagsdict
返回:
标签名称 : 标签值 对的字典。通过嵌套继承从 _tags 类属性收集，然后任何覆盖和新标签来自 _tags_dynamic 对象属性。
is_composite()[source]#

在未来视野上预测时间序列。

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

复合对象是包含其他对象作为参数的对象。

在实例上调用，因为这可能因实例而异。

  • composite: bool, whether self contains a parameter which is BaseObject

  • composite: bool，表示自身是否包含一个参数为 BaseObject 的对象

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

property is_fitted[source]#

参数:
符合 sktime 数据容器格式的时间序列。

是否已调用 fit。

符合 sktime 格式的时间序列，可选（默认值为 None）。

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

bool

返回:
对自身的引用。

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

估计器是否已 fit。

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

classmethod load_from_path(serial)[source]#

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

复合对象是包含其他对象作为参数的对象。

在实例上调用，因为这可能因实例而异。

  • composite: bool, whether self contains a parameter which is BaseObject

  • composite: bool，表示自身是否包含一个参数为 BaseObject 的对象

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

property is_fitted[source]#

参数:
符合 sktime 数据容器格式的时间序列。

是否已调用 fit。

serialresult of ZipFile(path).open("object)

  • ZipFile(path).open("object) 的结果

  • 反序列化自身，结果输出到 path，即 cls.save(path) 的输出

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

bool

classmethod load_from_serial(serial)[source]#

serial1st element of output of cls.save(None)

返回:
cls.save(None) 输出的第一个元素
反序列化自身，结果输出 serial，即 cls.save(None) 的输出
predict(fh=None, X=None)[source]#

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

访问自身

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

self.cutoff，self.is_fitted

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

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

Xtime series in sktime compatible format, optional (default=None)

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

符合 sktime 格式的时间序列，可选（默认值为 None）

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

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

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

复合对象是包含其他对象作为参数的对象。

在实例上调用，因为这可能因实例而异。

  • composite: bool, whether self contains a parameter which is BaseObject

  • composite: bool，表示自身是否包含一个参数为 BaseObject 的对象

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

property is_fitted[source]#

参数:
符合 sktime 数据容器格式的时间序列。

是否已调用 fit。

serialresult of ZipFile(path).open("object)

  • ZipFile(path).open("object) 的结果

  • 反序列化自身，结果输出到 path，即 cls.save(path) 的输出

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

bool

marginal布尔型，可选（默认为 True）

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

返回:
pred_distskpro BaseDistribution

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

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

计算/返回分位数预测。

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

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

复合对象是包含其他对象作为参数的对象。

在实例上调用，因为这可能因实例而异。

  • composite: bool, whether self contains a parameter which is BaseObject

  • composite: bool，表示自身是否包含一个参数为 BaseObject 的对象

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

property is_fitted[source]#

参数:
符合 sktime 数据容器格式的时间序列。

是否已调用 fit。

serialresult of ZipFile(path).open("object)

  • ZipFile(path).open("object) 的结果

  • 反序列化自身，结果输出到 path，即 cls.save(path) 的输出

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

bool

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

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

返回:
quantilespd.DataFrame
反序列化自身，结果输出 serial，即 cls.save(None) 的输出

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

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

self.cutoff，self.is_fitted

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

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

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.cutoff, self._is_fitted

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

无。

参数:
整数、列表、可强制转换为 pd.Index 或 ForecastingHorizon，默认值为 None

包含真实观测值的时间序列，用于计算残差。必须与 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]#

计算/返回方差预测。

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

复合对象是包含其他对象作为参数的对象。

在实例上调用，因为这可能因实例而异。

  • composite: bool, whether self contains a parameter which is BaseObject

  • composite: bool，表示自身是否包含一个参数为 BaseObject 的对象

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

property is_fitted[source]#

参数:
符合 sktime 数据容器格式的时间序列。

是否已调用 fit。

serialresult of ZipFile(path).open("object)

  • ZipFile(path).open("object) 的结果

  • 反序列化自身，结果输出到 path，即 cls.save(path) 的输出

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

bool

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

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

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

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

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

self.cutoff，self.is_fitted

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

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

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

第二级是 fh。

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

self.cutoff，self.is_fitted

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

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

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

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)

用于评分的时间序列

符合 sktime 数据容器格式的时间序列。

Xtime series in sktime compatible format, optional (default=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]#

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

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

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

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

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(**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_stateint, RandomState instance or None, default=None

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

For including overrides from dynamic tags, use get_tags.

是否在 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]#

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

将 fh 存储到 self.fh。

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

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

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

estimatorAn instance of :class:BaseObject or derived class

参数:
**tag_dict**字典

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

返回:
自身

对自身的引用。

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

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

如果未实现特定于估计器的更新方法，默认备用方案如下：

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

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

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

复合对象是包含其他对象作为参数的对象。

在实例上调用，因为这可能因实例而异。

  • composite: bool, whether self contains a parameter which is BaseObject

  • composite: bool，表示自身是否包含一个参数为 BaseObject 的对象

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

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

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

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

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

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

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

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

  • 如果传递了 fh，则将 fh 存储到 self.fh。

ytime series in sktime compatible data container format.

sktime 中的个体数据格式称为 mtype 规范，每个 mtype 实现一个抽象的 scitype。

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

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

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

返回:
self对 self 的引用
update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#

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

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

与以下操作相同（如果仅 y、cv 非默认）

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

  2. 记住 self.predict()（稍后在单个批次中返回）

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

  4. 记住 self.predict()（稍后在单个批次中返回）

  5. 等等

  6. 返回所有记住的预测

如果未实现特定于估计器的更新方法，默认备用方案如下：

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

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

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

复合对象是包含其他对象作为参数的对象。

在实例上调用，因为这可能因实例而异。

  • composite: bool, whether self contains a parameter which is BaseObject

  • composite: bool，表示自身是否包含一个参数为 BaseObject 的对象

写入 self（除非 reset_forecaster=True）

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

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

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

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

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

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

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

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

  • 如果传递了 fh，则将 fh 存储到 self.fh。

ytime series in sktime compatible data container format.

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_params布尔型，可选（默认为 True）

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

reset_forecaster布尔型，可选（默认为 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]#

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

此方法适用于在单个步骤中进行更新和预测。

如果未实现特定于估计器的更新方法，默认备用方案是先更新，然后预测。

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

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

在实例上调用，因为这可能因实例而异。

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

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

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

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

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

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

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

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

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

  • 如果传递了 fh，则将 fh 存储到 self.fh。

ytime series in sktime compatible data container format.

符合 sktime 数据容器格式的时间序列。

是否已调用 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，仅更新截止点，模型参数（例如系数）不更新。

返回:
对自身的引用。

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