回归模型

一个 RegressionModel 基于以下要素预测目标时间序列的未来值：

• 目标时间序列（仅过去滞后项）

• 可选的过去协变量序列（仅过去滞后项）

• 可选的未来协变量序列（可能包含过去和未来滞后项）

• 可用的静态协变量

回归模型以监督学习方式训练，可以封装任何在表格数据上具有 fit() 和 predict() 方法的“类似 scikit-learn”的回归模型。

Darts 还提供了 LinearRegressionModel 和 RandomForest，它们分别是封装 scikit-learn 线性回归和随机森林回归的回归模型。

在底层，此模型将时间序列数据转换为表格形式，以便与回归模型配合使用。

滞后项可以使用整数指定——表示要考虑的（过去或未来）滞后项的_数量_；也可以使用列表指定——此时必须列出滞后项（严格负值表示过去滞后项，包含 0 的正值表示未来滞后项）。当存在静态协变量时，它们会被附加到滞后特征中。当传入多个时间序列时，如果它们的静态协变量大小不同，则较短的静态协变量会用 0 值特征填充。

class darts.models.forecasting.regression_model.RegressionModel(lags=None, lags_past_covariates=None, lags_future_covariates=None, output_chunk_length=1, output_chunk_shift=0, add_encoders=None, model=None, multi_models=True, use_static_covariates=True)

基类： GlobalForecastingModel

回归模型 可用于拟合任何类似 scikit-learn 的回归器类，以便从滞后值预测目标时间序列。

参数

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

• model – 具有 fit() 和 predict() 方法的类似 scikit-learn 的模型。也可以使用不支持多元时间序列多输出回归的模型，在这种情况下，多元序列中的每个组件将使用一个回归器。如果为 None，则默认为：sklearn.linear_model.LinearRegression(n_jobs=-1)。

• 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() 中具有相同的静态协变量维度。

示例

>>> from darts.datasets import WeatherDataset
>>> from darts.models import RegressionModel
>>> from sklearn.linear_model import Ridge
>>> 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]
>>> # wrap around the sklearn Ridge model
>>> model = RegressionModel(
>>>     model=Ridge(),
>>>     lags=12,
>>>     lags_past_covariates=4,
>>>     lags_future_covariates=(0,6),
>>>     output_chunk_length=6
>>> )
>>> model.fit(target, past_covariates=past_cov, future_covariates=future_cov)
>>> pred = model.predict(6)
>>> pred.values()
array([[1005.73340676],
       [1005.71159051],
       [1005.7322616 ],
       [1005.76314504],
       [1005.82204348],
       [1005.89100967]])

属性

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])	返回预测第 `horizon` 个时间步的第 `target_dim` 个目标组件的估计器。
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，或者是可调用对象 (Callable) 且第一个可预测点早于第一个可训练点，则设置为第一个可预测点。

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

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

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

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

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

  向未来偏移 output_chunk_shift 个点。

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

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

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

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

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

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

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

  • pred_time (pd.Timestamp 或 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”）。如果提供，所有输入序列必须位于未转换的空间中。对于可拟合的转换器/管道

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

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

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

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

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

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

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

返回类型

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

返回值

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

  • 使用 last_points_only=True 生成的 historical_forecasts 的单个回测分数

  • 使用 last_points_only=False 生成的 historical_forecasts 并使用回测 reduction 的单个回测分数

• 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

如果存在静态协变量，模型是否考虑它们。

返回类型

布尔值

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 种操作模式：扩展窗口模式、拆分模式和拟合值模式。这三种操作模式通过实例化 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，或者是可调用对象 (Callable) 且第一个可预测点早于第一个可训练点，则设置为第一个可预测点。

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

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

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

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

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

  向未来偏移 output_chunk_shift 个点。

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

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

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

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

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

• val_series (Optional[TimeSeries, None]) – 在拆分模式中用于验证的时间序列实例。如果提供，此序列必须紧接在 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，或者是可调用对象 (Callable) 且第一个可预测点早于第一个可训练点，则设置为第一个可预测点。

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

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

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

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

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

  向未来偏移 output_chunk_shift 个点。

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

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

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

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

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

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

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

  • pred_time (pd.Timestamp 或 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”）。如果提供，所有输入序列必须位于未转换的空间中。对于可拟合的转换器/管道

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

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

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

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

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

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

返回类型

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

返回值

• TimeSeries – 对于单个 series 且 last_points_only=True 时返回的单个历史预测：它仅包含来自所有历史预测的 forecast_horizon 步骤处的预测。

• List[TimeSeries] – 对于以下情况返回的历史预测列表：

  • 一个 series 序列（列表）且 last_points_only=True：对于每个序列，它仅包含来自所有历史预测的 forecast_horizon 步骤处的预测。

  • 单个 series 且 last_points_only=False：对于每个历史预测，它包含整个 forecast_horizon 范围。

• List[List[TimeSeries]] – 对于 series 序列且 last_points_only=False 时返回的历史预测列表的列表。对于每个序列和历史预测，它包含整个 forecast_horizon 范围。外层列表对应于输入序列中提供的序列，内层列表包含每个序列的历史预测。

property 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 list of TimeSeries, optional) – 可选的，一个或多个输入 TimeSeries，表示其未来要被预测的目标序列的历史。如果指定，该方法返回这些序列的预测结果。否则，该方法返回（单个）训练序列的预测结果。

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

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

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

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

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

• **kwargs (dict, optional) – 传递给模型 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，或者是可调用对象 (Callable) 且第一个可预测点早于第一个可训练点，则设置为第一个可预测点。

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

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

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

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

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

  向未来偏移 output_chunk_shift 个点。

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

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

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

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

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

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

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

  • pred_time (pd.Timestamp 或 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”）。如果提供，所有输入序列必须位于未转换的空间中。对于可拟合的转换器/管道

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

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

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

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

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

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

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

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

返回类型

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

返回值

• TimeSeries – 对于单个 series 且使用 last_points_only=True 生成的 historical_forecasts 返回的残差 TimeSeries。

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

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

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

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

保存和加载 RegressionModel 的示例

from darts.models import RegressionModel

model = RegressionModel(lags=4)

model.save("my_model.pkl")
model_loaded = RegressionModel.load("my_model.pkl")

参数

• path (Union[str, PathLike, BinaryIO, None]) – 用于保存模型当前状态的路径或文件句柄。如果未指定路径，模型将自动保存到 "{ModelClass}_{YYYY-mm-dd_HH_MM_SS}.pkl" 下。例如，"RegressionModel_2020-01-01_12_00_00.pkl"。

• clean (bool) –

  是否存储模型的清理版本。仅对全局预测模型有效。如果为 True，则移除训练序列和协变量。

  注意：加载使用 clean=True 存储的全局预测模型后，必须向 ‘predict()’、historical_forecasts() 和其他预测方法传递一个 series。

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

class darts.models.forecasting.regression_model.RegressionModelWithCategoricalCovariates(model, lags=None, lags_past_covariates=None, lags_future_covariates=None, output_chunk_length=1, output_chunk_shift=0, add_encoders=None, multi_models=True, use_static_covariates=True, categorical_past_covariates=None, categorical_future_covariates=None, categorical_static_covariates=None)

基类: RegressionModel, ABC

扩展了 RegressionModel 类，用于支持分类协变量的回归模型。

参数

• model – 具有 fit() 和 predict() 方法的 Scikit-learn 风格模型。也可以使用不支持多元时间序列多输出回归的模型，在这种情况下，多元时间序列中的每个分量将使用一个回归器。

• lags (Union[int, list, 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], 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], None]) – 用于预测下一个时间步长的滞后 future_covariates 值。滞后项总是相对于输出块中的第一个步长，即使 output_chunk_shift > 0 也是如此。如果是一个 (过去, 未来) 的元组，两个值都必须 > 0。使用过去的最后 n=过去 个滞后和未来的 n=未来 个滞后；例如 (-过去, -(过去 - 1), …, -1, 0, 1, …. 未来 - 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'
  }
  

• multi_models (Optional[bool, None]) – 如果为 True，将为预测的每个未来滞后训练一个单独的模型。如果为 False，则训练一个模型来预测未来 ‘output_chunk_length’ 步长的数据。默认值: True。

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

• categorical_past_covariates (Union[str, list[str], None]) – 可选参数，指定应被视为分类类型的历史协变量的分量名称或分量名称列表。

• categorical_future_covariates (Union[str, list[str], None]) – 可选参数，指定应被视为分类类型的未来协变量的分量名称或分量名称列表。

• categorical_static_covariates (Union[str, list[str], None]) – 可选参数，指定应被视为分类类型的静态协变量的字符串或字符串列表。

属性

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`th 目标分量的 `horizon`th 步长的估计器。
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，或者是可调用对象 (Callable) 且第一个可预测点早于第一个可训练点，则设置为第一个可预测点。

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

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

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

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

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

  向未来偏移 output_chunk_shift 个点。

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

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

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

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

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

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

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

  • pred_time (pd.Timestamp 或 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”）。如果提供，所有输入序列必须位于未转换的空间中。对于可拟合的转换器/管道

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

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

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

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

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

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

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

返回类型

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

返回值

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

  • 使用 last_points_only=True 生成的 historical_forecasts 的单个回测分数

  • 使用 last_points_only=False 生成的 historical_forecasts 并使用回测 reduction 的单个回测分数

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

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

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

  • 多个单变量/多元序列，包括 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 包装器并行运行的作业数。仅在模型原生不支持多输出回归时使用。

• 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`th 目标分量的 `horizon`th 步长的估计器。

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

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

注意：在内部，估计器按 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，或者是可调用对象 (Callable) 且第一个可预测点早于第一个可训练点，则设置为第一个可预测点。

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

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

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

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

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

  向未来偏移 output_chunk_shift 个点。

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

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

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

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

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

• val_series (Optional[TimeSeries, None]) – 在拆分模式中用于验证的时间序列实例。如果提供，此序列必须紧接在 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，或者是可调用对象 (Callable) 且第一个可预测点早于第一个可训练点，则设置为第一个可预测点。

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

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

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

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

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

  向未来偏移 output_chunk_shift 个点。

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

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

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

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

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

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

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

  • pred_time (pd.Timestamp 或 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”）。如果提供，所有输入序列必须位于未转换的空间中。对于可拟合的转换器/管道

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

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

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

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

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

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

返回类型

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

返回值

• TimeSeries – 对于单个 series 且 last_points_only=True 时返回的单个历史预测：它仅包含来自所有历史预测的 forecast_horizon 步骤处的预测。

• List[TimeSeries] – 对于以下情况返回的历史预测列表：

  • 一个 series 序列（列表）且 last_points_only=True：对于每个序列，它仅包含来自所有历史预测的 forecast_horizon 步骤处的预测。

  • 单个 series 且 last_points_only=False：对于每个历史预测，它包含整个 forecast_horizon 范围。

• List[List[TimeSeries]] – 对于 series 序列且 last_points_only=False 时返回的历史预测列表的列表。对于每个序列和历史预测，它包含整个 forecast_horizon 范围。外层列表对应于输入序列中提供的序列，内层列表包含每个序列的历史预测。

property 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 list of TimeSeries, optional) – 可选的，一个或多个输入 TimeSeries，表示其未来要被预测的目标序列的历史。如果指定，该方法返回这些序列的预测结果。否则，该方法返回（单个）训练序列的预测结果。

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

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

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

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

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

• **kwargs (dict, optional) – 传递给模型 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，或者是可调用对象 (Callable) 且第一个可预测点早于第一个可训练点，则设置为第一个可预测点。

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

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

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

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

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

  向未来偏移 output_chunk_shift 个点。

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

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

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

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

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

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

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

  • pred_time (pd.Timestamp 或 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”）。如果提供，所有输入序列必须位于未转换的空间中。对于可拟合的转换器/管道

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

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

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

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

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

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

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

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

返回类型

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

返回值

• TimeSeries – 对于单个 series 且使用 last_points_only=True 生成的 historical_forecasts 返回的残差 TimeSeries。

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

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

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

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

保存和加载 RegressionModel 的示例

from darts.models import RegressionModel

model = RegressionModel(lags=4)

model.save("my_model.pkl")
model_loaded = RegressionModel.load("my_model.pkl")

参数

• path (Union[str, PathLike, BinaryIO, None]) – 用于保存模型当前状态的路径或文件句柄。如果未指定路径，模型将自动保存到 "{ModelClass}_{YYYY-mm-dd_HH_MM_SS}.pkl" 下。例如，"RegressionModel_2020-01-01_12_00_00.pkl"。

• clean (bool) –

  是否存储模型的清理版本。仅对全局预测模型有效。如果为 True，则移除训练序列和协变量。

  注意：加载使用 clean=True 存储的全局预测模型后，必须向 ‘predict()’、historical_forecasts() 和其他预测方法传递一个 series。

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

上一篇

回归集成模型

下一篇

循环神经网络