时间序列密集编码器（TiDE）¶
- class darts.models.forecasting.tide_model.TiDEModel(input_chunk_length, output_chunk_length, output_chunk_shift=0, num_encoder_layers=1, num_decoder_layers=1, decoder_output_dim=16, hidden_size=128, temporal_width_past=4, temporal_width_future=4, temporal_hidden_size_past=None, temporal_hidden_size_future=None, temporal_decoder_hidden=32, use_layer_norm=False, dropout=0.1, use_static_covariates=True, **kwargs)[来源]¶
基类:
MixedCovariatesTorchModelTiDE 模型的实现，如文献 [1] 中所述。
TiDE 与 Transformer（在
TransformerModel中实现）类似，但通过引入基于多层感知机 (MLP) 的无注意力机制的编码器-解码器，试图在较低的计算成本下提供更好的性能。该模型支持过去协变量（在预测时间之前 input_chunk_length 点已知）、未来协变量（在预测时间之后 output_chunk_length 点已知）、静态协变量以及概率预测。
编码器和解码器实现为一系列残差块。编码器和解码器中的残差块数量分别可以通过
num_encoder_layers和num_decoder_layers控制。残差块中层的宽度可以通过hidden_size控制。类似地，时序解码器中层的宽度可以通过temporal_decoder_hidden控制。- 参数
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）。num_encoder_layers (
int) – 编码器中的残差块数量。num_decoder_layers (
int) – 解码器中的残差块数量。decoder_output_dim (
int) – 解码器输出的维度。hidden_size (
int) – 编码器和解码器中残差块中层的宽度。temporal_width_past (
int) – 过去协变量投影残差块中输出层的宽度。如果为 0，将绕过特征投影并使用原始特征数据。temporal_width_future (
int) – 未来协变量投影残差块中输出层的宽度。如果为 0，将绕过特征投影并使用原始特征数据。temporal_hidden_size_past (
Optional[int,None]) – 过去协变量投影残差块中隐藏层的宽度。如果未指定，则默认为 hidden_size，即编码器和解码器中隐藏层的宽度。在许多情况下，这可能过大，因此建议明确设置此参数。temporal_hidden_size_future (
Optional[int,None]) – 未来协变量投影残差块中隐藏层的宽度。如果未指定，则默认为 hidden_size，即编码器和解码器中隐藏层的宽度。在许多情况下，这可能过大，因此建议明确设置此参数。temporal_decoder_hidden (
int) – 时序解码器中层的宽度。use_layer_norm (
bool) – 是否在残差块中使用层归一化。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 数（如果将验证
TimeSeries传递给fit()方法）。默认值：1。force_reset – 如果设置为
True，则具有相同名称的任何先前存在的模型将被重置（所有检查点将被丢弃）。默认值：False。save_checkpoints – 是否自动保存未训练的模型和训练检查点。要从检查点加载模型，请调用
MyModelClass.load_from_checkpoint()，其中MyModelClass是使用的TorchForecastingModel类（例如TFTModel,NBEATSModel等）。如果设置为False，仍可以使用save()手动保存模型，并使用load()加载。默认值：False。add_encoders –
可以使用 add_encoders 自动生成大量过去和未来协变量。这可以通过添加多个预定义索引编码器和/或将用作索引编码器的自定义用户函数来实现。此外，可以添加 Darts 的
Scaler等转换器来转换生成的协变量。这一切都在一个机制下发生，只需在模型创建时指定。阅读SequentialEncoder以了解更多关于add_encoders的信息。默认值：None。一个展示add_encoders部分功能的示例def encode_year(idx): return (idx.year - 1950) / 50 add_encoders={ 'cyclic': {'future': ['month']}, 'datetime_attribute': {'future': ['hour', 'dayofweek']}, 'position': {'past': ['relative'], 'future': ['relative']}, 'custom': {'past': [encode_year]}, 'transformer': Scaler(), 'tz': 'CET' }
random_state – 控制权重初始化的随机性。有关更多详细信息，请查看此 link。默认值：
None。pl_trainer_kwargs –
默认情况下，
TorchForecastingModel创建一个 PyTorch Lightning Trainer，其中包含一些有用的预设，用于执行训练、验证和预测过程。这些预设包括自动检查点、tensorboard 日志记录、设置 torch 设备等。通过pl_trainer_kwargs，您可以添加额外的 kwargs 来实例化 PyTorch Lightning trainer 对象。有关支持的 kwargs 的更多信息，请查阅 PL Trainer documentation。默认值：None。通过在pl_trainer_kwargs字典中指定键"accelerator", "devices", and "auto_select_gpus"，也可以在 GPU 上运行。设置pl_trainer_kwargs字典中设备的示例{"accelerator": "cpu"}用于 CPU，{"accelerator": "gpu", "devices": [i]}仅使用 GPUi（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"，您可以将自定义或 PyTorch-Lightning 内置的回调添加到 Darts 的TorchForecastingModel中。下面是向训练过程添加 EarlyStopping 的示例。如果验证损失 val_loss 未超出规格改进，模型将提前停止训练。有关回调的更多信息，请访问：PyTorch Lightning Callbacksfrom 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
A. Das 等人，“使用 TiDE 进行长期预测：时间序列密集编码器”，http://arxiv.org/abs/2304.08424
- 2
T. Kim 等人，“用于对抗分布偏移的精确时间序列预测的可逆实例归一化”，https://openreview.net/forum?id=cGDAkQo1C0p
示例
>>> from darts.datasets import WeatherDataset >>> from darts.models import TiDEModel >>> 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] >>> model = TiDEModel( >>> 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([[1008.1667634 ], [ 997.08337201], [1017.72035839], [1005.10790392], [ 998.90537286], [1005.91534452]])
注意
TiDE 示例 notebook 介绍了一些可用于改进预测质量的技术，与此简单用法示例相比。
属性
如果存在静态协变量，模型是否考虑它们。
一个包含以下内容的 8 元组，按顺序排列：(最小目标滞后，最大目标滞后，最小过去协变量滞后，最大过去协变量滞后，最小未来协变量滞后，最大未来协变量滞后，输出偏移，最大目标滞后训练（仅适用于 RNNModel）)。
返回模型用于概率预测的似然（如果存在）。
训练模型所需的最小样本数。
模型一次预测的时间步数，对于统计模型未定义。
输出/预测开始于输入结束之后的时间步数。
模型是否支持未来协变量
模型实例是否支持直接预测似然参数
模型是否考虑时间序列中的多个变量。
模型是否支持优化历史预测
模型是否支持过去协变量
检查此配置下的预测模型是否支持概率预测。
模型是否支持训练样本权重。
模型是否支持静态协变量
模型是否支持对任何输入 series 进行预测。
模型在拟合后是否使用未来协变量。
模型在拟合后是否使用过去协变量。
模型在拟合后是否使用静态协变量。
epochs_trained
input_chunk_length
model_created
model_params
方法
backtest(series[, past_covariates, ...])计算模型对（可能多个）series 的历史预测产生的误差值。
fit(series[, past_covariates, ...])在一个或多个 series 上拟合/训练模型。
fit_from_dataset(train_dataset[, ...])使用特定的
darts.utils.data.TrainingDataset实例训练模型。generate_fit_encodings(series[, ...])生成用于拟合模型的协变量编码，并返回一个元组，其中包含将原始协变量和编码协变量堆叠在一起的过去和未来协变量 series。
generate_fit_predict_encodings(n, series[, ...])生成用于训练和推理/预测的协变量编码，并返回一个元组，其中包含将原始协变量和编码协变量堆叠在一起的过去和未来协变量 series。
generate_predict_encodings(n, series[, ...])生成用于推理/预测集的协变量编码，并返回一个元组，其中包含将原始协变量和编码协变量堆叠在一起的过去和未来协变量 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个时间步，或指定series的n个时间步。predict_from_dataset(n, input_series_dataset)此方法允许使用特定的
darts.utils.data.InferenceDataset实例进行预测。重置模型对象并移除所有存储的数据 - 模型、检查点、记录器和训练历史。
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()方法（官方文档）。返回一个使用相同参数创建的新（未训练）模型实例。
- 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（默认为 mean）。
如果 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],Sequence[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 不在可训练/可预测点范围内，则使用最接近的有效起始点，该点
是 stride 在 start 前方的整数倍。如果不存在有效起始点，则引发 ValueError。
- 注意：如果模型使用偏移输出（output_chunk_shift > 0），则第一个预测点也会
向未来偏移 output_chunk_shift 个点。
- 注意：如果 start 在可能的历史预测时间之外，将忽略该参数
（使用
None时的默认行为）并从第一个可训练/可预测点开始。
start_format (
Literal[‘position’, ‘value’]) – 定义 start 格式。如果设置为'position'，start 对应于第一个预测点的索引位置，范围为(-len(series), len(series) - 1)。如果设置为'value'，start 对应于第一个预测点的索引值/标签。如果该值不在 series 的索引中，将引发错误。默认值：'value'。stride (
int) – 两个连续预测之间的时间步数。retrain (
Union[bool,int,Callable[…,bool]]) –在预测之前是否以及/或在何种条件下重新训练模型。此参数支持 3 种不同类型：
bool、（正）int和Callable（返回bool）。如果是bool：在每个步骤重新训练模型（True），或者从不重新训练模型（False）。如果是int：模型每 retrain 次迭代重新训练一次。如果是Callable：模型在 callable 返回 True 时重新训练。callable 必须具有以下位置参数counter (int): 当前 retrain 迭代次数
pred_time (pd.Timestamp or int): 预测时间的时间戳（训练 series 的结束）
train_series (TimeSeries): 到 pred_time 的训练 series
past_covariates (TimeSeries): 到 pred_time 的 past_covariates series
future_covariates (TimeSeries): 到
min(pred_time + series.freq * forecast_horizon, series.end_time())的 future_covariates series
注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则会将
None传递给相应的 retrain 函数参数。注意：某些模型需要每次都重新训练，并且不支持retrain=True之外的任何值。注意：这也控制data_transformers的重新训练。overlap_end (
bool) – 返回的预测是否可以超出 series 的末尾。last_points_only (
bool) – 是否仅返回每个历史预测的最后一个点。如果设置为True，则该方法返回一个TimeSeries（对于 series 中的每个时间序列），其中包含连续的点预测。否则，返回历史TimeSeries预测的列表。metric (
Union[Callable[…,Union[float,list[float],ndarray,list[ndarray]]],list[Callable[…,Union[float,list[float],ndarray,list[ndarray]]]]]) – 一个指标函数或指标函数列表。每个指标必须是 Darts 指标（参见 here），或者一个自定义指标，其签名与 Darts 指标相同，使用装饰器multi_ts_support()和multi_ts_support()，并返回指标分数。reduction (
Optional[Callable[…,float],None]) – 当 last_points_only 设置为False时，用于组合获得的单个误差分数的函数。当提供多个指标函数时，该函数将接收参数axis = 1，以获取每个指标函数的单个值。如果显式设置为None，该方法将改为返回单个误差分数的列表。默认为np.mean。verbose (
bool) – 是否打印进度。show_warnings (
bool) – 是否显示与历史预测优化相关的警告，或与参数 start 和 train_length 相关的警告。predict_likelihood_parameters (
bool) – 如果设置为True，模型将预测其 likelihood 的参数而不是目标。仅支持具有 likelihood、num_samples = 1和n<=output_chunk_length的概率模型。默认值：False。enable_optimization (
bool) – 在支持和可用时，是否使用 historical_forecasts 的优化版本。默认值：True。data_transformers (
Optional[dict[str,Union[BaseDataTransformer,Pipeline]],None]) –（可选）要应用于相应 series 的 BaseDataTransformer 或 Pipeline 字典（可能的键：“series”、“past_covariates”、“future_covariates”）。如果提供，所有输入 series 必须位于未转换的空间中。对于可拟合转换器/管道
如果 retrain=True，则数据转换器在每个历史预测步骤对训练数据重新拟合。
如果 retrain=False，则数据转换器在所有预测之前对 series 进行一次转换。
拟合后的转换器用于在训练和预测期间转换输入。如果转换是可逆的，则预测将被逆转换。仅当 historical_forecasts=None 时有效。
metric_kwargs (
Union[dict[str,Any],list[dict[str,Any]],None]) – 传递给 metric() 的附加参数，例如用于并行化的 ‘n_jobs’，用于减少组件度量指标的 ‘component_reduction’，缩放指标的季节性 ‘m’ 等。将单独向每个指标传递参数，仅当它们存在于相应的指标签名中时。缩放指标（例如 mase`，rmsse 等）的参数 ‘insample’ 将被忽略，因为它在内部处理。fit_kwargs (
Optional[dict[str,Any],None]) – （可选）传递给模型 fit() 方法的一些附加参数。predict_kwargs (
Optional[dict[str,Any],None]) – （可选）传递给模型 predict() 方法的一些附加参数。sample_weight (
Union[TimeSeries,Sequence[TimeSeries],str,None]) – （可选）应用于目标 series 标签的样本权重，用于训练。仅当 retrain 不为False时有效。它们按观测、按标签（output_chunk_length 中的每个步骤）和按组件应用。如果是一个或一系列 series，则使用这些权重。如果权重 series 仅具有单个组件/列，则权重全局应用于 series 中的所有组件。否则，对于特定组件的权重，组件数量必须与 series 的组件数量匹配。如果是一个字符串，则使用内置权重函数生成权重。可用选项为“linear”或“exponential”衰减 - 过去越远，权重越低。权重按时间 series 计算。
- 返回类型
Union[float,ndarray,list[float],list[ndarray]]- 返回
float – 对于单个单变量/多变量 series、单个 metric 函数和
使用 last_points_only=True 生成的 historical_forecasts 的单个回测分数
使用 last_points_only=False 和 backtest reduction 生成的 historical_forecasts
np.ndarray – 历史回测分数的 numpy 数组。对于单个 series 和以下之一
单个 metric 函数，使用 last_points_only=False 和 backtest reduction=None 生成的 historical_forecasts。输出形状为 (n forecasts, *, *)。
多个 metric 函数和使用 last_points_only=False 生成的 historical_forecasts。使用 backtest reduction 时，输出形状为 (*, n metrics)；当 reduction=None 时，形状为 (n forecasts, *, *, n metrics)。
包括 series_reduction 的多个单变量/多变量 series，以及用于“每时间步指标”的 component_reduction=None 或 time_reduction=None 之一
List[float] – 与 type float 相同，但针对一系列 series。返回的指标列表长度为 len(series)，其中包含每个输入 series 的 float 指标。
List[np.ndarray] – 与 type np.ndarray 相同，但针对一系列 series。返回的指标列表长度为 len(series)，其中包含每个输入 series 的 np.ndarray 指标。
- property considers_static_covariates: bool¶
如果存在静态协变量，模型是否考虑它们。
- 返回类型
bool
- property epochs_trained: int¶
- 返回类型
int
- property extreme_lags: tuple[Optional[int], Optional[int], Optional[int], Optional[int], Optional[int], Optional[int], int, Optional[int]]¶
包含以下元素的 8 元组（按顺序）：（最小目标滞后、最大目标滞后、最小过去协变量滞后、最大过去协变量滞后、最小未来协变量滞后、最大未来协变量滞后、输出偏移、最大目标滞后训练（仅适用于 RNNModel））。如果 0 是第一个预测的索引，则所有滞后都相对于此索引。
请参阅下面的示例。
- 如果模型在拟合时没有使用
target（仅适用于 RegressionModels）：则第一个元素应为 None。
past covariates：则第三和第四个元素应为 None。
future covariates：则第五和第六个元素应为 None。
使用 past 或 future covariates 的模型，以及/或者最小目标滞后和最大目标滞后可能与 -1 和 0 不同的模型应重写此方法。
注意
最大目标滞后（第二个值）不能为 None，并且总是大于或等于 0。
示例
>>> model = LinearRegressionModel(lags=3, output_chunk_length=2) >>> model.fit(train_series) >>> model.extreme_lags (-3, 1, None, None, None, None, 0, None) >>> model = LinearRegressionModel(lags=3, output_chunk_length=2, output_chunk_shift=2) >>> model.fit(train_series) >>> model.extreme_lags (-3, 1, None, None, None, None, 2, None) >>> model = LinearRegressionModel(lags=[-3, -5], lags_past_covariates = 4, output_chunk_length=7) >>> model.fit(train_series, past_covariates=past_covariates) >>> model.extreme_lags (-5, 6, -4, -1, None, None, 0, None) >>> model = LinearRegressionModel(lags=[3, 5], lags_future_covariates = [4, 6], output_chunk_length=7) >>> model.fit(train_series, future_covariates=future_covariates) >>> model.extreme_lags (-5, 6, None, None, 4, 6, 0, None) >>> model = NBEATSModel(input_chunk_length=10, output_chunk_length=7) >>> model.fit(train_series) >>> model.extreme_lags (-10, 6, None, None, None, None, 0, None) >>> model = NBEATSModel(input_chunk_length=10, output_chunk_length=7, lags_future_covariates=[4, 6]) >>> model.fit(train_series, future_covariates) >>> model.extreme_lags (-10, 6, None, None, 4, 6, 0, None)
- 返回类型
tuple[Optional[int,None],Optional[int,None],Optional[int,None],Optional[int,None],Optional[int,None],Optional[int,None],int,Optional[int,None]]
- fit(series, past_covariates=None, future_covariates=None, val_series=None, val_past_covariates=None, val_future_covariates=None, trainer=None, verbose=None, epochs=0, max_samples_per_ts=None, dataloader_kwargs=None, sample_weight=None, val_sample_weight=None)¶
在一个或多个 series 上拟合/训练模型。
此方法封装了
fit_from_dataset()方法，为本模型构建默认训练数据集。如果您需要更多地控制如何为训练切片时间序列，可以考虑使用自定义的darts.utils.data.TrainingDataset调用fit_from_dataset()。训练使用 PyTorch Lightning Trainer 进行。它使用预设的默认 Trainer 对象以及模型创建时使用的
pl_trainer_kwargs。您还可以使用可选参数trainer提供自定义 Trainer。有关 PyTorch Lightning Trainers 的更多信息，请查看此链接。此函数可以多次调用以进行额外的训练。如果指定了
epochs，模型将训练额外的epochs个 epoch。下面列出了所有可能的参数，但并非所有模型都支持所有参数。例如，所有
PastCovariatesTorchModel都只支持past_covariates而不支持future_covariates。如果您尝试使用错误的 covariates 参数拟合模型，Darts 会报错。处理 covariates 时，Darts 会尝试使用 target 和 covariates 的时间轴来确定正确的时间切片。因此，covariates 可以比需要的时间序列更长；只要时间轴正确，Darts 就会正确处理它们。如果它们的时间跨度不足，Darts 也会报错。
- 参数
series (
Union[TimeSeries,Sequence[TimeSeries]]) – 用作 target（即模型将训练预测的内容）的时间序列或时间序列序列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个 epoch，无论模型构造函数中提供了多少n_epochs。max_samples_per_ts (
Optional[int,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实例训练模型。这些数据集实现了 PyTorchDataset，并指定了如何为训练切片 target 和 covariates。如果您不确定使用哪个训练数据集，请考虑调用fit()方法，该方法将创建适合此模型的默认训练数据集。训练使用 PyTorch Lightning Trainer 进行。它使用预设的默认 Trainer 对象以及模型创建时使用的
pl_trainer_kwargs。您还可以使用可选参数trainer提供自定义 Trainer。有关 PyTorch Lightning Trainers 的更多信息，请查看此链接。此函数可以多次调用以进行额外的训练。如果指定了
epochs，模型将训练额外的epochs个 epoch。- 参数
train_dataset (
TrainingDataset) – 与本模型类型匹配的训练数据集（例如，PastCovariatesTrainingDataset用于PastCovariatesTorchModel）。val_dataset (
Optional[TrainingDataset,None]) – 与本模型类型匹配的训练数据集（例如，PastCovariatesTrainingDataset用于 :class:`PastCovariatesTorchModel`s），代表验证集（用于跟踪验证损失）。trainer (
Optional[Trainer,None]) – 可选参数，用于执行预测的自定义 PyTorch-Lightning Trainer 对象。使用自定义 trainer 将覆盖 Darts 的默认 trainer。verbose (
Optional[bool,None]) – 是否打印进度。如果在pl_trainer_kwargs中有 ProgressBar 回调，则忽略此参数。epochs (
int) – 如果指定，模型将额外训练epochs个 epoch，无论模型构造函数中提供了多少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)¶
生成用于拟合模型的协变量编码，并返回一个包含原始协变量和编码后协变量的 past 和 future covariates 时间序列元组。编码由模型创建时通过参数 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]) – 可选参数，拟合模型时使用的未来已知协变量时间序列或时间序列序列。
- 返回
包含 (past covariates, future covariates) 的元组。每个协变量都包含原始协变量以及编码后的协变量。
- 返回类型
Tuple[Union[TimeSeries, Sequence[TimeSeries]], Union[TimeSeries, Sequence[TimeSeries]]]
- generate_fit_predict_encodings(n, series, past_covariates=None, future_covariates=None)¶
生成用于训练和推理/预测的协变量编码，并返回一个包含原始协变量和编码后协变量的 past 和 future covariates 时间序列元组。编码由模型创建时通过参数 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]) – 可选参数，打算用于预测的未来已知协变量时间序列。其维度必须与用于训练的协变量的维度匹配。
- 返回
包含 (past covariates, future covariates) 的元组。每个协变量都包含原始协变量以及编码后的协变量。
- 返回类型
Tuple[Union[TimeSeries, Sequence[TimeSeries]], Union[TimeSeries, Sequence[TimeSeries]]]
- generate_predict_encodings(n, series, past_covariates=None, future_covariates=None)¶
生成用于推理/预测集的协变量编码，并返回一个包含原始协变量和编码后协变量的 past 和 future covariates 时间序列元组。编码由模型创建时通过参数 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]) – 可选参数，打算用于预测的未来已知协变量时间序列。其维度必须与用于训练的协变量的维度匹配。
- 返回
包含 (past covariates, future covariates) 的元组。每个协变量都包含原始协变量以及编码后的协变量。
- 返回类型
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 种操作模式：扩展窗口模式、拆分模式和拟合值模式。这 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) – 用作训练的输入和 target 的目标时间序列。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 不在可训练/可预测点范围内，则使用最接近的有效起始点，该点
是 stride 在 start 前方的整数倍。如果不存在有效起始点，则引发 ValueError。
- 注意：如果模型使用偏移输出（output_chunk_shift > 0），则第一个预测点也会
向未来偏移 output_chunk_shift 个点。
- 注意：如果 start 在可能的历史预测时间之外，将忽略该参数
（使用
None时的默认行为）并从第一个可训练/可预测点开始。
start_format (
Literal[‘position’, ‘value’]) – 仅在扩展窗口模式下使用。定义 start 的格式。仅当 start 为整数且 series 使用 pd.RangeIndexstart 对应于第一个预测点的索引位置，范围为 (-len(series), len(series) - 1)。如果设置为 ‘value’，start 对应于第一个预测点的值/标签。如果该值不在 series 的索引中，将引发错误。默认值：'value'last_points_only (
bool) – 仅在扩展窗口模式下使用。是使用整个预测还是仅使用每个预测的最后一个点来计算误差。show_warnings (
bool) – 仅在扩展窗口模式下使用。是否显示与 start 参数相关的警告。val_series (
Optional[TimeSeries,None]) – 在拆分模式下用于验证的时间序列实例。如果提供，此时间序列必须紧接在 series 的末尾之后开始，以便进行正确的预测比较。use_fitted_values (
bool) – 如果为 True，则使用与拟合值的比较。如果fitted_values不是 model_class 的属性，则引发错误。metric (
Callable[[TimeSeries,TimeSeries],float]) –一个度量函数，返回两个 TimeSeries 之间的误差作为浮点值。必须是 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]) –（可选）要应用于相应 series 的 BaseDataTransformer 或 Pipeline 字典（可能的键：“series”、“past_covariates”、“future_covariates”）。如果提供，所有输入 series 必须位于未转换的空间中。对于可拟合转换器/管道
如果 retrain=True，则数据转换器在每个历史预测步骤对训练数据重新拟合。
如果 retrain=False，则数据转换器在所有预测之前对 series 进行一次转换。
拟合后的 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],Sequence[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 不在可训练/可预测点范围内，则使用最接近的有效起始点，该点
是 stride 在 start 前方的整数倍。如果不存在有效起始点，则引发 ValueError。
- 注意：如果模型使用偏移输出（output_chunk_shift > 0），则第一个预测点也会
向未来偏移 output_chunk_shift 个点。
- 注意：如果 start 在可能的历史预测时间之外，将忽略该参数
（使用
None时的默认行为）并从第一个可训练/可预测点开始。
start_format (
Literal[‘position’, ‘value’]) – 定义 start 格式。如果设置为'position'，start 对应于第一个预测点的索引位置，范围为(-len(series), len(series) - 1)。如果设置为'value'，start 对应于第一个预测点的索引值/标签。如果该值不在 series 的索引中，将引发错误。默认值：'value'。stride (
int) – 两个连续预测之间的时间步数。retrain (
Union[bool,int,Callable[…,bool]]) –在预测之前是否以及/或在何种条件下重新训练模型。此参数支持 3 种不同类型：
bool、（正）int和Callable（返回bool）。如果是bool：在每个步骤重新训练模型（True），或者从不重新训练模型（False）。如果是int：模型每 retrain 次迭代重新训练一次。如果是Callable：模型在 callable 返回 True 时重新训练。callable 必须具有以下位置参数counter (int): 当前 retrain 迭代次数
pred_time (pd.Timestamp or int): 预测时间的时间戳（训练 series 的结束）
train_series (TimeSeries): 到 pred_time 的训练 series
past_covariates (TimeSeries): 到 pred_time 的 past_covariates series
future_covariates (TimeSeries): 到
min(pred_time + series.freq * forecast_horizon, series.end_time())的 future_covariates series
注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则会将
None传递给相应的 retrain 函数参数。注意：某些模型需要每次都重新训练，并且不支持retrain=True之外的任何值。注意：这也控制data_transformers的重新训练。overlap_end (
bool) – 返回的预测是否可以超出 series 的末尾。last_points_only (
bool) – 是否仅返回每个历史预测的最后一个点。如果设置为True，则该方法返回一个TimeSeries（对于 series 中的每个时间序列），其中包含连续的点预测。否则，返回历史TimeSeries预测的列表。verbose (
bool) – 是否打印进度。show_warnings (
bool) – 是否显示与历史预测优化相关的警告，或与参数 start 和 train_length 相关的警告。predict_likelihood_parameters (
bool) – 如果设置为True，模型将预测其 likelihood 的参数而不是目标。仅支持具有 likelihood、num_samples = 1和n<=output_chunk_length的概率模型。默认值：False。enable_optimization (
bool) – 在支持和可用时，是否使用 historical_forecasts 的优化版本。默认值：True。data_transformers (
Optional[dict[str,Union[BaseDataTransformer,Pipeline]],None]) –（可选）要应用于相应 series 的 BaseDataTransformer 或 Pipeline 字典（可能的键：“series”、“past_covariates”、“future_covariates”）。如果提供，所有输入 series 必须位于未转换的空间中。对于可拟合转换器/管道
如果 retrain=True，则数据转换器在每个历史预测步骤对训练数据重新拟合。
如果 retrain=False，则数据转换器在所有预测之前对 series 进行一次转换。
拟合后的 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 仅具有单个组件/列，则权重全局应用于 series 中的所有组件。否则，对于特定组件的权重，组件数量必须与 series 的组件数量匹配。如果是一个字符串，则使用内置权重函数生成权重。可用选项为“linear”或“exponential”衰减 - 过去越远，权重越低。权重按时间 series 计算。
- 返回类型
Union[TimeSeries,list[TimeSeries],list[list[TimeSeries]]]- 返回
TimeSeries – 用于单个 series 和 last_points_only=True 的单个历史预测：它仅包含所有历史预测中步长为 forecast_horizon 的预测。
List[TimeSeries] – 历史预测列表，用于
一个 series 的序列（列表）和 last_points_only=True：对于每个序列，它仅包含所有历史预测中步长为 forecast_horizon 的预测。
单个 series 和 last_points_only=False：对于每个历史预测，它包含整个范围 forecast_horizon。
List[List[TimeSeries]] – 用于 series 序列和 last_points_only=False 的历史预测列表的列表。对于每个序列和历史预测，它包含整个范围 forecast_horizon。外部列表遍历输入序列中提供的序列，内部列表包含每个序列的历史预测。
- property input_chunk_length: int¶
- 返回类型
int
- property likelihood: Optional[TorchLikelihood]¶
返回模型用于概率预测的似然（如果存在）。
- 返回类型
Optional[TorchLikelihood,None]
- static load(path, pl_trainer_kwargs=None, **kwargs)¶
从给定文件路径加载模型。
加载
RNNModel通用保存文件的示例from darts.models import RNNModel model_loaded = RNNModel.load(path)
将 CPU 上训练的
RNNModel加载到 GPU 的示例from darts.models import RNNModel model_loaded = RNNModel.load(path, pl_trainer_kwargs={"accelerator": "gpu"})
将 GPU 上保存的
RNNModel加载到 CPU 的示例from darts.models import RNNModel model_loaded = RNNModel.load(path, map_location="cpu", pl_trainer_kwargs={"accelerator": "gpu"})
- 参数
path (
str) – 加载模型的路径。如果保存模型时未指定路径，则必须提供自动生成的以“.pt”结尾的路径。pl_trainer_kwargs (
Optional[dict,None]) – 可选参数，用于创建一个新的 Lightning Trainer，以配置模型用于下游任务（例如预测）的关键字参数集。一些示例包括指定批量大小或将模型移动到 CPU/GPU。查看Lightning Trainer 文档了解更多关于支持的 kwargs 的信息。**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]]) – 用作 target（即模型将训练预测的内容）的时间序列或时间序列序列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个 epoch，无论模型构造函数中提供了多少n_epochs。max_samples_per_ts (
Optional[int,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 扫描的结果。
- 返回类型
lr_finder
- 属性 min_train_samples: int¶
训练模型所需的最小样本数。
- 返回类型
int
- 属性 model_created: bool¶
- 返回类型
bool
- 属性 model_params: dict¶
- 返回类型
dict
- 属性 output_chunk_length: int¶
模型一次预测的时间步数，对于统计模型未定义。
- 返回类型
int
- 属性 output_chunk_shift: int¶
输出/预测开始于输入结束之后的时间步数。
- 返回类型
int
- predict(n, series=None, past_covariates=None, future_covariates=None, trainer=None, batch_size=None, verbose=None, n_jobs=1, roll_size=None, num_samples=1, dataloader_kwargs=None, mc_dropout=False, predict_likelihood_parameters=False, show_warnings=True)¶
预测训练 series 结束后的
n个时间步，或指定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）。
处理 covariates 时，Darts 会尝试使用 target 和 covariates 的时间轴来确定正确的时间切片。因此，covariates 可以比需要的时间序列更长；只要时间轴正确，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 的参数而不是目标。仅支持具有 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实例进行预测。这些数据集实现了 PyTorchDataset，并指定了目标和协变量如何切片以进行推理。在大多数情况下，您更希望调用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 的参数而不是目标。仅支持带有似然函数、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 进行配置。计算历史预测与 series 之间每组件/列和每时间步的“每时间步” metric 回测（更多详情请参见
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],Sequence[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 不在可训练/可预测点范围内，则使用最接近的有效起始点，该点
是 stride 在 start 前方的整数倍。如果不存在有效起始点，则引发 ValueError。
- 注意：如果模型使用偏移输出（output_chunk_shift > 0），则第一个预测点也会
向未来偏移 output_chunk_shift 个点。
- 注意：如果 start 在可能的历史预测时间之外，将忽略该参数
（使用
None时的默认行为）并从第一个可训练/可预测点开始。
start_format (
Literal[‘position’, ‘value’]) – 定义 start 格式。如果设置为'position'，start 对应于第一个预测点的索引位置，范围为(-len(series), len(series) - 1)。如果设置为'value'，start 对应于第一个预测点的索引值/标签。如果该值不在 series 的索引中，将引发错误。默认值：'value'。stride (
int) – 两个连续预测之间的时间步数。retrain (
Union[bool,int,Callable[…,bool]]) –在预测之前是否以及/或在何种条件下重新训练模型。此参数支持 3 种不同类型：
bool、（正）int和Callable（返回bool）。如果是bool：在每个步骤重新训练模型（True），或者从不重新训练模型（False）。如果是int：模型每 retrain 次迭代重新训练一次。如果是Callable：模型在 callable 返回 True 时重新训练。callable 必须具有以下位置参数counter (int): 当前 retrain 迭代次数
pred_time (pd.Timestamp or int): 预测时间的时间戳（训练 series 的结束）
train_series (TimeSeries): 到 pred_time 的训练 series
past_covariates (TimeSeries): 到 pred_time 的 past_covariates series
future_covariates (TimeSeries): 到
min(pred_time + series.freq * forecast_horizon, series.end_time())的 future_covariates series
注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则会将
None传递给相应的 retrain 函数参数。注意：某些模型需要每次都重新训练，并且不支持retrain=True之外的任何值。注意：这也控制data_transformers的重新训练。overlap_end (
bool) – 返回的预测是否可以超出 series 的末尾。last_points_only (
bool) – 是否仅返回每个历史预测的最后一个点。如果设置为True，则该方法返回一个TimeSeries（对于 series 中的每个时间序列），其中包含连续的点预测。否则，返回历史TimeSeries预测的列表。metric (
Callable[…,Union[float,list[float],ndarray,list[ndarray]]]) –Darts 的一种“每时间步”度量（参见 此处），或具有与 Darts 的“每时间步”度量相同签名、使用装饰器
multi_ts_support()和multi_ts_support()并返回每时间步一个值的自定义度量。verbose (
bool) – 是否打印进度。show_warnings (
bool) – 是否显示与历史预测优化相关的警告，或与参数 start 和 train_length 相关的警告。predict_likelihood_parameters (
bool) – 如果设置为True，模型将预测其 likelihood 的参数而不是目标。仅支持具有 likelihood、num_samples = 1和n<=output_chunk_length的概率模型。默认值：False。enable_optimization (
bool) – 在支持和可用时，是否使用 historical_forecasts 的优化版本。默认值：True。data_transformers (
Optional[dict[str,Union[BaseDataTransformer,Pipeline]],None]) –（可选）要应用于相应 series 的 BaseDataTransformer 或 Pipeline 字典（可能的键：“series”、“past_covariates”、“future_covariates”）。如果提供，所有输入 series 必须位于未转换的空间中。对于可拟合转换器/管道
如果 retrain=True，则数据转换器在每个历史预测步骤对训练数据重新拟合。
如果 retrain=False，则数据转换器在所有预测之前对 series 进行一次转换。
拟合后的转换器用于在训练和预测期间转换输入。如果转换是可逆的，则预测将被逆转换。仅当 historical_forecasts=None 时有效。
metric_kwargs (
Optional[dict[str,Any],None]) – 传递给 metric() 的额外参数，例如用于并行化的 ‘n_jobs’，用于缩放度量的 ‘m’ 等。仅当参数存在于相应的度量签名中时才传递。忽略缩减参数 “series_reduction”、“component_reduction”、“time_reduction”，以及缩放度量（例如 mase`, `rmsse` 等）的参数 ‘insample’，因为它们在内部处理。fit_kwargs (
Optional[dict[str,Any],None]) – （可选）传递给模型 fit() 方法的一些附加参数。predict_kwargs (
Optional[dict[str,Any],None]) – （可选）传递给模型 predict() 方法的一些附加参数。sample_weight (
Union[TimeSeries,Sequence[TimeSeries],str,None]) – （可选）应用于目标 series 标签的样本权重，用于训练。仅当 retrain 不为False时有效。它们按观测、按标签（output_chunk_length 中的每个步骤）和按组件应用。如果是一个或一系列 series，则使用这些权重。如果权重 series 仅具有单个组件/列，则权重全局应用于 series 中的所有组件。否则，对于特定组件的权重，组件数量必须与 series 的组件数量匹配。如果是一个字符串，则使用内置权重函数生成权重。可用选项为“linear”或“exponential”衰减 - 过去越远，权重越低。权重按时间 series 计算。values_only (
bool) – 是否将残差作为 np.ndarray 返回。如果为 False，将残差作为 TimeSeries 返回。
- 返回类型
Union[TimeSeries,list[TimeSeries],list[list[TimeSeries]]]- 返回
TimeSeries – 当 last_points_only=True 时，针对单个 series 和生成的 historical_forecasts 的残差 TimeSeries。
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-Ligthning 检查点冲突。如果未指定路径，模型将自动保存到"{ModelClass}_{YYYY-mm-dd_HH_MM_SS}.pt"下。例如，"RNNModel_2020-01-01_12_00_00.pt"。clean (
bool) –是否存储模型的清理版本。如果为 True，则移除训练序列和协变量。此外，移除所有与 Lightning Trainer 相关的参数（在模型创建时通过 pl_trainer_kwargs 传递）。
注意：加载使用 clean=True 存储的模型后，必须将 series 传递给 ‘predict()’、historical_forecasts() 和其他预测方法。
- 返回类型
无
- 属性 supports_future_covariates: bool¶
模型是否支持未来协变量
- 返回类型
bool
- 属性 supports_likelihood_parameter_prediction: bool¶
模型实例是否支持直接预测似然参数
- 返回类型
bool
- 属性 supports_multivariate: bool¶
模型是否考虑时间序列中的多个变量。
- 返回类型
bool
- 属性 supports_optimized_historical_forecasts: bool¶
模型是否支持优化历史预测
- 返回类型
bool
- 属性 supports_past_covariates: bool¶
模型是否支持过去协变量
- 返回类型
bool
- 属性 supports_probabilistic_prediction: bool¶
检查此配置下的预测模型是否支持概率预测。
默认返回 False。需要由支持概率预测的模型覆盖。
- 返回类型
bool
- 属性 supports_sample_weight: bool¶
模型是否支持训练样本权重。
- 返回类型
bool
- 属性 supports_static_covariates: bool¶
模型是否支持静态协变量
- 返回类型
bool
- 属性 supports_transferable_series_prediction: bool¶
模型是否支持对任何输入 series 进行预测。
- 返回类型
bool
- 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()¶
返回一个使用相同参数创建的新（未训练）模型实例。
- 属性 uses_future_covariates: bool¶
模型在拟合后是否使用未来协变量。
- 返回类型
bool
- 属性 uses_past_covariates: bool¶
模型在拟合后是否使用过去协变量。
- 返回类型
bool
- 属性 uses_static_covariates: bool¶
模型在拟合后是否使用静态协变量。
- 返回类型
bool