N-HiTS

class darts.models.forecasting.nhits.NHiTSModel(input_chunk_length, output_chunk_length, output_chunk_shift=0, num_stacks=3, num_blocks=1, num_layers=2, layer_widths=512, pooling_kernel_sizes=None, n_freq_downsample=None, dropout=0.1, activation='ReLU', MaxPool1d=True, **kwargs)

基类: PastCovariatesTorchModel

N-HiTS 模型的实现，如文献 [1] 中所述。

N-HiTS 类似于 N-BEATS (在 NBEATSModel 中实现)，但通过引入输入的多种速率采样和输出的多尺度插值，试图以较低的计算成本提供更好的性能。

与 NBEATSModel 类似，除了论文中提出的单变量版本外，此实现还支持多变量序列（和协变量），通过将模型输入展平为一维序列并将输出重塑为适当维度的张量。此外，它还支持生成概率预测（通过指定 likelihood 参数）。

此模型支持过去协变量（在预测时间之前 input_chunk_length 个点可知）。

多速率采样通过 MaxPooling 完成，由 pooling_kernel_sizes 控制。此参数可以是元组的元组，大小为 (num_stacks x num_blocks)，指定用于输入池化层的每个堆栈中每个块的核大小。如果设置为 None，将根据 input_chunk_length 使用一些默认值。类似地，多尺度插值由 n_freq_downsample 控制，它给出内插前每个堆栈中每个块使用的下采样因子。如果设置为 None，将根据 output_chunk_length 使用一些默认值。

参数

• input_chunk_length (int) – 模型输入（每块）中使用的过去时间步长数量。适用于目标序列以及过去和/或未来协变量（如果模型支持）。

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

• output_chunk_shift (int) – 可选参数，将输出块的起始位置向未来偏移（相对于输入块末尾）的步数。这会在输入和输出之间创建一个间隔。如果模型支持 future_covariates，未来值将从偏移的输出块中提取。预测将从目标 series 结束后的 output_chunk_shift 步开始。如果设置了 output_chunk_shift，模型无法生成自回归预测 (n > output_chunk_length)。

• num_stacks (int) – 构成整个模型的堆栈数量。

• num_blocks (int) – 构成每个堆栈的块数量。

• num_layers (int) – 每个堆栈中每个块在最终分叉层之前全连接层的数量。

• layer_widths (Union[int, list[int]]) – 确定每个堆栈中每个块中每个全连接层包含的神经元数量。如果传入列表，其长度必须等于 num_stacks，且列表中的每个条目对应于相应堆栈的层宽度。如果传入整数，每个堆栈中的块将具有相同宽度的 FC 层。

• pooling_kernel_sizes (Optional[tuple[tuple[int]], None]) – 如果设置，此参数必须是元组的元组，大小为 (num_stacks x num_blocks)，指定用于输入池化层的每个堆栈中每个块的核大小。如果设置为 None，将根据 input_chunk_length 使用一些默认值。

• n_freq_downsample (Optional[tuple[tuple[int]], None]) – 如果设置，此参数必须是元组的元组，大小为 (num_stacks x num_blocks)，指定内插前每个堆栈中每个块的下采样因子。如果设置为 None，将根据 output_chunk_length 使用一些默认值。

• dropout (float) – 用于全连接层的 dropout 概率。在推理时，这与 Monte Carlo dropout 兼容，用于模型不确定性估计（在预测时通过 mc_dropout=True 启用）。

• activation (str) – 编码器/解码器中间层的激活函数（默认='ReLU'）。支持的激活函数：['ReLU', 'RReLU', 'PReLU', 'ELU', 'Softplus', 'Tanh', 'SELU', 'LeakyReLU', 'Sigmoid', 'GELU']

• MaxPool1d (bool) – 使用 MaxPool1d 池化。False 使用 AvgPool1d

• **kwargs – 初始化 pytorch_lightning.Module, pytorch_lightning.Trainer 和 Darts 的 TorchForecastingModel 的可选参数。

• loss_fn – 用于训练的 PyTorch 损失函数。如果指定了 likelihood 参数，则概率模型将忽略此参数。默认值：torch.nn.MSELoss()。

• likelihood – Darts 的 Likelihood 模型之一，用于概率预测。默认值：None。

• torch_metrics – 用于评估的 torch 指标或 MetricCollection。可用指标的完整列表可在 https://torchmetrics.readthedocs.io/en/latest/ 找到。默认值：None。

• optimizer_cls – 要使用的 PyTorch 优化器类。默认值：torch.optim.Adam。

• optimizer_kwargs – 可选参数，PyTorch 优化器的一些关键字参数（例如，{'lr': 1e-3} 用于指定学习率）。否则，将使用所选 optimizer_cls 的默认值。默认值：None。

• lr_scheduler_cls – 可选参数，要使用的 PyTorch 学习率调度器类。指定 None 对应于使用固定学习率。默认值：None。

• lr_scheduler_kwargs – 可选参数，PyTorch 学习率调度器的一些关键字参数。默认值：None。

• use_reversible_instance_norm – 是否使用可逆实例归一化 RINorm 来对抗分布偏移，如文献 [2] 所示。它仅应用于目标序列的特征，不应用于协变量。

• batch_size – 每次训练迭代中使用的（输入和输出序列）时间序列数量。默认值：32。

• n_epochs – 模型训练的总轮数（epochs）。默认值：100。

• model_name – 模型名称。用于创建检查点和保存 TensorBoard 数据。如果未指定，默认为字符串 "YYYY-mm-dd_HH_MM_SS_torch_model_run_PID"，其中名称的前半部分按本地日期和时间格式化，PID 是进程 ID（防止由不同进程同时启动的模型共享相同的 model_name）。例如，"2021-06-14_09_53_32_torch_model_run_44607"。

• work_dir – 工作目录路径，用于保存检查点和 TensorBoard 摘要。默认值：当前工作目录。

• log_tensorboard – 如果设置，使用 TensorBoard 记录不同的参数。日志将位于："{work_dir}/darts_logs/{model_name}/logs/"。默认值：False。

• nr_epochs_val_period – 在评估验证损失之前等待的轮数（如果将验证 TimeSeries 传递给 fit() 方法）。默认值：1。

• force_reset – 如果设置为 True，将重置任何先前存在的同名模型（所有检查点将被丢弃）。默认值：False。

• save_checkpoints – 是否自动保存未经训练的模型和训练检查点。要从检查点加载模型，请调用 MyModelClass.load_from_checkpoint()，其中 MyModelClass 是使用的 TorchForecastingModel 类（例如 TFTModel, NBEATSModel 等）。如果设置为 False，模型仍然可以使用 save() 手动保存，并使用 load() 加载。默认值：False。

• add_encoders –

  可以使用 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'
  }
  

• random_state – 控制权重初始化的随机性。请查看此 link 获取更多详细信息。默认值：None。

• pl_trainer_kwargs –

  默认情况下 TorchForecastingModel 创建一个 PyTorch Lightning Trainer，其中包含一些有用的预设，用于执行训练、验证和预测过程。这些预设包括自动检查点、TensorBoard 日志记录、设置 torch 设备等。通过 pl_trainer_kwargs，您可以添加额外的关键字参数来实例化 PyTorch Lightning trainer 对象。请查看 PL Trainer 文档以了解更多关于支持的关键字参数的信息。默认值：None。通过在 pl_trainer_kwargs 字典中指定键 "accelerator", "devices", and "auto_select_gpus"，也可以在 GPU 上运行。设置 pl_trainer_kwargs 字典中设备的示例

  • {"accelerator": "cpu"} for CPU,

  • {"accelerator": "gpu", "devices": [i]} to use only GPU i (i must be an integer),

  • {"accelerator": "gpu", "devices": -1, "auto_select_gpus": True} to use all available GPUS.

  更多信息请参阅：https://pytorch-lightning.readthedocs.io/en/stable/common/trainer.html#trainer-flags 和 https://pytorch-lightning.readthedocs.io/en/stable/accelerators/gpu_basic.html#train-on-multiple-gpus

  使用参数 "callbacks"，您可以向 Darts 的 TorchForecastingModel 添加自定义或 PyTorch-Lightning 内置回调函数。下面是向训练过程添加 EarlyStopping 的示例。如果验证损失 val_loss 未能按指定改进，模型将提前停止训练。有关回调函数的更多信息，请访问：PyTorch Lightning Callbacks

  from pytorch_lightning.callbacks.early_stopping import EarlyStopping
  
  # stop training when validation loss does not decrease more than 0.05 (`min_delta`) over
  # a period of 5 epochs (`patience`)
  my_stopper = EarlyStopping(
      monitor="val_loss",
      patience=5,
      min_delta=0.05,
      mode='min',
  )
  
  pl_trainer_kwargs={"callbacks": [my_stopper]}
  

  请注意，您也可以使用可选参数 trainer 在 fit() 和 predict() 中使用自定义的 PyTorch Lightning Trainer 进行训练和预测。

• show_warnings – 是否显示 PyTorch Lightning 提出的警告。有助于检测预测用例的潜在问题。默认值：False。

参考文献

1

C. Challu 等人。“N-HiTS: 用于时间序列预测的神经层次插值”，https://arxiv.org/abs/2201.12886

2

T. Kim 等人。“用于对抗分布偏移的准确时间序列预测的可逆实例归一化”，https://openreview.net/forum?id=cGDAkQo1C0p

示例

>>> from darts.datasets import WeatherDataset
>>> from darts.models import NHiTSModel
>>> 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]
>>> # increasing the number of blocks
>>> model = NHiTSModel(
>>>     input_chunk_length=6,
>>>     output_chunk_length=6,
>>>     num_blocks=2,
>>>     n_epochs=5,
>>> )
>>> model.fit(target, past_covariates=past_cov)
>>> pred = model.predict(6)
>>> pred.values()
array([[958.2354389 ],
       [939.23201079],
       [987.51425784],
       [919.41209025],
       [925.09583093],
       [938.95625528]])

属性

considers_static_covariates	如果存在静态协变量，模型是否考虑它们。
extreme_lags	一个包含以下顺序的 8 元组：（最小目标滞后，最大目标滞后，最小过去协变量滞后，最大过去协变量滞后，最小未来协变量滞后，最大未来协变量滞后，输出偏移，最大目标训练滞后（仅限 RNNModel））。
likelihood	返回模型用于概率预测的似然（如果存在）。
min_train_samples	训练模型所需的最小样本数量。
output_chunk_length	模型一次预测的时间步长数量，未为统计模型定义。
output_chunk_shift	输出/预测在输入结束之后开始的时间步长数量。
supports_likelihood_parameter_prediction	模型实例是否支持直接预测似然参数
supports_multivariate	模型是否考虑时间序列中的多个变量。
supports_optimized_historical_forecasts	模型是否支持优化的历史预测
supports_past_covariates	模型是否支持过去协变量
supports_probabilistic_prediction	检查具有此配置的预测模型是否支持概率预测。
supports_sample_weight	模型是否支持训练样本权重。
supports_static_covariates	模型是否支持静态协变量
supports_transferable_series_prediction	模型是否支持对任何输入 series 进行预测。
uses_future_covariates	模型拟合后是否使用未来协变量。
uses_past_covariates	模型拟合后是否使用过去协变量。
uses_static_covariates	模型拟合后是否使用静态协变量。

epochs_trained
input_chunk_length
model_created
model_params

方法

backtest(series[, past_covariates, ...])	计算模型对（潜在的多个）series 进行历史预测所产生的误差值。
fit(series[, past_covariates, ...])	在单个或多个 series 上拟合/训练模型。
fit_from_dataset(train_dataset[, ...])	使用特定的 darts.utils.data.TrainingDataset 实例训练模型。
generate_fit_encodings(series[, ...])	生成用于拟合模型的协变量编码，并返回一个元组，其中包含原始协变量和编码协变量堆叠在一起的过去和未来协变量序列。
generate_fit_predict_encodings(n, series[, ...])	生成用于训练和推理/预测的协变量编码，并返回一个元组，其中包含原始协变量和编码协变量堆叠在一起的过去和未来协变量序列。
generate_predict_encodings(n, series[, ...])	生成用于推理/预测集的协变量编码，并返回一个元组，其中包含原始协变量和编码协变量堆叠在一起的过去和未来协变量序列。
gridsearch(parameters, series[, ...])	使用网格搜索在给定集合中找到最佳超参数。
historical_forecasts(series[, ...])	通过模拟在提供的（潜在的多个）series 的整个历史中不同时间点的预测来生成历史预测。
load(path[, pl_trainer_kwargs])	从给定文件路径加载模型。
load_from_checkpoint(model_name[, work_dir, ...])	从 '{work_dir}/darts_logs/{model_name}/checkpoints/' 下自动保存的检查点加载模型。
load_weights(path[, load_encoders, skip_checks])	从手动保存的模型（使用 save() 保存）加载权重。
load_weights_from_checkpoint([model_name, ...])	仅从 '{work_dir}/darts_logs/{model_name}/ checkpoints/' 下自动保存的检查点加载权重。
lr_find(series[, past_covariates, ...])	PyTorch Lightning 的 Tuner.lr_find() 的封装。
predict(n[, series, past_covariates, ...])	预测训练 series 结束或指定 series 结束后的 n 个时间步。
predict_from_dataset(n, input_series_dataset)	此方法允许使用特定的 darts.utils.data.InferenceDataset 实例进行预测。
reset_model()	重置模型对象并移除所有存储的数据 - 模型、检查点、日志记录器和训练历史。
residuals(series[, past_covariates, ...])	计算模型对（潜在的多个）series 进行历史预测所产生的残差。
save([path, clean])	将模型保存到给定路径下。
to_cpu()	更新 PyTorch Lightning Trainer 参数，以便下次调用 :fun:`fit()` 或 predict() 时将模型移动到 CPU。
to_onnx([path])	将模型导出为 ONNX 格式以优化推理，这是 PyTorch Lightning 的 torch.onnx.export() 方法的封装（官方文档）。
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 进一步定制（例如，控制组件、时间步、多个 series 的聚合，以及分位数指标所需的其他参数，如 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：当 Callable 返回 True 时重新训练模型。Callable 必须具有以下位置参数

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

  • pred_time (pd.Timestamp or int)：预测时间的时间戳（训练 series 的结束时间）

  • train_series (TimeSeries)：截至 pred_time 的训练 series

  • past_covariates (TimeSeries)：截至 pred_time 的 past_covariates series

  • future_covariates (TimeSeries)：截至 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的 future_covariates series

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

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

• 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 指标（请参阅 here），或者是一个自定义指标，其签名与 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 的参数而不是目标。仅支持具有 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（可能的键：“series”, “past_covariates”, “future_covariates”）。如果提供，所有输入 series 必须在未转换空间中。对于可拟合的转换器/管道

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

  • 如果 retrain=False，数据转换器在所有预测之前一次性转换 series。

  拟合好的转换器在训练和预测期间用于转换输入。如果转换是可逆的，预测将进行逆转换。仅当 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 只有一个组件/列，则权重全局应用于 series 中的所有组件。否则，对于特定组件的权重，组件数量必须与 series 的组件数量匹配。如果是一个字符串，则使用内置权重函数生成权重。可用选项是“线性”或“指数”衰减 - 过去的时间越远，权重越低。权重按每个时间序列计算。

返回类型

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

返回值

• float – 单个单变量/多变量 series、单个 metric 函数以及

  • 使用 last_points_only=True 生成的 historical_forecasts 的单个回测分数

  • 使用 last_points_only=False 并使用回测 reduction 生成的 historical_forecasts 的单个回测分数

• np.ndarray – 回测分数的 numpy 数组。适用于单个 series 和以下情况之一

  • 单个 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，包括 series_reduction，并且对于“每时间步指标”，component_reduction=None 或 time_reduction=None 至少有一个。

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

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

property considers_static_covariates: bool

如果存在静态协变量，模型是否考虑它们。

返回类型

bool

property epochs_trained: int

返回类型

int

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

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

请参阅下面的示例。

如果模型未拟合

• target（仅涉及 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, trainer=None, verbose=None, epochs=0, max_samples_per_ts=None, dataloader_kwargs=None, sample_weight=None, val_sample_weight=None)

在单个或多个 series 上拟合/训练模型。

此方法封装了 fit_from_dataset()，为该模型构建默认训练数据集。如果您需要更多控制如何切片 series 进行训练，请考虑使用自定义的 darts.utils.data.TrainingDataset 调用 fit_from_dataset()。

训练使用 PyTorch Lightning Trainer 进行。它使用预设和模型创建时使用的 pl_trainer_kwargs 中的默认 Trainer 对象。您也可以使用可选参数 trainer 使用自定义 Trainer。有关 PyTorch Lightning Trainers 的更多信息，请查看 此链接 。

此函数可以多次调用以进行额外训练。如果 epochs 是指定的，模型将训练一些（额外）epochs 轮。

下面记录了所有可能的参数，但并非所有模型都支持所有参数。例如，所有 PastCovariatesTorchModel 仅支持 past_covariates 而不支持 future_covariates。如果您尝试使用错误的协变量参数拟合模型，Darts 会报错。

处理协变量时，Darts 会尝试使用目标和协变量的时间轴来确定正确的时间切片。因此，协变量可能比需要的更长；只要时间轴正确，Darts 就会正确处理它们。如果它们的时跨不足，Darts 也会报错。

参数

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 用作目标（即模型将训练预测的内容）的一个或一系列 series

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

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

• val_series (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，一个或一系列验证目标 series，将用于在整个训练过程中计算验证损失并跟踪表现最佳的模型。

• val_past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，对应于验证 series 的过去协变量（必须与 covariates 匹配）

• val_future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，对应于验证 series 的未来协变量（必须与 covariates 匹配）

• val_sample_weight (Union[TimeSeries, Sequence[TimeSeries], str, None]) – 与 sample_weight 相同，但用于评估数据集。

• trainer (Optional[Trainer, None]) – 可选的自定义 PyTorch-Lightning Trainer 对象，用于执行训练。使用自定义的 trainer 将覆盖 Darts 的默认 trainer。

• verbose (Optional[bool, None]) – 是否打印进度。如果 pl_trainer_kwargs 中存在 ProgressBar 回调，则忽略此参数。

• epochs (int) – 如果指定，模型将额外训练 epochs 个周期，无论模型构造函数中提供了多少 n_epochs。

• max_samples_per_ts (Optional[int, None]) – 可选参数，指定每个时间序列使用的最大样本数。模型通过构建 (输入, 输出) 示例切片进行监督训练。对于长时间序列，这可能导致训练样本数量过大。此参数限制了每个时间序列的训练样本数量上限（仅使用每个序列的最新样本）。设置为 None 则不应用任何上限。

• dataloader_kwargs (Optional[dict[str, Any], None]) –

  可选参数，一个字典，包含用于创建训练和验证数据集的 PyTorch DataLoader 实例的关键字参数。有关 DataLoader 的更多信息，请查看 此链接。默认情况下，Darts 会配置参数（“batch_size”、“shuffle”、“drop_last”、“collate_fn”、“pin_memory”）以实现无缝预测。更改这些参数时应小心，以免出现意外行为。

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

• val_sample_weight – 与 sample_weight 相同，但用于评估数据集。

返回值

拟合后的模型。

返回类型

self

fit_from_dataset(train_dataset, val_dataset=None, trainer=None, verbose=None, epochs=0, dataloader_kwargs=None)

使用特定的 darts.utils.data.TrainingDataset 实例训练模型。这些数据集实现了 PyTorch Dataset，并指定如何切分目标和协变量用于训练。如果您不确定使用哪种训练数据集，可以考虑调用 fit() 代替，它将创建适合该模型的默认训练数据集。

训练由 PyTorch Lightning Trainer 执行。它使用预设和模型创建时使用的 pl_trainer_kwargs 中的默认 Trainer 对象。您也可以使用可选参数 trainer 指定自定义 Trainer。有关 PyTorch Lightning Trainer 的更多信息，请查看 此链接。

此函数可以多次调用以进行额外训练。如果 epochs 是指定的，模型将训练一些（额外）epochs 轮。

参数

• train_dataset (TrainingDataset) – 与此模型类型匹配的训练数据集（例如，对于 PastCovariatesTorchModel，使用 PastCovariatesTrainingDataset）。

• val_dataset (Optional[TrainingDataset, None]) – 与此模型类型匹配的训练数据集（例如，对于 :class:`PastCovariatesTorchModel`s，使用 PastCovariatesTrainingDataset），表示验证集（用于跟踪验证损失）。

• trainer (Optional[Trainer, None]) – 可选参数，一个自定义的 PyTorch-Lightning Trainer 对象，用于执行预测。使用自定义的 trainer 将覆盖 Darts 的默认 trainer。

• verbose (Optional[bool, None]) – 是否打印进度。如果 pl_trainer_kwargs 中存在 ProgressBar 回调，则忽略此参数。

• epochs (int) – 如果指定，模型将额外训练 epochs 个周期，无论模型构造函数中提供了多少 n_epochs。

• dataloader_kwargs (Optional[dict[str, Any], None]) –

  可选参数，一个字典，包含用于创建训练和验证数据集的 PyTorch DataLoader 实例的关键字参数。有关 DataLoader 的更多信息，请查看 此链接。默认情况下，Darts 会配置参数（“batch_size”、“shuffle”、“drop_last”、“collate_fn”、“pin_memory”）以实现无缝预测。更改这些参数时应小心，以免出现意外行为。

返回值

拟合后的模型。

返回类型

self

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

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 种操作模式：扩展窗口模式、分割模式和拟合值模式。这三种操作模式通过使用参数字典 parameters 中提供的每个超参数值组合来实例化 ForecastingModel 的 model_class 子类，并返回关于 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]) – 在分割模式中用于验证的 TimeSeries 实例。如果提供，此序列必须紧接在 series 结束之后开始，以便进行适当的预测比较。

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

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

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

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

• verbose – 是否打印进度。

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

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

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

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

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

  • 如果 retrain=False，数据转换器在所有预测之前一次性转换 series。

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

• 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：当 Callable 返回 True 时重新训练模型。Callable 必须具有以下位置参数

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

  • pred_time (pd.Timestamp or int)：预测时间的时间戳（训练 series 的结束时间）

  • train_series (TimeSeries)：截至 pred_time 的训练 series

  • past_covariates (TimeSeries)：截至 pred_time 的 past_covariates series

  • future_covariates (TimeSeries)：截至 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的 future_covariates series

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

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

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

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

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

• predict_likelihood_parameters (bool) – 如果设置为 True，模型预测其 likelihood 的参数而不是目标。仅支持具有 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（可能的键：“series”, “past_covariates”, “future_covariates”）。如果提供，所有输入 series 必须在未转换空间中。对于可拟合的转换器/管道

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

  • 如果 retrain=False，数据转换器在所有预测之前一次性转换 series。

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

• 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 只有一个组件/列，则权重全局应用于 series 中的所有组件。否则，对于特定组件的权重，组件数量必须与 series 的组件数量匹配。如果是一个字符串，则使用内置权重函数生成权重。可用选项是“线性”或“指数”衰减 - 过去的时间越远，权重越低。权重按每个时间序列计算。

返回类型

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

返回值

• TimeSeries – 单个 series 且 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 input_chunk_length: int

返回类型

int

property likelihood: Optional[TorchLikelihood]

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

返回类型

Optional[TorchLikelihood, None]

static load(path, pl_trainer_kwargs=None, **kwargs)

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

从 RNNModel 加载通用保存的示例

from darts.models import RNNModel

model_loaded = RNNModel.load(path)

将训练在 CPU 上的 RNNModel 加载到 GPU 的示例

from darts.models import RNNModel

model_loaded = RNNModel.load(path, pl_trainer_kwargs={"accelerator": "gpu"})

将保存在 GPU 上的 RNNModel 加载到 CPU 的示例

from darts.models import RNNModel

model_loaded = RNNModel.load(path, map_location="cpu", pl_trainer_kwargs={"accelerator": "gpu"})

参数

• path (str) – 从中加载模型的路径。如果保存模型时未指定路径，则必须提供以“.pt”结尾的自动生成的路径。

• pl_trainer_kwargs (Optional[dict, None]) – 可选参数，一组用于创建新 Lightning Trainer 的 kwargs，用于配置模型以进行下游任务（例如预测）。例如，指定批量大小或将模型移动到 CPU/GPU(s)。有关支持的 kwargs 的更多信息，请查看 Lightning Trainer 文档。

• **kwargs –

  PyTorch Lightning LightningModule.load_from_checkpoint() 方法的附加 kwargs，例如 map_location 用于将模型加载到与保存时不同的设备上。更多信息请阅读官方文档。

返回类型

TorchForecastingModel

static load_from_checkpoint(model_name, work_dir=None, file_name=None, best=True, **kwargs)

从自动保存在 ‘{work_dir}/darts_logs/{model_name}/checkpoints/’ 下的检查点加载模型。此方法用于创建时设置了 save_checkpoints=True 的模型。

如果您手动保存了模型，请考虑使用 load()。

从检查点加载 RNNModel 的示例（model_name 是创建模型时使用的 model_name）

from darts.models import RNNModel

model_loaded = RNNModel.load_from_checkpoint(model_name, best=True)

如果提供了 file_name，则返回保存在 ‘{work_dir}/darts_logs/{model_name}/checkpoints/{file_name}’ 下的模型。

如果未提供 file_name，将尝试从 ‘{work_dir}/darts_logs/{model_name}/checkpoints/’ 恢复最佳检查点（如果 best 为 True）或最新检查点（如果 best 为 False）。

将保存在 GPU 上的 RNNModel 检查点加载到 CPU 的示例

from darts.models import RNNModel

model_loaded = RNNModel.load_from_checkpoint(model_name, best=True, map_location="cpu")
model_loaded.to_cpu()

参数

• model_name (str) – 模型名称，用于检索检查点文件夹的名称。

• work_dir (Optional[str, None]) – 工作目录（包含检查点文件夹）。默认为当前工作目录。

• file_name (Optional[str, None]) – 检查点文件名。如果未指定，则使用最新的文件。

• best (bool) – 如果设置，将检索最佳模型（根据验证损失）而不是最新模型。仅当给定 file_name 时忽略此参数。

• **kwargs –

  PyTorch Lightning LightningModule.load_from_checkpoint() 方法的附加 kwargs，例如 map_location 用于将模型加载到与保存时不同的设备上。更多信息请阅读官方文档。

返回值

相应的训练好的 TorchForecastingModel。

返回类型

TorchForecastingModel

load_weights(path, load_encoders=True, skip_checks=False, **kwargs)

从手动保存的模型（使用 save() 保存）加载权重。

注意：此方法需要能够访问 darts 模型检查点 (.pt) 文件，以便加载编码器并对模型参数执行健全性检查。

参数

• path (str) – 从中加载模型权重的路径。如果保存模型时未指定路径，则必须提供以“.pt”结尾的自动生成的路径。

• load_encoders (bool) – 如果设置，将从模型中加载编码器，以便能够直接调用 fit() 或 predict()。默认值：True。

• skip_checks (bool) – 如果设置，将禁用编码器的加载和模型参数的健全性检查（不建议）。不能与 load_encoders=True 一起使用。默认值：False。

• **kwargs –

  PyTorch load() 方法的附加 kwargs，例如 map_location 用于将模型加载到与保存时不同的设备上。更多信息请阅读官方文档。

load_weights_from_checkpoint(model_name=None, work_dir=None, file_name=None, best=True, strict=True, load_encoders=True, skip_checks=False, **kwargs)

仅从自动保存在 ‘{work_dir}/darts_logs/{model_name}/checkpoints/’ 下的检查点加载权重。此方法用于创建时设置了 save_checkpoints=True，并且需要使用不同的优化器或学习率调度器进行重新训练或微调的模型。但是，它也可以用于加载权重进行推理。

要恢复中断的训练，请考虑使用 load_from_checkpoint()，它也会重新加载 trainer、optimizer 和学习率调度器的状态。

对于手动保存的模型，请考虑使用 load() 或 load_weights() 代替。

注意：此方法需要能够访问 darts 模型检查点 (.pt) 文件，以便加载编码器并对模型参数执行健全性检查。

参数

• model_name (Optional[str, None]) – 模型名称，用于检索检查点文件夹的名称。默认值：self.model_name。

• work_dir (Optional[str, None]) – 工作目录（包含检查点文件夹）。默认为当前工作目录。

• file_name (Optional[str, None]) – 检查点文件名。如果未指定，则使用最新的文件。

• best (bool) – 如果设置，将检索最佳模型（根据验证损失）而不是最新模型。仅当给定 file_name 时忽略此参数。默认值：True。

• strict (bool) –

  如果设置，严格执行 state_dict 中的键与此模块的 state_dict() 返回的键匹配。默认值：True。更多信息请阅读官方文档。

• load_encoders (bool) – 如果设置，将从模型中加载编码器，以便能够直接调用 fit() 或 predict()。默认值：True。

• skip_checks (bool) – 如果设置，将禁用编码器的加载和模型参数的健全性检查（不建议）。不能与 load_encoders=True 一起使用。默认值：False。

• **kwargs –

  PyTorch load() 方法的附加 kwargs，例如 map_location 用于将模型加载到与保存时不同的设备上。更多信息请阅读官方文档。

lr_find(series, past_covariates=None, future_covariates=None, val_series=None, val_past_covariates=None, val_future_covariates=None, sample_weight=None, val_sample_weight=None, trainer=None, verbose=None, epochs=0, max_samples_per_ts=None, dataloader_kwargs=None, min_lr=1e-08, max_lr=1, num_training=100, mode='exponential', early_stop_threshold=4.0)

PyTorch Lightning Tuner.lr_find() 的包装器。对合适的初始学习率进行范围测试，以减少选择良好起始学习率的猜测量。有关 PyTorch Lightning Tuner 的更多信息，请查看此链接。如果调优器未给出令人满意的结果，建议增加 epochs 的数量。考虑使用建议的学习率创建新的模型对象，例如使用模型创建参数 optimizer_cls、optimizer_kwargs、lr_scheduler_cls 和 lr_scheduler_kwargs。

使用 RNNModel 的示例

import torch
from darts.datasets import AirPassengersDataset
from darts.models import NBEATSModel

series = AirPassengersDataset().load()
train, val = series[:-18], series[-18:]
model = NBEATSModel(input_chunk_length=12, output_chunk_length=6, random_state=42)
# run the learning rate tuner
results = model.lr_find(series=train, val_series=val)
# plot the results
results.plot(suggest=True, show=True)
# create a new model with the suggested learning rate
model = NBEATSModel(
    input_chunk_length=12,
    output_chunk_length=6,
    random_state=42,
    optimizer_cls=torch.optim.Adam,
    optimizer_kwargs={"lr": results.suggestion()}
)

参数

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 用作目标（即模型将训练预测的内容）的一个或一系列 series

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

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

• val_series (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，一个或一系列验证目标 series，将用于在整个训练过程中计算验证损失并跟踪表现最佳的模型。

• val_past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，对应于验证 series 的过去协变量（必须与 covariates 匹配）

• val_future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，对应于验证 series 的未来协变量（必须与 covariates 匹配）

• 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 相同，但用于评估数据集。

• trainer (Optional[Trainer, None]) – 可选的自定义 PyTorch-Lightning Trainer 对象，用于执行训练。使用自定义的 trainer 将覆盖 Darts 的默认 trainer。

• verbose (Optional[bool, None]) – 是否打印进度。如果 pl_trainer_kwargs 中存在 ProgressBar 回调，则忽略此参数。

• epochs (int) – 如果指定，模型将额外训练 epochs 个周期，无论模型构造函数中提供了多少 n_epochs。

• max_samples_per_ts (Optional[int, None]) – 可选参数，指定每个时间序列使用的最大样本数。模型通过构建 (输入, 输出) 示例切片进行监督训练。对于长时间序列，这可能导致训练样本数量过大。此参数限制了每个时间序列的训练样本数量上限（仅使用每个序列的最新样本）。设置为 None 则不应用任何上限。

• dataloader_kwargs (Optional[dict[str, Any], None]) –

  可选参数，一个字典，包含用于创建训练和验证数据集的 PyTorch DataLoader 实例的关键字参数。有关 DataLoader 的更多信息，请查看 此链接。默认情况下，Darts 会配置参数（“batch_size”、“shuffle”、“drop_last”、“collate_fn”、“pin_memory”）以实现无缝预测。更改这些参数时应小心，以免出现意外行为。

• min_lr (float) – 要考察的最小学习率

• max_lr (float) – 要考察的最大学习率

• num_training (int) – 要测试的学习率数量

• mode (str) – 每批更新学习率的搜索策略：‘exponential’：指数增加学习率。‘linear’：线性增加学习率。

• early_stop_threshold (float) – 停止搜索的阈值。如果任何一点的损失大于 early_stop_threshold * best_loss，则停止搜索。要禁用，请设置为 None

返回值

包含 LR 扫描结果的 Lightning 的 _LRFinder 对象。

返回类型

lr_finder

property min_train_samples: int

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

返回类型

int

property model_created: bool

返回类型

bool

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, trainer=None, batch_size=None, verbose=None, n_jobs=1, roll_size=None, num_samples=1, dataloader_kwargs=None, mc_dropout=False, predict_likelihood_parameters=False, show_warnings=True)

预测训练 series 结束或指定 series 结束后的 n 个时间步。

预测通过 PyTorch Lightning Trainer 执行。它使用预设的默认 Trainer 对象以及模型创建时使用的 pl_trainer_kwargs。您也可以使用可选参数 trainer 自定义 Trainer。更多关于 PyTorch Lightning Trainer 的信息请查看 此链接。

下面列出了所有可能的参数，但并非所有模型都支持所有参数。例如，所有 PastCovariatesTorchModel 只支持 past_covariates 而不支持 future_covariates。如果在调用 predict() 时对模型使用了错误的协变量参数，Darts 会报错。

如果提供的协变量时间跨度不足，Darts 也会报错。通常，并非所有模型都需要相同的协变量时间跨度。

• 依赖过去协变量的模型要求在预测时已知 past_covariates 的最后 input_chunk_length 个点。

  对于预测范围值 n > output_chunk_length，这些模型还要求至少已知接下来 n - output_chunk_length 个未来值。

  同样。
• 依赖未来协变量的模型要求已知接下来 n 个值。

  此外（对于 DualCovariatesTorchModel 和 MixedCovariatesTorchModel），它们还

  要求这些未来协变量的“历史”值（跨越过去的 input_chunk_length）。

处理协变量时，Darts 会尝试使用目标和协变量的时间轴来确定正确的时间切片。因此，协变量可能比需要的更长；只要时间轴正确，Darts 就会正确处理它们。如果它们的时跨不足，Darts 也会报错。

参数

• n (int) – 训练时间序列结束后，需要生成预测的时间步长数量。

• series (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，表示目标时间序列的历史数据，用于预测其未来。如果指定，该方法返回这些时间序列的预测结果。否则，该方法返回（单个）训练时间序列的预测结果。

• past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，模型所需的过去观测协变量时间序列。它们必须与训练时使用的协变量在维度上匹配。

• future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，模型所需的未来已知协变量时间序列。它们必须与训练时使用的协变量在维度上匹配。

• trainer (Optional[Trainer, None]) – 可选参数，用于执行预测的自定义 PyTorch-Lightning Trainer 对象。使用自定义 trainer 将覆盖 Darts 的默认 trainer。

• batch_size (Optional[int, None]) – 预测期间的批处理大小。默认为模型训练时使用的 batch_size 值。

• verbose (Optional[bool, None]) – 是否打印进度。如果 pl_trainer_kwargs 中存在 ProgressBar 回调，则忽略此参数。

• n_jobs (int) – 并行运行的作业数量。-1 表示使用所有处理器。默认为 1。

• roll_size (Optional[int, None]) – 对于自消耗预测，即 n > output_chunk_length，确定每次将预测的目标（以及可选的未来协变量）反馈到模型时，模型有多少输出被反馈。如果未提供此参数，则默认设置为 output_chunk_length。

• num_samples (int) – 从概率模型中采样预测的次数。对于确定性模型，必须为 1。

• dataloader_kwargs (Optional[dict[str, Any], None]) –

  dataloader_kwargs (Optional[dict[str, Any], None]) – 可选参数，用于创建推理/预测数据集的 PyTorch DataLoader 实例的关键字参数字典。更多关于 DataLoader 的信息请查看 此链接。默认情况下，Darts 为参数（“batch_size”、“shuffle”、“drop_last”、“collate_fn”、“pin_memory”）进行配置，以实现无缝预测。更改它们时应谨慎，以避免意外行为。

• mc_dropout (bool) – 可选参数，对于基于神经网络的模型，启用蒙特卡洛 dropout 进行预测。通过指定学习到的模型的隐式先验，这允许进行贝叶斯近似。

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

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

返回值

一个或多个时间序列，包含对 series 的预测，如果未指定 series 且模型在单个时间序列上训练，则包含对训练时间序列的预测。

返回类型

Union[TimeSeries, Sequence[TimeSeries]]

predict_from_dataset(n, input_series_dataset, trainer=None, batch_size=None, verbose=None, n_jobs=1, roll_size=None, num_samples=1, dataloader_kwargs=None, mc_dropout=False, predict_likelihood_parameters=False)

此方法允许使用特定的 darts.utils.data.InferenceDataset 实例进行预测。这些数据集实现了 PyTorch Dataset，并指定如何为推理切分目标和协变量。在大多数情况下，您会更希望调用 predict() 方法，它会为您创建一个适当的 InferenceDataset。

预测通过 PyTorch Lightning Trainer 执行。它使用预设的默认 Trainer 对象以及模型创建时使用的 pl_trainer_kwargs。您也可以使用可选参数 trainer 自定义 Trainer。更多关于 PyTorch Lightning Trainer 的信息请查看 此链接。

参数

• n (int) – 训练时间序列结束后，需要生成预测的时间步长数量。

• input_series_dataset (InferenceDataset) – 可选参数，表示目标时间序列历史数据的一个序列或多个序列，用于预测其未来。如果指定，该方法返回这些序列的预测结果。否则，该方法返回（单个）训练序列的预测结果。

• trainer (Optional[Trainer, None]) – 可选参数，用于执行预测的自定义 PyTorch-Lightning Trainer 对象。使用自定义 trainer 将覆盖 Darts 的默认 trainer。

• batch_size (Optional[int, None]) – 预测期间的批处理大小。默认为模型的 batch_size 值。

• verbose (Optional[bool, None]) – 是否打印进度。如果 pl_trainer_kwargs 中存在 ProgressBar 回调，则忽略此参数。

• n_jobs (int) – 并行运行的作业数量。-1 表示使用所有处理器。默认为 1。

• roll_size (Optional[int, None]) – 对于自消耗预测，即 n > output_chunk_length，确定每次将预测的目标（以及可选的未来协变量）反馈到模型时，模型有多少输出被反馈。如果未提供此参数，则默认设置为 output_chunk_length。

• num_samples (int) – 从概率模型中采样预测的次数。对于确定性模型，必须为 1。

• dataloader_kwargs (Optional[dict[str, Any], None]) –

  dataloader_kwargs (Optional[dict[str, Any], None]) – 可选参数，用于创建推理/预测数据集的 PyTorch DataLoader 实例的关键字参数字典。更多关于 DataLoader 的信息请查看 此链接。默认情况下，Darts 为参数（“batch_size”、“shuffle”、“drop_last”、“collate_fn”、“pin_memory”）进行配置，以实现无缝预测。更改它们时应谨慎，以避免意外行为。

• mc_dropout (bool) – 可选参数，对于基于神经网络的模型，启用蒙特卡洛 dropout 进行预测。通过指定学习到的模型的隐式先验，这允许进行贝叶斯近似。

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

返回值

返回一个或多个时间序列的预测结果。

返回类型

Sequence[TimeSeries]

reset_model()

重置模型对象并移除所有存储的数据 - 模型、检查点、日志记录器和训练历史。

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：当 Callable 返回 True 时重新训练模型。Callable 必须具有以下位置参数

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

  • pred_time (pd.Timestamp or int)：预测时间的时间戳（训练 series 的结束时间）

  • train_series (TimeSeries)：截至 pred_time 的训练 series

  • past_covariates (TimeSeries)：截至 pred_time 的 past_covariates series

  • future_covariates (TimeSeries)：截至 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的 future_covariates series

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

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

• 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 的参数而不是目标。仅支持具有 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（可能的键：“series”, “past_covariates”, “future_covariates”）。如果提供，所有输入 series 必须在未转换空间中。对于可拟合的转换器/管道

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

  • 如果 retrain=False，数据转换器在所有预测之前一次性转换 series。

  拟合好的转换器在训练和预测期间用于转换输入。如果转换是可逆的，预测将进行逆转换。仅当 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 只有一个组件/列，则权重全局应用于 series 中的所有组件。否则，对于特定组件的权重，组件数量必须与 series 的组件数量匹配。如果是一个字符串，则使用内置权重函数生成权重。可用选项是“线性”或“指数”衰减 - 过去的时间越远，权重越低。权重按每个时间序列计算。

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

返回类型

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

返回值

• TimeSeries – 对于单个 series 和使用 last_points_only=True 生成的 historical_forecasts，返回残差 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)

将模型保存到给定路径下。

在 path 下创建两个文件（模型对象）和 path.ckpt（检查点）。

注意：使用自定义类保存模型时可能会发生 Pickle 错误。在这种情况下，考虑使用 clean 标志从保存的模型中剥离训练相关的属性。

保存和加载 RNNModel 的示例

from darts.models import RNNModel

model = RNNModel(input_chunk_length=4)

model.save("my_model.pt")
model_loaded = RNNModel.load("my_model.pt")

参数

• path (Optional[str, None]) – 保存模型当前状态的路径。请避免路径以“last-”或“best-”开头，以避免与 Pytorch-Ligthning 检查点冲突。如果未指定路径，模型会自动保存在 "{ModelClass}_{YYYY-mm-dd_HH_MM_SS}.pt" 下。例如，"RNNModel_2020-01-01_12_00_00.pt"。

• clean (bool) –

  是否存储模型的清理版本。如果为 True，则移除训练时间序列和协变量。此外，移除所有与 Lightning Trainer 相关的参数（在模型创建时通过 pl_trainer_kwargs 传递）。

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

返回类型

None

supports_future_covariates = False

property supports_likelihood_parameter_prediction: bool

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

返回类型

bool

property supports_multivariate: bool

模型是否考虑时间序列中的多个变量。

返回类型

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

to_cpu()

更新 PyTorch Lightning Trainer 参数，以便下次调用 :fun:`fit()` 或 predict() 时将模型移动到 CPU。

to_onnx(path=None, **kwargs)

将模型导出为 ONNX 格式以进行优化推理，它封装了 PyTorch Lightning 的 torch.onnx.export() 方法（官方文档）。

注意：需要安装 onnx 库（可选依赖）。

导出 DLinearModel 的示例

from darts.datasets import AirPassengersDataset
from darts.models import DLinearModel

series = AirPassengersDataset().load()
model = DLinearModel(input_chunk_length=4, output_chunk_length=1)
model.fit(series, epochs=1)
model.to_onnx("my_model.onnx")

参数

• path (Optional[str, None]) – 保存模型当前状态的路径。如果未指定路径，模型会自动保存在 "{ModelClass}_{YYYY-mm-dd_HH_MM_SS}.onnx" 下。

• **kwargs –

  传递给 PyTorch 的 torch.onnx.export() 方法的额外关键字参数（除了参数 file_path、input_sample、input_name）。更多信息请阅读官方文档。

untrained_model()

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

property uses_future_covariates: bool

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

返回类型

bool

property uses_past_covariates: bool

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

返回类型

bool

property uses_static_covariates: bool

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

返回类型

bool

上一页

N-BEATS

下一页

N-Linear