GroupbyCategoryForecaster#

class GroupbyCategoryForecaster(forecasters, transformer=None, fallback_forecaster=None)[source]#

根据时间序列的类别或簇选择全局预测器。

是“聚类然后应用预测器”方法或 Syntetos/Boylan 启发式方法在程序上的泛化,用于按平滑、不稳定、间歇性、波动性等类别应用预测器。

对给定的时间序列应用一个时间序列到基本类型变换器。时间序列根据变换器生成的值进行分组,然后使用相应的预测器来预测时间序列。

TransformSelectForecaster 不同,此组合器将给定类别的所有时间序列传递给预测器,而不是一次只传递一个。

参数:
forecastersdict[sktime forecasters]

预测器字典,其键对应于给定变换器生成的类别,其值对应于一个 sktime 预测器。

transformersktime transformer or clusterer, default = ADICVTransformer()

一个将时间序列转换为基本类型的 sktime 变换器,生成一个值,该值可用于量化时间序列的预测器选择。

如果使用聚类器,它必须支持簇分配,即具有 capability:predict 标签。

注意:为确保功能正确,当调用 transform() 或 fit_transform() 函数时,变换器必须将生成的类别存储在返回值的第一个列中。

fallback_forecastersktime forecaster | None, Optional

一个备用预测器,如果变换器生成的类别与任何给定的预测器都不匹配,将使用此备用预测器。

属性:
cutoff

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

fh

已传递的预测范围。

is_fitted

是否已调用 fit

steps_
引发:
AssertionError:如果传入的不是有效的变换器(BaseTransformer 的实例)
或者没有给定有效的预测器(BaseForecaster 的实例)。

示例

此示例展示了如何利用 GroupbyCategoryForecaster 根据 ADICVTransformer 确定的时间序列类别选择合适的预测器。

>>> from sktime.forecasting.compose import GroupbyCategoryForecaster
>>> from sktime.forecasting.croston import Croston
>>> from sktime.forecasting.trend import PolynomialTrendForecaster
>>> from sktime.forecasting.naive import NaiveForecaster
>>> from sktime.transformations.series.adi_cv import ADICVTransformer

导入根据其方差和平均需求间隔生成特定类别数据的方法。

>>> from sktime.transformations.series.tests.test_adi_cv import (
...     _generate_erratic_series)

定义预测器,它接受一个预测器字典、一个变换器以及可选的备用预测器。

>>> group_forecaster = GroupbyCategoryForecaster(
...     forecasters =
...         {"smooth": NaiveForecaster(),
...         "erratic": Croston(),
...         "intermittent": PolynomialTrendForecaster()},
...     transformer=ADICVTransformer(features=["class"]))
>>> generated_data = _generate_erratic_series()

fit 函数首先将数据通过给定的变换器生成一个给定的类别。该类别可以通过变量 self.category_ 查看。

>>> group_forecaster = group_forecaster.fit(generated_data, fh=50)
>>> #print(f"The chosen category is: {group_forecaster.category}")
>>> # Print out the predicted value over the given forecasting horizon!
>>> # print(group_forecaster.predict(fh=50, X=None))

方法

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

检查对象是否由其他 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(parameter_set='default')[source]#

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

参数:
parameter_setstr, default=”default”

要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,将返回 “default” 集。目前预测器没有保留值。

返回:
paramsdict or list of dict, default = {}

用于创建类测试实例的参数。每个字典都是构造一个“有趣”测试实例的参数,即 MyClass(**params)MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个(或唯一)字典。

check_is_fitted(method_name=None)[source]#

检查估算器是否已拟合。

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

如果不是,则引发 NotFittedError

参数:
method_namestr, optional

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

引发:
NotFittedError

如果估算器尚未拟合。

clone()[source]#

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

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

等效于构造一个具有 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_tagsget_tag 查看。

参数:
estimator:class:BaseObject 或其派生类的实例
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 兼容的索引元素,如果已设置截止点;否则为 None

property fh[source]#

已传递的预测范围。

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

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

状态变化

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

写入自身

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

  • self.is_fitted 标志设置为 True

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

  • 如果传入 fh,则将其存储到 self.fh

参数:
ytime series in sktime compatible data container format.

要将预测器拟合到的时间序列。

sktime 中的单个数据格式称为 mtype 规范,每种 mtype 都实现一个抽象的 scitype

  • Series scitype = 单个时间序列,普通预测。pd.DataFrame, pd.Seriesnp.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, or ForecastingHorizon, default=None

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

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

用于拟合模型的外生时间序列。应与 y 具有相同的 scitype (SeriesPanelHierarchical)。如果 self.get_tag("X-y-must-have-same-index"),则 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) 相同。

状态变化

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

写入自身

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

  • self.is_fitted 标志设置为 True

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

  • fh 存储到 self.fh

参数:
ytime series in sktime compatible data container format

要将预测器拟合到的时间序列。

sktime 中的单个数据格式称为 mtype 规范,每种 mtype 都实现一个抽象的 scitype

  • Series scitype = 单个时间序列,普通预测。pd.DataFrame, pd.Seriesnp.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, or ForecastingHorizon (not optional)

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

If fh is not None and not of type ForecastingHorizon it is coerced to ForecastingHorizon via a call to _check_fh. In particular, if fh is of type pd.Index it is coerced via ForecastingHorizon(fh, is_relative=False)

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

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

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

用于预测的外生时间序列。如果传入,将用于 predict 而非 X。应与 fit 中的 y 具有相同的 scitype (SeriesPanelHierarchical)。如果 self.get_tag("X-y-must-have-same-index"),则 X.index 必须包含 fh 索引引用。

返回:
y_predtime series in sktime compatible data container format

fh 处的点预测,索引与 fh 相同。y_pred 的类型与最近传入的 y 相同:SeriesPanelHierarchical scitype,格式相同(见上文)。

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

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

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

get_class_tag 方法是一个类方法,用于检索标签值,仅考虑类级别的标签值和覆盖。

它从对象中返回名称为 tag_name 的标签的值,按以下优先级降序考虑标签覆盖:

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

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

按继承顺序排列。

不考虑通过 set_tagsclone_tags 在实例上设置的动态标签覆盖。

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

参数:
tag_namestr

标签值的名称。

tag_value_defaultany type

如果未找到标签,则使用的默认/备用值。

返回:
tag_value

selftag_name 标签的值。如果未找到,则返回 tag_value_default

classmethod get_class_tags()[source]#

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

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

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

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

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

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

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

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

按继承顺序排列。

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

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

不考虑通过 set_tagsclone_tags 在实例上设置的动态标签覆盖。

要包含动态标签的覆盖,请使用 get_tags

collected_tagsdict

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

get_config()[source]#

获取自身的配置标志。

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

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

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

配置在 clonereset 调用下保留。

返回:
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]#

获取对象的默认参数。

返回:
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,但不包括组件的参数。

返回:
paramsdict with str-valued keys

参数字典,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_tagsclone_tags 在实例上设置的标签,

在实例构造时设置的标签。

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

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

按继承顺序排列。

参数:
tag_namestr

要检索的标签名称

tag_value_defaultany type, optional; default=None

如果未找到标签,则使用的默认/备用值

raise_errorbool

未找到标签时是否引发 ValueError

返回:
tag_valueAny

selftag_name 标签的值。如果未找到,并且 raise_error 为 True,则引发错误,否则返回 tag_value_default

引发:
ValueError,如果 raise_errorTrue

如果 tag_name 不在 self.get_tags().keys() 中,则引发 ValueError

get_tags()[source]#

从实例中获取标签,并继承标签级别和覆盖。

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

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

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

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

  1. 通过 set_tagsclone_tags 在实例上设置的标签,

在实例构造时设置的标签。

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

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

按继承顺序排列。

返回:
collected_tagsdict

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

is_composite()[source]#

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

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

返回:
composite: bool

对象是否有任何参数的值是 BaseObject 的后代实例。

property is_fitted[source]#

是否已调用 fit

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

返回:
bool

估算器是否已 fit

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialresult of ZipFile(path).open(“object)
返回:
反序列化的自身,结果位于 path,来自 cls.save(path) 的输出
classmethod load_from_serial(serial)[source]#

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

参数:
serial1st element of output of cls.save(None)
返回:
反序列化的自身,结果为输出 serial,来自 cls.save(None) 的输出
predict(fh=None, X=None)[source]#

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

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入自身

如果传入了 fh 且之前未曾传入过,则将 fh 存储到 self.fh

参数:
fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

预测范围,编码了要进行预测的时间戳。如果已在 fit 方法中传入,则不应再次传入。如果在 fit 中未传入,则必须传入,非可选

If fh is not None and not of type ForecastingHorizon it is coerced to ForecastingHorizon via a call to _check_fh. In particular, if fh is of type pd.Index it is coerced via ForecastingHorizon(fh, is_relative=False)

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

预测中使用的外生时间序列。应与 fit 方法中 y 的 scitype(Series, PanelHierarchical)相同。如果 self.get_tag("X-y-must-have-same-index") 为 True,则 X.index 必须包含 fh 的索引参考。

返回:
y_predtime series in sktime compatible data container format

fh 处的点预测,索引与 fh 相同。y_pred 的类型与最近传入的 y 相同:SeriesPanelHierarchical scitype,格式相同(见上文)。

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

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

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

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入自身

如果传入了 fh 且之前未曾传入过,则将 fh 存储到 self.fh

参数:
fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

预测范围,编码了要进行预测的时间戳。如果已在 fit 方法中传入,则不应再次传入。如果在 fit 中未传入,则必须传入,非可选

如果 fh 不是 None 且不是 ForecastingHorizon 类型,则会在内部(通过 _check_fh)强制转换为 ForecastingHorizon

  • 如果 fhintint 的 array-like 类型,则解释为相对范围,并在内部强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fhpd.Index 类型,则解释为绝对范围,并在内部强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)

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

预测中使用的外生时间序列。应与 fit 方法中 y 的 scitype(Series, PanelHierarchical)相同。如果 self.get_tag("X-y-must-have-same-index") 为 True,则 X.index 必须包含 fh 的索引参考。

coveragefloat 或包含唯一浮点值的列表,可选 (default=0.90)

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

返回:
pred_intpd.DataFrame
列具有多级索引:第一级是 fit 方法中 `y` 的变量名,
第二级是计算区间的覆盖率分数,

顺序与输入的 coverage 相同。

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

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

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

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

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

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

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

注意

  • 目前仅针对 Series 类型(非 Panel、非 Hierarchical)的 y 实现了此功能。

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

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入自身

如果传入了 fh 且之前未曾传入过,则将 fh 存储到 self.fh

参数:
fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

预测范围,编码了要进行预测的时间戳。如果已在 fit 方法中传入,则不应再次传入。如果在 fit 中未传入,则必须传入,非可选

如果 fh 不是 None 且不是 ForecastingHorizon 类型,则会在内部(通过 _check_fh)强制转换为 ForecastingHorizon

  • 如果 fhintint 的 array-like 类型,则解释为相对范围,并在内部强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fhpd.Index 类型,则解释为绝对范围,并在内部强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)

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

预测中使用的外生时间序列。应与 fit 方法中 y 的 scitype(Series, PanelHierarchical)相同。如果 self.get_tag("X-y-must-have-same-index") 为 True,则 X.index 必须包含 fh 的索引参考。

marginalbool 类型,可选 (default=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

写入自身

如果传入了 fh 且之前未曾传入过,则将 fh 存储到 self.fh

参数:
fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

预测范围,编码了要进行预测的时间戳。如果已在 fit 方法中传入,则不应再次传入。如果在 fit 中未传入,则必须传入,非可选

如果 fh 不是 None 且不是 ForecastingHorizon 类型,则会在内部(通过 _check_fh)强制转换为 ForecastingHorizon

  • 如果 fhintint 的 array-like 类型,则解释为相对范围,并在内部强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fhpd.Index 类型,则解释为绝对范围,并在内部强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)

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

预测中使用的外生时间序列。应与 fit 方法中 y 的 scitype(Series, PanelHierarchical)相同。如果 self.get_tag("X-y-must-have-same-index") 为 True,则 X.index 必须包含 fh 的索引参考。

alphafloat 或包含唯一浮点值的列表,可选 (default=[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 上的预测计算残差。

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

所需状态

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

访问 self 中的属性

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

写入自身

无。

参数:
ytime series in sktime compatible data container format

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

如果为 None,则使用迄今为止所见的 `y` (self._y),特别是

  • 如果之前只调用了一次 `fit`,则会产生样本内残差。

  • 如果 `fit` 需要 fh,它必须指向 fit 方法中 y 的索引

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

用于更新和预测的外生时间序列。应与 `fit` 方法中 y 的 scitype(Series, PanelHierarchical)相同。如果 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]#

计算/返回方差预测。

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入自身

如果传入了 fh 且之前未曾传入过,则将 fh 存储到 self.fh

参数:
fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

预测范围,编码了要进行预测的时间戳。如果已在 fit 方法中传入,则不应再次传入。如果在 fit 中未传入,则必须传入,非可选

如果 fh 不是 None 且不是 ForecastingHorizon 类型,则会在内部(通过 _check_fh)强制转换为 ForecastingHorizon

  • 如果 fhintint 的 array-like 类型,则解释为相对范围,并在内部强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fhpd.Index 类型,则解释为绝对范围,并在内部强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)

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

预测中使用的外生时间序列。应与 fit 方法中 y 的 scitype(Series, PanelHierarchical)相同。如果 self.get_tag("X-y-must-have-same-index") 为 True,则 X.index 必须包含 fh 的索引参考。

covbool 类型,可选 (default=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, or ForecastingHorizon, default=None

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

Xpd.DataFrame 或 2D np.array,可选 (default=None)

用于评分的外生时间序列;如果 self.get_tag("X-y-must-have-same-index") 为 True,则 X.index 必须包含 y.index

返回:
scorefloat 类型

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

set_config(**config_dict)[source]#

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

参数:
config_dictdict

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

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

jupyter kernel 如何显示 `self` 的实例

  • “diagram” = HTML 框图表示

  • “text” = 字符串输出

print_changed_onlybool 类型,默认值=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_jobsbackend 必须作为 backend_params 的一个键传递。如果未传递 n_jobs,它将默认为 -1,其他参数将默认为 `joblib` 的默认值。

  • “dask”:可以传递 dask.compute 的任何有效键,例如 scheduler

  • “ray”:可以传递以下键

    • “ray_remote_args”:ray.init 的有效键的字典

    • “shutdown_ray”:bool 类型,默认值=True; False 防止 ray

      在并行化后关闭。

    • “logger_name”:str 类型,默认值=”ray”;要使用的日志记录器的名称。

    • “mute_warnings”:bool 类型,默认值=False;如果为 True,则抑制警告

remember_databool 类型,默认值=True

self._Xself._y 是否在 fit 中存储并在 update 中更新。如果为 True,self._Xself._y 会被存储和更新。如果为 False,self._Xself._y 不会被存储和更新。这在使用 save 时减少了序列化大小,但 `update` 将默认为“不执行任何操作”,而不是“重新拟合到所有已见数据”。

返回:
self指向 self 的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

此方法适用于简单的 skbase 对象和组合对象。参数键字符串 `__` 可用于组合对象(即包含其他对象的对象),以访问组件 `` 中的 `` 参数。如果引用是明确的,例如没有两个组件参数同名 ``,也可以使用不带 `__` 前缀的字符串 ``。

参数:
**paramsdict 类型

BaseObject 参数,键必须是 `__` 字符串。如果 `__` 后缀在 `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_tagsget_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.cutoff 更新为在 `y` 中看到的最新索引。

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

参数:
ytime series in sktime compatible data container format.

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

sktime 中的单个数据格式称为 mtype 规范,每种 mtype 都实现一个抽象的 scitype

  • Series scitype = 单个时间序列,普通预测。pd.DataFrame, pd.Seriesnp.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

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

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

update_paramsbool 类型,可选 (default=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,则不更新状态。

参数:
ytime series in sktime compatible data container format.

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

sktime 中的单个数据格式称为 mtype 规范,每种 mtype 都实现一个抽象的 scitype

  • Series scitype = 单个时间序列,普通预测。pd.DataFrame, pd.Seriesnp.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 的时间交叉验证生成器,可选

例如,SlidingWindowSplitterExpandingWindowSplitter;默认值 = 带有 initial_window=1 的 ExpandingWindowSplitter,并且默认值 = y/X 中的单个数据点被逐个添加和预测,initial_window = 1step_length = 1fh = 1

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

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

update_paramsbool 类型,可选 (default=True)

是否应更新模型参数。如果为 False,则仅更新截止点,模型参数(例如系数)不被更新。

reset_forecasterbool 类型,可选 (default=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 方法,默认回退行为是先 update,然后 predict。

所需状态

要求状态为“已拟合”。

访问 self 中的属性

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

写入自身

通过追加行的方式,使用 `y` 和 `X` 更新 self._yself._X。将 self.cutoffself._cutoff 更新为在 `y` 中看到的最后一个索引。如果 update_params=True

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

参数:
ytime series in sktime compatible data container format.

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

sktime 中的单个数据格式称为 mtype 规范,每种 mtype 都实现一个抽象的 scitype

  • Series scitype = 单个时间序列,普通预测。pd.DataFrame, pd.Seriesnp.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, or ForecastingHorizon, default=None

预测范围,编码了要进行预测的时间戳。如果已在 fit 方法中传入,则不应再次传入。如果在 fit 中未传入,则必须传入,非可选

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

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

update_paramsbool 类型,可选 (default=True)

是否应更新模型参数。如果为 False,则仅更新截止点,模型参数(例如系数)不被更新。

返回:
y_predtime series in sktime compatible data container format

fh 处的点预测,索引与 fh 相同。y_pred 的类型与最近传入的 y 相同:SeriesPanelHierarchical scitype,格式相同(见上文)。