ARIMA

ARIMA (自回归积分滑动平均) 模型 [1]。该实现封装了 statsmodels。

参考文献

1

https://wikipedia.org/wiki/Autoregressive_integrated_moving_average

class darts.models.forecasting.arima.ARIMA(p=12, d=1, q=0, seasonal_order=(0, 0, 0, 0), trend=None, random_state=None, add_encoders=None)

基类: TransferableFutureCovariatesLocalForecastingModel

ARIMA 类型模型，可扩展外部变量（未来协变量）和季节性分量。

参数

• p (int | Sequence[int]) – 自回归模型 (AR) 的阶数（时间滞后数量）。如果为整数序列，则指定要包含的确切滞后。

• d (int) – 差分阶数；即数据减去过去值的次数 (I)。

• q (int | Sequence[int]) – 滑动平均窗口 (MA) 的大小。如果为整数序列，则指定要包含在窗口中的确切滞后。

• seasonal_order (Tuple[int | Sequence[int], int, int | Sequence[int], int]) – 季节性分量的阶数 (P,D,Q,s)，分别对应 AR 参数 (P)、差分 (D)、MA 参数 (Q) 和周期性 (s)。D 和 s 始终为整数，而 P 和 Q 可以是整数或正整数序列，用于指定要包含的确切滞后阶数。

• trend (Literal['n', 'c', 't', 'ct'] | list[int], optional) – 控制确定性趋势的参数。可以是字符串或整数列表。如果是字符串，'n' 表示无趋势，'c' 表示常数项，'t' 表示时间上的线性趋势，'ct' 表示常数项和线性趋势。如果为整数列表，则根据 numpy.poly1d [1] 定义多项式。例如，[1,1,0,1] 将转换为 \(a + bt + ct^3\)。低于 d + D 阶的趋势项无法保留，因为它们会因差分操作而被消除。对于无积分的模型，默认值为 'c'；对于有积分的模型，默认值为 'n'。

• 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'
  }
  

示例

>>> from darts.datasets import AirPassengersDataset
>>> from darts.models import ARIMA
>>> 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 ARIMA parameters
>>> model = ARIMA(p=12, d=1, q=2)
>>> model.fit(series, future_covariates=future_cov)
>>> pred = model.predict(6, future_covariates=future_cov)
>>> pred.values()
array([[451.36489334],
       [416.88972829],
       [443.10520391],
       [481.07892911],
       [502.11286509],
       [555.50153984]])

参考文献

1

https://numpy.com.cn/doc/stable/reference/generated/numpy.poly1d.html

属性

considers_static_covariates	模型是否考虑静态协变量（如果存在）。
extreme_lags	一个 8 元组，依次包含：(最小目标滞后，最大目标滞后，最小过去协变量滞后，最大过去协变量滞后，最小未来协变量滞后，最大未来协变量滞后，输出偏移，最大目标滞后训练（仅适用于 RNNModel）)。
likelihood	返回模型用于概率预测的似然（如果存在）。
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])	在提供的（单个）series 上拟合/训练模型。
generate_fit_encodings(series[, ...])	生成用于拟合模型的协变量编码，并返回一个包含原始协变量和编码协变量叠加在一起的过去协变量和未来协变量 series 的元组。
generate_fit_predict_encodings(n, series[, ...])	生成用于训练和推断/预测的协变量编码，并返回一个包含原始协变量和编码协变量叠加在一起的过去协变量和未来协变量 series 的元组。
generate_predict_encodings(n, series[, ...])	生成用于推断/预测集的协变量编码，并返回一个包含原始协变量和编码协变量叠加在一起的过去协变量和未来协变量 series 的元组。
gridsearch(parameters, series[, ...])	使用网格搜索在一给定集合中找到最佳超参数。
historical_forecasts(series[, ...])	通过模拟在提供的（可能多个）series 的整个历史中不同时间点的预测来生成历史预测。
load(path)	从给定的路径或文件句柄加载模型。
predict(n[, series, future_covariates, ...])	如果未设置 series 参数，则预测训练 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 进一步定制（例如，控制跨分量、时间步、多个 series 的聚合，以及分位数度量所需的其他参数，如 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 or int): 预测时间戳（训练 series 的结束）

  • train_series (TimeSeries): 截至 pred_time 的训练 series

  • past_covariates (TimeSeries): 截至 pred_time 的 past_covariates series

  • future_covariates (TimeSeries): 截至 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的 future_covariates series

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

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

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

• metric (Union[Callable[…, Union[float, list[float], ndarray, list[ndarray]]], list[Callable[…, Union[float, list[float], ndarray, list[ndarray]]]]]) – 一个度量函数或度量函数列表。每个度量必须是 Darts 度量（参见 此处），或者是与 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（可能的键；“series”、“past_covariates”、“future_covariates”）。如果提供此参数，所有输入 series 都必须处于未转换空间。对于可拟合的转换器/Pipeline

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

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

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

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

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

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

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

返回值类型

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

返回值

• float – 单个单变量/多变量 series 的单个回测分数，单个 metric 函数和

  • 使用 last_points_only=True 生成的 historical_forecasts

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

• np.ndarray – 一个 numpy 数组形式的回测分数。适用于单个 series 和以下情况之一：

  • 单个 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 的多个单变量/多变量 series，以及“每时间步度量”中至少一个 component_reduction=None 或 time_reduction=None。

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

• List[np.ndarray] – 与 np.ndarray 类型类似，但适用于 series 序列。返回的度量列表长度为 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 上拟合/训练模型。

可选地，也可以提供一个未来协变量 series。

参数

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

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

返回值

拟合好的模型。

返回值类型

self

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

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

参数

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

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

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

返回值

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

返回值类型

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

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

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

参数

• n (int) – 打算用于预测的、位于 series 结尾之后的预测时间步数量。

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

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

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

返回值

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

返回值类型

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

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

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

参数

• n (int) – 打算用于预测的、位于 series 结尾之后的预测时间步数量。

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

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

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

返回值

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

返回值类型

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 上拟合的结果。与拟合值进行比较是评估模型的快速方法，但无法看出模型是否在 series 上过拟合。

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

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

参数

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

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

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

• past_covariates (Optional[TimeSeries, None]) – 可选参数，一个过去观测协变量 series。仅当模型支持过去协变量时适用。

• future_covariates (Optional[TimeSeries, None]) – 可选参数，一个未来已知协变量 series。仅当模型支持未来协变量时适用。

• 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 必须紧接在 series 结束后开始；以便可以进行适当的预测比较。

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

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

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

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

• 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（可能的键；“series”、“past_covariates”、“future_covariates”）。如果提供此参数，所有输入 series 都必须处于未转换空间。对于可拟合的转换器/Pipeline

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

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

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

• 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 or int): 预测时间戳（训练 series 的结束）

  • train_series (TimeSeries): 截至 pred_time 的训练 series

  • past_covariates (TimeSeries): 截至 pred_time 的 past_covariates series

  • future_covariates (TimeSeries): 截至 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的 future_covariates series

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

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

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

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

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

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

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

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

  可选参数，一个 BaseDataTransformer 或 Pipeline 字典，用于应用于相应的 series（可能的键；“series”、“past_covariates”、“future_covariates”）。如果提供此参数，所有输入 series 都必须处于未转换空间。对于可拟合的转换器/Pipeline

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

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

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

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

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

• sample_weight (Union[TimeSeries, Sequence[TimeSeries], str, None]) – 可选参数，应用于目标 series 标签进行训练的样本权重。仅当 retrain 不为 False 时有效。它们按观测值、标签（output_chunk_length 中的每个步骤）和分量应用。如果是一个 series 或 series 序列，则使用这些权重。如果权重 series 只有一个分量/列，则权重全局应用于 series 中的所有分量。否则，对于分量特定的权重，分量数量必须与 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)

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

参数

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 不在可训练/可预测点范围内，则使用最接近的有效起始点，该起始点

  是 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 or int): 预测时间戳（训练 series 的结束）

  • train_series (TimeSeries): 截至 pred_time 的训练 series

  • past_covariates (TimeSeries): 截至 pred_time 的 past_covariates series

  • future_covariates (TimeSeries): 截至 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的 future_covariates series

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

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

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

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

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

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

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

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

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

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

  可选参数，一个 BaseDataTransformer 或 Pipeline 字典，用于应用于相应的 series（可能的键；“series”、“past_covariates”、“future_covariates”）。如果提供此参数，所有输入 series 都必须处于未转换空间。对于可拟合的转换器/Pipeline

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

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

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

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

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

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

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

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

返回值类型

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

返回值

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

• List[TimeSeries] – 一系列（列表）series 的残差 TimeSeries 列表，其中 last_points_only=True。残差列表的长度为 len(series)。

• List[List[TimeSeries]] – 一系列 series 的残差 TimeSeries 列表的列表，其中 last_points_only=False。外层残差列表的长度为 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

上一页

预测模型

下一页

基线模型