NaiveForecaster#

class NaiveForecaster(strategy='last', window_length=None, sp=1)[source]#

基于朴素假设延续过去趋势进行预测。

NaiveForecaster 是一个使用简单策略进行预测的预测器。三种策略中有两种对 NaN 值具有鲁棒性。NaiveForecaster 也可用于多变量数据,并在内部应用 ColumnEnsembleForecaster,因此每列都使用相同的策略进行预测。

内部,这个预测器执行以下操作:- 获取所谓的“最后窗口”,一个表示预测器允许使用的

最近时间窗口的 1D 数组;

  • 根据给定的季节周期性将最后窗口重塑为 2D 数组(为了适配,前面填充 NaN 值);

  • 使用给定的策略为每列进行预测:- “last”:最后一个非 NaN 行 - “mean”:np.nanmean 对行求平均值

  • 使用季节周期性平铺预测结果。

为了计算预测分位数,我们首先在残差不相关的假设下估计预测残差的标准误差。然后通过将残差方差乘以一个常数来计算预测方差。这个常数是一个小样本偏差调整,并且每种方法(mean, last, drift)都有不同的公式来计算该常数。这些公式可以在《预测:原理与实践》教科书(表 5.2)中找到 [1]。最后,在残差服从正态分布的假设下,我们使用预测方差和正态分布的 z 值来估计预测分位数。

参数:
strategy{“last”, “mean”, “drift”}, 默认=”last”

用于进行预测的策略

  • “last”:(对 NaN 值具有鲁棒性)

    当 sp 为 1 时,预测训练序列的最后一个值。当 sp 不为 1 时,最后窗口中每个季节的最后一个值将作为该季节的预测值。

  • “mean”:(对 NaN 值具有鲁棒性)

    当 sp 为 1 时,预测训练序列最后窗口的平均值。当 sp 不为 1 时,最后窗口中某个季节所有值的平均值将作为该季节的预测值。

  • “drift”:(对 NaN 值不鲁棒)

    通过拟合窗口第一个点和最后一个点之间的线并将其外推到未来进行预测。

spint,或 None, 默认=1

季节性预测中使用的季节周期性。None=1。

window_lengthint 或 None, 默认=None
mean 策略中使用的窗口长度。如果为 None,则使用整个训练

序列。

属性:
cutoff

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

fh

已传递的预测范围。

is_fitted

是否已调用 fit

参考文献

[1]

Hyndman, R.J., & Athanasopoulos, G. (2021) Forecasting: principles and practice, 3rd edition, OTexts: Melbourne, Australia. OTexts.com/fpp3. 访问日期:2022年9月22日。

示例

>>> from sktime.datasets import load_airline
>>> from sktime.forecasting.naive import NaiveForecaster
>>> y = load_airline()
>>> forecaster = NaiveForecaster(strategy="drift")
>>> forecaster.fit(y)
NaiveForecaster(...)
>>> y_pred = forecaster.predict(fh=[1,2,3])

方法

check_is_fitted([method_name])

检查估计器是否已拟合。

clone()

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

clone_tags(estimator[, tag_names])

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

create_test_instance([parameter_set])

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

create_test_instances_and_names([parameter_set])

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

fit(y[, X, fh])

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

fit_predict(y[, X, fh, X_pred])

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

get_class_tag(tag_name[, tag_value_default])

从类获取类标签值,带有来自父类的标签级别继承。

get_class_tags()

从类获取类标签,带有来自父类的标签级别继承。

get_config()

获取自身的配置标志。

get_fitted_params([deep])

获取已拟合参数。

get_param_defaults()

获取对象的参数默认值。

get_param_names([sort])

获取对象的参数名称。

get_params([deep])

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

get_tag(tag_name[, tag_value_default, ...])

从实例获取标签值,带有标签级别继承和覆盖。

get_tags()

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

get_test_params([parameter_set])

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

is_composite()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict([fh, X])

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

predict_interval([fh, X, coverage])

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

predict_proba([fh, X, marginal])

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

predict_quantiles([fh, X, alpha])

计算/返回分位数预测。

predict_residuals([y, X])

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

predict_var([fh, X, cov])

计算/返回方差预测。

reset()

将对象重置为初始状态后的干净状态。

save([path, serialization_format])

将序列化的自身保存到字节状对象或到 (.zip) 文件。

score(y[, X, fh])

使用 MAPE(非对称)对照真实值对预测进行评分。

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

set_random_state([random_state, deep, ...])

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

set_tags(**tag_dict)

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

update(y[, X, update_params])

更新截至点值,并可选地更新已拟合参数。

update_predict(y[, cv, X, update_params, ...])

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

update_predict_single([y, fh, X, update_params])

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

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

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

参数:
parameter_setstr, 默认=”default”

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

返回:
paramsdict 或 dict 列表, 默认 = {}

用于创建类测试实例的参数。每个 dict 是用于构建一个“有趣”的测试实例的参数,即 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, 可选

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

抛出:
未拟合错误

如果估计器尚未拟合。

clone()[source]#

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

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

等同于构造一个 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_tagsget_tag 进行检查。

参数:
estimator:class:BaseObject 或派生类的实例
tag_namesstr 或 str 列表, 默认 = None

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

返回:
self

self 的引用。

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

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

参数:
parameter_setstr, 默认=”default”

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

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

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

参数:
parameter_setstr, 默认=”default”

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

返回:
objscls 实例列表

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

namesstr 列表,长度与 objs 相同

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

property cutoff[source]#

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

返回:
cutoffpandas 兼容索引元素,或 None

如果已设置截至点,则为 pandas 兼容索引元素;否则为 None

property fh[source]#

已传递的预测范围。

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

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

状态变更

将状态更改为“fitted”。

写入 self

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

  • self.is_fitted 标志设置为 True

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

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

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

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

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

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

  • Panel scitype = 时间序列集合,全局/面板预测。具有 2 级行 MultiIndex (instance, time)pd.DataFrame3D np.ndarray (instance, variable, time),Series 类型 pd.DataFramelist

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

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

fhint、列表、可强制转换为 pd.Index 的类型,或 ForecastingHorizon, 默认=None

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

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

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

返回:
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.DataFramepd.Seriesnp.ndarray(1D 或 2D)

  • Panel scitype = 时间序列集合,全局/面板预测。具有 2 级行 MultiIndex (instance, time)pd.DataFrame3D np.ndarray (instance, variable, time),Series 类型 pd.DataFramelist

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

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

fhint、列表、可强制转换为 pd.Index 的类型,或 ForecastingHorizon (非可选)

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

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

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

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

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

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

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

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_default任意类型

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

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

获取已拟合参数。

所需状态

要求状态为“fitted”。

参数:
deepbool, 默认=True

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

  • 如果为 True,将返回此对象的参数名称: 值字典,包括可拟合组件(= BaseEstimator 类型参数)的拟合参数。

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

返回:
fitted_params键为 str 的 dict

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

  • 始终:此对象的所有拟合参数,如通过 get_param_names 获得的值是此对象该键的拟合参数值

  • 如果 deep=True,还包含组件参数的键/值对 参数以 [componentname]__[paramname] 形式索引 componentname 的所有参数都以 paramname 形式出现,带其对应值

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

classmethod get_param_defaults()[source]#

获取对象的参数默认值。

返回:
default_dict: dict[str, Any]

键是 cls__init__ 中定义了默认值的所有参数。值是默认值,与 __init__ 中定义的值相同。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数:
sortbool, 默认=True

是否按字母顺序(True)或按其在类 __init__ 中出现的顺序(False)返回参数名称。

返回:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deepbool, 默认=True

是否返回组件的参数。

  • 如果为 True,将返回此对象的参数名称: 值 dict,包括组件(= BaseObject 类型参数)的参数。

  • 如果为 False,将返回此对象的参数名称: 值 dict,但不包括组件的参数。

返回:
params键为 str 的 dict

参数字典,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_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]#

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

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

返回:
composite: bool

对象是否包含任何值为 BaseObject 子孙实例的参数。

property is_fitted[source]#

是否已调用 fit

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

返回:
bool

估计器是否已 fit

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回:
path 处输出的、cls.save(path) 的反序列化自身
classmethod load_from_serial(serial)[source]#

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

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

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

所需状态

要求状态为“fitted”,即 self.is_fitted=True

访问 self

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

  • self.cutoff, self.is_fitted

写入 self

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

参数:
fhint、列表、可强制转换为 pd.Index 的类型,或 ForecastingHorizon, 默认=None

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

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

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

用于预测的外部时间序列。应与 fit 中的 y 具有相同的科学类型(SeriesPanelHierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为真,则 X.index 必须包含 fh 的索引引用。

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

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

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

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

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

所需状态

要求状态为“fitted”,即 self.is_fitted=True

访问 self

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

  • self.cutoff, self.is_fitted

写入 self

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

参数:
fhint、列表、可强制转换为 pd.Index 的类型,或 ForecastingHorizon, 默认=None

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

如果 fh 非 None 且不是 ForecastingHorizon 类型,它将在内部被强制转换为 ForecastingHorizon(通过 _check_fh)。

  • 如果 fhint 或类数组的 int,它被解释为相对预测期,并被强制转换为相对 ForecastingHorizon(fh, is_relative=True)

  • 如果 fhpd.Index 类型,它被解释为绝对预测期,并被强制转换为绝对 ForecastingHorizon(fh, is_relative=False)

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

用于预测的外部时间序列。应与 fit 中的 y 具有相同的科学类型(SeriesPanelHierarchical)。如果 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 是 Panel 或 Hierarchical 类型,则附加(上层)级别等于看到的实例级别。

来自于在拟合中看到的 y,如果该 y 是 Panel 或 Hierarchical 类型。

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

对于列索引中的变量,在第二列索引中的名义覆盖率下,取决于第三列索引是 lower/upper,对应于行索引。上下区间端点的预测值等同于在 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

所需状态

要求状态为“fitted”,即 self.is_fitted=True

访问 self

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

  • self.cutoff, self.is_fitted

写入 self

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

参数:
fhint、列表、可强制转换为 pd.Index 的类型,或 ForecastingHorizon, 默认=None

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

如果 fh 非 None 且不是 ForecastingHorizon 类型,它将在内部被强制转换为 ForecastingHorizon(通过 _check_fh)。

  • 如果 fhint 或类数组的 int,它被解释为相对预测期,并被强制转换为相对 ForecastingHorizon(fh, is_relative=True)

  • 如果 fhpd.Index 类型,它被解释为绝对预测期,并被强制转换为绝对 ForecastingHorizon(fh, is_relative=False)

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

用于预测的外部时间序列。应与 fit 中的 y 具有相同的科学类型(SeriesPanelHierarchical)。如果 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 是可迭代的,将计算多个分位数。

所需状态

要求状态为“fitted”,即 self.is_fitted=True

访问 self

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

  • self.cutoff, self.is_fitted

写入 self

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

参数:
fhint、列表、可强制转换为 pd.Index 的类型,或 ForecastingHorizon, 默认=None

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

如果 fh 非 None 且不是 ForecastingHorizon 类型,它将在内部被强制转换为 ForecastingHorizon(通过 _check_fh)。

  • 如果 fhint 或类数组的 int,它被解释为相对预测期,并被强制转换为相对 ForecastingHorizon(fh, is_relative=True)

  • 如果 fhpd.Index 类型,它被解释为绝对预测期,并被强制转换为绝对 ForecastingHorizon(fh, is_relative=False)

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

用于预测的外部时间序列。应与 fit 中的 y 具有相同的科学类型(SeriesPanelHierarchical)。如果 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 是 Panel 或 Hierarchical 类型,则附加(上层)级别等于看到的实例级别。

来自于在拟合中看到的 y,如果该 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])) 时计算

所需状态

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

访问 self

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

写入 self

无。

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

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

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

  • 如果前面只有一个 fit 调用,则会生成样本内残差

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

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

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

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

fh 处的预测残差,索引与 fh 相同。 y_res 的类型与最近传入的 y 相同:Series, Panel, Hierarchical 科学类型,格式相同(参见上文)

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

计算/返回方差预测。

所需状态

要求状态为“fitted”,即 self.is_fitted=True

访问 self

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

  • self.cutoff, self.is_fitted

写入 self

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

参数:
fhint、列表、可强制转换为 pd.Index 的类型,或 ForecastingHorizon, 默认=None

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

如果 fh 非 None 且不是 ForecastingHorizon 类型,它将在内部被强制转换为 ForecastingHorizon(通过 _check_fh)。

  • 如果 fhint 或类数组的 int,它被解释为相对预测期,并被强制转换为相对 ForecastingHorizon(fh, is_relative=True)

  • 如果 fhpd.Index 类型,它被解释为绝对预测期,并被强制转换为绝对 ForecastingHorizon(fh, is_relative=False)

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

用于预测的外部时间序列。应与 fit 中的 y 具有相同的科学类型(SeriesPanelHierarchical)。如果 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 是 Panel 或 Hierarchical 类型,则附加级别等于实例级别。

来自于在拟合中看到的 y,如果该 y 是 Panel 或 Hierarchical 类型。

条目是方差预测值,对应于列索引中的变量。对于给定的变量和 fh 索引的方差预测值,是在观测数据下对该变量和索引的预测方差。

基于观测数据,针对该变量和索引的方差。

如果 cov=True
列索引是多级索引:第一级是变量名(如上)

第二级是 fh。

行索引是 fh,如果 fit 中看到的 y 是 Panel 或 Hierarchical 类型,则附加级别等于实例级别。

来自于在拟合中看到的 y,如果该 y 是 Panel 或 Hierarchical 类型。

条目是(协)方差预测值,对应于列索引中的变量,以及

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

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

reset()[source]#

将对象重置为初始状态后的干净状态。

结果是将 self 设置回构造函数调用后立即拥有的状态,并保留相同的超参数。通过 set_config 设置的配置值也保留。

调用 reset 会删除所有对象属性,除了

  • 超参数 = 写入 self__init__ 参数,例如,self.paramname,其中 paramname__init__ 的参数

  • 包含双下划线(即字符串“__”)的对象属性。例如,名为“__myattr”的属性会被保留。

  • 配置属性,配置会保留不变。也就是说,get_configreset 前后的结果相等。

类和对象方法,以及类属性也不受影响。

等同于 clone,区别在于 reset 修改 self 而非返回一个新对象。

调用 self.reset() 后,self 在值和状态上与调用构造函数 type(self)(**self.get_params(deep=False)) 后获得的对象相等。

返回:
self

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

save(path=None, serialization_format='pickle')[source]#

将序列化的自身保存到字节状对象或到 (.zip) 文件。

行为:如果 path 为 None,返回内存中的序列化 self;如果 path 是文件位置,则将 self 存储为 zip 文件在该位置

保存的文件是包含以下内容的 zip 文件:_metadata - 包含 self 的类,即 type(self);_obj - 序列化的 self。此类使用默认序列化(pickle)。

参数:
pathNone 或文件位置(str 或 Path)

如果为 None,则将 self 保存到内存对象;如果为文件位置,则将 self 保存到该文件位置。如果

  • path="estimator",则将在当前工作目录创建 zip 文件 estimator.zip

  • 如果 path="/home/stored/estimator",则 zip 文件 estimator.zip 将被

存储在 /home/stored/ 中。

serialization_format: str, default = “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、列表、可强制转换为 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 损失。

set_config(**config_dict)[source]#

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

参数:
config_dictdict

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

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

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_only布尔值,默认为 True

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

warningsstr,“on”(默认)或“off”

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

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

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

backend:parallelstr,可选,默认为“None”

广播/向量化时用于并行化的后端,以下之一

  • “None”:顺序执行循环,简单的列表推导

  • “loky”、“multiprocessing”和“threading”:使用 joblib.Parallel

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

  • “dask”:使用 dask,需要在环境中安装 dask

  • “ray”:使用 ray,需要在环境中安装 ray

backend:parallel:paramsdict,可选,默认为 {}(未传递参数)

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

  • “None”:无附加参数,忽略 backend_params

  • “loky”、“multiprocessing”和“threading”:默认 joblib 后端,可在此处传递 joblib.Parallel 的任何有效键,例如 n_jobs,但 backend 除外,该参数由 backend 直接控制。如果未传递 n_jobs,则默认为 -1,其他参数将默认为 joblib 的默认值。

  • “joblib”:自定义和第三方 joblib 后端,例如 spark。可在此处传递 joblib.Parallel 的任何有效键,例如 n_jobs,在此情况下必须将 backend 作为 backend_params 的键传递。如果未传递 n_jobs,则默认为 -1,其他参数将默认为 joblib 的默认值。

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

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

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

    • “shutdown_ray”:布尔值,默认为 True;False 可阻止 ray 在并行化后关闭。

      在并行化后关闭。

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

    • “mute_warnings”:布尔值,默认为 False;如果为 True,则抑制警告

remember_data布尔型,默认为 True

remember_data布尔值,默认为 True

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

Notes

更改对象状态,将 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, 默认=True

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

  • 如果为 False,将仅设置 selfrandom_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_params=True:拟合所有迄今为止观测到的数据

  • update_params=False:仅更新截止点并记忆数据

所需状态

要求状态为“fitted”,即 self.is_fitted=True

访问 self

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

  • self.cutoff, self.is_fitted

写入 self

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

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

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

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

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

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

  • Panel scitype = 时间序列集合,全局/面板预测。具有 2 级行 MultiIndex (instance, time)pd.DataFrame3D np.ndarray (instance, variable, time),Series 类型 pd.DataFramelist

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

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

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

用于更新模型拟合的外部时间序列。应与 y 具有相同的科学类型SeriesPanelHierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为真,则 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:仅更新截止点并记忆数据

所需状态

要求状态为“fitted”,即 self.is_fitted=True

访问 self

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

  • self.cutoff, self.is_fitted

写入 self(除非 reset_forecaster=True
  • self.cutoff 更新为在 y 中看到的最新索引。

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

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

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

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

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

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

  • Panel scitype = 时间序列集合,全局/面板预测。具有 2 级行 MultiIndex (instance, time)pd.DataFrame3D np.ndarray (instance, variable, time),Series 类型 pd.DataFramelist

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

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

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

例如,SlidingWindowSplitterExpandingWindowSplitter;默认为 ExpandingWindowSplitter,其中 initial_window=1,默认值为 y/X 中的每个数据点都被逐个添加和预测,initial_window = 1step_length = 1fh = 1

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

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

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

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

reset_forecaster布尔值,可选(默认为 True)
  • 如果为 True,则不会改变预测器的状态,即 update/predict 序列使用副本运行,self 的截止点、模型参数、数据记忆不会改变

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

返回:
y_pred用于列表化来自多个分割批次的点预测值的对象

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

  • 如果绝对预测期点的集合是唯一的:类型是 sktime 兼容数据容器格式的时间序列,输出中会抑制截止点,类型与最近传入的 y 相同:Series, Panel, Hierarchical 科学类型,格式相同(见上文)

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

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

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

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

如果未实现估计器特定的更新方法,默认的回退行为是先更新,然后预测。

所需状态

要求状态为“fitted”。

访问 self

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

写入 self

通过附加行更新 self._y 和 self._X 以及 yX。将 self.cutoff 和 self._cutoff 更新为在 y 中看到的最后索引。如果 update_params=True,

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

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

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

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

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

  • Panel scitype = 时间序列集合,全局/面板预测。具有 2 级行 MultiIndex (instance, time)pd.DataFrame3D np.ndarray (instance, variable, time),Series 类型 pd.DataFramelist

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

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

fhint、列表、可强制转换为 pd.Index 的类型,或 ForecastingHorizon, 默认=None

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

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

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

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

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

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

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