DartsXGBModel#

class DartsXGBModel(past_covariates: list[str] | None = None, num_samples: int | None = 1000, 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, add_encoders: dict | None = None, likelihood: str | None = None, quantiles: list[float] | None = None, random_state: int | None = None, multi_models: bool | None = True, use_static_covariates: bool | None = True, kwargs: dict | None = None)[source]#

Darts XGBModel 估计器。

这基于 Darts [1] 中 Unit8 实现的 XGBoost 模型。

参数：
lagsint, list, dict 中的一种，默认=None

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

lags_past_covariatesint, list, dict 中的一种，默认=None

用于预测下一时间步的滞后 past_covariates 值数量。如果给定一个整数，则使用过去 lags_past_covariates 个滞后值（包含，从滞后 -1 开始）。否则，需要一个滞后整数列表（每个滞后值必须 < 0）。如果给定一个字典，键对应于 past_covariates 组件名称（在使用多个系列时是第一个系列的名称），值对应于组件滞后（整数或整数列表）。

lags_future_covariatestuple, list, dict 中的一种，默认=None

用于预测下一时间步的滞后 future_covariates 值数量。如果给定一个元组 (past, future)，则使用过去的最后 past 个滞后值（包含，从滞后 -1 开始）以及未来的前 future 个未来滞后值（从 0 - 预测时间 - 开始，包含 future - 1）。否则，需要一个滞后整数列表。如果给定一个字典，键对应于 future_covariates 组件名称（在使用多个系列时是第一个系列的名称），值对应于组件滞后（整数或整数列表）。

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()
}
likelihoodstr，默认=None

可以设置为 poisson 或 quantile。如果设置，模型将是概率性的，允许在预测时采样。这将覆盖任何 objective 参数。

quantileslist，默认=None

如果 likelihood 设置为 quantile，则将模型拟合到这些分位数。

random_stateint，默认=None

控制拟合过程和采样的随机性。默认值：None。

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

kwargsdict，默认=None

传递给 xgb.XGBRegressor 的附加关键字参数。作为字典传递以符合 sklearn 的 API。默认值：None。

属性：
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()

获取自身的配置标志。

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

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

score(y[, X, fh])

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

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

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

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

set_tags(**tag_dict)

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

update(y[, X, update_params])

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

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

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

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

用新数据更新模型并进行预测。
classmethod get_test_params(parameter_set='default')[source]#

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

参数：
parameter_setstr，默认=”default”

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

返回：
paramsdict 或 list of dict，默认 = {}

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数：
method_namestr，可选

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

引发：
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

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

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

返回：
自身

self 的引用。

static convert_dataframe_to_timeseries(dataset: DataFrame)[source]#

转换数据集以兼容 darts。

参数：
datasetpandas.DataFrame

要转换的源数据集

返回：
darts.TimeSeries

转换后的目标数据集

convert_exogenous_dataset(dataset: DataFrame | None)[source]#

如果可用，将外生特征转换为 darts 兼容格式。

参数：
datasetOptional[pandas.DataFrame]

可用的外生特征数据

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

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

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

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

参数：
parameter_setstr，默认=”default”

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

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

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

参数：
parameter_setstr，默认=”default”

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

返回：
objscls 实例列表

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

nameslist of str，与 objs 长度相同

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

property cutoff[source]#

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

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

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

property fh[source]#

已传递的预测范围。

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

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

状态变更

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

写入自身

  • 设置以“_”结尾的已拟合模型属性，已拟合属性可通过 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 (实例，时间)，3D np.ndarray (实例，变量，时间)，list 类型的 Series 类型的 pd.DataFrame

  • Hierarchical scitype = 层级集合，用于层级预测。pd.DataFrame，带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

有关数据格式的更多详细信息，请参阅 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。

返回：
自身自身的引用。
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) 相同。

状态变更

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

写入自身

  • 设置以“_”结尾的已拟合模型属性，已拟合属性可通过 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 (实例，时间)，3D np.ndarray (实例，变量，时间)，list 类型的 Series 类型的 pd.DataFrame

  • Hierarchical scitype = 层级集合，用于层级预测。pd.DataFrame，带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

有关数据格式的更多详细信息，请参阅 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)[source]#

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

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

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

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

获取自身的配置标志。

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

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

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

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

返回：
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态

要求状态为“fitted”。

参数：
deepbool, 默认=True

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

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

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

返回：
fitted_params键为 str 的 dict

已拟合参数的字典，paramname : paramvalue 键值对包含

  • 总是：此对象的所有已拟合参数，通过 get_param_names 获取的值是此对象的该键的已拟合参数值

  • 如果 deep=True，还包含组件参数的键/值对，组件参数以 [componentname]__[paramname] 格式索引，componentname 的所有参数显示为 paramname 及其值

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

classmethod get_param_defaults()[source]#

获取对象的参数默认值。

返回：
default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数：
sortbool, 默认=True

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

返回：
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数：
deepbool, 默认=True

是否返回组件的参数。

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

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

返回：
params键为 str 的 dict

参数字典，paramname : paramvalue 键值对包含

  • 总是：此对象的所有参数，通过 get_param_names 获取的值是此对象的该键的参数值，值总是与构造时传递的值相同

  • 如果 deep=True，还包含组件参数的键/值对，组件参数以 [componentname]__[paramname] 格式索引，componentname 的所有参数显示为 paramname 及其值

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

get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

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

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

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

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

  1. 通过实例上的 set_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]#

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

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入自身

如果 fh 被传递并且之前未传递过，则将 fh 存储到 self.fh。

参数：
fhint, list, pd.Index 可强制转换，或 ForecastingHorizon，默认=None

forecasting horizon (预测范围)，用于编码要预测的时间戳。如果已在 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)[source]#

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

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

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入自身

如果 fh 被传递并且之前未传递过，则将 fh 存储到 self.fh。

参数：
fhint, list, pd.Index 可强制转换，或 ForecastingHorizon，默认=None

forecasting horizon (预测范围)，用于编码要预测的时间戳。如果已在 fit 中传递，则不应再次传递。如果在 fit 中未传递，则必须传递，不可选

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

  • 如果 fh 是 int 或 int 的 array-like，则被解释为相对范围，并强制转换为相对 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 索引引用。

coveragefloat 或唯一值的 float 列表，可选 (默认=0.90)

预测区间(s) 的名义覆盖率(s)

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

与输入 coverage 的顺序相同。

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

行索引是 fh，具有与实例级别相同的附加（上层）级别，

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

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

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

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

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

注意

  • 当前仅对 Series（非 Panel，非 Hierarchical）y 实现。

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

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入自身

如果 fh 被传递并且之前未传递过，则将 fh 存储到 self.fh。

参数：
fhint, list, pd.Index 可强制转换，或 ForecastingHorizon，默认=None

forecasting horizon (预测范围)，用于编码要预测的时间戳。如果已在 fit 中传递，则不应再次传递。如果在 fit 中未传递，则必须传递，不可选

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

  • 如果 fh 是 int 或 int 的 array-like，则被解释为相对范围，并强制转换为相对 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 索引引用。

marginalbool, 可选 (默认=True)

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

返回：
pred_distskpro BaseDistribution

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

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

计算/返回分位数预测。

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

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入自身

如果 fh 被传递并且之前未传递过，则将 fh 存储到 self.fh。

参数：
fhint, list, pd.Index 可强制转换，或 ForecastingHorizon，默认=None

forecasting horizon (预测范围)，用于编码要预测的时间戳。如果已在 fit 中传递，则不应再次传递。如果在 fit 中未传递，则必须传递，不可选

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

  • 如果 fh 是 int 或 int 的 array-like，则被解释为相对范围，并强制转换为相对 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 索引引用。

alphafloat 或唯一值的 float 列表，可选 (默认=[0.05, 0.95])

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

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

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

行索引是 fh，具有与实例级别相同的附加（上层）级别，

来自 fit 中看到的 y，如果 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])) 时计算。

所需状态

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

访问 self 中的属性

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

写入自身

无。

参数：
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 scitype，格式相同（见上文）

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

计算/返回方差预测。

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入自身

如果 fh 被传递并且之前未传递过，则将 fh 存储到 self.fh。

参数：
fhint, list, pd.Index 可强制转换，或 ForecastingHorizon，默认=None

forecasting horizon (预测范围)，用于编码要预测的时间戳。如果已在 fit 中传递，则不应再次传递。如果在 fit 中未传递，则必须传递，不可选

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

  • 如果 fh 是 int 或 int 的 array-like，则被解释为相对范围，并强制转换为相对 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 索引引用。

covbool, 可选 (默认=False)

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

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

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

行索引是 fh，具有与实例级别相同的附加级别，

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

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

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

给定观测数据，对该变量和索引的预测方差。
如果 cov=True

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

行索引是 fh，具有与实例级别相同的附加级别，

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

第二级是 fh。

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

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

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

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

reset()[source]#

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

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

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

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

配置属性，配置不变地保留。也就是说，get_config 在 reset 前后的结果相同。

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

等同于 clone，但 reset 会改变 self 而不是返回新对象。

返回：
自身

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

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

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

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

行为：如果 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。

存储在 /home/stored/ 中。

serialization_format: str, 默认 = “pickle”

返回：
用于序列化的模块。可用选项是“pickle”和“cloudpickle”。请注意，非默认格式可能需要安装其他软依赖项。
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 引用文件的 ZipFile

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

参数：
score(y, X=None, fh=None)[source]#

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

scorefloat

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

另请参阅
sktime.performance_metrics.forecasting.mean_absolute_percentage_error

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

参数：
config_dictdict

set_config(**config_dict)[source]#

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

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

  • jupyter kernels 如何显示 self 实例

  • “diagram” = html 框图表示

“text” = 字符串打印输出

print_changed_onlybool, 默认=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”：bool, 默认=True；False 防止 ray

    • 在并行化后关闭。

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

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

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

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

注意

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对自身的引用（设置参数后）

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

set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

通过 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

deepbool, 默认=True

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

  • 是否在 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对自身的引用

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

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

set_tags(**tag_dict)[source]#

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

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

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

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

**tag_dictdict

返回：
标签名称：标签值对的字典。

Self

对自身的引用。

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

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

  • 如果尚未实现针对特定评估器的 update 方法，则默认回退行为如下：

  • update_params=True：对所有已观测数据进行拟合

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

写入自身

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

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

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

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

sktime 中的单个数据格式称为 mtype 规范，每个 mtype 实现一个抽象 scitype。

  • Series scitype = 单个时间序列，普通预测。pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame，带有 2 级行 MultiIndex (实例，时间)，3D np.ndarray (实例，变量，时间)，list 类型的 Series 类型的 pd.DataFrame

  • Hierarchical scitype = 层级集合，用于层级预测。pd.DataFrame，带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

有关数据格式的更多详细信息，请参阅 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, 可选 (默认=True)

返回：
由输入 random_state 派生，通常与输入不同
模型参数是否应该更新。如果为 False，则只更新 cutoff，模型参数（例如，系数）不更新。

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

update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#

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

  1. 与以下操作相同（如果只有 y, cv 不是默认值）

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

  3. 记住 self.predict()（稍后批量返回）

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

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

  6. 等等

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

  • 如果尚未实现针对特定评估器的 update 方法，则默认回退行为如下：

  • update_params=True：对所有已观测数据进行拟合

所需状态

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

访问 self 中的属性

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

  • self.cutoff, self.is_fitted

返回所有记住的预测

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

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

写入 self（除非 reset_forecaster=True）

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

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

sktime 中的单个数据格式称为 mtype 规范，每个 mtype 实现一个抽象 scitype。

  • Series scitype = 单个时间序列，普通预测。pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame，带有 2 级行 MultiIndex (实例，时间)，3D np.ndarray (实例，变量，时间)，list 类型的 Series 类型的 pd.DataFrame

  • Hierarchical scitype = 层级集合，用于层级预测。pd.DataFrame，带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

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

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

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

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

例如，SlidingWindowSplitter 或 ExpandingWindowSplitter；默认 = ExpandingWindowSplitter，initial_window=1 且默认 = y/X 中的单独数据点逐个添加并预测，initial_window = 1，step_length = 1 且 fh = 1

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

update_paramsbool, 可选 (默认=True)

reset_forecaster布尔型，可选（默认为 True）

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

  • reset_forecasterbool, 可选 (默认=True)

返回：
如果为 True，则不会改变预测器的状态，即更新/预测序列在副本上运行，并且 self 的 cutoff、模型参数、数据内存不会改变

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

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

  • 格式取决于整体预测的 (cutoff, 绝对范围) 对

如果绝对范围点的集合是唯一的：类型是 sktime 兼容数据容器格式的时间序列，输出中不显示 cutoff，与最近传递的 y 具有相同的类型：Series, Panel, Hierarchical scitype，格式相同（见上文）

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

如果绝对范围点的集合不唯一：类型是 pandas DataFrame，行和列索引是时间戳，行索引对应于从中预测的 cutoff，列索引对应于预测的绝对范围，条目是列索引的点预测，根据行索引预测，如果在该 (cutoff, horizon) 对没有进行预测，则条目为 nan

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

所需状态

要求状态为“fitted”。

访问 self 中的属性

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

写入自身

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

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

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

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

sktime 中的单个数据格式称为 mtype 规范，每个 mtype 实现一个抽象 scitype。

  • Series scitype = 单个时间序列，普通预测。pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame，带有 2 级行 MultiIndex (实例，时间)，3D np.ndarray (实例，变量，时间)，list 类型的 Series 类型的 pd.DataFrame

  • Hierarchical scitype = 层级集合，用于层级预测。pd.DataFrame，带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

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

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

forecasting horizon (预测范围)，用于编码要预测的时间戳。如果已在 fit 中传递，则不应再次传递。如果在 fit 中未传递，则必须传递，不可选

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

例如，SlidingWindowSplitter 或 ExpandingWindowSplitter；默认 = ExpandingWindowSplitter，initial_window=1 且默认 = y/X 中的单独数据点逐个添加并预测，initial_window = 1，step_length = 1 且 fh = 1

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

update_paramsbool, 可选 (默认=True)

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

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