LightGBM 模型

这是梯度提升树算法的 LightGBM 实现。

此实现能够产生概率预测。

要在 Darts 中启用 LightGBM 支持，请按照 INSTALL 中的详细安装说明进行操作：https://github.com/unit8co/darts/blob/master/INSTALL.md

class darts.models.forecasting.lgbm.LightGBMModel(lags=None, lags_past_covariates=None, lags_future_covariates=None, output_chunk_length=1, output_chunk_shift=0, add_encoders=None, likelihood=None, quantiles=None, random_state=None, multi_models=True, use_static_covariates=True, categorical_past_covariates=None, categorical_future_covariates=None, categorical_static_covariates=None, **kwargs)

基类: RegressionModelWithCategoricalCovariates

LGBM 模型

参数

• lags (Union[int, list[int], dict[str, Union[int, list[int]]], None]) – 用于预测下一个或多个时间步的滞后目标 series 值。如果为整数，则必须 > 0。使用最后 n=lags 个过去滞后；例如 (-1, -2, …, -lags)，其中 0 对应每个样本的第一个预测时间步。如果 output_chunk_shift > 0，则滞后 -1 会转换到第一个预测步之前的 -1 - output_chunk_shift 步。如果为整数列表，则每个值必须 < 0。仅使用指定的滞后值。如果为字典，键对应于 series 组件名称（使用多个序列时为第一个序列），值对应于组件滞后（整数或整数列表）。键 ‘default_lags’ 可用于为未指定的组件提供默认滞后。如果某些组件缺失且未提供 ‘default_lags’ 键，则会引发错误。

• lags_past_covariates (Union[int, list[int], dict[str, Union[int, list[int]]], None]) – 用于预测下一个或多个时间步的滞后 past_covariates 值。如果为整数，则必须 > 0。使用最后 n=lags_past_covariates 个过去滞后；例如 (-1, -2, …, -lags)，其中 0 对应每个样本的第一个预测时间步。如果 output_chunk_shift > 0，则滞后 -1 会转换到第一个预测步之前的 -1 - output_chunk_shift 步。如果为整数列表，则每个值必须 < 0。仅使用指定的滞后值。如果为字典，键对应于 past_covariates 组件名称（使用多个序列时为第一个序列），值对应于组件滞后（整数或整数列表）。键 ‘default_lags’ 可用于为未指定的组件提供默认滞后。如果某些组件缺失且未提供 ‘default_lags’ 键，则会引发错误。

• lags_future_covariates (Union[tuple[int, int], list[int], dict[str, Union[tuple[int, int], list[int]]], None]) – 用于预测下一个或多个时间步的滞后 future_covariates 值。即使 output_chunk_shift > 0，滞后也总是相对于输出块中的第一步。如果为 (past, future) 元组，则两个值都必须 > 0。使用最后 n=past 个过去滞后和 n=future 个未来滞后；例如 (-past, -(past - 1), …, -1, 0, 1, …. future - 1)，其中 0 对应每个样本的第一个预测时间步。如果 output_chunk_shift > 0，负滞后的位置与 lags 和 lags_past_covariates 的位置不同。在这种情况下，未来滞后 -5 将指向与目标滞后 -5 + output_chunk_shift 相同的步骤。如果为整数列表，则仅使用指定的滞后值。如果为字典，键对应于 future_covariates 组件名称（使用多个序列时为第一个序列），值对应于组件滞后（元组或整数列表）。键 ‘default_lags’ 可用于为未指定的组件提供默认滞后。如果某些组件缺失且未提供 ‘default_lags’ 键，则会引发错误。

• output_chunk_length (int) – 内部模型一次（每个块）预测的时间步数。这与 predict() 中使用的预测范围 n 不同，后者是使用一次性或自回归预测生成的所需预测点数。设置 n <= output_chunk_length 可以防止自回归。当协变量未充分延伸到未来时，或者为了禁止模型使用过去和/或未来协变量的未来值进行预测时（取决于模型的协变量支持），这很有用。

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

• add_encoders (Optional[dict, None]) –

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

  def encode_year(idx):
      return (idx.year - 1950) / 50
  
  add_encoders={
      'cyclic': {'future': ['month']},
      'datetime_attribute': {'future': ['hour', 'dayofweek']},
      'position': {'past': ['relative'], 'future': ['relative']},
      'custom': {'past': [encode_year]},
      'transformer': Scaler(),
      'tz': 'CET'
  }
  

• likelihood (Optional[str, None]) – 可以设置为 quantile 或 poisson。如果设置，模型将是概率性的，允许在预测时进行采样。这将覆盖任何 objective 参数。

• quantiles (Optional[list[float], None]) – 如果 likelihood 设置为 quantile，则将模型拟合到这些分位数。

• random_state (Optional[int, None]) – 控制拟合过程和采样的随机性。默认值：None。

• multi_models (Optional[bool, None]) – 如果为 True，则会为每个未来的滞后训练一个单独的模型进行预测。如果为 False，则会训练一个模型来预测 ‘output_chunk_length’ 中的所有步骤（每个步骤 n 的特征滞后都会后移 output_chunk_length - n）。默认值：True。

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

• categorical_past_covariates (Union[str, list[str], None]) – 可选地，组件名称或组件名称列表，指定底层 lightgbm.LightGBMRegressor 应视为分类的过去协变量。指定为分类的组件必须是整数编码的。有关 LightGBM 如何处理分类特征的更多信息，请访问：分类特征支持文档。

• categorical_future_covariates (Union[str, list[str], None]) – 可选地，组件名称或组件名称列表，指定底层 lightgbm.LightGBMRegressor 应视为分类的未来协变量。指定为分类的组件必须是整数编码的。

• categorical_static_covariates (Union[str, list[str], None]) – 可选地，字符串或字符串列表，指定底层 lightgbm.LightGBMRegressor 应视为分类的静态协变量。指定为分类的组件必须是整数编码的。

• **kwargs – 传递给 lightgbm.LGBRegressor 的附加关键字参数。

示例

>>> from darts.datasets import WeatherDataset
>>> from darts.models import LightGBMModel
>>> series = WeatherDataset().load()
>>> # predicting atmospheric pressure
>>> target = series['p (mbar)'][:100]
>>> # optionally, use past observed rainfall (pretending to be unknown beyond index 100)
>>> past_cov = series['rain (mm)'][:100]
>>> # optionally, use future temperatures (pretending this component is a forecast)
>>> future_cov = series['T (degC)'][:106]
>>> # predict 6 pressure values using the 12 past values of pressure and rainfall, as well as the 6 temperature
>>> # values corresponding to the forecasted period
>>> model = LightGBMModel(
>>>     lags=12,
>>>     lags_past_covariates=12,
>>>     lags_future_covariates=[0,1,2,3,4,5],
>>>     output_chunk_length=6,
>>>     verbose=-1
>>> )
>>> model.fit(target, past_covariates=past_cov, future_covariates=future_cov)
>>> pred = model.predict(6)
>>> pred.values()
array([[1006.85376674],
       [1006.83998586],
       [1006.63884831],
       [1006.57201255],
       [1006.52290556],
       [1006.39550065]])

属性

considers_static_covariates	模型是否考虑静态协变量（如果存在）。
extreme_lags	一个 8 元组，依次包含：（最小目标滞后，最大目标滞后，最小过去协变量滞后，最大过去协变量滞后，最小未来协变量滞后，最大未来协变量滞后，输出移位，最大目标训练滞后（仅适用于 RNNModel））
lagged_feature_names	模型已在其上训练的滞后特征名称。
lagged_label_names	模型估计器的滞后标签名称。
likelihood	返回模型用于概率预测的似然（如果存在）。
min_train_samples	训练模型所需的最小样本数。
output_chunk_length	模型一次预测的时间步数，对统计模型未定义。
output_chunk_shift	输出/预测开始于输入结束之后的时间步数。
supports_future_covariates	模型是否支持未来协变量
supports_likelihood_parameter_prediction	模型实例是否支持直接预测似然参数
supports_multivariate	如果可用，使用 model 的原生多元支持。
supports_optimized_historical_forecasts	模型是否支持优化的历史预测
supports_past_covariates	模型是否支持过去协变量
supports_probabilistic_prediction	检查具有此配置的预测模型是否支持概率预测。
supports_sample_weight	模型在训练期间是否支持验证集。
supports_static_covariates	模型是否支持静态协变量
supports_transferable_series_prediction	模型是否支持对任何输入 series 进行预测。
supports_val_set	模型在训练期间是否支持验证集。
uses_future_covariates	模型在拟合后是否使用未来协变量。
uses_past_covariates	模型在拟合后是否使用过去协变量。
uses_static_covariates	模型在拟合后是否使用静态协变量。
val_set_params	返回验证集的参数名称，以及如果支持验证集则返回验证样本权重。

model_params

方法

backtest(series[, past_covariates, ...])	计算模型对（潜在多个）series 的历史预测产生的误差值。
fit(series[, past_covariates, ...])	使用提供的特征时间序列列表和目标时间序列拟合/训练模型。
generate_fit_encodings(series[, ...])	生成用于拟合模型的协变量编码，并返回一个元组，其中包含过去和未来的协变量序列，以及原始和编码的协变量堆叠在一起。
generate_fit_predict_encodings(n, series[, ...])	生成用于训练和推理/预测的协变量编码，并返回一个元组，其中包含过去和未来的协变量序列，以及原始和编码的协变量堆叠在一起。
generate_predict_encodings(n, series[, ...])	生成用于推理/预测集的协变量编码，并返回一个元组，其中包含过去和未来的协变量序列，以及原始和编码的协变量堆叠在一起。
get_estimator(horizon, target_dim[, quantile])	返回预测 `target_dim`th 目标组件的第 `horizon` 步的估计器。
gridsearch(parameters, series[, ...])	使用网格搜索在一组给定超参数中找到最佳超参数。
historical_forecasts(series[, ...])	通过模拟在提供的（潜在多个）series 历史中各个时间点的预测来生成历史预测。
load(path)	从给定路径或文件句柄加载模型。
predict(n[, series, past_covariates, ...])	预测序列结束后的 n 个时间步的值。
residuals(series[, past_covariates, ...])	计算模型对（潜在多个）series 的历史预测产生的残差。
save([path, clean])	将模型保存到给定路径或文件句柄。
untrained_model()	返回使用相同参数创建的新（未经训练的）模型实例。

backtest(series, past_covariates=None, future_covariates=None, historical_forecasts=None, forecast_horizon=1, num_samples=1, train_length=None, start=None, start_format='value', stride=1, retrain=True, overlap_end=False, last_points_only=False, metric=<function mape>, reduction=<function mean>, verbose=False, show_warnings=True, predict_likelihood_parameters=False, enable_optimization=True, data_transformers=None, metric_kwargs=None, fit_kwargs=None, predict_kwargs=None, sample_weight=None)

计算模型对（潜在多个）series 的历史预测产生的误差值。

如果提供了 historical_forecasts，则（由 metric 函数给出的）度量指标将直接在所有预测值和实际值上进行评估。必须传递用于生成历史预测的相同 series 和 last_points_only 值。最后，该方法返回所有这些度量指标分数的（可选的）reduction（默认为均值）。

如果 historical_forecasts 为 None，它首先根据下面给出的参数生成历史预测（更多信息请参阅 ForecastingModel.historical_forecasts()），然后按照上述方法进行评估。

度量指标可以使用 metric_kwargs 进一步自定义（例如，控制组件、时间步、多个序列上的聚合，以及其他必需参数，如分位数指标的 q 等）。

参数

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 用于连续训练（如果 retrain 不是 False）并计算历史预测的（一个或多个）目标时间序列。

• past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，用于 series 中每个输入时间序列的（一个或多个）过去观测协变量时间序列。这仅适用于模型支持过去协变量的情况。

• future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，用于 series 中每个输入时间序列的（一个或多个）未来已知协变量时间序列。这仅适用于模型支持未来协变量的情况。

• historical_forecasts (Union[TimeSeries, Sequence[TimeSeries], Sequence[Sequence[TimeSeries]], None]) – 可选地，要评估的（一个或多个 / 一个序列的序列的）历史预测时间序列。对应于 historical_forecasts() 的输出。必须传递用于生成历史预测的相同 series 和 last_points_only 值。如果提供，将跳过历史预测，并忽略除 series、last_points_only、metric 和 reduction 之外的所有参数。

• forecast_horizon (int) – 预测的预测范围。

• num_samples (int) – 从概率模型中采样预测值的次数。仅对概率模型使用 >1 的值。

• train_length (Optional[int, None]) – 可选地，对每个构建的训练集使用固定的长度/时间步数（滚动窗口模式）。仅当 retrain 不是 False 时有效。默认值为 None，此时使用直到预测时间为止的所有时间步（扩展窗口模式）。如果大于可用时间步数，则使用扩展模式。需要至少为 min_train_series_length。

• start (Union[Timestamp, float, int, None]) –

  可选地，计算预测的第一个时间点。此参数支持：float、int、pandas.Timestamp 和 None。如果为 float，它是第一个预测点之前应占时间序列的比例。如果为 int，则对于具有 pd.DatetimeIndex 的 series 而言，它是第一个预测点的索引位置；对于具有 pd.RangeIndex 的 series 而言，它是索引值。后者可以通过 start_format=”position” 更改为索引位置。如果为 pandas.Timestamp，它是第一个预测点的时间戳。如果为 None，则第一个预测点将自动设置为

  • 如果 retrain 为 False，或者 retrain 是一个 Callable 且第一个可预测点早于第一个可训练点，则为第一个可预测点。

  • 如果 retrain 为 True 或 int（给定 train_length），或者 retrain 是一个 Callable 且第一个可训练点早于第一个可预测点，则为第一个可训练点。

  • 否则为第一个可训练点（给定 train_length）

  注意：如果 start 不在可训练/可预测点范围内，则使用最接近的有效起始点，该点

  是 start 前面 stride 的整数倍。如果不存在有效起始点，则引发 ValueError。

  注意：如果模型使用移位输出 (output_chunk_shift > 0)，则第一个预测点也会

  向未来移位 output_chunk_shift 个点。

  注意：如果 start 超出了可能的历史预测时间范围，将忽略该参数

  （None 时的默认行为）并从第一个可训练/可预测点开始。

• start_format (Literal[‘position’, ‘value’]) – 定义 start 的格式。如果设置为 'position'，start 对应于第一个预测点的索引位置，范围为 (-len(series), len(series) - 1)。如果设置为 'value'，start 对应于第一个预测点的索引值/标签。如果该值不在 series 的索引中，将引发错误。默认值：'value'。

• stride (int) – 两个连续预测之间的时间步数。

• retrain (Union[bool, int, Callable[…, bool]]) –

  是否以及/或者在何种条件下在预测之前重新训练模型。此参数支持 3 种不同类型：bool、(正) int 和 Callable（返回 bool）。对于 bool 类型：在每一步重新训练模型（True），或者从不重新训练模型（False）。对于 int 类型：模型每 retrain 次迭代重新训练。对于 Callable 类型：只要可调用对象返回 True，模型就会重新训练。可调用对象必须具有以下位置参数

  • counter (int)：当前 retrain 迭代次数

  • pred_time (pd.Timestamp 或 int)：预测时间的时间戳（训练序列的末尾）

  • train_series (TimeSeries)：直到 pred_time 的训练序列

  • past_covariates (TimeSeries)：直到 pred_time 的 past_covariates 序列

  • future_covariates (TimeSeries)：直到 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的 future_covariates 序列

  注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则会将 None 传递给相应的 retrain 函数参数。注意：有些模型需要每次都重新训练，并且不支持 retrain=True 之外的任何值。注意：这也控制着 data_transformers 的重新训练。

• overlap_end (bool) – 返回的预测是否可以超出序列的末尾。

• last_points_only (bool) – 是否仅返回每个历史预测的最后一点。如果设置为 True，该方法返回一个单独的 TimeSeries（对于 series 中的每个时间序列），其中包含连续的点预测。否则，返回历史 TimeSeries 预测列表。

• metric (Union[Callable[…, Union[float, list[float], ndarray, list[ndarray]]], list[Callable[…, Union[float, list[float], ndarray, list[ndarray]]]]]) – 一个度量函数或一个度量函数列表。每个度量指标必须是 Darts 度量指标（请参阅此处），或者具有与 Darts 度量指标相同签名的自定义度量指标，使用装饰器 multi_ts_support() 和 multi_ts_support()，并返回度量分数。

• reduction (Optional[Callable[…, float], None]) – 当 last_points_only 设置为 False 时，用于组合获得的单个误差分数的函数。提供多个度量函数时，该函数将接收参数 axis = 1 以获取每个度量函数的单个值。如果明确设置为 None，该方法将返回单个误差分数的列表。默认设置为 np.mean。

• verbose (bool) – 是否打印进度。

• show_warnings (bool) – 是否显示与历史预测优化或参数 start 和 train_length 相关的警告。

• predict_likelihood_parameters (bool) – 如果设置为 True，模型将预测其 likelihood 的参数，而不是目标。仅支持具有似然、num_samples = 1 且 n<=output_chunk_length 的概率模型。默认值：False。

• enable_optimization (bool) – 如果支持且可用，是否使用优化的 historical_forecasts 版本。默认值：True。

• data_transformers (Optional[dict[str, Union[BaseDataTransformer, Pipeline]], None]) –

  可选地，一个 BaseDataTransformer 或 Pipeline 字典，用于应用于相应的序列（可能的键包括：“series”、“past_covariates”、“future_covariates”）。如果提供，所有输入序列必须位于未转换的空间中。对于可拟合的转换器/管道

  • 如果 retrain=True，数据转换器将在每个历史预测步骤中在训练数据上重新拟合。

  • 如果 retrain=False，数据转换器将在所有预测之前对序列进行一次转换。

  拟合好的转换器用于在训练和预测期间转换输入。如果转换是可逆的，则预测结果将被反向转换。仅当 historical_forecasts=None 时有效。

• metric_kwargs (Union[dict[str, Any], list[dict[str, Any]], None]) – 传递给 metric() 的附加参数，例如用于并行化的 ‘n_jobs’，用于减少组件级别指标的 ‘component_reduction’，用于缩放指标的季节性 ‘m’ 等。将单独传递参数给每个指标，仅当它们存在于相应的指标签名中时。缩放指标（例如 mase`、rmsse 等）的参数 ‘insample’ 被忽略，因为它在内部处理。

• fit_kwargs (Optional[dict[str, Any], None]) – 可选地，传递给模型 fit() 方法的一些附加参数。

• predict_kwargs (Optional[dict[str, Any], None]) – 可选地，传递给模型 predict() 方法的一些附加参数。

• sample_weight (Union[TimeSeries, Sequence[TimeSeries], str, None]) – 可选地，应用于目标 series 标签进行训练的一些样本权重。仅当 retrain 不是 False 时有效。它们按观测、按标签（output_chunk_length 中的每一步）和按组件应用。如果是一个序列或序列的序列，则使用这些权重。如果权重序列只有一个组件/列，则权重全局应用于 series 中的所有组件。否则，对于特定组件的权重，组件数量必须与 series 的组件数量匹配。如果为字符串，则使用内置的权重函数生成权重。可用选项包括 “linear” 或 “exponential” 衰减——过去越远，权重越低。权重是针对每个时间 series 计算的。

返回类型

Union[float, ndarray, list[float], list[ndarray]]

返回值

• float – 单个单变量/多变量序列的单个回测分数，单个 metric 函数以及

  • 使用 last_points_only=True 生成的 historical_forecasts

  • 使用 last_points_only=False 和回测 reduction 生成的 historical_forecasts

• np.ndarray – 回测分数的 numpy 数组。对于单个序列和以下情况之一：

  • 单个 metric 函数，使用 last_points_only=False 和回测 reduction=None 生成的 historical_forecasts。输出形状为 (n forecasts, *)。

  • 多个 metric 函数，以及使用 last_points_only=False 生成的 historical_forecasts。使用回测 reduction 时，输出形状为 (*, n metrics)；当 reduction=None 时，输出形状为 (n forecasts, *, n metrics)。

  • 多个单变量/多变量序列，包括 series_reduction 以及“每时间步度量指标”的 component_reduction=None 或 time_reduction=None 之一或两者。

• List[float] – 与 float 类型相同，但适用于序列的序列。返回的度量指标列表长度为 len(series)，其中包含每个输入 series 的 float 度量指标。

• List[np.ndarray] – 与 np.ndarray 类型相同，但适用于序列的序列。返回的度量指标列表长度为 len(series)，其中包含每个输入 series 的 np.ndarray 度量指标。

property considers_static_covariates: bool

模型是否考虑静态协变量（如果存在）。

返回类型

bool

property extreme_lags: tuple[Optional[int], Optional[int], Optional[int], Optional[int], Optional[int], Optional[int], int, Optional[int]]

一个 8 元组，依次包含：（最小目标滞后，最大目标滞后，最小过去协变量滞后，最大过去协变量滞后，最小未来协变量滞后，最大未来协变量滞后，输出移位，最大目标训练滞后（仅适用于 RNNModel））。如果 0 是第一个预测的索引，则所有滞后都相对于此索引。

参见下面的示例。

如果模型未拟合

• 目标（仅涉及 RegressionModels）：则第一个元素应为 None。

• 过去协变量：则第三和第四个元素应为 None。

• 未来协变量：则第五和第六个元素应为 None。

应由使用过去或未来协变量的模型覆盖，和/或由最小目标滞后和最大目标滞后可能与 -1 和 0 不同的模型覆盖。

注意

最大目标滞后（第二个值）不能为 None，并且始终大于或等于 0。

示例

>>> model = LinearRegressionModel(lags=3, output_chunk_length=2)
>>> model.fit(train_series)
>>> model.extreme_lags
(-3, 1, None, None, None, None, 0, None)
>>> model = LinearRegressionModel(lags=3, output_chunk_length=2, output_chunk_shift=2)
>>> model.fit(train_series)
>>> model.extreme_lags
(-3, 1, None, None, None, None, 2, None)
>>> model = LinearRegressionModel(lags=[-3, -5], lags_past_covariates = 4, output_chunk_length=7)
>>> model.fit(train_series, past_covariates=past_covariates)
>>> model.extreme_lags
(-5, 6, -4, -1,  None, None, 0, None)
>>> model = LinearRegressionModel(lags=[3, 5], lags_future_covariates = [4, 6], output_chunk_length=7)
>>> model.fit(train_series, future_covariates=future_covariates)
>>> model.extreme_lags
(-5, 6, None, None, 4, 6, 0, None)
>>> model = NBEATSModel(input_chunk_length=10, output_chunk_length=7)
>>> model.fit(train_series)
>>> model.extreme_lags
(-10, 6, None, None, None, None, 0, None)
>>> model = NBEATSModel(input_chunk_length=10, output_chunk_length=7, lags_future_covariates=[4, 6])
>>> model.fit(train_series, future_covariates)
>>> model.extreme_lags
(-10, 6, None, None, 4, 6, 0, None)

返回类型

tuple[Optional[int, None], Optional[int, None], Optional[int, None], Optional[int, None], Optional[int, None], Optional[int, None], int, Optional[int, None]]

fit(series, past_covariates=None, future_covariates=None, val_series=None, val_past_covariates=None, val_future_covariates=None, max_samples_per_ts=None, n_jobs_multioutput_wrapper=None, sample_weight=None, val_sample_weight=None, **kwargs)

使用提供的特征时间序列列表和目标时间序列拟合/训练模型。

参数

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 包含目标值的 TimeSeries 或 Sequence[TimeSeries] 对象。

• past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，一个序列或序列的序列，指定过去观测的协变量

• future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，一个序列或序列的序列，指定未来已知的协变量

• val_series (Union[TimeSeries, Sequence[TimeSeries], None]) – 包含评估数据集目标值的 TimeSeries 或 Sequence[TimeSeries] 对象。

• val_past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，一个序列或序列的序列，指定评估数据集的过去观测协变量

• val_future_covariates (Union[TimeSeries, Sequence[TimeSeries]]) – 可选参数，用于指定评估数据集的未来已知协变量序列或序列列表

• max_samples_per_ts (Optional[int, None]) – 这是每个时间序列可以生成的元组数量的整数上限。它可用于对数据集的总大小设置上限并确保正确的抽样。如果为 None，它将在数据集创建时预先读取所有单个时间序列以了解其大小，这在大型数据集上可能很昂贵。如果某些序列的长度允许超过 max_samples_per_ts，则只考虑最近的 max_samples_per_ts 个样本。

• n_jobs_multioutput_wrapper (Optional[int, None]) – MultiOutputRegressor 包装器并行运行的作业数。仅当模型本身不支持多输出回归时使用。

• sample_weight (Union[TimeSeries, Sequence[TimeSeries], str, None]) – 可选参数，应用于目标 series 标签的样本权重。它们按观测、按标签（output_chunk_length 中的每个步骤）和按分量应用。如果是时间序列或时间序列序列，则使用这些权重。如果权重序列只有一个分量/列，则权重全局应用于 series 中的所有分量。否则，对于特定于分量的权重，分量数量必须与 series 的分量数量匹配。如果是字符串，则使用内置的权重函数生成权重。可用选项有 “linear”（线性）或 “exponential”（指数）衰减——时间越远，权重越低。权重是根据 series 中最长序列的长度全局计算的。然后对于每个序列，从全局权重的末端提取权重。这为所有序列提供了共同的时间加权。

• val_sample_weight (Union[TimeSeries, Sequence[TimeSeries], str, None]) –

  与 sample_weight 类似，但用于评估数据集。**kwargs

  传递给 lightgbm.LGBRegressor.fit() 的附加关键字参数

generate_fit_encodings(series, past_covariates=None, future_covariates=None)

生成用于模型拟合的协变量编码，并返回一个包含原始和编码协变量堆叠在一起的过去和未来协变量序列元组。编码是由模型创建时使用参数 add_encoders 定义的编码器生成的。传入您用于训练/拟合模型的相同的 series、past_covariates 和 future_covariates。

参数

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 用于拟合模型时带有目标值的序列或序列列表。

• past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，用于拟合模型时带有过去观测协变量的序列或序列列表。

• future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，用于拟合模型时带有未来已知协变量的序列或序列列表。

返回值

一个元组，包含（过去协变量，未来协变量）。每个协变量都包含原始协变量和编码后的协变量。

返回类型

Tuple[Union[TimeSeries, Sequence[TimeSeries]], Union[TimeSeries, Sequence[TimeSeries]]]

generate_fit_predict_encodings(n, series, past_covariates=None, future_covariates=None)

为训练和推理/预测生成协变量编码，并返回一个包含原始和编码协变量堆叠在一起的过去和未来协变量序列元组。编码是由模型创建时使用参数 add_encoders 定义的编码器生成的。传入您打算用于训练和预测的相同的 series、past_covariates 和 future_covariates。

参数

• n (int) – 在 series 结束之后用于预测的时间步长数。

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 打算用于训练和预测的带有目标值的序列或序列列表。

• past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，打算用于训练和预测的过去观测协变量序列。维度必须与用于训练的协变量的维度匹配。

• future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，打算用于预测的未来已知协变量序列。维度必须与用于训练的协变量的维度匹配。

返回值

一个元组，包含（过去协变量，未来协变量）。每个协变量都包含原始协变量和编码后的协变量。

返回类型

Tuple[Union[TimeSeries, Sequence[TimeSeries]], Union[TimeSeries, Sequence[TimeSeries]]]

generate_predict_encodings(n, series, past_covariates=None, future_covariates=None)

为推理/预测集生成协变量编码，并返回一个包含原始和编码协变量堆叠在一起的过去和未来协变量序列元组。编码是由模型创建时使用参数 add_encoders 定义的编码器生成的。传入您打算用于预测的相同的 series、past_covariates 和 future_covariates。

参数

• n (int) – 在 series 结束之后用于预测的时间步长数。

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 打算用于预测的带有目标值的序列或序列列表。

• past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，打算用于预测的过去观测协变量序列。维度必须与用于训练的协变量的维度匹配。

• future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，打算用于预测的未来已知协变量序列。维度必须与用于训练的协变量的维度匹配。

返回值

一个元组，包含（过去协变量，未来协变量）。每个协变量都包含原始协变量和编码后的协变量。

返回类型

Tuple[Union[TimeSeries, Sequence[TimeSeries]], Union[TimeSeries, Sequence[TimeSeries]]]

get_estimator(horizon, target_dim, quantile=None)

返回预测 `horizon`th 步长 `target_dim`th 目标分量的估计器。

对于拟合分位数的概率模型，也可以指定分位数。

如果模型本身支持多输出，则直接返回该模型。

注意：在内部，估计器按 output_chunk_length 位置分组，然后按分量分组。对于拟合分位数的概率模型，还有一个额外的抽象层，按 quantile 对估计器进行分组。

参数

• horizon (int) – 预测点在 output_chunk_length 中的索引。

• target_dim (int) – 目标分量的索引。

• quantile (Optional[float, None]) – 可选参数，对于使用 likelihood=”quantile” 的概率模型，表示一个分位数的值。

classmethod gridsearch(parameters, series, past_covariates=None, future_covariates=None, forecast_horizon=None, stride=1, start=None, start_format='value', last_points_only=False, show_warnings=True, val_series=None, use_fitted_values=False, metric=<function mape>, reduction=<function mean>, verbose=False, n_jobs=1, n_random_samples=None, data_transformers=None, fit_kwargs=None, predict_kwargs=None, sample_weight=None)

使用网格搜索在一组给定超参数中找到最佳超参数。

此函数有 3 种操作模式：扩展窗口模式、分割模式和拟合值模式。这 3 种操作模式通过实例化 model_class（ForecastingModel 的子类）并使用 parameters 字典中提供的每个超参数值组合来评估所有可能的组合，并返回在 metric 函数方面表现最佳的模型。预期 metric 函数返回一个误差值，因此将选择导致 metric 输出最小的模型。

训练数据和测试数据的关系取决于操作模式。

扩展窗口模式（当传入 forecast_horizon 时激活）：对于每个超参数组合，模型都会在 series 的不同分割上重复训练和评估。这个过程通过使用 backtest() 函数作为子程序来生成从 start 开始的历史预测，并将其与 series 的真实值进行比较。请注意，模型会为每个预测进行重新训练，因此此模式速度较慢。

分割窗口模式（当传入 val_series 时激活）：当传入 val_series 参数时将使用此模式。对于每个超参数组合，模型在 series 上训练，并在 val_series 上评估。

拟合值模式（当 use_fitted_values 设置为 True 时激活）：对于每个超参数组合，模型在 series 上训练，并在产生的拟合值上评估。并非所有模型都有拟合值，如果模型没有 fitted_values 成员，此方法会引发错误。拟合值是模型在 series 上拟合的结果。与拟合值进行比较是评估模型的快速方法，但无法看出模型是否对序列过拟合。

派生类必须确保模型的单个实例不会与其他实例共享参数，例如将模型保存在同一路径下。否则，在并行运行多个模型时（当 n_jobs != 1 时）可能会出现意外行为。如果无法避免这一点，则应重新定义 gridsearch，强制 n_jobs = 1。

目前此方法仅支持确定性预测（即当模型的预测只有 1 个样本时）。

参数

• model_class – 要针对 'series' 进行调整的 ForecastingModel 子类。

• parameters (dict) – 一个字典，其中键是超参数名称，值是相应超参数的值列表。

• series (TimeSeries) – 用作输入和训练目标的源目标序列。

• past_covariates (Optional[TimeSeries, None]) – 可选参数，过去观测的协变量序列。仅当模型支持过去协变量时适用。

• future_covariates (Optional[TimeSeries, None]) – 可选参数，未来已知的协变量序列。仅当模型支持未来协变量时适用。

• forecast_horizon (Optional[int, None]) – 预测范围的整数值。激活扩展窗口模式。

• stride (int) – 仅在扩展窗口模式中使用。两次连续预测之间的时间步长数。

• start (Union[Timestamp, float, int, None]) –

  仅在扩展窗口模式中使用。可选参数，第一次计算预测的时间点。此参数支持：float、int、pandas.Timestamp 和 None。如果为 float，则表示第一次预测点之前的时间序列的比例。如果为 int，则对于具有 pd.DatetimeIndex 的 series，它是第一次预测点的索引位置；对于具有 pd.RangeIndex 的 series，它是索引值。后者可以使用 start_format=”position” 更改为索引位置。如果为 pandas.Timestamp，则表示第一次预测点的时间戳。如果为 None，则第一次预测点将自动设置为

  • 如果 retrain 为 False，或者 retrain 是一个 Callable 且第一个可预测点早于第一个可训练点，则为第一个可预测点。

  • 如果 retrain 为 True 或 int（给定 train_length），则为第一个可训练点；或者如果 retrain 是可调用对象且第一个可训练点早于第一个可预测点。

  • 否则为第一个可训练点（给定 train_length）

  注意：如果 start 不在可训练/可预测点范围内，则使用最接近的有效起始点，该点

  是 start 前面 stride 的整数倍。如果不存在有效起始点，则引发 ValueError。

  注意：如果模型使用移位输出 (output_chunk_shift > 0)，则第一个预测点也会

  向未来移位 output_chunk_shift 个点。

  注意：如果 start 超出了可能的历史预测时间范围，将忽略该参数

  （None 时的默认行为）并从第一个可训练/可预测点开始。

• start_format (Literal[‘position’, ‘value’]) – 仅在扩展窗口模式中使用。定义 start 的格式。仅当 start 是整数且 series 使用 pd.RangeIndex 索引时有效。如果设置为 'position'，则 start 对应于第一个预测点的索引位置，范围可以是 (-len(series), len(series) - 1)。如果设置为 'value'，则 start 对应于第一个预测点的索引值/标签。如果该值不在 series 的索引中，将引发错误。默认值：'value'

• last_points_only (bool) – 仅在扩展窗口模式中使用。是使用整个预测还是仅使用每个预测的最后一个点来计算误差。

• show_warnings (bool) – 仅在扩展窗口模式中使用。是否显示与 start 参数相关的警告。

• val_series (Optional[TimeSeries, None]) – 在分割模式中用于验证的时间序列实例。如果提供，此序列必须紧接在 series 结束之后开始；以便可以对预测进行适当的比较。

• use_fitted_values (bool) – 如果为 True，则使用与拟合值的比较。如果 fitted_values 不是 model_class 的属性，则引发错误。

• metric (Callable[[TimeSeries, TimeSeries], float]) –

  一个度量函数，它返回两个 TimeSeries 之间的误差，类型为 float 值。必须是 Darts 的“按时间聚合”度量之一（参见此处），或者一个自定义度量，该度量以两个 TimeSeries 作为输入并返回误差

• reduction (Callable[[ndarray], float]) – 一个约简函数（将数组映射到 float），描述如何在回测时聚合在不同验证序列上获得的误差。默认情况下，它将计算误差的均值。

• verbose – 是否打印进度。

• n_jobs (int) – 并行运行的作业数。只有当有两个或更多参数组合需要评估时才会创建并行作业。每个作业将实例化、训练和评估一个不同的模型实例。默认值为 1（顺序）。将参数设置为 -1 表示使用所有可用的核心。

• n_random_samples (Union[int, float, None]) – 从完整参数网格中选择的超参数组合数/比例。这将执行随机搜索而不是使用完整网格。如果为整数，n_random_samples 是从完整网格中选择的参数组合数，必须介于 0 和参数组合总数之间。如果为 float，n_random_samples 是从完整网格中选择的参数组合的比例，必须介于 0 和 1 之间。默认值为 None，此时将忽略随机选择。

• data_transformers (Optional[dict[str, Union[BaseDataTransformer, Pipeline]], None]) –

  可选地，一个 BaseDataTransformer 或 Pipeline 字典，用于应用于相应的序列（可能的键包括：“series”、“past_covariates”、“future_covariates”）。如果提供，所有输入序列必须位于未转换的空间中。对于可拟合的转换器/管道

  • 如果 retrain=True，数据转换器将在每个历史预测步骤中在训练数据上重新拟合。

  • 如果 retrain=False，数据转换器将在所有预测之前对序列进行一次转换。

  拟合后的转换器用于在训练和预测期间转换输入。如果转换是可逆的，则预测结果将被逆变换。

• fit_kwargs (Optional[dict[str, Any], None]) – 传递给模型 fit() 方法的附加参数。

• predict_kwargs (Optional[dict[str, Any], None]) – 传递给模型 predict() 方法的附加参数。

• sample_weight (Union[TimeSeries, str, None]) – 可选参数，应用于目标 series 标签用于训练的样本权重。仅当 retrain 不是 False 时有效。它们按观测、按标签（output_chunk_length 中的每个步骤）和按分量应用。如果是时间序列，则使用这些权重。如果权重序列只有一个分量/列，则权重全局应用于 series 中的所有分量。否则，对于特定于分量的权重，分量数量必须与 series 的分量数量匹配。如果是字符串，则使用内置的权重函数生成权重。可用选项有 “linear”（线性）或 “exponential”（指数）衰减——时间越远，权重越低。

返回值

一个元组，包含一个由最佳表现超参数创建的未经训练的 model_class 实例，以及一个包含这些最佳超参数和最佳超参数度量分数的字典。

返回类型

ForecastingModel, Dict, float

historical_forecasts(series, past_covariates=None, future_covariates=None, forecast_horizon=1, num_samples=1, train_length=None, start=None, start_format='value', stride=1, retrain=True, overlap_end=False, last_points_only=True, verbose=False, show_warnings=True, predict_likelihood_parameters=False, enable_optimization=True, data_transformers=None, fit_kwargs=None, predict_kwargs=None, sample_weight=None)

通过模拟在所提供的（可能多个）series 的整个历史中的各个时间点进行预测来生成历史预测。此过程涉及回顾性地将模型应用于不同的时间步，就好像在那些特定时刻进行了实时预测一样。这使得可以评估模型在序列的整个持续时间内的性能，从而深入了解其在不同历史时期的预测准确性和鲁棒性。

此方法有两种主要模式

• 再训练模式（默认，retrain=True）：在模拟的每个步骤中，模型都会进行再训练，并使用更新后的模型生成预测。对于多个序列，模型在每个序列上独立进行再训练（尚不支持全局训练）。

• 预训练模式（retrain=False）：在模拟的每个步骤中生成预测，无需再训练。仅支持预训练的全局预测模型。此模式显著更快，因为它跳过了再训练步骤。

通过选择合适的模式，可以在计算效率和需要最新模型训练之间取得平衡。

再训练模式：此模式通过从 series 开头扩展或使用固定长度的 train_length（开始点也可以通过 start 和 start_format 配置）来重复构建训练集。然后模型在此训练集上进行训练，并生成长度为 forecast_horizon 的预测。随后，训练集的结束点按 stride 时间步长向前移动，并重复此过程。

预训练模式：此模式仅支持预训练的全局预测模型。它使用与再训练模式相同的模拟步骤（忽略 train_length），但直接生成预测，无需再训练。

默认情况下，当 last_points_only=True 时，此方法返回一个由每个历史预测的最后一个点组成的单个时间序列（或时间序列序列）。因此，此时间序列的频率将为 series.freq * stride。如果 last_points_only=False，它将改为返回一个列表（或列表序列），其中包含每个完整历史预测序列，每个序列的频率为 series.freq。

参数

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 用于连续训练（如果 retrain 不是 False）并计算历史预测的（一个或多个）目标时间序列。

• past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，用于 series 中每个输入时间序列的（一个或多个）过去观测协变量时间序列。这仅适用于模型支持过去协变量的情况。

• future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，用于 series 中每个输入时间序列的（一个或多个）未来已知协变量时间序列。这仅适用于模型支持未来协变量的情况。

• forecast_horizon (int) – 预测的预测范围。

• num_samples (int) – 从概率模型中采样预测值的次数。仅对概率模型使用 >1 的值。

• train_length (Optional[int, None]) – 可选地，对每个构建的训练集使用固定的长度/时间步数（滚动窗口模式）。仅当 retrain 不是 False 时有效。默认值为 None，此时使用直到预测时间为止的所有时间步（扩展窗口模式）。如果大于可用时间步数，则使用扩展模式。需要至少为 min_train_series_length。

• start (Union[Timestamp, float, int, None]) –

  可选地，计算预测的第一个时间点。此参数支持：float、int、pandas.Timestamp 和 None。如果为 float，它是第一个预测点之前应占时间序列的比例。如果为 int，则对于具有 pd.DatetimeIndex 的 series 而言，它是第一个预测点的索引位置；对于具有 pd.RangeIndex 的 series 而言，它是索引值。后者可以通过 start_format=”position” 更改为索引位置。如果为 pandas.Timestamp，它是第一个预测点的时间戳。如果为 None，则第一个预测点将自动设置为

  • 如果 retrain 为 False，或者 retrain 是一个 Callable 且第一个可预测点早于第一个可训练点，则为第一个可预测点。

  • 如果 retrain 为 True 或 int（给定 train_length），或者 retrain 是一个 Callable 且第一个可训练点早于第一个可预测点，则为第一个可训练点。

  • 否则为第一个可训练点（给定 train_length）

  注意：如果 start 不在可训练/可预测点范围内，则使用最接近的有效起始点，该点

  是 start 前面 stride 的整数倍。如果不存在有效起始点，则引发 ValueError。

  注意：如果模型使用移位输出 (output_chunk_shift > 0)，则第一个预测点也会

  向未来移位 output_chunk_shift 个点。

  注意：如果 start 超出了可能的历史预测时间范围，将忽略该参数

  （None 时的默认行为）并从第一个可训练/可预测点开始。

• start_format (Literal[‘position’, ‘value’]) – 定义 start 的格式。如果设置为 'position'，start 对应于第一个预测点的索引位置，范围为 (-len(series), len(series) - 1)。如果设置为 'value'，start 对应于第一个预测点的索引值/标签。如果该值不在 series 的索引中，将引发错误。默认值：'value'。

• stride (int) – 两个连续预测之间的时间步数。

• retrain (Union[bool, int, Callable[…, bool]]) –

  是否以及/或者在何种条件下在预测之前重新训练模型。此参数支持 3 种不同类型：bool、(正) int 和 Callable（返回 bool）。对于 bool 类型：在每一步重新训练模型（True），或者从不重新训练模型（False）。对于 int 类型：模型每 retrain 次迭代重新训练。对于 Callable 类型：只要可调用对象返回 True，模型就会重新训练。可调用对象必须具有以下位置参数

  • counter (int)：当前 retrain 迭代次数

  • pred_time (pd.Timestamp 或 int)：预测时间的时间戳（训练序列的末尾）

  • train_series (TimeSeries)：直到 pred_time 的训练序列

  • past_covariates (TimeSeries)：直到 pred_time 的 past_covariates 序列

  • future_covariates (TimeSeries)：直到 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的 future_covariates 序列

  注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则会将 None 传递给相应的 retrain 函数参数。注意：有些模型需要每次都重新训练，并且不支持 retrain=True 之外的任何值。注意：这也控制着 data_transformers 的重新训练。

• overlap_end (bool) – 返回的预测是否可以超出序列的末尾。

• last_points_only (bool) – 是否仅返回每个历史预测的最后一点。如果设置为 True，该方法返回一个单独的 TimeSeries（对于 series 中的每个时间序列），其中包含连续的点预测。否则，返回历史 TimeSeries 预测列表。

• verbose (bool) – 是否打印进度。

• show_warnings (bool) – 是否显示与历史预测优化或参数 start 和 train_length 相关的警告。

• predict_likelihood_parameters (bool) – 如果设置为 True，模型将预测其 likelihood 的参数，而不是目标。仅支持具有似然、num_samples = 1 且 n<=output_chunk_length 的概率模型。默认值：False。

• enable_optimization (bool) – 如果支持且可用，是否使用优化的 historical_forecasts 版本。默认值：True。

• data_transformers (Optional[dict[str, Union[BaseDataTransformer, Pipeline]], None]) –

  可选地，一个 BaseDataTransformer 或 Pipeline 字典，用于应用于相应的序列（可能的键包括：“series”、“past_covariates”、“future_covariates”）。如果提供，所有输入序列必须位于未转换的空间中。对于可拟合的转换器/管道

  • 如果 retrain=True，数据转换器将在每个历史预测步骤中在训练数据上重新拟合。

  • 如果 retrain=False，数据转换器将在所有预测之前对序列进行一次转换。

  拟合后的转换器用于在训练和预测期间转换输入。如果转换是可逆的，则预测结果将被逆变换。

• fit_kwargs (Optional[dict[str, Any], None]) – 可选地，传递给模型 fit() 方法的一些附加参数。

• predict_kwargs (Optional[dict[str, Any], None]) – 可选地，传递给模型 predict() 方法的一些附加参数。

• sample_weight (Union[TimeSeries, Sequence[TimeSeries], str, None]) – 可选地，应用于目标 series 标签进行训练的一些样本权重。仅当 retrain 不是 False 时有效。它们按观测、按标签（output_chunk_length 中的每一步）和按组件应用。如果是一个序列或序列的序列，则使用这些权重。如果权重序列只有一个组件/列，则权重全局应用于 series 中的所有组件。否则，对于特定组件的权重，组件数量必须与 series 的组件数量匹配。如果为字符串，则使用内置的权重函数生成权重。可用选项包括 “linear” 或 “exponential” 衰减——过去越远，权重越低。权重是针对每个时间 series 计算的。

返回类型

Union[TimeSeries, list[TimeSeries], list[list[TimeSeries]]]

返回值

• TimeSeries – 单个序列且 last_points_only=True 时的单个历史预测：它仅包含所有历史预测中步长为 forecast_horizon 的预测。

• List[TimeSeries] – 以下情况下的历史预测列表：

  • 一系列（列表）series 且 last_points_only=True：对于每个序列，它仅包含所有历史预测中步长为 forecast_horizon 的预测。

  • 单个 series 且 last_points_only=False：对于每个历史预测，它包含完整的 forecast_horizon 范围。

• List[List[TimeSeries]] – 一系列 series 且 last_points_only=False 时的历史预测列表的列表。对于每个序列和历史预测，它包含完整的 forecast_horizon 范围。外层列表对应于输入的序列，内层列表包含每个序列的历史预测。

property lagged_feature_names: Optional[list[str]]

模型已在其上训练的滞后特征名称。

目标、过去和未来协变量的命名约定为："{name}_{type}_lag{i}"，其中

• {name} （第一个）序列的分量名称

• {type} 是特征类型，可以是 “target”、“pastcov” 和 “futcov” 之一

• {i} 是滞后值

静态协变量的命名约定为："{name}_statcov_target_{comp}"，其中

• {name} （第一个）序列的静态协变量名称

• {comp} 静态协变量作用的（第一个）目标分量名称。如果静态

  协变量全局作用于多变量目标序列，将显示 “global”。

返回类型

Optional[list[str], None]

property lagged_label_names: Optional[list[str]]

模型估计器的滞后标签名称。

命名约定为："{name}_target_hrz{i}"，其中

• {name} （第一个）序列的分量名称

• {i} 是 output_chunk_length 中的位置（标签滞后）

返回类型

Optional[list[str], None]

property likelihood: Optional[SKLearnLikelihood]

返回模型用于概率预测的似然（如果存在）。

返回类型

Optional[SKLearnLikelihood, None]

static load(path)

从给定路径或文件句柄加载模型。

参数

path (Union[str, PathLike, BinaryIO]) – 加载模型的路径或文件句柄。

返回类型

ForecastingModel

property min_train_samples: int

训练模型所需的最小样本数。

返回类型

int

property model_params: dict

返回类型

dict

property output_chunk_length: int

模型一次预测的时间步数，对统计模型未定义。

返回类型

int

property output_chunk_shift: int

输出/预测开始于输入结束之后的时间步数。

返回类型

int

predict(n, series=None, past_covariates=None, future_covariates=None, num_samples=1, verbose=False, predict_likelihood_parameters=False, show_warnings=True, **kwargs)

预测序列结束后的 n 个时间步的值。

参数

• n (int) – 预测范围 - 在序列结束之后要生成预测的时间步长数。

• series (TimeSeries or list of TimeSeries, optional) – 可选参数，一个或多个输入 TimeSeries，表示要预测其未来的目标序列的历史记录。如果指定，则方法返回这些序列的预测。否则，方法返回（单个）训练序列的预测。

• past_covariates (TimeSeries or list of TimeSeries, optional) – 可选参数，模型所需的过去观测协变量序列作为输入。它们的维度和类型必须与用于训练的协变量匹配。

• future_covariates (TimeSeries or list of TimeSeries, optional) – 可选参数，模型所需的未来已知协变量序列作为输入。它们的维度和类型必须与用于训练的协变量匹配。

• num_samples (int, default: 1) – 从概率模型中采样的预测次数。对于确定性模型应设置为 1。

• verbose (bool) – 是否打印进度。

• predict_likelihood_parameters (bool) – 如果设置为 True，模型预测其 likelihood 的参数而不是目标。仅支持具有似然函数、num_samples = 1 且 n<=output_chunk_length 的概率模型。默认值：False

• **kwargs (dict, optional) – 传递给模型 predict 方法的附加关键字参数。仅适用于单变量目标序列。

• show_warnings (bool) – 可选参数，控制是否显示警告。并非对所有模型都有效。

返回类型

Union[TimeSeries, Sequence[TimeSeries]]

residuals(series, past_covariates=None, future_covariates=None, historical_forecasts=None, forecast_horizon=1, num_samples=1, train_length=None, start=None, start_format='value', stride=1, retrain=True, overlap_end=False, last_points_only=True, metric=<function err>, verbose=False, show_warnings=True, predict_likelihood_parameters=False, enable_optimization=True, data_transformers=None, metric_kwargs=None, fit_kwargs=None, predict_kwargs=None, sample_weight=None, values_only=False)

计算模型对（潜在多个）series 的历史预测产生的残差。

此函数计算 series 中的实际观测值与通过在 series 上训练模型（或使用 retrain=False 的预训练模型）获得的拟合值之间的差值（或 Darts 的“按时间步长”度量之一）。并非所有模型都支持拟合值，因此我们使用历史预测作为它们的近似值。

此方法依次执行

• 使用预先计算的 historical_forecasts 或计算每个序列的历史预测（有关详细信息，请参见historical_forecasts()）。历史预测的生成方式可以通过参数 num_samples、train_length、start、start_format、forecast_horizon、stride、retrain、last_points_only、fit_kwargs 和 predict_kwargs 进行配置。

• 使用“按时间步长”metric 在历史预测和 series 之间按分量/列和时间步长计算回测（有关详细信息，请参见backtest()）。默认情况下，使用残差 err()（误差）作为 metric。

• 创建并返回带有历史预测时间索引以及按分量和时间步长计算的度量值的 TimeSeries（或当 values_only=True 时仅返回一个 np.ndarray）。

此方法适用于单个或多个单变量或多变量序列。它使用中位数预测（处理随机预测时）。

参数

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 用于连续训练（如果 retrain 不是 False）并计算历史预测的（一个或多个）目标时间序列。

• past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，用于 series 中每个输入时间序列的（一个或多个）过去观测协变量时间序列。这仅适用于模型支持过去协变量的情况。

• future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，用于 series 中每个输入时间序列的（一个或多个）未来已知协变量时间序列。这仅适用于模型支持未来协变量的情况。

• historical_forecasts (Union[TimeSeries, Sequence[TimeSeries], Sequence[Sequence[TimeSeries]], None]) – 可选地，要评估的（一个或多个 / 一个序列的序列的）历史预测时间序列。对应于 historical_forecasts() 的输出。必须传递用于生成历史预测的相同 series 和 last_points_only 值。如果提供，将跳过历史预测，并忽略除 series、last_points_only、metric 和 reduction 之外的所有参数。

• forecast_horizon (int) – 预测的预测范围。

• num_samples (int) – 从概率模型中采样预测值的次数。仅对概率模型使用 >1 的值。

• train_length (Optional[int, None]) – 可选地，对每个构建的训练集使用固定的长度/时间步数（滚动窗口模式）。仅当 retrain 不是 False 时有效。默认值为 None，此时使用直到预测时间为止的所有时间步（扩展窗口模式）。如果大于可用时间步数，则使用扩展模式。需要至少为 min_train_series_length。

• start (Union[Timestamp, float, int, None]) –

  可选地，计算预测的第一个时间点。此参数支持：float、int、pandas.Timestamp 和 None。如果为 float，它是第一个预测点之前应占时间序列的比例。如果为 int，则对于具有 pd.DatetimeIndex 的 series 而言，它是第一个预测点的索引位置；对于具有 pd.RangeIndex 的 series 而言，它是索引值。后者可以通过 start_format=”position” 更改为索引位置。如果为 pandas.Timestamp，它是第一个预测点的时间戳。如果为 None，则第一个预测点将自动设置为

  • 如果 retrain 为 False，或者 retrain 是一个 Callable 且第一个可预测点早于第一个可训练点，则为第一个可预测点。

  • 如果 retrain 为 True 或 int（给定 train_length），或者 retrain 是一个 Callable 且第一个可训练点早于第一个可预测点，则为第一个可训练点。

  • 否则为第一个可训练点（给定 train_length）

  注意：如果 start 不在可训练/可预测点范围内，则使用最接近的有效起始点，该点

  是 start 前面 stride 的整数倍。如果不存在有效起始点，则引发 ValueError。

  注意：如果模型使用移位输出 (output_chunk_shift > 0)，则第一个预测点也会

  向未来移位 output_chunk_shift 个点。

  注意：如果 start 超出了可能的历史预测时间范围，将忽略该参数

  （None 时的默认行为）并从第一个可训练/可预测点开始。

• start_format (Literal[‘position’, ‘value’]) – 定义 start 的格式。如果设置为 'position'，start 对应于第一个预测点的索引位置，范围为 (-len(series), len(series) - 1)。如果设置为 'value'，start 对应于第一个预测点的索引值/标签。如果该值不在 series 的索引中，将引发错误。默认值：'value'。

• stride (int) – 两个连续预测之间的时间步数。

• retrain (Union[bool, int, Callable[…, bool]]) –

  是否以及/或者在何种条件下在预测之前重新训练模型。此参数支持 3 种不同类型：bool、(正) int 和 Callable（返回 bool）。对于 bool 类型：在每一步重新训练模型（True），或者从不重新训练模型（False）。对于 int 类型：模型每 retrain 次迭代重新训练。对于 Callable 类型：只要可调用对象返回 True，模型就会重新训练。可调用对象必须具有以下位置参数

  • counter (int)：当前 retrain 迭代次数

  • pred_time (pd.Timestamp 或 int)：预测时间的时间戳（训练序列的末尾）

  • train_series (TimeSeries)：直到 pred_time 的训练序列

  • past_covariates (TimeSeries)：直到 pred_time 的 past_covariates 序列

  • future_covariates (TimeSeries)：直到 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的 future_covariates 序列

  注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则会将 None 传递给相应的 retrain 函数参数。注意：有些模型需要每次都重新训练，并且不支持 retrain=True 之外的任何值。注意：这也控制着 data_transformers 的重新训练。

• overlap_end (bool) – 返回的预测是否可以超出序列的末尾。

• last_points_only (bool) – 是否仅返回每个历史预测的最后一点。如果设置为 True，该方法返回一个单独的 TimeSeries（对于 series 中的每个时间序列），其中包含连续的点预测。否则，返回历史 TimeSeries 预测列表。

• metric (Callable[…, Union[float, list[float], ndarray, list[ndarray]]]) –

  Darts 的“按时间步长”度量之一（参见此处），或具有与 Darts 的“按时间步长”度量相同的签名，使用装饰器 multi_ts_support() 和 multi_ts_support()，并返回每个时间步长的一个值。

• verbose (bool) – 是否打印进度。

• show_warnings (bool) – 是否显示与历史预测优化或参数 start 和 train_length 相关的警告。

• predict_likelihood_parameters (bool) – 如果设置为 True，模型将预测其 likelihood 的参数，而不是目标。仅支持具有似然、num_samples = 1 且 n<=output_chunk_length 的概率模型。默认值：False。

• enable_optimization (bool) – 如果支持且可用，是否使用优化的 historical_forecasts 版本。默认值：True。

• data_transformers (Optional[dict[str, Union[BaseDataTransformer, Pipeline]], None]) –

  可选地，一个 BaseDataTransformer 或 Pipeline 字典，用于应用于相应的序列（可能的键包括：“series”、“past_covariates”、“future_covariates”）。如果提供，所有输入序列必须位于未转换的空间中。对于可拟合的转换器/管道

  • 如果 retrain=True，数据转换器将在每个历史预测步骤中在训练数据上重新拟合。

  • 如果 retrain=False，数据转换器将在所有预测之前对序列进行一次转换。

  拟合好的转换器用于在训练和预测期间转换输入。如果转换是可逆的，则预测结果将被反向转换。仅当 historical_forecasts=None 时有效。

• metric_kwargs (Optional[dict[str, Any], None]) – 传递给 metric() 的附加参数，例如用于并行化的 ‘n_jobs’、用于缩放度量的 ‘m’ 等。仅当参数存在于相应的度量签名中时才传递。忽略约简参数 “series_reduction”, “component_reduction”, “time_reduction” 以及用于缩放度量（例如 mase`, rmsse, …）的参数 ‘insample’，因为它们在内部处理。

• fit_kwargs (Optional[dict[str, Any], None]) – 可选地，传递给模型 fit() 方法的一些附加参数。

• predict_kwargs (Optional[dict[str, Any], None]) – 可选地，传递给模型 predict() 方法的一些附加参数。

• sample_weight (Union[TimeSeries, Sequence[TimeSeries], str, None]) – 可选地，应用于目标 series 标签进行训练的一些样本权重。仅当 retrain 不是 False 时有效。它们按观测、按标签（output_chunk_length 中的每一步）和按组件应用。如果是一个序列或序列的序列，则使用这些权重。如果权重序列只有一个组件/列，则权重全局应用于 series 中的所有组件。否则，对于特定组件的权重，组件数量必须与 series 的组件数量匹配。如果为字符串，则使用内置的权重函数生成权重。可用选项包括 “linear” 或 “exponential” 衰减——过去越远，权重越低。权重是针对每个时间 series 计算的。

• values_only (bool) – 是否将残差作为 np.ndarray 返回。如果为 False，则将残差作为 TimeSeries 返回。

返回类型

Union[TimeSeries, list[TimeSeries], list[list[TimeSeries]]]

返回值

• TimeSeries – 单个 series 且 historical_forecasts 使用 last_points_only=True 生成时的残差 TimeSeries。

• List[TimeSeries] – 一系列（列表）series 且 last_points_only=True 时的残差 TimeSeries 列表。残差列表的长度为 len(series)。

• List[List[TimeSeries]] – 一系列 series 且 last_points_only=False 时的残差 TimeSeries 列表的列表。外层残差列表的长度为 len(series)。内层列表包含每个序列所有可能的历史预测的残差。

save(path=None, clean=False, **pkl_kwargs)

将模型保存到给定路径或文件句柄。

RegressionModel 保存和加载示例

from darts.models import RegressionModel

model = RegressionModel(lags=4)

model.save("my_model.pkl")
model_loaded = RegressionModel.load("my_model.pkl")

参数

• path (Union[str, PathLike, BinaryIO, None]) – 保存模型当前状态的路径或文件句柄。如果未指定路径，模型将自动保存到 "{ModelClass}_{YYYY-mm-dd_HH_MM_SS}.pkl"。例如，"RegressionModel_2020-01-01_12_00_00.pkl"。

• clean (bool) –

  是否存储模型的清除版本。仅对全局预测模型有效。如果为 True，则删除训练序列和协变量。

  注意：加载使用 clean=True 存储的全局预测模型后，必须将 series 传递给 'predict()'、historical_forecasts() 和其他预测方法。

• pkl_kwargs – 传递给 pickle.dump() 的关键字参数

返回类型

None

property supports_future_covariates: bool

模型是否支持未来协变量

返回类型

bool

property supports_likelihood_parameter_prediction: bool

模型实例是否支持直接预测似然参数

返回类型

bool

property supports_multivariate: bool

如果可用，使用 model 原生的多变量支持。如果不可用，则通过将单变量模型封装在 sklearn.multioutput.MultiOutputRegressor 中获得多变量支持。

返回类型

bool

property supports_optimized_historical_forecasts: bool

模型是否支持优化的历史预测

返回类型

bool

property supports_past_covariates: bool

模型是否支持过去协变量

返回类型

bool

property supports_probabilistic_prediction: bool

检查具有此配置的预测模型是否支持概率预测。

默认返回 False。需要由支持概率预测的模型覆盖。

返回类型

bool

property supports_sample_weight: bool

模型在训练期间是否支持验证集。

返回类型

bool

property supports_static_covariates: bool

模型是否支持静态协变量

返回类型

bool

property supports_transferable_series_prediction: bool

模型是否支持对任何输入 series 进行预测。

返回类型

bool

property supports_val_set: bool

模型在训练期间是否支持验证集。

返回类型

bool

untrained_model()

返回使用相同参数创建的新（未经训练的）模型实例。

property uses_future_covariates: bool

模型在拟合后是否使用未来协变量。

返回类型

bool

property uses_past_covariates: bool

模型在拟合后是否使用过去协变量。

返回类型

bool

property uses_static_covariates: bool

模型在拟合后是否使用静态协变量。

返回类型

bool

property val_set_params: tuple[Optional[str], Optional[str]]

返回验证集的参数名称，以及如果支持验证集则返回验证样本权重。

返回类型

tuple[Optional[str, None], Optional[str, None]]

上一页

卡尔曼滤波器预测器

下一页

线性回归模型