VARIMA

VARIMA (向量自回归移动平均) 模型 [1]。实现基于 statsmodels 封装。

参考

1

https://en.wikipedia.org/wiki/Vector_autoregression

class darts.models.forecasting.varima.VARIMA(p=1, d=0, q=0, trend=None, add_encoders=None)

基类: TransferableFutureCovariatesLocalForecastingModel

参数

• p (int) – 自回归模型 (AR) 的阶数 (时间滞后数量)

• d (int) – 差分阶数；即数据减去过去值的次数。(I) 注意，Darts 只支持 d <= 1，因为对于 d > 1，优化器通常无法产生稳定的预测结果。如果 d = 1 时结果不稳定，请尝试将 d 设置为 0 并启用趋势参数以考虑可能的非平稳性。

• q (int) – 移动平均窗口 (MA) 的大小。

• trend (str) – 控制确定性趋势的参数。“n” 表示无趋势，“c” 表示常数项，“t” 表示时间线性趋势，“ct” 表示两者都包含。对于没有积分的模型，默认为“c”，对于有积分的模型，默认为无趋势。

• 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 ETTh2Dataset
>>> from darts.models import VARIMA
>>> from darts.utils.timeseries_generation import holidays_timeseries
>>> # forecasting the High UseFul Load ("HUFL") and Oil Temperature ("OT")
>>> series = ETTh2Dataset().load()[:500][["HUFL", "OT"]]
>>> # optionally, use some future covariates; e.g. encode each timestep whether it is on a holiday
>>> future_cov = holidays_timeseries(series.time_index, "CN", add_length=6)
>>> # no clear trend in the dataset
>>> model = VARIMA(trend="n")
>>> model.fit(series, future_covariates=future_cov)
>>> pred = model.predict(6, future_covariates=future_cov)
>>> # the two targets are predicted together
>>> pred.values()
array([[48.11846185, 47.94272629],
       [49.85314633, 47.97713346],
       [51.16145791, 47.99804203],
       [52.14674087, 48.00872598],
       [52.88729152, 48.01166578],
       [53.44242919, 48.00874069]])

属性

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])	在提供的（单个）时间序列上拟合/训练模型。
generate_fit_encodings(series[, ...])	生成用于拟合模型的协变量编码，并返回一个元组，其中包含原始协变量和编码协变量堆叠在一起的过去和未来协变量序列。编码由模型创建时使用参数 add_encoders 定义的编码器生成。传递与训练/拟合模型时使用的相同的 series、past_covariates 和 future_covariates。
generate_fit_predict_encodings(n, series[, ...])	生成用于训练和推理/预测的协变量编码，并返回一个元组，其中包含原始协变量和编码协变量堆叠在一起的过去和未来协变量序列。编码由模型创建时使用参数 add_encoders 定义的编码器生成。传递打算用于训练和预测的相同的 series、past_covariates 和 future_covariates。
generate_predict_encodings(n, series[, ...])	生成用于推理/预测集的协变量编码，并返回一个元组，其中包含原始协变量和编码协变量堆叠在一起的过去和未来协变量序列。编码由模型创建时使用参数 add_encoders 定义的编码器生成。传递打算用于预测的相同的 series、past_covariates 和 future_covariates。
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 为 True 或 int（给定 train_length），或者 retrain 是 Callable 且第一个可训练点早于第一个可预测点，则为第一个可训练点。

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

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

  是 stride 在 start 之前的整数倍。如果不存在有效的起始点，则引发 ValueError。

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

  向未来偏移 output_chunk_shift 个点。

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

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

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

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

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

  是否以及/或在何种条件下在预测前重新训练模型。此参数支持 3 种不同的类型：bool、(正数) int 和 Callable (返回 bool)。对于 bool 类型：在每个步骤重新训练模型 (True)，或永不重新训练模型 (False)。对于 int 类型：模型每 retrain 次迭代重新训练。对于 Callable 类型：只要可调用对象返回 True，模型就会重新训练。可调用对象必须具有以下位置参数

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

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

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

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

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

  注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则会向相应的重新训练函数参数传递 None。注意：某些模型需要每次都重新训练，并且不支持除 retrain=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]) –

  可选，要应用于相应序列的 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’，用于减少组件维度度量的 ‘component_reduction’，用于缩放度量的季节性参数 ‘m’ 等。将单独传递参数给每个度量，并且仅当它们存在于相应的度量签名中时才会传递。缩放度量（例如 mase、rmsse 等）的参数 ‘insample’ 被忽略，因为它在内部处理。

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

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

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

返回值类型

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

返回值

• float – 对于单个单变量/多变量序列、单个 metric 函数和

  • 使用 last_points_only=True 生成的 historical_forecasts

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

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

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

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

  • 多个单变量/多变量序列，包括 series_reduction，以及“按时间步度量”时至少一个 component_reduction=None 或 time_reduction=None

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

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

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 种操作模式：扩展窗口模式、分割模式和拟合值模式。这 3 种操作模式通过使用 model_class 的 ForecastingModel 子类对 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 为 True 或 int（给定 train_length），或者 retrain 是可调用对象且第一个可训练点早于第一个可预测点，则为第一个可训练点。

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

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

  是 stride 在 start 之前的整数倍。如果不存在有效的起始点，则引发 ValueError。

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

  向未来偏移 output_chunk_shift 个点。

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

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

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

• 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 为 True 或 int（给定 train_length），或者 retrain 是 Callable 且第一个可训练点早于第一个可预测点，则为第一个可训练点。

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

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

  是 stride 在 start 之前的整数倍。如果不存在有效的起始点，则引发 ValueError。

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

  向未来偏移 output_chunk_shift 个点。

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

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

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

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

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

  是否以及/或在何种条件下在预测前重新训练模型。此参数支持 3 种不同的类型：bool、(正数) int 和 Callable (返回 bool)。对于 bool 类型：在每个步骤重新训练模型 (True)，或永不重新训练模型 (False)。对于 int 类型：模型每 retrain 次迭代重新训练。对于 Callable 类型：只要可调用对象返回 True，模型就会重新训练。可调用对象必须具有以下位置参数

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

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

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

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

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

  注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则会向相应的重新训练函数参数传递 None。注意：某些模型需要每次都重新训练，并且不支持除 retrain=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]) –

  可选，要应用于相应序列的 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: 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 的参数而不是目标值。仅支持具有似然函数、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 进行配置。

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

• 创建并返回具有历史预测时间索引的 TimeSeries（或仅包含 values_only=True 的 np.ndarray），其值是每个分量和时间步的度量结果。

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

参数

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

• past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选，每个输入时间序列 series 对应的过去观测协变量时间序列（或序列）。仅当模型支持过去协变量时适用。

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

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

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

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

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

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

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

  • 如果 retrain 为 False，或者是可调用对象且第一个可预测点早于第一个可训练点，则为第一个可预测点。

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

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

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

  是 stride 在 start 之前的整数倍。如果不存在有效的起始点，则引发 ValueError。

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

  向未来偏移 output_chunk_shift 个点。

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

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

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

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

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

  是否以及/或在何种条件下在预测前重新训练模型。此参数支持 3 种不同的类型：bool、(正数) int 和 Callable (返回 bool)。对于 bool 类型：在每个步骤重新训练模型 (True)，或永不重新训练模型 (False)。对于 int 类型：模型每 retrain 次迭代重新训练。对于 Callable 类型：只要可调用对象返回 True，模型就会重新训练。可调用对象必须具有以下位置参数

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

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

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

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

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

  注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则会向相应的重新训练函数参数传递 None。注意：某些模型需要每次都重新训练，并且不支持除 retrain=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]) –

  可选，要应用于相应序列的 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 – 对于单个 series 且通过 last_points_only=True 生成的 historical_forecasts 的残差 TimeSeries。

• List[TimeSeries] – 对于使用 last_points_only=True 的序列（列表）series 的残差 TimeSeries 列表。残差列表的长度为 len(series)。

• List[List[TimeSeries]] – 对于使用 last_points_only=False 的序列 series 的残差 TimeSeries 的列表的列表。外层残差列表的长度为 len(series)。内层列表包含所有可能的序列特定历史预测的残差。

save(path=None, clean=False, **pkl_kwargs)

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

保存和加载 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

上一页

Time-Series Mixer (TSMixer)

下一页

XGBoost Model