AutoARIMA

class darts.models.forecasting.sf_auto_arima.AutoARIMA(*args, add_encoders=None, quantiles=None, random_state=None, **kwargs)

基类: StatsForecastModel

基于 Statsforecasts 包 的 Auto-ARIMA。

使用信息准则自动选择最佳的自回归积分滑动平均 (ARIMA) 模型。有关参数的详尽文档，请参阅 StatsForecast 文档。

除了单变量确定性预测之外，它还提供额外的支持：

• 未来协变量： 使用外部特征来潜在提高预测准确性。

• 概率预测： 要生成概率预测，您可以在调用 predict() 时设置以下参数：

  • 通过设置 predict_likelihood_parameters=True 直接预测分位数。

  • 通过设置 num_samples >> 1 从这些分位数生成采样预测。

• 保形预测： 除了原生概率支持之外，您还可以在模型创建时设置 prediction_intervals 来执行保形预测。然后以与上述相同的方式进行预测。

• 可迁移序列预测： 在预测时将拟合的模型应用于新的输入 series。

注意

当输入序列包含缺失值时，不支持未来协变量。

注意

第一次模型调用可能比所有后续调用花费更多时间，因为该模型依赖于 Numba 和 jit 编译。

参数

• args – statsforecasts.models.AutoARIMA 的位置参数。

• add_encoders (Optional[dict, None]) –

  可以使用 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': {'future': ['relative']},
      'custom': {'future': [encode_year]},
      'transformer': Scaler(),
      'tz': 'CET'
  }
  

• quantiles (Optional[list[float], None]) – （可选）在使用 num_samples > 1 或 predict_likelihood_parameters=True 进行概率预测时，在指定的 quantiles 水平下产生分位数预测。

• random_state (Optional[int, None]) – 控制跨不同运行的概率保形预测（样本生成）的随机性。

• kwargs – statsforecasts.models.AutoARIMA 的关键字参数。

示例

>>> from darts.datasets import AirPassengersDataset
>>> from darts.models import AutoARIMA
>>> from darts.utils.timeseries_generation import datetime_attribute_timeseries
>>> series = AirPassengersDataset().load()
>>> # optionally, use some future covariates; e.g. the value of the month encoded as a sine and cosine series
>>> future_cov = datetime_attribute_timeseries(series, "month", cyclic=True, add_length=6)
>>> # define AutoARIMA parameters
>>> model = AutoARIMA(season_length=12)
>>> model.fit(series, future_covariates=future_cov)
>>> pred = model.predict(6, future_covariates=future_cov)
>>> pred.values()
array([[445.4276575 ],
       [420.04912881],
       [448.7142377 ],
       [491.23406559],
       [502.67834069],
       [566.04774778]])

属性

considers_static_covariates	模型是否考虑静态协变量（如果存在）。
extreme_lags	包含按顺序排列的 8 元组：（最小目标滞后、最大目标滞后、最小过去协变量滞后、最大过去协变量滞后、最小未来协变量滞后、最大未来协变量滞后、输出偏移、训练中的最大目标滞后（仅适用于 RNNModel））。
似然函数	返回模型用于概率预测的似然函数（如果存在）。
min_train_samples	训练模型的最小样本数。
output_chunk_length	模型一次预测的时间步长数，对于统计模型未定义。
output_chunk_shift	输出/预测在输入结束后开始的时间步长数。
supports_future_covariates	模型是否支持未来协变量
supports_likelihood_parameter_prediction	检查模型实例是否支持直接预测似然参数
supports_multivariate	模型是否考虑时间序列中的多个变量。
supports_optimized_historical_forecasts	模型是否支持优化的历史预测
supports_past_covariates	模型是否支持过去协变量
supports_probabilistic_prediction	检查此配置的预测模型是否支持概率预测。
supports_sample_weight	模型是否支持训练的样本权重。
supports_static_covariates	模型是否支持静态协变量
supports_transferable_series_prediction	模型是否支持对任何输入 series 进行预测。
uses_future_covariates	模型在拟合后是否使用未来协变量。
uses_past_covariates	模型在拟合后是否使用过去协变量。
uses_static_covariates	模型在拟合后是否使用静态协变量。

model_params

方法

backtest(series[, past_covariates, ...])	计算模型对（可能多个）series 的历史预测所产生的误差值。
fit(series[, future_covariates])	在提供的（单个）序列上拟合/训练模型。
generate_fit_encodings(series[, ...])	生成用于拟合模型的协变量编码，并返回一个包含原始协变量和编码协变量堆叠在一起的过去和未来协变量序列的元组。
generate_fit_predict_encodings(n, series[, ...])	生成用于训练和推断/预测的协变量编码，并返回一个包含原始协变量和编码协变量堆叠在一起的过去和未来协变量序列的元组。
generate_predict_encodings(n, series[, ...])	生成用于推断/预测集的协变量编码，并返回一个包含原始协变量和编码协变量堆叠在一起的过去和未来协变量序列的元组。
gridsearch(parameters, series[, ...])	使用网格搜索在一组给定参数中找到最佳超参数。
historical_forecasts(series[, ...])	通过模拟在提供的（可能多个）series 的整个历史中不同时间点的预测来生成历史预测。
load(path)	从给定的路径或文件句柄加载模型。
predict(n[, series, future_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 不在可训练/可预测点范围内，则使用最接近的有效起始点，该点是 stride 的倍数且在 start 之后。如果不存在有效的起始点，则引发 ValueError。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则 None 将传递给相应的重新训练函数参数。注意：某些模型要求每次都重新训练，并且不支持除 retrain=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 的参数而不是目标。仅支持具有 likelihood、num_samples = 1 和 n<=output_chunk_length 的概率模型。默认值：False。

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

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

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

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

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

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

• metric_kwargs (Union[dict[str, Any], list[dict[str, Any]], None]) – 传递给 metric() 的附加参数，例如并行化的 ‘n_jobs’，用于减小分量wise指标的 ‘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 生成的 historical_forecasts 并使用回测 reduction，返回单个回测分数。

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

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

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

  • 多个单变量/多变量序列，包括 series_reduction，以及至少一个 component_reduction=None 或 time_reduction=None（用于“每时间步长指标”）。

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

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

property considers_static_covariates: bool

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

返回类型

bool

property 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, future_covariates=None)

在提供的（单个）序列上拟合/训练模型。

（可选）可以提供未来协变量序列。

参数

• series (TimeSeries) – 模型将训练以预测此时间序列。如果模型支持，可以是多变量。

• future_covariates (Optional[TimeSeries, None]) – 未来已知协变量的时间序列。此时间序列不会被预测，但可以被某些模型用作输入。它必须至少包含与目标 series 相同的时间步长/索引。如果比必要长度长，将自动截断。

返回

拟合模型。

返回类型

self

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

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

参数

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 训练模型时使用的目标值序列或序列列表。

• past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – （可选）训练模型时使用的过去观测协变量序列或序列列表。

• future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – （可选）训练模型时使用的未来已知协变量序列或序列列表。

返回

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

返回类型

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

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

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

参数

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

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

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

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

返回

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

返回类型

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

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

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

参数

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

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

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

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

返回

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

返回类型

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

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

使用网格搜索在一组给定参数中找到最佳超参数。

此函数有 3 种操作模式：扩展窗口模式、分割模式和拟合值模式。这三种操作模式通过实例化 ForecastingModel 的 model_class 子类，并使用 parameters 字典中提供的每种超参数值组合，来评估所有可能的组合，并返回在 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 不在可训练/可预测点范围内，则使用最接近的有效起始点，该点是 stride 的倍数且在 start 之后。如果不存在有效的起始点，则引发 ValueError。

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

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

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

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

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

• start_format (Literal['position', 'value']) – 仅用于扩展窗口模式。定义 start 参数的格式。仅当 start 是整数且 series 使用 pd.RangeIndex 索引时有效。如果设置为“position”，则 start 对应于第一个预测点的索引位置，范围为 (-len(series), len(series) - 1)。如果设置为“value”，则 start 对应于第一个预测点的索引值/标签。如果该值不在 series 的索引中，将引发错误。默认值: 'value'

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

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

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

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

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

  一个指标函数，返回两个 TimeSeries 之间的误差，结果为浮点值。必须是 Darts 中“按时间聚合”的指标之一（参见 此处），或者是一个接受两个 TimeSeries 作为输入并返回误差的自定义指标。

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

• verbose – 是否打印进度。

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

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

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

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

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

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

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

• 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 不在可训练/可预测点范围内，则使用最接近的有效起始点，该点是 stride 的倍数且在 start 之后。如果不存在有效的起始点，则引发 ValueError。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则 None 将传递给相应的重新训练函数参数。注意：某些模型要求每次都重新训练，并且不支持除 retrain=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 的参数而不是目标。仅支持具有 likelihood、num_samples = 1 和 n<=output_chunk_length 的概率模型。默认值：False。

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

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

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

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

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

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

• 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: QuantilePrediction

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

返回类型

QuantilePrediction (分位数预测)

static load(path)

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

参数

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

返回类型

ForecastingModel (预测模型)

property min_train_samples: int

训练模型的最小样本数。

返回类型

int (整数)

property model_params: dict

返回类型

dict (字典)

property output_chunk_length: Optional[int]

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

返回类型

Optional[int, None]

property output_chunk_shift: int

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

返回类型

int (整数)

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

如果未设置 series 参数，则预测训练序列结束后的 n 个时间步长的值。如果在训练期间指定了某些未来协变量，则此处也必须指定它们。

如果设置了 series 参数，则预测新目标序列结束后的 n 个时间步长的值。如果在训练期间指定了某些未来协变量，则此处也必须指定它们。

参数

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

• series (Optional[TimeSeries, None]) – 可选参数，一个新的目标序列，将预测其未来值。默认为 None，表示模型将预测训练序列的未来值。

• future_covariates (Optional[TimeSeries, None]) –

  未来已知协变量的时间序列，可以作为模型的输入。它必须与用于训练时使用的 fit() 方法的协变量时间序列相对应。

  如果未设置 series，它必须包含至少训练目标序列结束后的接下来 n 个时间步长/索引。如果设置了 series，它必须包含至少与新目标序列相对应的时间步长/索引（历史未来协变量），加上结束后的接下来 n 个时间步长/索引。

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

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

• verbose (bool) – 可选参数，设置预测的详细程度。并非对所有模型都有效。

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

返回类型

TimeSeries，一个包含训练序列结束后的接下来 n 个点的时间序列。

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], 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 时的默认行为），并从第一个可训练/可预测点开始。

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

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

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

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

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

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

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

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

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

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

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

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

  注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则 None 将传递给相应的重新训练函数参数。注意：某些模型要求每次都重新训练，并且不支持除 retrain=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 的参数而不是目标。仅支持具有 likelihood、num_samples = 1 和 n<=output_chunk_length 的概率模型。默认值：False。

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

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

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

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

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

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

• metric_kwargs (Optional[dict[str, Any], None]) – 传递给 metric() 的额外参数，例如用于并行化的 ‘n_jobs’，用于缩放指标的 ‘m’ 等。仅当参数存在于相应的指标签名中时才会传递。忽略归约参数 “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 – 当 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, **pkl_kwargs)

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

保存和加载 RegressionModel 的示例

from darts.models import RegressionModel

model = RegressionModel(lags=4)

model.save("my_model.pkl")
model_loaded = RegressionModel.load("my_model.pkl")

参数

• path (Union[str, PathLike, BinaryIO, None]) – 保存模型当前状态的路径或文件句柄。如果未指定路径，模型将自动保存为 "{ModelClass}_{YYYY-mm-dd_HH_MM_SS}.pkl"。例如，"RegressionModel_2020-01-01_12_00_00.pkl"。

• clean (bool) –

  是否存储模型的“干净”版本。仅对全局预测模型有效。如果为 True，则移除训练序列和协变量。

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

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

返回类型

None (空)

property supports_future_covariates: bool

模型是否支持未来协变量

返回类型

bool

property supports_likelihood_parameter_prediction: bool

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

返回类型

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

上一页

循环神经网络

下一页

AutoCES