D-Linear

class darts.models.forecasting.dlinear.DLinearModel(input_chunk_length, output_chunk_length, output_chunk_shift=0, shared_weights=False, kernel_size=25, const_init=True, use_static_covariates=True, **kwargs)

基类: MixedCovariatesTorchModel

DLinear 模型的实现，如 [1] 中所述。

此实现通过允许可选使用过去协变量（在预测时间前 input_chunk_length 点已知）、未来协变量（在预测时间后 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）。

• shared_weights (bool) –

  是否对多元序列的所有分量使用共享权重。

  警告

  设置为 True 时，协变量将被忽略，因为输入维度和输出维度之间需要一对一的映射。

  默认值: False。

• kernel_size (int) – 移动平均的核大小（默认值=25）。如果核大小是偶数，则填充将是不对称的（开始/左侧较短）。

• const_init (bool) – 是否将权重初始化为 1/in_len。如果为 False，则使用默认的 PyTorch 初始化（默认值='True'）。

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

• **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 – 训练模型所需的 epoch 数。默认值: 100。

• model_name – 模型的名称。用于创建检查点和保存 tensorboard 数据。如果未指定，则默认为字符串 "YYYY-mm-dd_HH_MM_SS_torch_model_run_PID"，其中名称的初始部分格式化为本地日期和时间，而 PID 是进程 ID（防止不同进程同时生成的模型共享相同的模型名称）。例如，"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 – 评估验证损失之前等待的 epoch 数（如果将验证 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 – 控制权重初始化的随机性。有关更多详细信息，请查看此链接。默认值: None。

• pl_trainer_kwargs –

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

  • {"accelerator": "cpu"} 用于 CPU，

  • {"accelerator": "gpu", "devices": [i]} 仅使用 GPU i（i 必须是整数），

  • {"accelerator": "gpu", "devices": -1, "auto_select_gpus": True} 使用所有可用的 GPU。

  有关更多信息，请参阅此处：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]}
  

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

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

参考文献

1

Zeng, A., Chen, M., Zhang, L., & Xu, Q. (2022). Transformer 对时序预测有效吗？(Are Transformers Effective for Time Series Forecasting?). arXiv 预印本 arXiv:2205.13504。

2

T. Kim 等人。“用于对抗分布偏移的精确时序预测的可逆实例归一化 (Reversible Instance Normalization for Accurate Time-Series Forecasting against Distribution Shift)”，https://openreview.net/forum?id=cGDAkQo1C0p

示例

>>> from darts.datasets import WeatherDataset
>>> from darts.models import DLinearModel
>>> 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 = DLinearModel(
>>>     input_chunk_length=6,
>>>     output_chunk_length=6,
>>>     n_epochs=20,
>>> )
>>> model.fit(target, past_covariates=past_cov, future_covariates=future_cov)
>>> pred = model.predict(6)
>>> pred.values()
array([[667.20957388],
       [666.76986848],
       [666.67733306],
       [666.06625381],
       [665.8529289 ],
       [665.75320573]])

注意

此简单的用法示例会产生较差的预测。为了获得更好的性能，用户应转换输入数据、增加 epoch 数、使用验证集、优化超参数等。

属性

considers_static_covariates	模型是否考虑静态协变量（如果存在）。
extreme_lags	一个包含以下顺序的 8 元组：（最小目标滞后、最大目标滞后、最小过去协变量滞后、最大过去协变量滞后、最小未来协变量滞后、最大未来协变量滞后、输出偏移、最大目标训练滞后（仅适用于 RNNModel））。
likelihood	返回模型用于概率预测的似然（如果存在）。
min_train_samples	训练模型所需的最小样本数。
output_chunk_length	模型一次预测的时间步数，对于统计模型未定义。
output_chunk_shift	输出/预测开始于输入结束后的时间步数。
supports_future_covariates	模型是否支持未来协变量
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, ...])	在单个或多个序列上拟合/训练模型。
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 结束后的 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 进一步定制（例如，控制分量、时间步、多个序列上的聚合，以及其他必需参数，例如分位数指标的 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'。

  注意：如果 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): 预测时间（训练序列结束）的时间戳

  • train_series (TimeSeries): 直至 pred_time 的训练序列

  • past_covariates (TimeSeries): 直至 pred_time 的过去协变量序列

  • future_covariates (TimeSeries): 直至 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的未来协变量序列

  注意: 如果任何可选的 *_covariates 未传递给 historical_forecast，则将向相应的 retrain 函数参数传递 None。注意: 某些模型需要每次都重新训练，不支持除 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” 衰减——过去越远，权重越低。权重按每个时序计算。

返回类型

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（用于“按时间步计算的指标”）。

  • 多个单变量/多变量序列，包括 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

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

返回类型

布尔值

property epochs_trained: int

返回类型

整数

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, trainer=None, verbose=None, epochs=0, max_samples_per_ts=None, dataloader_kwargs=None, sample_weight=None, val_sample_weight=None)

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

此方法包装了 fit_from_dataset()，为该模型构建了一个默认的训练数据集。如果您需要更精细地控制用于训练的序列切片方式，请考虑使用自定义的 darts.utils.data.TrainingDataset 调用 fit_from_dataset()。

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

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

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

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

参数

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

• past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，指定过去已知协变量的序列或序列列表

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

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

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

• val_future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，与验证序列对应的未来协变量（必须与 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 Trainers 的更多信息，请查看 此链接。

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

参数

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

• val_dataset (Optional[TrainingDataset, None]) – 与此模型类型匹配的训练数据集（例如，PastCovariatesTorchModel 的 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 种操作模式：扩展窗口模式、分割模式和拟合值模式。这三种操作模式通过实例化带有每个组合的 model_class（ForecastingModel 的子类），并返回关于 metric 函数表现最佳的模型，来评估 parameters 字典中提供的超参数值的每种可能的组合。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 为 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'。

  注意：如果 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”、“past_covariates”、“future_covariates”）。如果提供，所有输入序列必须位于未转换空间中。对于可拟合转换器/管道：

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

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

  拟合好的 transformer 用于在训练和预测期间转换输入。如果转换是可逆的，预测将被反向转换。

• 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'。

  注意：如果 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): 预测时间（训练序列结束）的时间戳

  • train_series (TimeSeries): 直至 pred_time 的训练序列

  • past_covariates (TimeSeries): 直至 pred_time 的过去协变量序列

  • future_covariates (TimeSeries): 直至 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的未来协变量序列

  注意: 如果任何可选的 *_covariates 未传递给 historical_forecast，则将向相应的 retrain 函数参数传递 None。注意: 某些模型需要每次都重新训练，不支持除 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，数据转换器在所有预测之前一次性转换序列。

  拟合好的 transformer 用于在训练和预测期间转换输入。如果转换是可逆的，预测将被反向转换。

• 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” 衰减——过去越远，权重越低。权重按每个时序计算。

返回类型

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

返回类型

整数

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 的关键字参数，以配置模型进行下游任务（例如预测）。一些示例包括指定批次大小或将模型移动到 CPU/GPU。有关支持的关键字参数的更多信息，请查看 Lightning Trainer 文档。

• **kwargs –

  PyTorch Lightning 的 LightningModule.load_from_checkpoint() 方法的额外关键字参数，例如 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() 方法的额外关键字参数，例如 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() 方法的额外关键字参数，例如 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、优化器和学习率调度器的状态。

对于手动保存的模型，请考虑改用 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() 方法的额外关键字参数，例如 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 的更多信息，请查看此链接。如果 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]]) – 用作目标（即模型将被训练来预测的内容）的序列或序列的序列

• past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，指定过去已知协变量的序列或序列列表

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

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

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

• val_future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，与验证序列对应的未来协变量（必须与 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

返回

Lightning 的 _LRFinder 对象，包含学习率扫描的结果。

返回类型

lr_finder

property min_train_samples: int

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

返回类型

整数

property model_created: bool

返回类型

布尔值

property model_params: dict

返回类型

字典

property output_chunk_length: int

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

返回类型

整数

property output_chunk_shift: 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 结束后的 n 个时间步。

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

下面记录了所有可能的参数，但并非所有模型都支持所有参数。例如，所有 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]) –

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

• mc_dropout (bool) – 可选参数，为基于神经网络的模型启用 Monte Carlo dropout 进行预测。通过指定学习模型的隐式先验，可以实现贝叶斯近似。

• predict_likelihood_parameters (bool) – 如果设置为 True，则模型预测其 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 执行。它使用预设和模型创建时使用的 pl_trainer_kwargs 中的默认 Trainer 对象。您也可以使用带可选参数 trainer 的自定义 Trainer。有关 PyTorch Lightning Trainers 的更多信息，请查看此链接。

参数

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

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

• mc_dropout (bool) – 可选参数，为基于神经网络的模型启用 Monte Carlo 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'。

  注意：如果 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): 预测时间（训练序列结束）的时间戳

  • train_series (TimeSeries): 直至 pred_time 的训练序列

  • past_covariates (TimeSeries): 直至 pred_time 的过去协变量序列

  • future_covariates (TimeSeries): 直至 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的未来协变量序列

  注意: 如果任何可选的 *_covariates 未传递给 historical_forecast，则将向相应的 retrain 函数参数传递 None。注意: 某些模型需要每次都重新训练，不支持除 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' 等。仅当参数存在于相应的指标签名中时才会传递。忽略reduction参数 “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” 衰减——过去越远，权重越低。权重按每个时序计算。

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

返回类型

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

返回

• TimeSeries – 单个 series 的残差 TimeSeries，以及使用 last_points_only=True 生成的 historical_forecasts。

• List[TimeSeries] – 对于使用 last_points_only=True 的序列（列表）series，返回残差 TimeSeries 的列表。残差列表的长度为 len(series)。

• List[List[TimeSeries]] – 对于使用 last_points_only=False 的序列 series，返回残差 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-Lightning 检查点冲突。如果未指定路径，模型将自动保存在 "{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。

返回类型

无

property supports_future_covariates: bool

模型是否支持未来协变量

返回类型

布尔值

property supports_likelihood_parameter_prediction: bool

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

返回类型

布尔值

property supports_multivariate: bool

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

返回类型

布尔值

property supports_optimized_historical_forecasts: bool

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

返回类型

布尔值

property supports_past_covariates: bool

模型是否支持过去协变量

返回类型

布尔值

property supports_probabilistic_prediction: bool

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

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

返回类型

布尔值

property supports_sample_weight: bool

模型是否支持训练样本权重。

返回类型

布尔值

property supports_static_covariates: bool

模型是否支持静态协变量

返回类型

布尔值

property supports_transferable_series_prediction: bool

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

返回类型

布尔值

to_cpu()

更新 PyTorch Lightning Trainer 参数，以便下次调用 `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

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

返回类型

布尔值

property uses_past_covariates: bool

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

返回类型

布尔值

property uses_static_covariates: bool

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

返回类型

布尔值

上一页

Conformal Models

下一页

<no title>