CurveFitForecaster#

class CurveFitForecaster(function, curve_fit_params=None, origin='unix_zero', normalise_index=False)[source]#

CurveFitForecaster 接受一个函数，并使用 scipy 的 curve_fit 方法进行拟合。

CurveFitForecaster 使用 scipy 的 curve_fit 方法来确定给定函数的最佳参数。

如果索引是整数索引，它直接使用索引值。如果索引是 pd.DatetimeIndex 或 pd.PeriodIndex，索引值将使用两种不同的方法转换为浮点数。

对于 pd.DatetimeIndex，它计算自 1970-01-01 以来的天数。对于 pd.PeriodIndex，它计算自

1970-01-01.
对于 pd.DatetimeIndex，它计算自第一个索引值以来的天数。对于 pd.PeriodIndex，它计算自第一个索引值以来的（完整）周期数。

此外，可以通过将第一个和第二个索引值之间的差异设置为一来归一化索引值之间的差异。

在 fit 中，1. 输入时间序列的索引被转换为浮点数列表。2. 使用该浮点数列表作为 x 值调用 scipy 的 curve_fit 方法，

时间序列值作为 y 值。

在 predict 中，1. 预测范围 ForecastingHorizon 被转换为浮点数列表。2. 将该浮点数列表和已拟合的参数传递给

函数以提供预测。

参数:

function: Callable[[Iterable[float], …], Iterable[float]]: 应该被拟合并用于进行预测的函数。函数的签名为 function(x, ...)。它接受自变量作为第一个参数，其余参数作为独立的待拟合参数。更多信息请参阅 scipy.optimize.curve_fit。
curve_fit_params: dict, default=None: 应该传递给 curve_fit 方法的附加参数。更多信息请参阅 scipy.optimize.curve_fit。
origin: {“unix_zero”, “first_index”}, default=”unix_zero”: 时间序列索引的起点。
normalise_index: bool, default=False: 如果为 True，则通过将第一个和第二个索引值之间的差异设置为一来，归一化索引值之间的差异。

属性:

cutoff: 截止点 = 预测器的“当前时间”状态。
fh: 已传递的预测范围。
is_fitted: fit 方法是否已被调用。

示例

>>> from sktime.forecasting.trend import CurveFitForecaster
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> def linear_function(x, a, b):
...     return a * x + b
>>> forecaster = CurveFitForecaster(function=linear_function,
...                                 curve_fit_params={"p0":[-1, 1]})
>>> forecaster.fit(y)
CurveFitForecaster(...)
>>> 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`()	获取 self 的配置标志。
`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])	将序列化的 self 保存到字节类对象或 (.zip) 文件。
`score`(y[, X, fh])	使用 MAPE（非对称）对地面真实值进行预测评分。
`set_config`(**config_dict)	将配置标志设置为给定值。
`set_params`(**params)	设置此对象的参数。
`set_random_state`([random_state, deep, ...])	设置 self 的 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 = {}: 用于创建类测试实例的参数。

check_is_fitted(method_name=None)[source]#

检查估算器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:

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

引发:

NotFittedError: 如果估算器尚未拟合。

clone()[source]#

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

克隆是一个不同的对象，没有共享引用，处于初始化后状态。此函数等同于返回 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)[source]#

将其他对象的标签克隆为动态覆盖。

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

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

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

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

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

tag_names 的默认值将 estimator 中的所有标签写入 self。

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

参数:

estimator:class:BaseObject 或派生类的实例
tag_namesstr 或 list of str, default = None: 要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回:

self: Reference to self.

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

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

参数:

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

返回:

instance类的实例，带有默认参数

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

创建所有测试实例的列表以及它们的名称列表。

参数:

parameter_setstr, default=”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]#

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

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

写入 self

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

将 self.is_fitted 标志设置为 True。

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

如果传递了 fh，则将 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, default=None

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

Xsktime 兼容格式的时间序列，可选（default=None）。

用于拟合模型的外部时间序列。应与 y 具有相同的 scitype（Series, Panel, 或 Hierarchical）。如果 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) 相同。

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

写入 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 (非可选)

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

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

Xsktime 兼容格式的时间序列，可选（default=None）。

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

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

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

返回:

y_predsktime 兼容数据容器格式的时间序列: 在 fh 处的点预测，与 fh 具有相同的索引。y_pred 的类型与最近传递的 y 类型相同：Series, Panel, Hierarchical scitype，格式相同（参见上文）

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

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

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

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

它返回名称为 tag_name 的标签值，考虑标签覆盖，优先级从高到低如下：

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

按照继承顺序。

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

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

参数:

tag_namestr: 标签值的名称。
tag_value_default任意类型: 如果找不到标签，则为默认/回退值。

返回:

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

classmethod get_class_tags()[source]#

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

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

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

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

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

值是对应的标签值，覆盖的优先级从高到低如下：

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

按照继承顺序。

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

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

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

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

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

get_config()[source]#

获取 self 的配置标志。

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

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

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

配置在 clone 或 reset 调用中被保留。

返回:

config_dictdict: 配置名称：配置值对的字典。通过嵌套继承从 _config 类属性收集，然后是来自 _onfig_dynamic 对象属性的任何覆盖和新标签。

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态: 要求状态为“已拟合”。

参数:

deepbool, default=True

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

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

返回:

fitted_params键为 str 的字典

已拟合参数字典，参数名：参数值键值对包括：

始终：此对象的所有已拟合参数，通过 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，但不包括组件的参数。

返回:

params键为 str 的字典

参数字典，参数名：参数值键值对包括：

始终：此对象的所有参数，通过 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 的单个标签的值，并考虑标签覆盖，优先级从高到低如下：

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

在实例构建时。

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

按照继承顺序。

参数:

tag_namestr: 要检索的标签名称。
tag_value_default任意类型，可选；default=None: 如果找不到标签，则为默认/回退值
raise_errorbool: 如果找不到标签是否引发 ValueError

返回:

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

引发:

ValueError, 如果 raise_error 为 True。: ValueError 会在 tag_name 不在 self.get_tags().keys() 中时引发。

get_tags()[source]#

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

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

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

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

值是对应的标签值，覆盖的优先级从高到低如下：

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

在实例构建时。

在类的 _tags 属性中设置的标签。
在父类的 _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]#

从文件位置加载对象。

参数:

serialZipFile(path).open(“object) 的结果

返回:

在 path 处输出的 cls.save(path) 生成的反序列化 self

classmethod load_from_serial(serial)[source]#

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

参数:

serialcls.save(None) 输出的第一个元素

返回:

cls.save(None) 生成的输出 serial 产生的反序列化 self

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

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

所需状态: 要求状态为“已拟合”(fitted)，即 self.is_fitted=True。

在 self 中访问

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

self.cutoff, self.is_fitted

写入 self: 如果 `fh` 被传递且之前未传递过，则将 `fh` 存储到 self.fh 中。

参数:

fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, default=None

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

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

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

在预测中使用的外生时间序列。应与 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，格式相同（参见上文）

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

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

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

所需状态: 要求状态为“已拟合”(fitted)，即 self.is_fitted=True。

在 self 中访问

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

self.cutoff, self.is_fitted

写入 self: 如果 `fh` 被传递且之前未传递过，则将 `fh` 存储到 self.fh 中。

参数:

fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, default=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)。

Xsktime 兼容格式的时间序列，可选 (默认=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`，如果 `fit` 中看到的 `y` 是 Panel 或 Hierarchical。

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

对于列索引中的变量，在第二列索引的名义覆盖率下，根据第三列索引区分下限/上限，对应于行索引。上限/下限区间预测值等同于在 alpha = 0.5 - c/2, 0.5 + c/2 (对于 coverage 中的 c) 处的分位数预测值。

predict_proba(fh=None, X=None, marginal=True)[源文件]#

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

注意

目前仅对 Series 类型 (非 panel, 非 hierarchical) 的 y 实现了此功能。
返回的分布对象需要安装 skpro。

所需状态: 要求状态为“已拟合”(fitted)，即 self.is_fitted=True。

在 self 中访问

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

self.cutoff, self.is_fitted

写入 self: 如果 `fh` 被传递且之前未传递过，则将 `fh` 存储到 self.fh 中。

参数:

fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, default=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)。

Xsktime 兼容格式的时间序列，可选 (默认=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)[源文件]#

计算/返回分位数预测。

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

所需状态: 要求状态为“已拟合”(fitted)，即 self.is_fitted=True。

在 self 中访问

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

self.cutoff, self.is_fitted

写入 self: 如果 `fh` 被传递且之前未传递过，则将 `fh` 存储到 self.fh 中。

参数:

fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, default=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)。

Xsktime 兼容格式的时间序列，可选 (默认=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`，如果 `fit` 中看到的 `y` 是 Panel 或 Hierarchical。
条目是分位数预测值，对应于列索引中的变量，: 在第二列索引的分位数概率下，对应于行索引。

predict_residuals(y=None, X=None)[源文件]#

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

残差将根据 `y.index` 处的预测值进行计算。

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

所需状态: 要求状态为“已拟合”。如果已设置 fh，则必须对应于 `y` 的索引 (pandas 或整数)。
在 self 中访问: 以“_”结尾的已拟合模型属性。`self.cutoff`, self._is_fitted
写入 self: 无。

参数:

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

带有真实观测值的时间序列，用于计算残差。必须与 `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 科学类型，格式相同（见上文）。

predict_var(fh=None, X=None, cov=False)[源文件]#

计算/返回方差预测。

所需状态: 要求状态为“已拟合”(fitted)，即 self.is_fitted=True。

在 self 中访问

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

self.cutoff, self.is_fitted

写入 self: 如果 `fh` 被传递且之前未传递过，则将 `fh` 存储到 self.fh 中。

参数:

fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, default=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)。

Xsktime 兼容格式的时间序列，可选 (默认=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`，附加级别等于实例级别，: 来自 `fit` 中看到的 `y`，如果 `fit` 中看到的 `y` 是 Panel 或 Hierarchical。

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

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

如果 cov=True

列索引是多级索引：第一级是变量名（同上）: 第二级是 `fh`。
行索引是 `fh`，附加级别等于实例级别，: 来自 `fit` 中看到的 `y`，如果 `fit` 中看到的 `y` 是 Panel 或 Hierarchical。
条目是（协）方差预测值，对应于列索引中的变量，以及: 行和列中的时间索引之间的协方差。

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

reset()[源文件]#

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

结果是将 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')[源文件]#

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

行为：如果 path 为 None，则返回一个内存中的序列化 self；如果 path 是文件位置，则将 self 以 zip 文件形式存储在该位置。

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

参数:

pathNone 或文件位置 (str 或 Path)

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

path=”estimator”，则将在当前工作目录下创建一个名为 estimator.zip 的 zip 文件。
path=”/home/stored/estimator”，则将在 /home/stored/ 中

存储一个名为 estimator.zip 的 zip 文件。

serialization_format: str，默认 = “pickle”

用于序列化的模块。可用选项有“pickle”和“cloudpickle”。请注意，非默认格式可能需要安装其他软依赖项。

返回:

如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 引用该文件的 ZipFile 对象

score(y, X=None, fh=None)[源文件]#

使用 MAPE（非对称）对地面真实值进行预测评分。

参数:

ypd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D): 要评分的时间序列
fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, default=None: 编码要预测的时间戳的预测范围。
Xpd.DataFrame 或 2D np.array，可选 (默认=None): 用于评分的外生时间序列。如果 self.get_tag(“X-y-must-have-same-index”) 为 True，则 X.index 必须包含 y.index。

返回:

score浮点数: self.predict(fh, X) 相对于 y_test 的 MAPE 损失。

另请参阅

sktime.performance_metrics.forecasting.mean_absolute_percentage_error

set_config(**config_dict)[源文件]#

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

参数:

config_dictdict

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

display字符串，“diagram”（默认）或“text”

jupyter 内核如何显示 self 的实例

“diagram” = html 框图表示
“text” = 字符串打印输出

print_changed_only布尔值，默认=True

打印 self 时是否仅列出与默认值不同的 self 参数（如果为 True），或列出所有参数名称和值（如果为 False）。不进行嵌套，即只影响 self，不影响组件估计器。

warnings字符串，“on”（默认）或“off”

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

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

backend:parallel字符串，可选，默认=“None”

在广播/向量化时用于并行化的后端，可选值之一

“None”：顺序执行循环，简单的列表推导式
“loky”、“multiprocessing”和“threading”：使用 joblib.Parallel
“joblib”：自定义和第三方 joblib 后端，例如 spark
“dask”：使用 dask，需要环境中安装 dask 包
“ray”：使用 ray，需要环境中安装 ray 包

backend:parallel:params字典，可选，默认={}（不传递参数）

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

“None”：无附加参数，忽略 backend_params
“loky”、“multiprocessing”和“threading”：默认的 joblib 后端。此处可以传递 joblib.Parallel 的任何有效键，例如 n_jobs，但 backend 除外，它直接由 backend 控制。如果未传递 n_jobs，则默认为 `-1`，其他参数将默认为 joblib 的默认值。
“joblib”：自定义和第三方 joblib 后端，例如 spark。此处可以传递 joblib.Parallel 的任何有效键，例如 n_jobs，在这种情况下，backend 必须作为 backend_params 的一个键传递。如果未传递 n_jobs，则默认为 `-1`，其他参数将默认为 joblib 的默认值。
“dask”：可以传递 dask.compute 的任何有效键，例如 scheduler
“ray”：可以传递以下键
- “ray_remote_args”：ray.init 的有效键字典
- “shutdown_ray”：布尔值，默认=True；如果为 False，则阻止 ray 在
  并行化后关闭。
- “logger_name”：字符串，默认=“ray”；要使用的日志记录器名称。
- “mute_warnings”：布尔值，默认=False；如果为 True，则抑制警告

remember_data布尔值，默认=True

是否在 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)[源文件]#

设置此对象的参数。

此方法适用于简单的 skbase 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象，即包含其他对象的对象，以访问组件 <component> 中的 <parameter>。如果引用明确，也可以使用不带 <component>__ 的字符串 <parameter>，例如，没有两个组件参数的名称相同为 <parameter>。

参数:

**params字典: BaseObject 参数，键必须是 <component>__<parameter> 字符串。如果 __ 后缀在 `get_params` 键中是唯一的，则可以作为完整字符串的别名。

返回:

self对 self 的引用（设置参数后）

set_random_state(random_state=None, deep=True, self_policy='copy')[源文件]#

设置 self 的 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_state整数、RandomState 实例或 None，默认=None

伪随机数生成器，用于控制随机整数的生成。传递整数可确保多次函数调用输出可复现。

deepbool, default=True

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

如果为 False，则仅设置 self 的 random_state 参数（如果存在）。
如果为 True，也将设置组件对象中的 random_state 参数。

self_policy字符串，{“copy”、“keep”、“new”} 之一，默认=“copy”

“copy”：self.random_state 设置为输入的 random_state
“keep”：self.random_state 保持不变
“new”：self.random_state 设置为一个新的随机状态，

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

返回:

self对 self 的引用

set_tags(**tag_dict)[源文件]#

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

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

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

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

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

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

参数:

**tag_dict字典: 标签名称：标签值对的字典。

返回:

Self: 对 self 的引用。

update(y, X=None, update_params=True)[源文件]#

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

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

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.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 兼容格式的时间序列，可选（default=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)[源文件]#

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

执行多个 update / predict 调用的链式快捷方式，数据回放基于时间分割器 cv。

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

self.update(y=cv.split_series(y)[0][0])
记住 self.predict() 的结果（稍后在单个批次中返回）
self.update(y=cv.split_series(y)[1][0])
记住 self.predict() 的结果（稍后在单个批次中返回）
等
返回所有记住的预测值

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

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.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；默认值为 initial_window=1 的 ExpandingWindowSplitter，以及默认值 = 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 科学类型，格式相同（见上文）
如果绝对时限点的集合不唯一：类型为 pandas DataFrame，行和列索引均为时间戳。行索引对应于进行预测的截止点，列索引对应于预测的绝对时限。条目是根据行索引预测的列索引的点预测值。如果在该（截止点，时限）对处未进行预测，则条目为 nan。

update_predict_single(y=None, fh=None, X=None, update_params=True)[源文件]#

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

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

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

所需状态: 要求状态为“已拟合”。
在 self 中访问: 以“_”结尾的已拟合模型属性。已见数据的指针，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, default=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_predsktime 兼容数据容器格式的时间序列: 在 fh 处的点预测，与 fh 具有相同的索引。y_pred 的类型与最近传递的 y 类型相同：Series, Panel, Hierarchical scitype，格式相同（参见上文）