回归集成模型

一种使用回归模型计算集成预测的集成模型。

class darts.models.forecasting.regression_ensemble_model.RegressionEnsembleModel(forecasting_models, regression_train_n_points, regression_model=None, regression_train_num_samples=1, regression_train_samples_reduction='median', train_forecasting_models=True, train_using_historical_forecasts=False, show_warnings=True)

基类: EnsembleModel

使用回归模型通过堆叠技术 [1] 集成单个模型的预测。

提供的回归模型必须实现 fit() 和 predict() 方法（例如来自 scikit-learn 的回归模型）。请注意，这里的回归模型用于学习如何最好地集成单个预测模型的预测。这与 RegressionModel 中的回归用法不同，后者使用回归模型根据滞后序列生成预测。

如果在训练或推理时提供了 future_covariates 或 past_covariates，它们将只传递给支持它们的预测模型。

如果 forecasting_models 只包含 GlobalForecastingModels，则它们可以预先训练。否则，forecasting_models 必须未经训练。

回归模型不利用传递给 fit() 和 predict() 的协变量。

参数

• forecasting_models (list[ForecastingModel]) – 待集成的预测模型的列表

• regression_train_n_points (int) – 用于训练回归模型的每个序列的点数。如果 forecasting_models 已经拟合并且 train_forecasting_models=False，可以设置为 -1 以使用整个序列训练回归器。

• regression_model –

  任何具有 predict() 和 fit() 方法的回归模型（例如来自 scikit-learn）。默认值: darts.models.LinearRegressionModel(fit_intercept=False)

  注意

  如果 regression_model 是概率模型，则 RegressionEnsembleModel 也将是概率模型。

• regression_train_num_samples (int) –

  用于训练回归模型的每个预测模型的预测样本数量（样本将被平均）。对于确定性模型应设置为 1。默认值: 1。

  注意

  如果 forecasting_models 包含概率模型和确定性模型的混合，regression_train_num_samples 将仅传递给概率模型。

• regression_train_samples_reduction (Union[str, float, None]) – 如果 forecasting_models 是概率模型且 regression_train_num_samples > 1，则用于在将样本传递给回归模型之前减少样本的方法。可能的值：“mean”、“median”或对应于所需分位数的浮点值。默认值：“median”

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

• train_using_historical_forecasts (bool) – 如果设置为 True，则在 fit() 中使用 historical_forecasts() 生成用于训练回归模型的预测模型的预测。当 forecasting_models 只包含 GlobalForecastingModels 时可用。当 regression_train_n_points 大于底层 forecasting_models 的 output_chunk_length 时推荐使用。默认值: False。

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

参考文献

1

4. 8. Wolpert，“堆叠泛化 (Stacked generalization)”，Neural Networks，卷 5，第 2 期，第 241–259 页，1992 年 1 月

示例

>>> from darts.datasets import AirPassengersDataset
>>> from darts.models import RegressionEnsembleModel, NaiveSeasonal, LinearRegressionModel
>>> series = AirPassengersDataset().load()
>>> model = RegressionEnsembleModel(
>>>     forecasting_models = [
>>>         NaiveSeasonal(K=12),
>>>         LinearRegressionModel(lags=4)
>>>     ],
>>>     regression_train_n_points=20
>>> )
>>> model.fit(series)
>>> pred = model.predict(6)
>>> pred.values()
array([[494.24050364],
       [464.3869697 ],
       [496.53180506],
       [544.82269341],
       [557.35256055],
       [630.24334385]])

属性

considers_static_covariates	模型是否考虑静态协变量（如果存在）。
extreme_lags	一个包含按顺序排列的 8 元组：(最小目标滞后，最大目标滞后，最小过去协变量滞后，最大过去协变量滞后，最小未来协变量滞后，最大未来协变量滞后，输出偏移，最大目标训练滞后（仅适用于 RNNModel）)。
likelihood	返回模型用于概率预测的似然（如果存在）。
min_train_samples	训练模型的最小样本数。
output_chunk_length	返回回归模型（集成层）的 output_chunk_length。
output_chunk_shift	输出/预测在输入结束之后开始的时间步数。
supports_future_covariates	模型是否支持未来协变量
supports_likelihood_parameter_prediction	如果回归模型支持似然参数预测，则 RegressionEnsembleModel 也支持。
supports_multivariate	模型是否考虑时间序列中的多个变量。
supports_optimized_historical_forecasts	模型是否支持优化的历史预测
supports_past_covariates	模型是否支持过去协变量
supports_probabilistic_prediction	如果回归模型是概率模型（集成层），则 RegressionEnsembleModel 是概率模型。
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, ...])	使用整个序列（除了最后 regression_train_n_points 个值，这些值用于训练回归模型）拟合预测模型。
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, ...])	预测系列结束后的 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()），然后按照上面描述进行评估。

可以 Gideon metrics (e.g. control the aggregation over components, time steps, multiple series, other required arguments such as q for quantile metrics, …).

参数

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

  注意：如果 start 超出可能的历史预测时间范围，将忽略该参数（None 时的默认行为），并从第一个可训练/可预测点开始。

  Note: If the model uses a shifted output (output_chunk_shift > 0), then the first predicted point is also shifted by output_chunk_shift points into the future.

  Note: If start is outside the possible historical forecasting times, will ignore the parameter (default behavior with None) and start at the first trainable/predictable point.

  Note: If start is not within the trainable / forecastable points, uses the closest valid start point that

  is a round multiple of stride ahead of start. Raises a ValueError, if no valid start point exists.

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

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

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

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

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

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

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

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

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

  注意：如果没有将任何可选的 *_covariates 传递给 historical_forecast，则将 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() 和 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]) –

  可选地，要应用于相应序列（可能的键：“series”、“past_covariates”、“future_covariates”）的 BaseDataTransformer 或 Pipeline 字典。如果提供，所有输入序列必须处于未转换空间。对于可拟合的转换器/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 函数和

  • historical_forecasts 生成 with last_points_only=True

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

• np.ndarray – 回测分数的 numpy 数组。对于单个序列和以下之一

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

  • 多个 metric 函数和 historical_forecasts 生成 with last_points_only=False。使用回测 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

ensemble(predictions, series, num_samples=1, predict_likelihood_parameters=False)

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

参数

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

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

返回值

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

返回类型

TimeSeries or Sequence[TimeSeries]

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

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

参见以下示例。

如果模型未拟合

• 目标（仅适用于 RegressionModels）：则第一个元素应为 None。

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

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

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

注意

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

示例

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

返回类型

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

fit(series, past_covariates=None, future_covariates=None, sample_weight=None)

使用整个序列（除了最后 regression_train_n_points 个值，这些值用于训练回归模型）拟合预测模型。

如果 forecasting_models 包含已拟合的 GlobalForecastingModels 且 train_forecasting_model=False，则只训练回归模型。

参数

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 包含目标值的 TimeSeries 或 Sequence[TimeSeries] 对象。

• past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，一个序列或序列的序列，指定传递给预测模型的过去观测协变量。

• future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，一个序列或序列的序列，指定传递给预测模型的未来已知协变量。

• sample_weight (Union[TimeSeries, Sequence[TimeSeries], str, None]) – 可选地，一些样本权重应用于目标 series 的标签。它们应用于每个观测、每个标签（output_chunk_length 中的每一步）以及每个分量。如果是一个序列或序列的序列，则使用这些权重。如果权重序列只有一个分量/列，则这些权重将全局应用于 series 中的所有分量。否则，对于分量特定的权重，分量数量必须与 series 的分量数量匹配。如果是一个字符串，则使用内置加权函数生成权重。可用选项是 “linear” 或 “exponential” 衰减——过去越远，权重越低。权重基于 series 中最长序列的长度进行全局计算。然后对于每个序列，权重从全局权重的末尾提取。这提供了所有序列的共同时间加权。

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

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

参数

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

• past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，拟合模型时使用的带有过去观测协变量的序列或序列的序列。

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

返回值

一个 (过去协变量, 未来协变量) 的元组。每个协变量包含原始以及编码的协变量。

返回类型

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

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

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

参数

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

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

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

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

返回值

一个 (过去协变量, 未来协变量) 的元组。每个协变量包含原始以及编码的协变量。

返回类型

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

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

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

参数

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

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

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

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

返回值

一个 (过去协变量, 未来协变量) 的元组。每个协变量包含原始以及编码的协变量。

返回类型

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

classmethod gridsearch(parameters, series, past_covariates=None, future_covariates=None, forecast_horizon=None, stride=1, start=None, start_format='value', last_points_only=False, show_warnings=True, val_series=None, use_fitted_values=False, metric=<function mape>, reduction=<function mean>, verbose=False, n_jobs=1, n_random_samples=None, data_transformers=None, fit_kwargs=None, predict_kwargs=None, sample_weight=None)

使用网格搜索从给定集合中找到最佳超参数。

此函数具有 3 种操作模式：扩展窗口模式、分割模式和拟合值模式。这三种操作模式通过使用 parameters 字典中提供的超参数值的每种组合实例化 ForecastingModel 的 model_class 子类，并返回在 metric 函数方面表现最佳的模型，来评估每种可能的超参数值组合。metric 函数预计返回一个误差值，因此将选择导致最小 metric 输出的模型。

训练数据和测试数据的关系取决于操作模式。

扩展窗口模式（当传递 forecast_horizon 时激活）：对于每种超参数组合，模型都会在 series 的不同分割上重复进行训练和评估。此过程通过使用 backtest() 函数作为子程序生成从 start 开始的历史预测，并将其与 series 的真实值进行比较来实现。请注意，模型会针对每个预测重新训练，因此此模式较慢。

分割窗口模式（当传递 val_series 时激活）：当传递 val_series 参数时将使用此模式。对于每种超参数组合，模型在 series 上训练并在 val_series 上评估。

拟合值模式（当 use_fitted_values 设置为 True 时激活）：对于每种超参数组合，模型在 series 上训练并在生成的拟合值上评估。并非所有模型都有拟合值，如果模型没有 fitted_values 成员，则此方法会引发错误。拟合值是模型在 series 上拟合的结果。与拟合值进行比较是评估模型的一种快速方法，但无法判断模型是否对序列过拟合。

派生类必须确保模型的单个实例不会与其他实例共享参数，例如，将模型保存在同一路径下。否则，当并行运行多个模型时（当 n_jobs != 1 时），可能会出现意外行为。如果无法避免这种情况，则应重新定义 gridsearch，强制设置 n_jobs = 1。

当前此方法仅支持确定性预测（即模型预测仅包含 1 个样本时）。

参数

• model_class – 要为 ‘series’ 调优的 ForecastingModel 子类。

• parameters (dict) – 一个字典，其中键是超参数名称，值是相应超参数的值列表。

• series (TimeSeries) – 用作训练输入和目标的序列。

• past_covariates (Optional[TimeSeries, None]) – 可选的，一个过去观测的协变量序列。这仅适用于模型支持过去协变量的情况。

• future_covariates (Optional[TimeSeries, None]) – 可选的，一个未来已知的协变量序列。这仅适用于模型支持未来协变量的情况。

• forecast_horizon (Optional[int, None]) – 预测范围的整数值。激活扩展窗口模式。

• stride (int) – 仅在扩展窗口模式下使用。两次连续预测之间的时间步数。

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

  仅在扩展窗口模式下使用。可选地，计算预测的第一个时间点。此参数支持：float、int、pandas.Timestamp 和 None。如果是 float，则是时间序列中应位于第一个预测点之前的部分比例。如果是 int，则对于具有 pd.DatetimeIndex 的 series，它是第一个预测点的索引位置；对于具有 pd.RangeIndex 的 series，它是索引值。后者可以通过 start_format=”position” 更改为索引位置。如果是 pandas.Timestamp，它是第一个预测点的时间戳。如果是 None，第一个预测点将自动设置为

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

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

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

  注意：如果 start 不在可训练/可预测点范围内，则使用距离 start 最近的、并且是 stride 的整数倍的有效起始点。如果不存在有效的起始点，则引发 ValueError。

  注意：如果 start 超出可能的历史预测时间范围，将忽略该参数（None 时的默认行为），并从第一个可训练/可预测点开始。

  Note: If the model uses a shifted output (output_chunk_shift > 0), then the first predicted point is also shifted by output_chunk_shift points into the future.

  Note: If start is outside the possible historical forecasting times, will ignore the parameter (default behavior with None) and start at the first trainable/predictable point.

  Note: If start is not within the trainable / forecastable points, uses the closest valid start point that

  is a round multiple of stride ahead of start. Raises a ValueError, if no valid start point exists.

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

  可选地，要应用于相应序列（可能的键：“series”、“past_covariates”、“future_covariates”）的 BaseDataTransformer 或 Pipeline 字典。如果提供，所有输入序列必须处于未转换空间。对于可拟合的转换器/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。

  注意：如果 start 超出可能的历史预测时间范围，将忽略该参数（None 时的默认行为），并从第一个可训练/可预测点开始。

  Note: If the model uses a shifted output (output_chunk_shift > 0), then the first predicted point is also shifted by output_chunk_shift points into the future.

  Note: If start is outside the possible historical forecasting times, will ignore the parameter (default behavior with None) and start at the first trainable/predictable point.

  Note: If start is not within the trainable / forecastable points, uses the closest valid start point that

  is a round multiple of stride ahead of start. Raises a ValueError, if no valid start point exists.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  可选地，要应用于相应序列（可能的键：“series”、“past_covariates”、“future_covariates”）的 BaseDataTransformer 或 Pipeline 字典。如果提供，所有输入序列必须处于未转换空间。对于可拟合的转换器/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。有关支持的 kwargs 的更多信息，请查看Lightning Trainer 文档。

• **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: int

返回回归模型（集成层）的 output_chunk_length。

返回类型

int

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)

预测系列结束后的 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() (error) 作为 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。

  注意：如果 start 超出可能的历史预测时间范围，将忽略该参数（None 时的默认行为），并从第一个可训练/可预测点开始。

  Note: If the model uses a shifted output (output_chunk_shift > 0), then the first predicted point is also shifted by output_chunk_shift points into the future.

  Note: If start is outside the possible historical forecasting times, will ignore the parameter (default behavior with None) and start at the first trainable/predictable point.

  Note: If start is not within the trainable / forecastable points, uses the closest valid start point that

  is a round multiple of stride ahead of start. Raises a ValueError, if no valid start point exists.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  可选地，要应用于相应序列（可能的键：“series”、“past_covariates”、“future_covariates”）的 BaseDataTransformer 或 Pipeline 字典。如果提供，所有输入序列必须处于未转换空间。对于可拟合的转换器/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”，以及用于缩放度量（例如 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 计算。

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

返回类型

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

返回值

• 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, **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

如果回归模型支持似然参数预测，则 RegressionEnsembleModel 也支持。

返回类型

bool

property supports_multivariate: bool

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

返回类型

bool

property supports_optimized_historical_forecasts: bool

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

返回类型

bool

property supports_past_covariates: bool

模型是否支持过去协变量

返回类型

bool

property supports_probabilistic_prediction: bool

如果回归模型是概率模型（集成层），则 RegressionEnsembleModel 是概率模型。

返回类型

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

上一页

Random Forest

下一页

Regression Model