DartsRegressionModel#

class DartsRegressionModel(lags: int | list[int] | dict[str, int | list[int]] | None = None, lags_past_covariates: int | list[int] | dict[str, int | list[int]] | None = None, lags_future_covariates: tuple[int, int] | list[int] | dict[str, tuple[int, int] | list[int]] | None = None, output_chunk_length: int | None = 1, output_chunk_shift: int | None = 0, add_encoders: dict | None = None, model=None, multi_models: bool | None = True, use_static_covariates: bool | None = True, past_covariates: list[str] | None = None, num_samples: int | None = 1000)[源代码]#

Darts 回归模型估计器。

参数:
lagsint, list, dict 之一, 默认=None

用于预测下一个时间步的滞后目标值。如果给定一个整数，则使用过去最后的 lags 个滞后（从 -1 向后）。否则，需要一个包含滞后的整数列表（每个滞后必须 < 0）。如果给定一个字典，键对应于分量名称（使用多个序列时为第一个序列的分量名称），值对应于分量滞后（整数或整数列表）。

lags_past_covariatesint, list, dict 之一, 默认=None

用于预测下一个时间步的滞后过去协变量值数量。如果给定一个整数，则使用过去最后的 lags_past_covariates 个滞后（包含，从滞后 -1 开始）。否则，需要一个包含滞后 < 0 的整数列表。如果给定一个字典，键对应于过去协变量分量名称（使用多个序列时为第一个序列的分量名称），值对应于分量滞后（整数或整数列表）。

lags_future_covariatestuple, list, dict 之一, 默认=None

用于预测下一个时间步的滞后未来协变量值数量。如果给定一个 tuple (past, future)，则使用过去最后的 past 个滞后（包含，从滞后 -1 开始），以及未来最初的 future 个滞后（从 0 - 预测时间 - 到 future - 1 包含）。否则，需要一个包含滞后的整数列表。如果给定字典，键对应于未来协变量分量名称（使用多个序列时为第一个序列的分量名称），值对应于分量滞后（整数或整数列表）。

output_chunk_shiftint, 默认=0

可选地，将输出块的起始点向未来偏移（相对于输入块结束）的步数。这将在输入（目标和过去协变量的历史）和输出之间创建间隙。如果模型支持未来协变量，则 lags_future_covariates 是相对于偏移输出块中的第一个步长的。预测将在目标系列结束后的 output_chunk_shift 步开始。如果设置了 output_chunk_shift，模型无法生成自回归预测 (n > output_chunk_length)。

output_chunk_lengthint, 默认=1

内部回归模型一次预测的时间步长数量。不必等于 predict() 中使用的预测范围 n。但是，如果协变量未能充分延伸到未来，将 output_chunk_length 设置为预测范围可能很有用。

add_encodersdict, 默认=None

可以使用 add_encoders 自动生成大量过去和未来协变量。这可以通过添加多个预定义的索引编码器和/或用户制作的自定义函数（将用作索引编码器）来实现。此外，可以添加转换器（例如 Darts 的 Scaler）来转换生成的协变量。这一切都在一个框架下发生，只需在模型创建时指定。阅读 SequentialEncoder 以了解更多关于 add_encoders 的信息。默认值：None。一个展示 add_encoders 部分功能的示例

add_encoders={
    'cyclic': {'future': ['month']},
    'datetime_attribute': {'future': ['hour', 'dayofweek']},
    'position': {'past': ['relative'], 'future': ['relative']},
    'custom': {'past': [lambda idx: (idx.year - 1950) / 50]},
    'transformer': Scaler()
}
model: object, 默认=None

具有 fit() 和 predict() 方法的类似 scikit-learn 的模型。也可以使用不支持多元时间序列的多输出回归模型，在这种情况下，将为多元系列中的每个分量使用一个回归器。如果为 None，则默认使用：sklearn.linear_model.LinearRegression(n_jobs=-1)。

multi_modelsbool, 默认=True

如果为 True，将为每个未来的滞后训练一个单独的模型进行预测。如果为 False，则训练一个单一模型来预测未来步骤“output_chunk_length”。默认值：True。

use_static_covariatesbool, 默认=True

模型是否应使用静态协变量信息，以防传递给 fit() 的输入 series 包含静态协变量。如果为 True，并且在拟合时有静态协变量可用，则将强制所有目标 series 在 fit() 和 predict() 中具有相同的静态协变量维度。

past_covariateslist, 默认=None

X 中仅在历史数据中已知的列名，默认为 None

num_samplesint, 默认=1000

从概率模型中采样预测结果的次数，默认为 1000

属性:
cutoff

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

fh

已传递的预测范围。

is_fitted

fit 方法是否已被调用。

说明

如果未指定，将假定所有列在预测期间已知。

方法

check_is_fitted([method_name])

检查估计器是否已拟合。

clone()

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

clone_tags(estimator[, tag_names])

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

convert_dataframe_to_timeseries(dataset)

转换数据集以与 darts 兼容。

convert_exogenous_dataset(dataset)

使外部特征与 darts 兼容（如果可用）。

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')[源代码]#

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

参数:
parameter_setstr, 默认="default"

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

返回:
paramsdict 或 list of dict, 默认 = {}

用于创建类测试实例的参数

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

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:
method_namestr, 可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[源代码]#

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

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

等同于构造一个 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 检查当前标签值。

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

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

返回:
self

对 self 的引用。

static convert_dataframe_to_timeseries(dataset: DataFrame)[源代码]#

转换数据集以与 darts 兼容。

参数:
datasetpandas.DataFrame

要从中转换的源数据集

返回:
darts.TimeSeries

已转换的目标数据集

convert_exogenous_dataset(dataset: DataFrame | None)[源代码]#

使外部特征与 darts 兼容（如果可用）。

参数:
datasetOptional[pandas.DataFrame]

关于外部特征的可用数据

返回:
Tuple[darts.TimeSeries, darts.TimeSeries]

关于未来已知和未来未知外部特征的已转换数据

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，则将 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 of 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")，则 X.index 必须包含 y.index。

返回:
self对 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 of 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 兼容格式的时间序列，可选 (默认=None)。

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

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

从类中获取类标签值，具有从父类继承的标签级别。

每个与 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 的配置标志。

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

get_config 返回动态配置，该配置覆盖默认配置。

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

配置在调用 clone 或 reset 时保留。

返回:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态

要求状态为“已拟合”。

参数:
deepbool，默认值=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，默认值=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 类型的字典

参数的字典，参数名 : 参数值键值对包括

  • 始终：此对象的所有参数，如同通过 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_tags 或 clone_tags 设置的标签，

在实例构建时。

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

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

按继承顺序排列。

参数:
tag_namestr

要检索的标签名称

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()[source]#

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

每个与 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()[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) 的结果
返回:
反序列化的 self，其输出位于 path，即 cls.save(path) 的输出
classmethod load_from_serial(serial)[source]#

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

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

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

所需状态

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

访问 self 中的

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

  • self.cutoff，self.is_fitted

写入 self

如果传递了 fh 且之前未传递过，则将 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）

预测中使用的外生时间序列。其科学类型（Series、Panel 或 Hierarchical）应与 fit 中 y 的科学类型相同。如果 self.get_tag("X-y-must-have-same-index") 为真，X.index 必须包含 fh 索引引用。

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

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 中的

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

  • self.cutoff，self.is_fitted

写入 self

如果传递了 fh 且之前未传递过，则将 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）

预测中使用的外生时间序列。其科学类型（Series、Panel 或 Hierarchical）应与 fit 中 y 的科学类型相同。如果 self.get_tag("X-y-must-have-same-index") 为真，X.index 必须包含 fh 索引引用。

coveragefloat 或包含唯一 float 值的列表，可选（默认值=0.90）

预测区间(s) 的标称覆盖率

返回:
pred_intpd.DataFrame
列具有多级索引：第一级是 fit 中 y 的变量名，
第二级是计算区间的覆盖率。

与输入 coverage 中的顺序相同。

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

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

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

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

对于列索引中的 var，在第二列索引中的标称覆盖率下，取决于第三列索引的 lower/upper，对于行索引而言。上限/下限区间末端预测等同于在 alpha = 0.5 - c/2, 0.5 + c/2 处的分位数预测，其中 c 在 coverage 中。

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

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

注意

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

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

所需状态

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

访问 self 中的

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

  • self.cutoff，self.is_fitted

写入 self

如果传递了 fh 且之前未传递过，则将 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）

预测中使用的外生时间序列。其科学类型（Series、Panel 或 Hierarchical）应与 fit 中 y 的科学类型相同。如果 self.get_tag("X-y-must-have-same-index") 为真，X.index 必须包含 fh 索引引用。

marginalbool，可选（默认值=True）

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

返回:
pred_distskpro BaseDistribution

如果 marginal=True，则为预测分布，将是按时间点的边际分布如果 marginal=False 且方法实现，则将是联合分布

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

计算/返回分位数预测。

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

所需状态

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

访问 self 中的

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

  • self.cutoff，self.is_fitted

写入 self

如果传递了 fh 且之前未传递过，则将 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）

预测中使用的外生时间序列。其科学类型（Series、Panel 或 Hierarchical）应与 fit 中 y 的科学类型相同。如果 self.get_tag("X-y-must-have-same-index") 为真，X.index 必须包含 fh 索引引用。

alphafloat 或包含唯一 float 值的列表，可选（默认值=[0.05, 0.95]）

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

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

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

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

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

条目是分位数预测，针对列索引中的 var，

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

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 兼容数据容器格式的时间序列

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

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

  • 如果之前进行了一次 fit 调用，则生成样本内残差

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

X符合 sktime 格式的时间序列，可选（默认值=None）

用于更新和预测的外生时间序列。其科学类型（Series、Panel 或 Hierarchical）应与 fit 中 y 的科学类型相同。如果 self.get_tag("X-y-must-have-same-index") 为真，X.index 必须包含 fh 索引引用和 y.index。

返回:
y_res符合 sktime 数据容器格式的时间序列

在 fh 处的预测残差，索引与 fh 相同。y_res 的类型与最近传递的 y 类型相同：Series、Panel、Hierarchical 科学类型，格式相同（见上文）

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

计算/返回方差预测。

所需状态

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

访问 self 中的

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

  • self.cutoff，self.is_fitted

写入 self

如果传递了 fh 且之前未传递过，则将 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）

预测中使用的外生时间序列。其科学类型（Series、Panel 或 Hierarchical）应与 fit 中 y 的科学类型相同。如果 self.get_tag("X-y-must-have-same-index") 为真，X.index 必须包含 fh 索引引用。

covbool，可选（默认值=False）

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

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

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

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

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

条目是方差预测，针对列索引中的 var。给定变量和 fh 索引的方差预测是一个预测的

在给定观测数据的情况下，该变量和索引的方差。

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

第二级是 fh。

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

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

条目是（协）方差预测，针对列索引中的 var，以及

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

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

reset()[source]#

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

结果是将 self 设置为在构造函数调用后立即拥有的状态，具有相同的超参数。通过 set_config 设置的配置值也会被保留。

reset 调用删除任何对象属性，除了

  • 超参数 = 写入 self 的 __init__ 参数，例如 self.paramname，其中 paramname 是 __init__ 的一个参数

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

  • 配置属性，配置保持不变。也就是说，在 reset 之前和之后 get_config 的结果是相同的。

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

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

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

返回:
self

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

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

将序列化的 self 保存到字节对象或 (.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") 为真，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”（默认）或“text”

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

  • “text” = 字符串输出

print_changed_onlybool，默认值=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”：bool，默认值=True；False 阻止 ray 在并行化后

      关闭。

    • “logger_name”：str，默认值=”ray”；要使用的日志记录器名称。

    • “mute_warnings”：bool，默认值=False；如果为 True，则抑制警告

remember_databool，默认值=True

self._X 和 self._y 是否在 fit 中存储并在 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>。字符串 <parameter>（不带 <component>__）也可以使用，如果这样引用不含糊，例如组件参数中没有两个参数具有相同的名称 <parameter>。

参数:
**paramsdict

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

返回:
self对 self 的引用（设置参数后）
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

为 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_stateint、RandomState 实例或 None，默认值=None

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

deepbool，默认值=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_params=True：拟合到目前为止所有观测到的数据

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

所需状态

要求状态为“已拟合”，即 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 of Series 类型 pd.DataFrame

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

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

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

用于更新模型拟合的外生时间序列。其 科学类型（Series、Panel 或 Hierarchical）应与 fit 中 y 的科学类型相同。如果 self.get_tag("X-y-must-have-same-index") 为真，X.index 必须包含 y.index。

update_paramsbool，可选（默认值=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_params=True：拟合到目前为止所有观测到的数据

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

所需状态

要求状态为“已拟合”，即 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 of 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

X符合 sktime 格式的时间序列，可选（默认值=None）

用于更新和预测的外生时间序列。其科学类型（Series、Panel 或 Hierarchical）应与 fit 中 y 的科学类型相同。如果 self.get_tag("X-y-must-have-same-index") 为真，X.index 必须包含 fh 索引引用。

update_paramsbool，可选（默认值=True）

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

reset_forecasterbool，可选（默认值=True）

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

  • 如果为 False，则在运行更新/预测序列时会更新 self，就像直接调用 update/predict 一样。

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

格式取决于整体预测的（cutoff，绝对范围）对

  • 如果绝对范围点的集合是唯一的：类型是符合 sktime 数据容器格式的时间序列输出中隐藏 cutoff类型与最近传递的 y 类型相同：Series、Panel、Hierarchical 科学类型，格式相同（见上文）

  • 如果绝对范围点的集合不唯一：类型是 pandas DataFrame，行和列索引是时间戳行索引对应于预测所基于的 cutoff列索引对应于预测的绝对范围

条目是根据行索引预测的列索引的点预测如果在该（cutoff，范围）对没有进行预测，则条目为 nan

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

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

此方法对于一步完成更新和预测非常有用。

所需状态

要求状态为“已拟合”。

访问 self 中的

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

写入 self

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

通过追加行来用 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 of 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

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

X符合 sktime 格式的时间序列，可选（默认值=None）

用于更新和预测的外生时间序列。其科学类型（Series、Panel 或 Hierarchical）应与 fit 中 y 的科学类型相同。如果 self.get_tag("X-y-must-have-same-index") 为真，X.index 必须包含 fh 索引引用。

update_paramsbool，可选（默认值=True）

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

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

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