线性回归模型

一种预测模型，使用目标序列的某些滞后，并可选地使用某些协变量序列的滞后来进行预测。

class darts.models.forecasting.linear_regression_model.LinearRegressionModel(lags=None, lags_past_covariates=None, lags_future_covariates=None, output_chunk_length=1, output_chunk_shift=0, add_encoders=None, likelihood=None, quantiles=None, random_state=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 步。如果为整数列表，则仅使用指定的滞后值。如果为字典，则键对应于 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 步。如果为整数列表，则仅使用指定的滞后值。如果为字典，则键对应于 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 是使用一次性或自回归预测生成的所需预测点数。设置 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'
  }
  

• likelihood (Optional[str, None]) – 可以设置为 quantile 或 poisson。如果设置，模型将是概率性的，允许在预测时进行采样。如果设置为 quantile，则使用 sklearn.linear_model.QuantileRegressor。类似地，如果设置为 poisson，则使用 sklearn.linear_model.PoissonRegressor。

• quantiles (Optional[list[float], None]) – 如果 likelihood 设置为 quantile，则根据这些分位数拟合模型。

• random_state (Optional[int, None]) – 控制采样的随机性。用作 numpy.random.Generator 的种子。未设置 likelihood 时忽略。默认值: None。

• multi_models (Optional[bool, None]) – 如果为 True，则为预测的每个未来滞后训练一个单独的模型。如果为 False，则训练单个模型来预测 'output_chunk_length' 中的所有步（特征滞后通过 output_chunk_length - n 向后移动每个步 n）。默认值: True。

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

• **kwargs – 传递给 sklearn.linear_model.LinearRegression（默认）、sklearn.linear_model.PoissonRegressor（如果 likelihood=”poisson”）或 sklearn.linear_model.QuantileRegressor（如果 likelihood=”quantile”）的附加关键字参数。

示例

确定性预测，使用过去/未来协变量（可选）

>>> from darts.datasets import WeatherDataset
>>> from darts.models import LinearRegressionModel
>>> 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]
>>> # predict 6 pressure values using the 12 past values of pressure and rainfall, as well as the 6 temperature
>>> # values corresponding to the forecasted period
>>> model = LinearRegressionModel(
>>>     lags=12,
>>>     lags_past_covariates=12,
>>>     lags_future_covariates=[0,1,2,3,4,5],
>>>     output_chunk_length=6,
>>> )
>>> model.fit(target, past_covariates=past_cov, future_covariates=future_cov)
>>> pred = model.predict(6)
>>> pred.values()
array([[1005.72085839],
       [1005.6548696 ],
       [1005.65403772],
       [1005.6846175 ],
       [1005.75753605],
       [1005.81830675]])

属性

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 是可调用对象且第一个可预测点早于第一个可训练点，则为第一个可预测点。

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

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

  注意：如果 start 不在可训练/可预测点范围内，则使用距离 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）。当为 bool 时：在每一步重新训练模型（True），或从不重新训练模型（False）。当为 int 时：模型每 retrain 次迭代重新训练。当为 Callable 时：模型在可调用对象返回 True 时重新训练。可调用对象必须具有以下位置参数：

  • 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，则会向相应的 retrain 函数参数传递 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 标签的一些样本权重。它们按观测值、标签（output_chunk_length 中的每一步）和组件应用。如果是一个序列或序列的序列，则使用这些权重。如果权重序列只有一个组件/列，则将权重全局应用于 series 中的所有组件。否则，对于组件特定的权重，组件数量必须与 series 中的组件数量匹配。如果是一个字符串，则使用内置权重函数生成权重。可用选项是 "linear" 或 "exponential" 衰减——时间越靠后，权重越低。权重根据 series 中最长序列的长度全局计算。然后对于每个序列，从全局权重的末尾提取权重。这使得所有序列具有共同的时间权重。

返回类型

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

返回

• float – 对于单个单变量/多变量序列、单个 metric 函数以及使用 last_points_only=True 生成的

  • historical_forecasts 的单个回测分数。

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

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

  • 单个 metric 函数，使用 last_points_only=False 生成的 historical_forecasts 以及回测 reduction=None。输出形状为 (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

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

返回类型

布尔值

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 wrapper 并行运行的作业数。仅当模型不原生支持多输出回归时使用。

• 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)

返回预测 `horizon` 时间步和 `target_dim` 目标分量的估计器。

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

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

注意：在内部，估计器按 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 种操作模式：扩展窗口模式、分割模式和拟合值模式。这三种操作模式通过实例化 ForecastingModel 的 model_class 子类并使用 parameters 字典中提供的超参数值的每种可能组合，评估每种组合的性能，并返回关于 metric 函数表现最佳的模型。metric 函数应返回一个误差值，因此将选择产生最小 metric 输出的模型。

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

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

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

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

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

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

参数

• model_class – 需要针对 'series' 进行调优的 ForecastingModel 子类。

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

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

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

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

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

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

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

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

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

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

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

  注意：如果 start 不在可训练/可预测点范围内，则使用距离 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”）。如果提供，所有输入序列必须在未转换的空间中。对于可拟合的转换器/流水线

  • 如果 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 是可调用对象且第一个可预测点早于第一个可训练点，则为第一个可预测点。

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

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

  注意：如果 start 不在可训练/可预测点范围内，则使用距离 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）。当为 bool 时：在每一步重新训练模型（True），或从不重新训练模型（False）。当为 int 时：模型每 retrain 次迭代重新训练。当为 Callable 时：模型在可调用对象返回 True 时重新训练。可调用对象必须具有以下位置参数：

  • 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，则会向相应的 retrain 函数参数传递 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 标签的一些样本权重。它们按观测值、标签（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 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 or TimeSeries 列表, 可选) – 可选参数，一个或多个输入 TimeSeries，表示需要预测其未来的目标序列的历史。如果指定，该方法返回这些序列的预测。否则，该方法返回（单个）训练序列的预测。

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

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

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

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

• predict_likelihood_parameters (bool) – 如果设置为 True，模型会预测其 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 进行配置。

• 使用“每时间步” 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 是可调用对象且第一个可预测点早于第一个可训练点，则为第一个可预测点。

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

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

  注意：如果 start 不在可训练/可预测点范围内，则使用距离 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）。当为 bool 时：在每一步重新训练模型（True），或从不重新训练模型（False）。当为 int 时：模型每 retrain 次迭代重新训练。当为 Callable 时：模型在可调用对象返回 True 时重新训练。可调用对象必须具有以下位置参数：

  • 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，则会向相应的 retrain 函数参数传递 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 标签的一些样本权重。它们按观测值、标签（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] – 对于 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 存储的全局预测模型后，必须将 series 传递给 ‘predict()’、historical_forecasts() 和其他预测方法。

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

返回类型

None

property supports_future_covariates: bool

模型是否支持未来协变量

返回类型

布尔值

property supports_likelihood_parameter_prediction: bool

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

返回类型

布尔值

property supports_multivariate: bool

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

返回类型

布尔值

property supports_optimized_historical_forecasts: bool

模型是否支持优化的历史预测

返回类型

布尔值

property supports_past_covariates: bool

模型是否支持过去协变量

返回类型

布尔值

property supports_probabilistic_prediction: bool

检查具有此配置的预测模型是否支持概率预测。

默认情况下返回 False。支持概率预测的模型需要覆盖此属性。

返回类型

布尔值

property supports_sample_weight: bool

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

返回类型

布尔值

property supports_static_covariates: bool

模型是否支持静态协变量

返回类型

布尔值

property supports_transferable_series_prediction: bool

模型是否支持对任何输入 series 进行预测。

返回类型

布尔值

property supports_val_set: bool

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

返回类型

布尔值

untrained_model()

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

property uses_future_covariates: bool

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

返回类型

布尔值

property uses_past_covariates: bool

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

返回类型

布尔值

property uses_static_covariates: bool

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

返回类型

布尔值

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

返回验证集的参数名称以及它是否支持验证集的验证样本权重。

返回类型

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

上一页

LightGBM 模型

下一页

N-BEATS