时间卷积网络

class darts.models.forecasting.tcn_model.TCNModel(input_chunk_length, output_chunk_length, output_chunk_shift=0, kernel_size=3, num_filters=3, num_layers=None, dilation_base=2, weight_norm=False, dropout=0.2, **kwargs)[source]

继承自: PastCovariatesTorchModel

时间卷积网络模型 (TCN)。

这是用于时间序列预测的一种膨胀 TCN 的实现，灵感来自 [1]。

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

参数

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

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

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

  • kernel_size (int) – 卷积层中每个核的大小。

  • num_filters (int) – TCN 卷积层中的滤波器数量。

  • weight_norm (bool) – 布尔值，指示是否使用权重归一化。

  • dilation_base (int) – 决定每个级别的膨胀的指数底数。

  • num_layers (Optional[int, None]) – 卷积层数量。

  • dropout (float) – 每个卷积层的 dropout 率。这与推断时用于模型不确定性估计的 Monte Carlo dropout 兼容（在预测时启用 mc_dropout=True）。

  • **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（防止不同进程同时生成的模型共享同一个 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 – 在评估验证损失之前等待的 epoch 数量（如果向 fit() 方法传递了验证 TimeSeries）。默认值: 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，该 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 字典中设置设备的一些示例:

    • {"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]}

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

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

参考

1

https://arxiv.org/abs/1803.01271

2

T. Kim et al. “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 TCNModel
>>> 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]
>>> # `output_chunk_length` must be strictly smaller than `input_chunk_length`
>>> model = TCNModel(
>>>     input_chunk_length=12,
>>>     output_chunk_length=6,
>>>     n_epochs=20,
>>> )
>>> model.fit(target, past_covariates=past_cov)
>>> pred = model.predict(6)
>>> pred.values()
array([[-80.48476824],
       [-80.47896667],
       [-41.77135603],
       [-41.76158729],
       [-41.76854107],
       [-41.78166819]])

注意

DeepTCN 示例 notebook 介绍了可用于改进预测质量的技术，相比于此简单使用示例。

属性

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

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

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 参数，以便在下次调用 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'。

    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 或 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，则将 None 传递给相应的 retrain 函数参数。注意: 某些模型需要每次都重新训练，并且不支持 retrain=True 之外的任何值。注意: 也控制 data_transformers 的重新训练。

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

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

    metric (Union[Callable[…, Union[float, list[float], ndarray, list[ndarray]]], list[Callable[…, Union[float, list[float], ndarray, list[ndarray]]]]]) – 一个指标函数或指标函数列表。每个指标必须是 Darts 指标（参见此处），或者是一个自定义指标，其签名与 Darts 指标完全相同，使用装饰器 multi_ts_support()，并返回指标得分。

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

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

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

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

  • enable_optimization (bool) – 当支持并可用时，是否使用优化的 historical_forecasts 版本。默认值: True。

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

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

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

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

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

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

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

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

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

  • 返回类型

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

  • 返回

float – 单个单变量/多变量序列、单个 metric 函数和

使用 last_points_only=True 生成的 historical_forecasts 的单一回测得分

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

  • np.ndarray – 一个 numpy 数组的回测得分。对于单个序列和其中之一:

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

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

  • 包括 series_reduction 和至少一个 component_reduction=None 或 time_reduction=None 的多个单变量/多变量序列，用于“每个时间步指标”

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

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

    • property considers_static_covariates: bool

  • bool

  • property epochs_trained: int

int

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

float – 单个单变量/多变量序列、单个 metric 函数和

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

一个 8 元组，按顺序包含：(最小目标滞后, 最大目标滞后, 最小过去协变量滞后, 最大过去协变量滞后, 最小未来协变量滞后, 最大未来协变量滞后, 输出偏移, 最大目标滞后训练 (仅适用于 RNNModel))。如果 0 是第一个预测的索引，则所有滞后都相对于此索引。
float – 单个单变量/多变量序列、单个 metric 函数和

参见下面的示例。

如果模型未拟合

目标 (仅关于 RegressionModels): 则第一个元素应为 None。

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

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

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

  • 注意

  • 最大目标滞后（第二个值）不能为 None 且总是大于或等于 0。

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

说明

最大目标滞后（第二个值）不能为 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)
float – 单个单变量/多变量序列、单个 metric 函数和

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 轮次的训练。

下文文档记录了所有可能的参数，但并非所有模型都支持所有参数。例如，所有 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 的默认训练器。

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

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

拟合好的模型。

float – 单个单变量/多变量序列、单个 metric 函数和

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 轮次的训练。

参数

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

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

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

  • 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"）以实现无缝预测。更改这些参数时应小心谨慎，以避免意外行为。

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

拟合好的模型。

float – 单个单变量/多变量序列、单个 metric 函数和

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]) – 可选的，拟合模型时使用的包含未来已知协变量的序列或序列列表。

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

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

float – 单个单变量/多变量序列、单个 metric 函数和

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]) – 可选的，打算用于预测的未来已知协变量序列。维度必须与训练时使用的协变量维度匹配。

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

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

float – 单个单变量/多变量序列、单个 metric 函数和

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]) – 可选的，打算用于预测的未来已知协变量序列。维度必须与训练时使用的协变量维度匹配。

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

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

float – 单个单变量/多变量序列、单个 metric 函数和

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 是一个 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]]) –

  • 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，此时将忽略随机选择。

  • 如果 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() 方法的一些附加参数。

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

  • 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” 衰减——越是过去的数据，权重越低。

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

一个元组，包含根据表现最佳的超参数创建的未训练的 model_class 实例，以及一个包含这些最佳超参数的字典，以及最佳超参数的指标得分。

float – 单个单变量/多变量序列、单个 metric 函数和

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 或 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，则将 None 传递给相应的 retrain 函数参数。注意: 某些模型需要每次都重新训练，并且不支持 retrain=True 之外的任何值。注意: 也控制 data_transformers 的重新训练。

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

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

    metric (Union[Callable[…, Union[float, list[float], ndarray, list[ndarray]]], list[Callable[…, Union[float, list[float], ndarray, list[ndarray]]]]]) – 一个指标函数或指标函数列表。每个指标必须是 Darts 指标（参见此处），或者是一个自定义指标，其签名与 Darts 指标完全相同，使用装饰器 multi_ts_support()，并返回指标得分。

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

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

  • 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() 方法的一些附加参数。

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

  • 返回类型

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

  • 返回

float – 单个单变量/多变量序列、单个 metric 函数和

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

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

  • TimeSeries – 对于单个 series 且 last_points_only=True 时的一个历史预测结果：它仅包含所有历史预测中，在 forecast_horizon 步的预测值。

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

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

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

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

property input_chunk_length: int
float – 单个单变量/多变量序列、单个 metric 函数和

参见下面的示例。

property likelihood: Optional[TorchLikelihood]

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

float – 单个单变量/多变量序列、单个 metric 函数和

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 用于将模型加载到与保存时不同的设备上。有关更多信息，请阅读官方文档。

float – 单个单变量/多变量序列、单个 metric 函数和

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 用于将模型加载到与保存时不同的设备上。有关更多信息，请阅读官方文档。

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

相应的已训练 TorchForecastingModel。

float – 单个单变量/多变量序列、单个 metric 函数和

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() 方法，它也会重新加载训练器、优化器和学习率调度器的状态。

对于手动保存的模型，请考虑使用 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 的更多信息，请查阅此链接。如果 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 的默认训练器。

  • 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

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

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

float – 单个单变量/多变量序列、单个 metric 函数和

lr_finder

property min_train_samples: int

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

float – 单个单变量/多变量序列、单个 metric 函数和

参见下面的示例。

property model_created: bool
float – 单个单变量/多变量序列、单个 metric 函数和

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

property model_params: dict
float – 单个单变量/多变量序列、单个 metric 函数和

dict

property output_chunk_length: int

模型一次预测的时间步长数量，统计模型未定义此属性。

float – 单个单变量/多变量序列、单个 metric 函数和

参见下面的示例。

property output_chunk_shift: int

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

float – 单个单变量/多变量序列、单个 metric 函数和

参见下面的示例。

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) – 可选参数，为基于神经网络的模型启用蒙特卡洛 dropout 进行预测。这允许通过指定学习模型上的隐式先验来进行贝叶斯近似。

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

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

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

包含 series 预测结果的一个或多个时间序列；如果在未指定 series 且模型在单个序列上训练的情况下，则返回训练序列的预测结果。

float – 单个单变量/多变量序列、单个 metric 函数和

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) – 可选参数，为基于神经网络的模型启用蒙特卡洛 dropout 进行预测。这允许通过指定学习模型上的隐式先验来进行贝叶斯近似。

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

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

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

float – 单个单变量/多变量序列、单个 metric 函数和

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 或 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，则将 None 传递给相应的 retrain 函数参数。注意: 某些模型需要每次都重新训练，并且不支持 retrain=True 之外的任何值。注意: 也控制 data_transformers 的重新训练。

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

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

    metric (Union[Callable[…, Union[float, list[float], ndarray, list[ndarray]]], list[Callable[…, Union[float, list[float], ndarray, list[ndarray]]]]]) – 一个指标函数或指标函数列表。每个指标必须是 Darts 指标（参见此处），或者是一个自定义指标，其签名与 Darts 指标完全相同，使用装饰器 multi_ts_support()，并返回指标得分。

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

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

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

    可以是 Darts 的“每时间步”指标之一（参见此处），也可以是签名与 Darts 的“每时间步”指标相同的自定义指标，该自定义指标使用装饰器 multi_ts_support() 和 multi_ts_support()，并为每个时间步返回一个值。

  • 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() 方法的一些附加参数。

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

  • 返回类型

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

  • 返回

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

float – 单个单变量/多变量序列、单个 metric 函数和

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

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

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

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

  • List[List[TimeSeries]] – 对于序列 series 且 last_points_only=False 时的残差 TimeSeries 的列表的列表。外部残差列表的长度为 len(series)。内部列表包含所有可能的序列特有历史预测结果的残差。

save(path=None, clean=False)

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

在 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 参数。

float – 单个单变量/多变量序列、单个 metric 函数和

None

supports_future_covariates = False
property supports_likelihood_parameter_prediction: bool

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

float – 单个单变量/多变量序列、单个 metric 函数和

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

property supports_multivariate: bool

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

float – 单个单变量/多变量序列、单个 metric 函数和

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

property supports_optimized_historical_forecasts: bool

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

float – 单个单变量/多变量序列、单个 metric 函数和

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

property supports_past_covariates: bool

模型是否支持过去协变量

float – 单个单变量/多变量序列、单个 metric 函数和

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

property supports_probabilistic_prediction: bool

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

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

float – 单个单变量/多变量序列、单个 metric 函数和

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

property supports_sample_weight: bool

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

float – 单个单变量/多变量序列、单个 metric 函数和

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

property supports_static_covariates: bool

模型是否支持静态协变量

float – 单个单变量/多变量序列、单个 metric 函数和

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

property supports_transferable_series_prediction: bool

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

float – 单个单变量/多变量序列、单个 metric 函数和

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

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

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

float – 单个单变量/多变量序列、单个 metric 函数和

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

property uses_past_covariates: bool

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

float – 单个单变量/多变量序列、单个 metric 函数和

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

property uses_static_covariates: bool

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

float – 单个单变量/多变量序列、单个 metric 函数和

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

上一页

TBATS

下一页

Temporal Fusion Transformer (TFT)