ForecastKnownValues#

class ForecastKnownValues(y_known, method=None, fill_value=None, limit=None)[源代码]#

将已知或预设值作为预测值返回的预测器。

接受一组“已知未来值”数据，并在 sktime 接口中生成这些值。

此预测器的常见用例

  • 作为具有已知基线预期的虚拟或朴素预测器

  • 作为具有（非朴素）专家预测值的预测器，即专家提供的“已知”值

  • 在基准测试实验中作为反事实情境，“如果我们知道真相会怎样”

  • 在用于后处理的组合中传递预测数据值，例如与 ReconcilerForecaster 结合使用，用于独立的协调步骤

预测时，底层使用 pandas.DataFrame.reindex 从 y_known 中获取预测值。除了 y_known 之外的参数将直接传递给 pandas.DataFrame.reindex。

参数:
y_knownsktime 兼容数据格式之一的 pd.DataFrame 或 pd.Series

应包含预测器在预测时将重现的已知值，也可以是非 pandas sktime 数据格式，然后将被强制转换为 pandas

methodstr 或 None，可选，默认为 None

以下之一：{None, ‘backfill’/’bfill’, ‘pad’/’ffill’, ‘nearest’} 用于填补 y_known 中预测值不可用的索引的方法

fill_value标量，可选，默认为 np.NaN

用于任何缺失值的值（例如，如果 method 为 None）

limitint，可选，默认为 None = 无穷

如果 method=bfill/ffill，要 bfill/ffill 的连续元素的最大数量

属性:
cutoff

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

fh

已传递的预测范围。

is_fitted

fit 是否已被调用。

示例

>>> import pandas as pd
>>> y_known = pd.DataFrame(range(100))
>>> y_train = y_known[:24]
>>>
>>> from sktime.forecasting.dummy import ForecastKnownValues
>>>
>>> fcst = ForecastKnownValues(y_known)
>>> fcst.fit(y_train, fh=[1, 2, 3])
ForecastKnownValues(...)

预测“重现”来自 y_known 的已知/预设值

>>> y_pred = fcst.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()

检查对象是否由其他 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')[源代码]#

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

参数:
parameter_setstr，默认为“default”

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

返回:
paramsdict 或 list of dict，默认为 {}

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

check_is_fitted(method_name=None)[源代码]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:
method_namestr，可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[源代码]#

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

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

等同于构造一个 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 查看。

参数:
estimatorBaseObject 或派生类的实例
tag_namesstr 或 list of str，默认为 None

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

返回:
self

对 self 的引用。

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

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

参数:
parameter_setstr，默认为“default”

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

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

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

参数:
parameter_setstr，默认为“default”

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

返回:
objscls 实例的列表

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

namesstr 列表，与 objs 长度相同

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

property cutoff[源代码]#

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

返回:
cutoffpandas 兼容索引元素，或 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 = 时间序列集合，全局/面板预测。具有 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

fhint, 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") 为 True，则 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 = 时间序列集合，全局/面板预测。具有 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

fhint, 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") 为 True，则 X.index 必须包含 y.index。

X_pred采用 sktime 兼容格式的时间序列，可选（默认为 None）

用于预测的外生时间序列。如果传递，则在预测中使用而不是 X。应与 fit 中的 y 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 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_namestr

标签值的名称。

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布尔值，默认为 True

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

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

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

返回:
fitted_params键为 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布尔值，默认为 True

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

返回:
param_names: list[str]

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

get_params(deep=True)[源代码]#

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

参数:
deep布尔值，默认为 True

是否返回组件的参数。

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

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

返回:
params键为 str 类型的字典

参数字典， 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)[源代码]#

从实例获取标签值，并考虑标签级别的继承和覆盖。

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

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

get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，考虑标签覆盖，优先级从高到低如下：

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

在实例构造时。

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

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

按继承顺序。

参数:
tag_namestr

要检索的标签名称

tag_value_default任意类型，可选；默认为 None

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

raise_error布尔值

如果未找到标签是否引发 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 对象属性获取任何覆盖和新标签。

is_composite()[源代码]#

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

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

返回:
composite: bool

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

property is_fitted[源代码]#

fit 是否已被调用。

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

返回:
布尔值

估计器是否已拟合。

classmethod load_from_path(serial)[源代码]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回:
反序列化的 self，其结果位于 path，来自 cls.save(path) 的输出
classmethod load_from_serial(serial)[源代码]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化的 self，其结果为 serial，来自 cls.save(None) 的输出
predict(fh=None, X=None)[源代码]#

预测未来时间序列。

所需状态

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

访问自身中的

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

  • self.cutoff, self.is_fitted

写入自身

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

参数:
fhint, list, pd.Index 可强制转换类型, 或 ForecastingHorizon, 默认为 None

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

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

X采用 sktime 兼容格式的时间序列，可选（默认为 None）

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

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

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

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

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

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

所需状态

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

访问自身中的

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

  • self.cutoff, self.is_fitted

写入自身

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

参数:
fhint, 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)。

X采用 sktime 兼容格式的时间序列，可选（默认为 None）

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

coverage浮点数或由唯一浮点数组成的列表，可选 (默认=0.90)

预测区间的标称覆盖率

返回:
pred_intpd.DataFrame
列包含多级索引：第一级是 fit 中 y 的变量名，
第二级是计算区间所对应的覆盖率分数。

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

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

行索引是 fh，如果 fit 中看到的 y 是 Panel 或 Hierarchical，则还有等于实例级别的额外（上级）级别。

行索引是 fh，如果 fit 中看到的 y 是 Panel 或 Hierarchical，则还有等于实例级别的额外（上级）级别。

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

对应于列索引中的变量，第二级列索引中标称覆盖率下的值，取决于第三级列索引是 lower 还是 upper，对应于行索引。上限/下限区间预测值相当于覆盖率为 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.cutoff, self.is_fitted

写入自身

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

参数:
fhint, 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)。

X采用 sktime 兼容格式的时间序列，可选（默认为 None）

用于预测的外生时间序列。应与 fit 中的 y 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 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 中。

参数:
fhint, 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)。

X采用 sktime 兼容格式的时间序列，可选（默认为 None）

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

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

用于计算分位点预测值的概率或概率列表。

返回:
quantilespd.DataFrame
列包含多级索引：第一级是 fit 中 y 的变量名，

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

行索引是 fh，如果 fit 中看到的 y 是 Panel 或 Hierarchical，则还有等于实例级别的额外（上级）级别。

行索引是 fh，如果 fit 中看到的 y 是 Panel 或 Hierarchical，则还有等于实例级别的额外（上级）级别。

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

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

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

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

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

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

所需状态

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

访问自身中的

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

写入自身

无。

参数:
y采用 sktime 兼容数据容器格式的时间序列

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

计算/返回方差预测值。

所需状态

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

访问自身中的

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

  • self.cutoff, self.is_fitted

写入自身

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

参数:
fhint, 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)。

X采用 sktime 兼容格式的时间序列，可选（默认为 None）

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

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

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

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

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

行索引是 fh，包含额外的实例级别级别，

行索引是 fh，如果 fit 中看到的 y 是 Panel 或 Hierarchical，则还有等于实例级别的额外（上级）级别。

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

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

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

第二级是 fh。

行索引是 fh，包含额外的实例级别级别，

行索引是 fh，如果 fit 中看到的 y 是 Panel 或 Hierarchical，则还有等于实例级别的额外（上级）级别。

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

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

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

reset()[source]#

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

结果是将 self 设置为构造函数调用后直接拥有的状态，使用相同的超参数。set_config 设置的配置值也会保留。

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

  • 超参数 = __init__ 的参数，写入到 self 中，例如 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”，则会在当前工作目录创建一个 zip 文件 estimator.zip。

  • path=”/home/stored/estimator”，则会在

/home/stored/ 中存储一个 zip 文件 estimator.zip。

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 可强制转换类型, 或 ForecastingHorizon, 默认为 None

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

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

要评分的外生时间序列。如果 self.get_tag(“X-y-must-have-same-index”) 为 True，X.index 必须包含 y.index。

返回:
score浮点数

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

另请参见

sktime.performance_metrics.forecasting.mean_absolute_percentage_error
set_config(**config_dict)[source]#

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

参数:
config_dictdict

config 名称：config 值对的字典。有效的 config、值及其含义列举如下：

displaystr, "diagram" (默认), 或 "text"

Jupyter 内核如何显示实例自身

  • "diagram" = html 框图表示

  • "text" = 字符串打印输出

print_changed_only布尔值, 默认=True

打印 self 时是否仅列出与默认值不同的 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

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

Notes

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

set_params(**params)[source]#

设置此对象的参数。

此方法适用于简单的 skbase 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象（即包含其他对象的对象），以访问组件 <component> 中的 <parameter>。字符串 <parameter>（不带 <component>__）也可以使用，前提是引用明确，例如，没有两个组件参数具有相同的名称 <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 可在多次函数调用中获得可重现的输出。

deep布尔值，默认为 True

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

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

  • 如果为 True，也将设置组件对象中的 random_state 参数。

self_policystr, {“copy”, “keep”, “new”} 之一, 默认=”copy”

  • “copy” : self.random_state 设置为输入的 random_state

  • “keep” : self.random_state 保持原样

  • “new” : self.random_state 设置为新的随机状态，

由输入的 random_state 派生，通常与它不同

返回:
self对 self 的引用
set_tags(**tag_dict)[source]#

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

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

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

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

set_tags 方法应仅在对象的 __init__ 方法中、构造期间或通过 __init__ 构造后直接调用。

当前标签值可以通过 get_tags 或 get_tag 查看。

参数:
**tag_dictdict

标签名：标签值对的字典。

返回:
Self

对 self 的引用。

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

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

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

  • update_params=True: 拟合到目前为止所有观测到的数据

  • update_params=False: 仅更新截止日期并记住数据

所需状态

需要状态为“已拟合”，即 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 = 时间序列集合，全局/面板预测。具有 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

X采用 sktime 兼容格式的时间序列，可选（默认为 None）。

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

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

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

返回:
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.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 = 时间序列集合，全局/面板预测。具有 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

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

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

所需状态

需要状态为“已拟合”。

访问自身中的

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

写入自身

通过追加行来更新 self._y 和 self._X，使用 y 和 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 = 时间序列集合，全局/面板预测。具有 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

fhint, list, pd.Index 可强制转换类型, 或 ForecastingHorizon, 默认为 None

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

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

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

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

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

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

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