随机森林

一种使用随机森林回归的预测模型。它使用目标序列的一些滞后项，以及可选的协变量序列的一些滞后项来获得预测。

有关随机森林的参考，请参阅 [1]。

其实现封装了 RandomForestRegressor。

参考资料

1

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

class darts.models.forecasting.random_forest.RandomForest(lags=None, lags_past_covariates=None, lags_future_covariates=None, output_chunk_length=1, output_chunk_shift=0, add_encoders=None, n_estimators=100, max_depth=None, multi_models=True, use_static_covariates=True, **kwargs)

基类: RegressionModel

随机森林模型

参数

• lags (Union[int, list[int], dict[str, Union[int, list[int]]], None]) – 用于预测下一个时间步/多个时间步的滞后目标 series 值。如果是整数，必须 > 0。使用最近的 n=lags 个过去滞后项；例如 (-1, -2, …, -lags)，其中 0 对应于每个样本的第一个预测时间步。如果 output_chunk_shift > 0，则滞后项 -1 对应于第一个预测步之前的 -1 - output_chunk_shift 步。如果是整数列表，每个值必须 < 0。只使用指定的滞后值。如果是字典，键对应于 series 组件名称（使用多个序列时，指第一个序列的），值对应于组件滞后项（整数或整数列表）。键 ‘default_lags’ 可用于提供未指定组件的默认滞后项。如果缺少某些组件且未提供 ‘default_lags’ 键，则会引发错误。

• lags_past_covariates (Union[int, list[int], dict[str, Union[int, list[int]]], None]) – 用于预测下一个时间步/多个时间步的滞后 past_covariates 值。如果是整数，必须 > 0。使用最近的 n=lags_past_covariates 个过去滞后项；例如 (-1, -2, …, -lags)，其中 0 对应于每个样本的第一个预测时间步。如果 output_chunk_shift > 0，则滞后项 -1 对应于第一个预测步之前的 -1 - output_chunk_shift 步。如果是整数列表，每个值必须 < 0。只使用指定的滞后值。如果是字典，键对应于 past_covariates 组件名称（使用多个序列时，指第一个序列的），值对应于组件滞后项（整数或整数列表）。键 ‘default_lags’ 可用于提供未指定组件的默认滞后项。如果缺少某些组件且未提供 ‘default_lags’ 键，则会引发错误。

• lags_future_covariates (Union[tuple[int, int], list[int], dict[str, Union[tuple[int, int], list[int]]], None]) – 用于预测下一个时间步/多个时间步的滞后 future_covariates 值。滞后项总是相对于输出块中的第一个步，即使 output_chunk_shift > 0。如果是 (past, future) 元组，两个值都必须 > 0。使用最近的 n=past 个过去滞后项和 n=future 个未来滞后项；例如 (-past, -(past - 1), …, -1, 0, 1, …. future - 1)，其中 0 对应于每个样本的第一个预测时间步。如果 output_chunk_shift > 0，则负滞后项的位置与 lags 和 lags_past_covariates 的不同。在这种情况下，未来滞后项 -5 会指向与目标滞后项 -5 + output_chunk_shift 相同的步。如果是整数列表，只使用指定的滞后值。如果是字典，键对应于 future_covariates 组件名称（使用多个序列时，指第一个序列的），值对应于组件滞后项（元组或整数列表）。键 ‘default_lags’ 可用于提供未指定组件的默认滞后项。如果缺少某些组件且未提供 ‘default_lags’ 键，则会引发错误。

• output_chunk_length (int) – 内部模型一次预测的时间步数 (每块)。它与 predict() 中使用的预测范围 n 不同，后者是使用一次性或自回归预测所需的预测点数量。设置 n <= output_chunk_length 可防止自回归。当协变量在未来没有足够远的范围，或者为了禁止模型在预测时使用过去和/或未来协变量的未来值（取决于模型对协变量的支持）时，这很有用。

• output_chunk_shift (int) – 可选地，将输出块的开始向未来偏移的步数（相对于输入块结束）。这将产生一个间隔在输入（目标和过去协变量的历史）和输出之间。如果模型支持 future_covariates，则 lags_future_covariates 是相对于偏移输出块中的第一个步。预测将从目标 series 结束后的 output_chunk_shift 步开始。如果设置了 output_chunk_shift，模型无法生成自回归预测（n > output_chunk_length）。

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

• n_estimators (int) – 森林中树的数量。

• max_depth (int) – 树的最大深度。如果为 None，则节点会扩展直到所有叶子节点都是纯净的，或直到所有叶子节点包含的样本少于 min_samples_split。

• multi_models (Optional[bool, None]) – 如果为 True，将为每个未来的滞后项训练一个单独的模型进行预测。如果为 False，训练一个单一模型来预测 ‘output_chunk_length’ 中的所有步（对于每个步 n，特征滞后项会向后偏移 output_chunk_length - n）。默认值: True。

• use_static_covariates (bool) – 模型是否应该使用静态协变量信息，如果传递给 fit() 的输入 series 包含静态协变量。如果为 True，并且在拟合时提供了静态协变量，将强制所有目标 series 在 fit() 和 predict() 中具有相同的静态协变量维度。

• **kwargs – 传递给 sklearn.ensemble.RandomForest 的附加关键字参数。

示例

>>> from darts.datasets import WeatherDataset
>>> from darts.models import RandomForest
>>> series = WeatherDataset().load()
>>> # predicting atmospheric pressure
>>> target = series['p (mbar)'][:100]
>>> # optionally, use past observed rainfall (pretending to be unknown beyond index 100)
>>> past_cov = series['rain (mm)'][:100]
>>> # optionally, use future temperatures (pretending this component is a forecast)
>>> future_cov = series['T (degC)'][:106]
>>> # random forest with 200 trees trained with MAE
>>> model = RandomForest(
>>>     lags=12,
>>>     lags_past_covariates=12,
>>>     lags_future_covariates=[0,1,2,3,4,5],
>>>     output_chunk_length=6,
>>>     n_estimators=200,
>>>     criterion="absolute_error",
>>> )
>>> model.fit(target, past_covariates=past_cov, future_covariates=future_cov)
>>> pred = model.predict(6)
>>> pred.values()
array([[1006.29805],
       [1006.23675],
       [1006.17325],
       [1006.10295],
       [1006.06505],
       [1006.05465]])

属性

considers_static_covariates	模型是否考虑静态协变量（如果存在）。
extreme_lags	一个包含以下内容的 8 元组 (按顺序)：(最小目标滞后项, 最大目标滞后项, 最小过去协变量滞后项, 最大过去协变量滞后项, 最小未来协变量滞后项, 最大未来协变量滞后项, 输出偏移, 训练时的最大目标滞后项 (仅限 RNNModel))。
lagged_feature_names	模型训练时使用的滞后特征名称。
lagged_label_names	模型估计器的滞后标签名称。
likelihood	返回模型用于概率预测的似然（如果存在）。
min_train_samples	训练模型所需的最小样本数。
output_chunk_length	模型一次预测的时间步数，未为统计模型定义。
output_chunk_shift	输出/预测在输入结束之后开始的时间步数。
supports_future_covariates	模型是否支持未来协变量
supports_likelihood_parameter_prediction	模型实例是否支持直接预测似然参数
supports_multivariate	如果可用，使用 model 原生的多元支持。
supports_optimized_historical_forecasts	模型是否支持优化的历史预测
supports_past_covariates	模型是否支持过去协变量
supports_probabilistic_prediction	检查具有此配置的预测模型是否支持概率预测。
supports_sample_weight	模型在训练期间是否支持验证集。
supports_static_covariates	模型是否支持静态协变量
supports_transferable_series_prediction	模型是否支持对任何输入 series 进行预测。
supports_val_set	模型在训练期间是否支持验证集。
uses_future_covariates	模型拟合后是否使用未来协变量。
uses_past_covariates	模型拟合后是否使用过去协变量。
uses_static_covariates	模型拟合后是否使用静态协变量。
val_set_params	返回验证集的参数名称，如果支持验证集，还返回验证样本权重。

model_params

方法

backtest(series[, past_covariates, ...])	计算模型对（可能多个）series 的历史预测产生的误差值。
fit(series[, past_covariates, ...])	在一个或多个序列上拟合/训练模型。
generate_fit_encodings(series[, ...])	生成用于模型拟合的协变量编码，并返回过去协变量和未来协变量序列的元组，其中原始协变量和编码协变量堆叠在一起。
generate_fit_predict_encodings(n, series[, ...])	生成用于训练和推断/预测的协变量编码，并返回过去协变量和未来协变量序列的元组，其中原始协变量和编码协变量堆叠在一起。
generate_predict_encodings(n, series[, ...])	生成用于推断/预测集的协变量编码，并返回过去协变量和未来协变量序列的元组，其中原始协变量和编码协变量堆叠在一起。
get_estimator(horizon, target_dim[, quantile])	返回预测目标组件第 `target_dim` 个维度第 `horizon` 步的估计器。
gridsearch(parameters, series[, ...])	使用网格搜索在给定集合中寻找最佳超参数。
historical_forecasts(series[, ...])	通过模拟提供的（可能多个）series 在不同时间点的预测来生成历史预测。
load(path)	从给定路径或文件句柄加载模型。
predict(n[, series, past_covariates, ...])	预测序列结束后的 n 个时间步的值。
residuals(series[, past_covariates, ...])	计算模型对（可能多个）series 的历史预测产生的残差。
save([path, clean])	将模型保存到给定路径或文件句柄。
untrained_model()	返回使用相同参数创建的新（未训练）模型实例。

backtest(series, past_covariates=None, future_covariates=None, historical_forecasts=None, forecast_horizon=1, num_samples=1, train_length=None, start=None, start_format='value', stride=1, retrain=True, overlap_end=False, last_points_only=False, metric=<function mape>, reduction=<function mean>, verbose=False, show_warnings=True, predict_likelihood_parameters=False, enable_optimization=True, data_transformers=None, metric_kwargs=None, fit_kwargs=None, predict_kwargs=None, sample_weight=None)

计算模型对（可能多个）series 的历史预测产生的误差值。

如果提供了 historical_forecasts，则直接评估所有预测值和实际值上的指标（由 metric 函数给出）。必须传递用于生成历史预测的相同的 series 和 last_points_only 值。最后，该方法返回这些指标得分的可选 reduction (默认为平均值)。

如果 historical_forecasts 为 None，它首先使用下面给定的参数生成历史预测（更多信息请参阅 ForecastingModel.historical_forecasts()），然后按照上述描述进行评估。

指标可以通过 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 的整数倍

  ahead of start. Raises a ValueError, if no valid start point exists. (原文重复，无需翻译)

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

  into the future. (原文重复，无需翻译)

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

  (default behavior with None) and start at the first trainable/predictable point. (原文重复，无需翻译)

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

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

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

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

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

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

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

  • past_covariates (TimeSeries): 截止到 pred_time 的 past_covariates 序列

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  拟合好的转换器用于训练和预测过程中的输入转换。如果转换是可逆的，预测结果将被反向转换。仅当 historical_forecasts=None 时生效。

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

• 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, past_covariates=None, future_covariates=None, max_samples_per_ts=None, n_jobs_multioutput_wrapper=None, sample_weight=None, **kwargs)

在一个或多个序列上拟合/训练模型。

参数

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

• past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，一个或多个序列指定过去观测到的协变量

• future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，一个或多个序列指定未来已知的协变量

• max_samples_per_ts (Optional[int, None]) – 这是每个时间序列可以生成的元组数量的整数上限。它可用于限制数据集的总大小并确保适当采样。如果为 None，它将预先读取所有单独的时间序列（在数据集创建时）以了解它们的大小，这对于大数据集可能很昂贵。如果某些序列的长度允许超过 max_samples_per_ts，则只会考虑最近的 max_samples_per_ts 个样本。

• n_jobs_multioutput_wrapper (Optional[int, None]) – MultiOutputRegressor 封装器并行运行的作业数。仅当模型原生不支持多输出回归时使用。

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

• **kwargs – 传递给模型 fit 方法的附加关键字参数。

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]]]

get_estimator(horizon, target_dim, quantile=None)

返回预测目标组件第 `target_dim` 个维度第 `horizon` 步的估计器。

对于拟合分位数的概率模型，也可以指定分位数。

如果模型原生支持多输出，则直接返回模型。

注意：在内部，估计器按 output_chunk_length 位置分组，然后按组件分组。对于拟合分位数的概率模型，还有一个额外的抽象层，按 quantile 对估计器进行分组。

参数

• horizon (int) – 预测点在 output_chunk_length 中的索引。

• target_dim (int) – 目标分量的索引。

• quantile (Optional[float, None]) – 可选参数，对于带有 likelihood=”quantile” 的概率模型，表示分位数的值。

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 字典中提供的每个超参数值组合实例化 model_class（ForecastingModel 的子类），并返回关于 metric 函数的最佳性能模型。metric 函数应返回一个误差值，因此将选择产生最小 metric 输出的模型。

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

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

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

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

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

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

参数

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

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

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

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

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

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

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

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

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

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

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

  • 否则为第一个可训练点 (给定 train_length)

  注意：如果 start 不在可训练/可预测点范围内，将使用离 start 最近的有效起始点，且该点是 stride 的整数倍

  ahead of start. Raises a ValueError, if no valid start point exists. (原文重复，无需翻译)

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

  into the future. (原文重复，无需翻译)

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

  (default behavior with None) and start at the first trainable/predictable point. (原文重复，无需翻译)

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

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

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

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

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

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

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

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

• verbose – 是否打印进度。

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

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

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

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

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

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

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

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

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

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

返回值

一个元组，包含一个由性能最佳的超参数创建的未训练的 model_class 实例，以及一个包含这些最佳超参数的字典，以及最佳超参数的度量得分。

返回类型

ForecastingModel, Dict, float

historical_forecasts(series, past_covariates=None, future_covariates=None, forecast_horizon=1, num_samples=1, train_length=None, start=None, start_format='value', stride=1, retrain=True, overlap_end=False, last_points_only=True, verbose=False, show_warnings=True, predict_likelihood_parameters=False, enable_optimization=True, data_transformers=None, fit_kwargs=None, predict_kwargs=None, sample_weight=None)

通过模拟在提供的（可能多个）series 的整个历史中不同时间点的预测来生成历史预测。此过程涉及回顾性地将模型应用于不同的时间步长，就像在那些特定时刻实时进行了预测一样。这允许评估模型在整个序列持续时间内的性能，提供对其在不同历史时期的预测准确性和鲁棒性的见解。

此方法主要有两种模式

• 重新训练模式（默认，retrain=True）：在模拟的每一步都会重新训练模型，并使用更新后的模型生成预测。对于多个序列，模型会独立地在每个序列上重新训练（尚不支持全局训练）。

• 预训练模式（retrain=False）：在模拟的每一步生成预测，无需重新训练。仅支持预训练的全局预测模型。此模式显著更快，因为它跳过了重新训练步骤。

通过选择适当的模式，可以在计算效率和模型最新训练需求之间取得平衡。

重新训练模式：此模式通过从 series 的开头扩展或使用固定长度 train_length（起始点也可以用 start 和 start_format 配置）来重复构建训练集。然后在该训练集上训练模型，并生成长度为 forecast_horizon 的预测。随后，训练集的末端向前移动 stride 个时间步，重复该过程。

预训练模式：此模式仅支持预训练的全局预测模型。它使用与重新训练模式相同的模拟步骤（忽略 train_length），但直接生成预测，无需重新训练。

默认情况下，当 last_points_only=True 时，此方法返回一个时间序列（或时间序列序列），该序列由每个历史预测的最后一个点组成。因此，该时间序列的频率将是 series.freq * stride。如果 last_points_only=False，则会返回一个列表（或列表序列），其中包含完整的历史预测序列，每个序列的频率为 series.freq。

参数

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 一个（或多个）目标时间序列，用于依次训练（如果 retrain 不为 False）并计算历史预测。

• past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，一个（或多个）与 series 中每个输入时间序列相关的过去观测到的协变量时间序列。这仅适用于模型支持过去协变量的情况。

• future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，一个（或多个）与 series 中每个输入时间序列相关的未来已知的协变量时间序列。这仅适用于模型支持未来协变量的情况。

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

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

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

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

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

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

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

  • 否则为第一个可训练点 (给定 train_length)

  注意：如果 start 不在可训练/可预测点范围内，将使用离 start 最近的有效起始点，且该点是 stride 的整数倍

  ahead of start. Raises a ValueError, if no valid start point exists. (原文重复，无需翻译)

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

  into the future. (原文重复，无需翻译)

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

  (default behavior with None) and start at the first trainable/predictable point. (原文重复，无需翻译)

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

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

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

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

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

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

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

  • past_covariates (TimeSeries): 截止到 pred_time 的 past_covariates 序列

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

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

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

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

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

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

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

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

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

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

  • 如果 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 时，历史预测的列表嵌套列表。外层列表对应于输入的序列，内层列表包含每个序列的历史预测。

property lagged_feature_names: Optional[list[str]]

模型训练时使用的滞后特征名称。

目标、过去和未来协变量的命名约定是："{name}_{type}_lag{i}"，其中

• {name} (第一个)序列的分量名称

• {type} 是特征类型，可以是 “target”、“pastcov” 和 “futcov” 之一

• {i} 是滞后值

静态协变量的命名约定是："{name}_statcov_target_{comp}"，其中

• {name} (第一个)序列的静态协变量名称

• {comp} (第一个)序列的静态协变量作用的目标分量名称。如果静态

  协变量全局作用于多元目标序列，则显示“global”。

返回类型

Optional[list[str], None]

property lagged_label_names: Optional[list[str]]

模型估计器的滞后标签名称。

命名约定是："{name}_target_hrz{i}"，其中

• {name} (第一个)序列的分量名称

• {i} 是 output_chunk_length 中的位置（标签滞后）

返回类型

Optional[list[str], None]

property likelihood: Optional[SKLearnLikelihood]

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

返回类型

Optional[SKLearnLikelihood, 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: int

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

返回类型

int

property output_chunk_shift: int

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

返回类型

int

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

预测序列结束后的 n 个时间步的值。

参数

• n (int) – 预测范围 - 在序列末尾之后要生成预测的时间步数。

• series (TimeSeries 或 TimeSeries 列表，可选) – 可选参数，一个或多个输入 TimeSeries，表示其未来将被预测的目标序列的历史。如果指定，此方法将返回这些序列的预测。否则，此方法返回（单个）训练序列的预测。

• past_covariates (TimeSeries 或 TimeSeries 列表，可选) – 可选参数，作为模型输入所需的过去观测协变量序列。它们必须在维度和类型上与训练时使用的协变量匹配。

• future_covariates (TimeSeries 或 TimeSeries 列表，可选) – 可选参数，作为模型输入所需的未来已知协变量序列。它们必须在维度和类型上与训练时使用的协变量匹配。

• num_samples (int, 默认值: 1) – 从概率模型中采样预测的次数。对于确定性模型应设置为 1。

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

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

• **kwargs (dict, 可选) – 传递给模型 predict 方法的附加关键字参数。仅适用于单变量目标序列。

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

返回类型

Union[TimeSeries, Sequence[TimeSeries]]

residuals(series, past_covariates=None, future_covariates=None, historical_forecasts=None, forecast_horizon=1, num_samples=1, train_length=None, start=None, start_format='value', stride=1, retrain=True, overlap_end=False, last_points_only=True, metric=<function err>, verbose=False, show_warnings=True, predict_likelihood_parameters=False, enable_optimization=True, data_transformers=None, metric_kwargs=None, fit_kwargs=None, predict_kwargs=None, sample_weight=None, values_only=False)

计算模型对（可能多个）series 的历史预测产生的残差。

此函数计算 series 中的实际观测值与通过在 series 上训练模型（或使用 retrain=False 的预训练模型）获得的拟合值之间的差异（或 Darts 的“按时间步长”度量之一）。并非所有模型都支持拟合值，因此我们使用历史预测作为其近似值。

此方法按顺序执行以下操作

• 使用预计算的 historical_forecasts 或计算每个序列的历史预测（更多详细信息参见 historical_forecasts()）。历史预测的生成方式可以用参数 num_samples、train_length、start、start_format、forecast_horizon、stride、retrain、last_points_only、fit_kwargs 和 predict_kwargs 进行配置。

• 使用历史预测和 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 的整数倍

  ahead of start. Raises a ValueError, if no valid start point exists. (原文重复，无需翻译)

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

  into the future. (原文重复，无需翻译)

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

  (default behavior with None) and start at the first trainable/predictable point. (原文重复，无需翻译)

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

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

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

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

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

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

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

  • past_covariates (TimeSeries): 截止到 pred_time 的 past_covariates 序列

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  拟合好的转换器用于训练和预测过程中的输入转换。如果转换是可逆的，预测结果将被反向转换。仅当 historical_forecasts=None 时生效。

• metric_kwargs (Optional[dict[str, Any], None]) – 传递给 metric() 的附加参数，例如用于并行化的 ‘n_jobs’，用于缩放度量的 ‘m’ 等。仅当参数存在于对应的度量签名中时才会传递。忽略归约参数 “series_reduction”、“component_reduction”、“time_reduction”，以及缩放度量（例如 mase、rmsse 等）的参数 ‘insample’，因为它们在内部处理。

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

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

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

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

返回类型

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

返回值

• TimeSeries – 对于单个 series 且 historical_forecasts 是用 last_points_only=True 生成的情况下的残差 TimeSeries。

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

• List[List[TimeSeries]] – 对于 series 序列且 last_points_only=False 的情况下的残差 TimeSeries 列表嵌套列表。外层残差列表的长度为 len(series)。内层列表包含所有可能的针对特定序列的历史预测产生的残差。

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

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

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

如果可用，使用 model 的原生多元支持。如果不可用，则通过将单变量模型包装在 sklearn.multioutput.MultiOutputRegressor 中来获得多元支持。

返回类型

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

property supports_val_set: bool

模型在训练期间是否支持验证集。

返回类型

bool

untrained_model()

返回使用相同参数创建的新（未训练）模型实例。

property uses_future_covariates: bool

模型拟合后是否使用未来协变量。

返回类型

bool

property uses_past_covariates: bool

模型拟合后是否使用过去协变量。

返回类型

bool

property uses_static_covariates: bool

模型拟合后是否使用静态协变量。

返回类型

bool

property val_set_params: tuple[Optional[str], Optional[str]]

返回验证集的参数名称，如果支持验证集，还返回验证样本权重。

返回类型

tuple[Optional[str, None], Optional[str, None]]

上一页

Facebook Prophet

下一页

回归集成模型