集成模型基类

类 darts.models.forecasting.ensemble_model.EnsembleModel(forecasting_models, train_num_samples, train_samples_reduction, train_forecasting_models=True, show_warnings=True)

基类：GlobalForecastingModel

集成模型的抽象基类。集成模型接收一个预测模型列表，并根据其 ensemble() 方法定义的规则，将它们的预测结果集成为单个预测结果。

如果在训练或推理时提供了 future_covariates 或 past_covariates，它们将仅传递给支持这些参数的模型。

参数

• forecasting_models (list[ForecastingModel]) –

  要集成的预测模型列表

  注意

  如果所有模型都是概率模型，则 EnsembleModel 也将是概率模型。

• train_num_samples (int) – 每个预测模型的预测样本数量，用于多层集成。n_samples 维度将使用 train_samples_reduction 方法进行降维。

• train_samples_reduction (Union[str, float, None]) – 如果 forecasting_models 是概率模型且 train_num_samples > 1，则使用此方法将样本维度降至 1。可能的值包括：“mean”、“median” 或与所需分位数对应的浮点值。

• train_forecasting_models (bool) – 如果设置为 False，则在调用 fit() 时不会重新训练 forecasting_models（仅当所有 forecasting_models 都是预训练的 GlobalForecastingModels 时才支持）。默认值：True。

• show_warnings (bool) – 是否显示与模型协变量支持相关的警告。

属性

considers_static_covariates	模型是否考虑静态协变量（如果存在）。
extreme_lags	一个包含以下顺序元素的 8 元组：（最小目标滞后、最大目标滞后、最小过去协变量滞后、最大过去协变量滞后、最小未来协变量滞后、最大未来协变量滞后、输出偏移、最大训练目标滞后（仅限 RNNModel））。
likelihood	返回模型用于概率预测的似然函数（如果存在）。
min_train_samples	训练模型的最小样本数。
output_chunk_length	如果所有预测模型都没有 output_chunk_length，则返回 None；否则返回最小的 output_chunk_length。
output_chunk_shift	输出/预测开始时间点在输入结束之后的步数。
supports_future_covariates	模型是否支持未来协变量
supports_likelihood_parameter_prediction	如果所有预测模型都使用相同的似然函数进行拟合，则 EnsembleModel 可以预测似然参数。
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	模型在拟合后是否使用静态协变量。

model_params

方法

backtest(series[, past_covariates, ...])	计算模型对（可能多个）series 的历史预测产生的误差值。
ensemble(predictions, series[, num_samples, ...])	定义如何集成单个模型的预测结果以产生单个预测。
fit(series[, past_covariates, future_covariates])	在提供的 series 上拟合模型。
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])	从给定路径或文件句柄加载模型。
predict(n[, series, past_covariates, ...])	预测 series 结束后的 n 个时间步长值。
residuals(series[, past_covariates, ...])	计算模型对（可能多个）series 的历史预测产生的残差。
save([path, clean])	将集成模型保存到给定路径或文件句柄。
untrained_model()	返回使用相同参数创建的新（未训练）模型实例。

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

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

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

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

指标可以通过 metric_kwargs 进一步定制（例如，控制对组件、时间步长、多个序列的聚合，其他所需参数如分位数指标的 q 等）。

参数

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

• past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，对于 series 中的每个输入时间序列，提供一个（一系列）过去观察到的协变量时间序列。仅当模型支持过去协变量时适用。

• future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，对于 series 中的每个输入时间序列，提供一个（一系列）未来已知协变量时间序列。仅当模型支持未来协变量时适用。

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

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

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

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

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

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

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

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

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

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

  是 stride 的整数倍。如果不存在有效的起始点，则抛出 ValueError。

  注意：如果模型使用偏移输出（output_chunk_shift > 0），则第一个预测点也将

  向未来偏移 output_chunk_shift 个点。

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

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

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

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

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

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

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

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

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

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

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

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

• overlap_end (bool) – 返回的预测是否可以超出 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 指标（参见 这里），或者是一个与 Darts 指标具有相同签名的自定义指标，使用装饰器 multi_ts_support() 和 multi_ts_support()，并返回指标得分。

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

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

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

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

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

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

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

  • 如果 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 指标。

属性 considers_static_covariates: bool

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

返回类型

bool

抽象方法 ensemble(predictions, series, num_samples=1, predict_likelihood_parameters=False)

定义如何集成单个模型的预测结果以产生单个预测。

参数

• predictions (Union[TimeSeries, Sequence[TimeSeries]]) – 要集成的单个预测结果

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 要预测的时间序列序列。可选参数，因为它仅对时间序列序列有意义——本地模型保留时间序列用于预测。

返回值

通过集成单个预测结果获得的预测 TimeSeries 或 TimeSeries 序列

返回类型

TimeSeries 或 Sequence[TimeSeries]

属性 extreme_lags: tuple[Optional[int], Optional[int], Optional[int], Optional[int], Optional[int], Optional[int], int, Optional[int]]

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

参见下面的示例。

如果模型未拟合以下内容：

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

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

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

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

注意

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

示例

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

返回类型

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

抽象方法 fit(series, past_covariates=None, future_covariates=None)

在提供的 series 上拟合模型。请注意，EnsembleModel.fit() 不会在其每个组成预测模型上调用 fit()。这需要继承自 EnsembleModel 的类在覆盖 fit() 时适当地完成。

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

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

参数

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 拟合模型时使用的包含目标值的序列或序列的序列。

• past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，拟合模型时使用的包含过去观察到的协变量的序列或序列的序列。

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

返回值

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

返回类型

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

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

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

参数

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

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

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

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

返回值

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

返回类型

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

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

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

参数

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

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

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

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

返回值

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

返回类型

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

类方法 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) – 用作训练输入和目标的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 的格式。仅当 start 为整数且 series 使用 pd.RangeIndex 索引时有效。如果设置为 'position'，则 start 对应于第一个预测点的索引位置，范围可以从 (-len(series), len(series) - 1)。如果设置为 'value'，则 start 对应于第一个预测点的索引值/标签。如果该值不在 series 的索引中，则会引发错误。默认值：'value'。

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

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

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

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

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

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

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

• verbose – 是否打印进度。

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

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

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

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

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

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

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

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

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

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

返回值

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

返回类型

ForecastingModel, Dict, float

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

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

此方法有两种主要模式：

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

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

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

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

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

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

参数

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

• past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，对于 series 中的每个输入时间序列，提供一个（一系列）过去观察到的协变量时间序列。仅当模型支持过去协变量时适用。

• future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，对于 series 中的每个输入时间序列，提供一个（一系列）未来已知协变量时间序列。仅当模型支持未来协变量时适用。

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

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

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

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

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

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

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

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

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

  是 stride 的整数倍。如果不存在有效的起始点，则抛出 ValueError。

  注意：如果模型使用偏移输出（output_chunk_shift > 0），则第一个预测点也将

  向未来偏移 output_chunk_shift 个点。

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

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

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

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

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

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

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

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

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

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

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

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

• overlap_end (bool) – 返回的预测是否可以超出 series 的结束时间。

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

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

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

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

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

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

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

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

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

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

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

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

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

返回类型

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

返回值

• TimeSeries – 对于单个 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 likelihood: Optional[Likelihood]

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

返回类型

Optional[Likelihood, None]

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

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

参数

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

• pl_trainer_kwargs (Optional[dict, None]) – 仅在底层预测模型包含 TorchForecastingModel 时有效。可选的，用于创建新的 Lightning Trainer 的 kwargs 集合，用于配置模型以执行下游任务（例如预测）。一些示例包括指定批大小或将模型移动到 CPU/GPU(s)。请查阅 Lightning Trainer 文档，以获取有关支持的 kwargs 的更多信息。

• **kwargs – 仅在底层预测模型包含 TorchForecastingModel 时有效。PyTorch Lightning 的 LightningModule.load_from_checkpoint() 方法的附加 kwargs。欲了解更多信息，请阅读官方文档。

返回类型

EnsembleModel

property min_train_samples: int

训练模型的最小样本数。

返回类型

int

property model_params: dict

返回类型

dict

property output_chunk_length: Optional[int]

如果所有预测模型都没有 output_chunk_length，则返回 None；否则返回最小的 output_chunk_length。

返回类型

Optional[int, None]

property output_chunk_shift: int

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

返回类型

int

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

预测 series 结束后的 n 个时间步长值。

如果 fit() 被调用时仅以一个 TimeSeries 作为参数，则此函数的 series 参数是可选的，它将简单地生成接下来的 horizon 个时间步的预测。在这种情况下，past_covariates 和 future_covariates 参数也无需再次提供。

如果 fit() 被调用时 series 指定为 Sequence[TimeSeries]（即模型已在多个时间序列上训练），则必须指定 series 参数。

当指定 series 参数时，此函数将为由 series 给定的简单序列（或序列中的每个序列）计算接下来的 n 个时间步的预测。

如果在训练期间指定了多个过去或未来的协变量，则此处也必须指定一些相应的协变量。对于 series 中的每个输入，必须提供一个匹配的（过去和/或未来）协变量时间序列。

参数

• n (int) – 预测范围 - 系列结束后的时间步数，用于生成预测。

• series (Union[TimeSeries, Sequence[TimeSeries], None]) – 将预测未来值的系列。

• past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 对于 series 中的每个输入时间序列，提供一个过去观测的协变量时间序列。它们在维度上必须与训练时用于 fit() 函数的过去协变量匹配。

• future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 对于 series 中的每个输入时间序列，提供一个未来已知的协变量时间序列。它们在维度上必须与训练时用于 fit() 函数的未来协变量匹配。

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

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

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

• show_warnings (bool) – 是否显示与自回归和过去协变量使用相关的警告。

返回值

如果未指定 series，此函数返回一个包含训练系列结束后的 n 个点的单个时间序列。如果指定了 series 且是一个简单的 TimeSeries，则此函数返回 series 结束后的 n 个点。如果指定了 series 且是一个包含多个时间序列的序列，则此函数返回一个序列，其中每个元素包含相应的 n 个点预测。

返回类型

Union[TimeSeries, Sequence[TimeSeries]]

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

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

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

按顺序，此方法执行：

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

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

• 创建并返回 TimeSeries（或当 values_only=True 时简单返回一个 np.ndarray），其时间索引来自历史预测，其值来自每个分量和时间步的度量。

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

参数

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

• past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，对于 series 中的每个输入时间序列，提供一个（一系列）过去观察到的协变量时间序列。仅当模型支持过去协变量时适用。

• future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，对于 series 中的每个输入时间序列，提供一个（一系列）未来已知协变量时间序列。仅当模型支持未来协变量时适用。

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

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

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

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

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

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

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

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

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

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

  是 stride 的整数倍。如果不存在有效的起始点，则抛出 ValueError。

  注意：如果模型使用偏移输出（output_chunk_shift > 0），则第一个预测点也将

  向未来偏移 output_chunk_shift 个点。

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

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

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

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

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

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

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

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

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

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

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

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

• overlap_end (bool) – 返回的预测是否可以超出 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 的参数而不是目标值。仅支持具有似然函数、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”）。如果提供，所有输入序列必须在未转换的空间中。对于可拟合的 transformer / pipeline

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

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

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

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

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

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

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

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

返回类型

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

返回值

• TimeSeries – 对于单个 series 和使用 last_points_only=True 生成的 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, **pkl_kwargs)

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

此外，每个 TorchForecastingModel 下会存储两个文件。

保存和加载 RegressionEnsembleModel 的示例

from darts.models import RegressionEnsembleModel, LinearRegressionModel, TiDEModel

model = RegressionEnsembleModel(
    forecasting_models = [
        LinearRegressionModel(lags=4),
        TiDEModel(input_chunk_length=4, output_chunk_length=4),
        ],
        regression_train_n_points=10,
)

model.save("my_ensemble_model.pkl")
model_loaded = RegressionEnsembleModel.load("my_ensemble_model.pkl")

参数

• path (Union[str, PathLike, BinaryIO, None]) – 保存集成模型当前状态的路径或文件句柄。如果未指定路径，则集成模型会自动保存在 "{RegressionEnsembleModel}_{YYYY-mm-dd_HH_MM_SS}.pkl" 下。如果 forecasting_models 的第 i 个模型是 TorchForecastingModel，则会保存在 "{path}.{ithModelClass}_{i}.pt" 和 "{path}.{ithModelClass}_{i}.ckpt" 下。

• clean (bool) –

  是否存储模型的清理版本。如果为 True，则移除训练系列和协变量。如果底层 forecasting_models 包含任何 TorchForecastingModel，则还会移除所有与其 Lightning Trainer 相关的参数。

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

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

返回类型

None

property supports_future_covariates: bool

模型是否支持未来协变量

返回类型

bool

property supports_likelihood_parameter_prediction: bool

如果所有预测模型都使用相同的似然函数进行拟合，则 EnsembleModel 可以预测似然参数。

返回类型

bool

property supports_multivariate: bool

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

返回类型

bool

property supports_optimized_historical_forecasts: bool

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

返回类型

bool

property supports_past_covariates: bool

模型是否支持过去协变量

返回类型

bool

property supports_probabilistic_prediction: bool

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

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

返回类型

bool

property supports_sample_weight: bool

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

返回类型

bool

property supports_static_covariates: bool

模型是否支持静态协变量

返回类型

bool

property supports_transferable_series_prediction: bool

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

返回类型

bool

untrained_model()

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

property uses_future_covariates: bool

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

返回类型

bool

property uses_past_covariates: bool

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

返回类型

bool

property uses_static_covariates: bool

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

返回类型

bool

上一页

D-Linear

下一页

Exponential Smoothing