TBATS

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

基类：StatsForecastModel

基于 Statsforecasts 包 的 TBATS 模型。

三角 Box-Cox 变换、ARMA 误差、趋势和季节成分 (TBATS) 模型。它是一个创新状态空间模型框架，用于预测具有多个季节性的时间序列。它使用 Box-Cox 变换、ARMA 误差以及基于傅里叶级数的季节模式三角表示。

有关参数的详尽文档，请参考 StatsForecast 文档。

除了单变量确定性预测，它还附带额外支持

• 未来协变量： 使用外部特征以潜在地提高预测准确性。Darts 通过首先使用 LinearRegressionModel 模型将时间序列与未来协变量进行回归，然后在此原始回归的样本内残差上运行 StatsForecast 模型来添加支持。这种方法受到了 Stephan Kolassa 此帖 的启发。

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

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

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

• 可迁移时序预测： 在预测时将拟合的模型应用于新的输入 series。Darts 通过首先在新序列上拟合模型的副本，然后使用该模型生成相应的预测来添加支持。

注意

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

注意

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

参数

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

• add_encoders (Optional[dict, None]) –

  可以使用 add_encoders 自动生成大量未来协变量。这可以通过添加多个预定义索引编码器和/或将用于索引编码器的自定义用户函数来实现。此外，可以添加一个转换器，例如 Darts 的 Scaler，来转换生成的协变量。这一切都在幕后进行，只需在模型创建时指定。默认值：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.TBATS 的关键字参数。

示例

>>> from darts.datasets import AirPassengersDataset
>>> from darts.models import TBATS
>>> series = AirPassengersDataset().load()
>>> # define TBATS parameters
>>> model = TBATS(season_length=12)
>>> model.fit(series)
>>> pred = model.predict(6)
>>> pred.values()
array([[450.79653684],
       [472.09265790],
       [497.76948306],
       [510.74927369],
       [520.92224557],
       [570.33881522]])

属性

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[, ...])	生成用于模型拟合的协变量编码，并返回一个包含原始和编码协变量堆叠在一起的过去和未来协变量序列的元组。
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 不在可训练/可预测点范围内，则使用距离 start 最近的有效起始点，该点是 stride 整数倍并位于 start 之后。如果不存在有效的起始点，则引发 ValueError。

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

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

  向前偏移了 output_chunk_shift 个点。

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

  （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）。在布尔值的情况下：在每个步骤重新训练模型（True），或从不重新训练模型（False）。在整数的情况下：模型每 retrain 次迭代重新训练一次。在 Callable 的情况下：当 callable 返回 True 时，模型重新训练。Callable 必须具有以下位置参数：

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

  • pred_time (pd.Timestamp or int)：预测时间的时间戳

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

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

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

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

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

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

• metric (Union[Callable[…, Union[float, list[float], ndarray, list[ndarray]]], list[Callable[…, Union[float, list[float], ndarray, list[ndarray]]]]]) – 一个指标函数或一个指标函数列表。每个指标必须是 Darts 指标（参见此处），或具有与 Darts 指标相同签名的自定义指标，使用装饰器 multi_ts_support() 和 multi_ts_support()，并返回指标分数。

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

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

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

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

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

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

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

  • 如果 retrain=True，data transformer 会在每个历史预测步骤重新拟合训练数据。

  • 如果 retrain=False，data transformer 会在所有预测之前对序列进行一次转换。

  拟合的 transformer 用于训练和预测期间的输入转换。如果转换是可逆的，预测将进行逆转换。仅在 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 的组件数量匹配。如果是字符串，则使用内置加权函数生成权重。可用选项为“线性”或“指数”衰减——过去越远，权重越低。权重按每个时间序列计算。

返回类型

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

返回

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

  • historical_forecasts 使用 last_points_only=True 生成。

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

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

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

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

  • 多个单变量/多变量序列，包括 series_reduction，并且至少 component_reduction=None 或 time_reduction=None 之一用于“按时间步长的指标”。

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

• List[np.ndarray] – 与 type 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 种操作模式：扩展窗口模式、拆分模式和拟合值模式。这三种操作模式通过使用 parameters 字典中提供的每种超参数值组合实例化 ForecastingModel 的 model_class 子类，从而评估所有可能的组合，并返回在 metric 函数方面表现最佳的模型。metric 函数期望返回一个误差值，因此将选择产生最小 metric 输出的模型。

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

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

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

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

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

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

参数

• model_class – 用于针对 ‘series’ 进行调优的 ForecastingModel 子类。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  向前偏移了 output_chunk_shift 个点。

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

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

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

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

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

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

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

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

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

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

• verbose – 是否打印进度。

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

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

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

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

  • 如果 retrain=True，data transformer 会在每个历史预测步骤重新拟合训练数据。

  • 如果 retrain=False，data transformer 会在所有预测之前对序列进行一次转换。

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

• 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 整数倍并位于 start 之后。如果不存在有效的起始点，则引发 ValueError。

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

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

  向前偏移了 output_chunk_shift 个点。

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

  （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）。在布尔值的情况下：在每个步骤重新训练模型（True），或从不重新训练模型（False）。在整数的情况下：模型每 retrain 次迭代重新训练一次。在 Callable 的情况下：当 callable 返回 True 时，模型重新训练。Callable 必须具有以下位置参数：

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

  • pred_time (pd.Timestamp or int)：预测时间的时间戳

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

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

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

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

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

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

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

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

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

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

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

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

  • 如果 retrain=True，data transformer 会在每个历史预测步骤重新拟合训练数据。

  • 如果 retrain=False，data transformer 会在所有预测之前对序列进行一次转换。

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

• 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 的组件数量匹配。如果是字符串，则使用内置加权函数生成权重。可用选项为“线性”或“指数”衰减——过去越远，权重越低。权重按每个时间序列计算。

返回类型

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]] – 对于带有 last_points_only=False 的 series 序列的历史预测列表的列表。对于每个序列和历史预测，它包含整个预测范围 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 的参数而不是目标。仅支持具有似然函数、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 是一个 Callable 且第一个可预测点早于第一个可训练点，则设置为第一个可预测点。

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

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

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

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

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

  向前偏移了 output_chunk_shift 个点。

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

  （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）。在布尔值的情况下：在每个步骤重新训练模型（True），或从不重新训练模型（False）。在整数的情况下：模型每 retrain 次迭代重新训练一次。在 Callable 的情况下：当 callable 返回 True 时，模型重新训练。Callable 必须具有以下位置参数：

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

  • pred_time (pd.Timestamp or int)：预测时间的时间戳

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

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

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

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

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

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

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

  Darts 的“按时间步长”指标之一（参见此处），或者一个自定义指标，其签名与 Darts 的“按时间步长”指标相同，使用装饰器 multi_ts_support() 和 multi_ts_support()，并按时间步长返回一个值。

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

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

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

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

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

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

  • 如果 retrain=True，data transformer 会在每个历史预测步骤重新拟合训练数据。

  • 如果 retrain=False，data transformer 会在所有预测之前对序列进行一次转换。

  拟合的 transformer 用于训练和预测期间的输入转换。如果转换是可逆的，预测将进行逆转换。仅在 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 的组件数量匹配。如果是字符串，则使用内置加权函数生成权重。可用选项为“线性”或“指数”衰减——过去越远，权重越低。权重按每个时间序列计算。

• 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 存储的全局预测模型后，必须向 ‘predict()’、historical_forecasts() 和其他预测方法传递一个 series。

• 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

上一页

StatsForecastModel

下一页

Temporal Convolutional Network