DirectTimeSeriesRegressionForecaster#

class DirectTimeSeriesRegressionForecaster(estimator, window_length=10, transformers=None, pooling='local', windows_identical=True)[来源]#

将预测直接还原为时间序列回归。

对于直接还原策略，为预测范围的每个步长分别拟合一个预测器。

参数:
estimator估计器

sktime 提供的时间序列回归估计器。

window_lengthint, 可选 (默认=10)

用于将时间序列转换为表格矩阵的滑动窗口长度。

属性:
cutoff

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

fh

传入的预测范围。

is_fitted

是否已调用过 fit 方法。

方法

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

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

检查估计器是否已拟合。

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

否则，引发 NotFittedError。

参数:
method_namestr, 可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[来源]#

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

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

等同于使用 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)[来源]#

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

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

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

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

clone_tags 方法只能在对象构建期间的 __init__ 方法中或通过 __init__ 直接在构建后调用。

动态标签被设置为 estimator 中标签的值，名称由 tag_names 指定。

tag_names 的默认值 (None) 克隆 estimator 中的所有标签，并将其写入到 self。

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

参数:
estimator:class:BaseObject 或派生类的实例
tag_namesstr 或 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 个元素是测试中 obj 的第 i 个实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

property cutoff[来源]#

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

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

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

property fh[来源]#

传入的预测范围。

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

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

状态变更

状态变更为“已拟合”。

写入 self

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

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

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

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

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

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

sktime 中的独立数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

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

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

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

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

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

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

Xsktime 兼容格式的时间序列，可选 (默认=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) 相同。

状态变更

状态变更为“已拟合”。

写入 self

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

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

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

  • 将 fh 存储到 self.fh。

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

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

sktime 中的独立数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

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

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

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

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

fhint, 列表, pd.Index 可强制转换类型, 或 ForecastingHorizon (不可选)

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

如果 fh 不是 None 且类型不是 ForecastingHorizon，则通过调用 _check_fh 将其强制转换为 ForecastingHorizon。

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

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

特别是，如果 fh 的类型是 pd.Index，则通过 ForecastingHorizon(fh, is_relative=False) 将其强制转换。

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

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

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

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

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

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

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

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

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

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

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

按继承顺序排列。

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

参数:
要检索可能带有实例覆盖的标签值，请改用 get_tag 方法。

tag_namestr

标签值的名称。

tag_value_default任意类型

返回:
如果找不到标签，则为默认/备用值。

tag_value

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

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

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

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

classmethod get_class_tags()[来源]#

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

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

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

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

在父类的 _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)[来源]#

获取拟合参数。

所需状态

要求状态为“已拟合”。

参数:
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()[来源]#

获取对象的参数默认值。

返回:
default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)[来源]#

获取对象的参数名称。

参数:
sortbool, 默认=True

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

返回:
param_names: list[str]

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

get_params(deep=True)[来源]#

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

参数:
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)[来源]#

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

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

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

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

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

在实例构建时设置。

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

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

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

参数:
要检索可能带有实例覆盖的标签值，请改用 get_tag 方法。

要检索的标签名称

tag_value_default任意类型, 可选; 默认=None

如果找不到标签，则为默认/备用值

raise_errorbool

当找不到标签时是否引发 ValueError

返回:
tag_valueAny

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

引发:
ValueError, 如果 raise_error 为 True。

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

get_tags()[来源]#

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

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

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

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

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

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

在实例构建时设置。

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

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

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

返回:
collected_tagsdict

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

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

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

参数:
parameter_setstr, 默认=”default”

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

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

创建类测试实例的参数

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

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

is_composite()[来源]#

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

composite: bool

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

是否已调用过 fit 方法。

property is_fitted[来源]#

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

bool

估计器是否已 fit (拟合)。

从文件位置加载对象。

参数:
classmethod load_from_path(serial)[来源]#
返回:
serialZipFile(path).open(“object) 的结果
反序列化 self，结果输出到 path，即 cls.save(path) 的输出

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

参数:
classmethod load_from_serial(serial)[来源]#
返回:
serialcls.save(None) 输出的第 1 个元素
反序列化 self，结果输出 serial，即 cls.save(None) 的输出

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

所需状态

predict(fh=None, X=None)[来源]#

所需状态

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

  • 访问 self 中的内容

写入 self

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

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

self.cutoff, self.is_fitted

如果 fh 不是 None 且类型不是 ForecastingHorizon，则通过调用 _check_fh 将其强制转换为 ForecastingHorizon。

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

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

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

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

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

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

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

所需状态

predict(fh=None, X=None)[来源]#

所需状态

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

  • 访问 self 中的内容

写入 self

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

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

self.cutoff, self.is_fitted

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

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

  • 如果 fh 不是 None 且类型不是 ForecastingHorizon，则在内部将其强制转换为 ForecastingHorizon（通过 _check_fh）。

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

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

如果 fh 是 int 或 int 的类似数组，则被解释为相对范围，并强制转换为相对 ForecastingHorizon(fh, is_relative=True)。

如果 fh 的类型是 pd.Index，则被解释为绝对范围，并强制转换为绝对 ForecastingHorizon(fh, is_relative=False)。

返回:
coveragefloat 或包含唯一值的 float 列表，可选 (默认=0.90)
预测区间的名义覆盖率
pred_intpd.DataFrame

列具有多级索引：第一级是来自 fit 中 y 的变量名称，

第二级是计算区间的覆盖率分数。

顺序与输入 coverage 相同。

第三级是字符串“lower”（下界）或“upper”（上界），表示区间端点。

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

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

条目是下界/上界区间端点的预测，

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

对于列索引中的 var，在第二列索引中的名义覆盖率下，根据第三列索引（lower/upper），针对行索引进行预测。

  • 上界/下界区间端点预测等同于在 alpha = 0.5 - c/2, 0.5 + c/2（其中 c 在 coverage 中）时的分位数预测。

  • 注意

所需状态

predict(fh=None, X=None)[来源]#

所需状态

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

  • 访问 self 中的内容

写入 self

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

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

self.cutoff, self.is_fitted

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

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

  • 如果 fh 不是 None 且类型不是 ForecastingHorizon，则在内部将其强制转换为 ForecastingHorizon（通过 _check_fh）。

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

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

当前仅对 Series（非面板、非层级）y 实现。

需要安装 skpro 以返回分布对象。

返回:
marginalbool, 可选 (默认=True)

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

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

计算/返回分位数预测。

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

所需状态

predict(fh=None, X=None)[来源]#

所需状态

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

  • 访问 self 中的内容

写入 self

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

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

self.cutoff, self.is_fitted

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

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

  • 如果 fh 不是 None 且类型不是 ForecastingHorizon，则在内部将其强制转换为 ForecastingHorizon（通过 _check_fh）。

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

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

alphafloat 或 list of float of unique values, optional (default=[0.05, 0.95])

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

返回:
quantilespd.DataFrame
预测区间的名义覆盖率

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

顺序与输入 coverage 相同。

第三级是字符串“lower”（下界）或“upper”（上界），表示区间端点。

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

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

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 或 integer）对应。

所需状态

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

写入 self

无。

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

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

如果为 None，则使用到目前为止观察到的 y (self._y)，特别是

  • 如果在 fit 调用后紧接着调用，则生成内样本残差

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

Xsktime 兼容格式的时间序列，可选 (default=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]#

计算/返回方差预测。

所需状态

predict(fh=None, X=None)[来源]#

所需状态

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

  • 访问 self 中的内容

写入 self

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

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

self.cutoff, self.is_fitted

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

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

  • 如果 fh 不是 None 且类型不是 ForecastingHorizon，则在内部将其强制转换为 ForecastingHorizon（通过 _check_fh）。

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

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

covbool, optional (default=False)

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

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

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

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

第三级是字符串“lower”（下界）或“upper”（上界），表示区间端点。

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

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

如果 cov=True
列索引是 multiindex：第一层是变量名（如上）

第二层是 fh。

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

第三级是字符串“lower”（下界）或“upper”（上界），表示区间端点。

条目是（协）方差预测，用于列索引中的变量，以及

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

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

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 or Path)

如果为 None，self 保存到内存对象；如果为文件位置，self 保存到该文件位置。如果

  • path=”estimator” 则在当前工作目录 (cwd) 下生成一个 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, list, pd.Index 可强制转换类型, 或 ForecastingHorizon, 默认=None

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

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

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

返回:
scorefloat

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

另请参阅

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

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

参数:
config_dictdict

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

displaystr, “diagram” (default), 或 “text”

jupyter kernel 显示 self 实例的方式

  • “diagram” = html 框图表示

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

print_changed_onlybool, default=True

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

warningsstr, “on” (default), 或 “off”

是否引发警告，只影响来自 sktime 的警告

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

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

backend:parallelstr, optional, default=”None”

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

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

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

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

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

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

backend:parallel:paramsdict, optional, default={} (不传递参数)

作为配置传递给并行化后端的附加参数。有效键取决于 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”: bool, default=True; False 防止 ray 在并行化后

      关闭。

    • “logger_name”: str, default=”ray”; 要使用的 logger 名称。

    • “mute_warnings”: bool, default=False; 如果为 True，则抑制警告

remember_databool, default=True

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

返回:
self对 self 的引用。

注意事项

更改对象状态，将 config_dict 中的配置复制到 self._config_dynamic。

set_params(**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, default=None

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

deepbool, 默认=True

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

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

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

self_policystr, 以下之一 {“copy”, “keep”, “new”}, default=”copy”

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

  • “keep” : self.random_state 保持不变

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

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

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

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

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

标签是特定于实例 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: 仅更新 cutoff 并记住数据

所需状态

predict(fh=None, X=None)[来源]#

所需状态

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

  • 访问 self 中的内容

写入 self

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

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

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

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

sktime 中的独立数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

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

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

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

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

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

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

update_paramsbool, optional (default=True)

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

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

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

这是执行多次 update / predict 链式操作的简写，数据回放在时间分割器 cv 的基础上进行。

与以下操作相同（如果只有 y, cv 为非默认值）

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

  2. 记住 self.predict() （稍后一次性返回）

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

  4. 记住 self.predict() （稍后一次性返回）

  5. 等

  6. 返回所有记住的预测结果

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

  • update_params=True: 拟合所有已观察到的数据

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

所需状态

predict(fh=None, X=None)[来源]#

所需状态

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

  • 访问 self 中的内容

写入 self （除非 reset_forecaster=True）

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

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

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

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

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

sktime 中的独立数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

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

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

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

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

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

例如，SlidingWindowSplitter 或 ExpandingWindowSplitter；默认值为 ExpandingWindowSplitter，initial_window=1，以及默认值 = y/X 中的各个数据点被逐个添加和预测，initial_window = 1，step_length = 1，fh = 1。

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

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

update_paramsbool, optional (default=True)

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

reset_forecasterbool, optional (default=True)

  • 如果为 True，则不会更改预测器的状态，即使用副本运行 update/predict 序列，并且 self 的 cutoff、模型参数、数据内存不会改变。

  • 如果为 False，则在运行 update/predict 序列时更新 self，如同直接调用 update/predict。

返回:
y_pred汇总来自多个分割批次的点预测结果的对象

格式取决于总体预测的 (cutoff, absolute horizon) 对

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

  • 如果 absolute horizon 点的集合不唯一：类型是 pandas DataFrame，行索引和列索引是时间戳，行索引对应于进行预测的 cutoffs，列索引对应于进行预测的 absolute horizons，条目是在该 (cutoff, horizon) 对下的点预测值，如果未在该对下进行预测，则条目为 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 和 X 更新 self._y 和 self._X。将 self.cutoff 和 self._cutoff 更新为在 y 中看到的最后一个索引。如果 update_params=True，

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

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

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

sktime 中的独立数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

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

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

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

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

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

self.cutoff, self.is_fitted

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

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

update_paramsbool, optional (default=True)

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

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

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

本页内容