克罗士顿方法

class darts.models.forecasting.sf_croston.Croston(version='classic', alpha_d=None, alpha_p=None, add_encoders=None, quantiles=None, random_state=None, **kwargs)

基类: StatsForecastModel

克罗士顿方法，如本文所述，并基于 Statsforecasts 包。

请参考 StatsForecast 关于 CrostonClassic、CrostonOptimized、CrostonSBA 和 Teunter-Syntetos-Babai 的文档。

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

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

• 概率/保形预测： 可以使用保形预测执行概率预测。要激活它，只需在模型创建时设置 prediction_intervals。调用 predict() 时，可以设置以下参数来生成概率预测

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

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

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

注意

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

注意

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

参数

• version (str) –

  • “classic” 对应于经典克罗士顿方法。

  • “optimized” 对应于优化的经典克罗士顿方法，它搜索最优的 alpha 平滑参数，运行时间可能更长。否则，使用固定值 alpha=0.1。

  • “sba” 对应于克罗士顿方法的调整，称为 Syntetos-Boylan 近似 [1]。

  • “tsb” 对应于 Teunter, Syntetos 和 Babai 提出的克罗士顿方法调整 [2]。在这种情况下，必须设置 alpha_d 和 alpha_p。

• alpha_d (Optional[float, None]) – 对于“tsb”版本，应用于需求的 alpha 平滑参数。

• alpha_p (Optional[float, None]) – 对于“tsb”版本，应用于概率的 alpha 平滑参数。

• add_encoders (Optional[dict, None]) –

  可以使用 add_encoders 自动生成大量未来协变量。这可以通过添加多个预定义索引编码器和/或将被用作索引编码器的自定义用户制作函数来完成。此外，可以添加 Darts 的 Scaler 等转换器来转换生成的协变量。所有这些都在一个框架下完成，只需要在模型创建时指定。阅读 SequentialEncoder 了解更多关于 add_encoders 的信息。默认值：None。一个示例展示了 add_encoders 的一些功能

  def encode_year(idx):
      return (idx.year - 1950) / 50
  
  add_encoders={
      'cyclic': {'future': ['month']},
      'datetime_attribute': {'future': ['hour', 'dayofweek']},
      'position': {'future': ['relative']},
      'custom': {'future': [encode_year]},
      'transformer': Scaler(),
      'tz': 'CET'
  }
  

• quantiles (Optional[list[float], None]) – 可选地，当使用 num_samples > 1 或 predict_likelihood_parameters=True 执行概率预测时，在 quantiles 级别生成分位数预测。

• random_state (Optional[int, None]) – 控制不同运行中概率保形预测（样本生成）的随机性。

• kwargs – statsforecasts.models.Croston* 的关键字参数。

参考

1

Aris A. Syntetos 和 John E. Boylan。《间歇性需求估计的准确性》。International Journal of Forecasting, 21(2):303 – 314, 2005。

2

Ruud H. Teunter, Aris A. Syntetos, 和 M. Zied Babai。《间歇性需求：将预测与库存报废联系起来》。European Journal of Operational Research, 214(3):606 – 615, 2011。

示例

>>> from darts.datasets import AirPassengersDataset
>>> from darts.models import Croston
>>> from darts.utils.timeseries_generation import datetime_attribute_timeseries
>>> series = AirPassengersDataset().load()
>>> # optionally, use some future covariates; e.g. the value of the month encoded as a sine and cosine series
>>> future_cov = datetime_attribute_timeseries(series, "month", cyclic=True, add_length=6)
>>> # define Croston parameters
>>> model = Croston(version="optimized")
>>> model.fit(series, future_covariates=future_cov)
>>> pred = model.predict(6, future_covariates=future_cov)
>>> pred.values()
array([[419.84565922],
       [424.06484452],
       [440.05509455],
       [463.53183473],
       [488.20449148],
       [507.46204636]])

属性

considers_static_covariates	模型是否考虑静态协变量（如果存在）。
extreme_lags	一个 8 元组，按顺序包含：（最小目标滞后，最大目标滞后，最小历史协变量滞后，最大历史协变量滞后，最小未来协变量滞后，最大未来协变量滞后，输出偏移，最大训练目标滞后（仅适用于 RNNModel））。
likelihood	返回模型用于概率预测的似然函数（如果存在）。
min_train_samples	训练模型所需的最小样本数。
output_chunk_length	模型一次预测的时间步数，统计模型未定义。
output_chunk_shift	输出/预测开始于输入结束之后的时间步数。
supports_future_covariates	模型是否支持未来协变量
supports_likelihood_parameter_prediction	模型实例是否支持直接预测似然参数
supports_multivariate	模型是否考虑时间序列中的多个变量。
supports_optimized_historical_forecasts	模型是否支持优化的历史预测
supports_past_covariates	模型是否支持历史协变量
supports_probabilistic_prediction	检查具有此配置的预测模型是否支持概率预测。
supports_sample_weight	模型是否支持训练样本权重。
supports_static_covariates	模型是否支持静态协变量
supports_transferable_series_prediction	模型是否支持对任何输入 series 进行预测。
uses_future_covariates	模型拟合后是否使用未来协变量。
uses_past_covariates	模型拟合后是否使用历史协变量。
uses_static_covariates	模型拟合后是否使用静态协变量。

model_params

方法

backtest(series[, past_covariates, ...])	计算模型在（潜在的多个）series 上为历史预测产生的误差值。
fit(series[, future_covariates])	在提供的（单个）系列上拟合/训练模型。
generate_fit_encodings(series[, ...])	生成用于模型拟合的协变量编码，并返回一个包含原始和编码协变量堆叠在一起的历史和未来协变量系列的元组。
generate_fit_predict_encodings(n, series[, ...])	为训练和推理/预测生成协变量编码，并返回一个包含原始和编码协变量堆叠在一起的历史和未来协变量系列的元组。
generate_predict_encodings(n, series[, ...])	为推理/预测集生成协变量编码，并返回一个包含原始和编码协变量堆叠在一起的历史和未来协变量系列的元组。
gridsearch(parameters, series[, ...])	使用网格搜索在给定集合中寻找最佳超参数。
historical_forecasts(series[, ...])	通过模拟在提供的（潜在多个）series 的历史中各个时间点进行的预测，生成历史预测。
load(path)	从给定路径或文件句柄加载模型。
predict(n[, series, future_covariates, ...])	如果未设置 series 参数，则预测训练系列结束后的 n 个时间步的值。
residuals(series[, past_covariates, ...])	计算模型在（潜在多个）series 上为历史预测产生的残差。
save([path, clean])	将模型保存到给定路径或文件句柄下。
untrained_model()	返回使用相同参数创建的新（未训练的）模型实例。

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

计算模型在（潜在的多个）series 上为历史预测产生的误差值。

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

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

指标可以使用 metric_kwargs 进一步自定义（例如，控制组件、时间步、多个系列上的聚合，分位数指标的其他必需参数，如 q，等）。

参数

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

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

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

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

• forecast_horizon (int) – 预测的未来视野。

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

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

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

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

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

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

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

  注意：如果 start 不在可训练/可预测点之内，则使用距离 start 最近的、比 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：当 Callable 返回 True 时重新训练模型。Callable 必须具有以下位置参数

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

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

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

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

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

  • metric_kwargs (Union[dict[str, Any], list[dict[str, Any]], None]) – 传递给 metric() 的附加参数，例如用于并行化的 ‘n_jobs’，用于减少组件指标的 ‘component_reduction’，用于缩放指标的季节性 ‘m’ 等。将参数单独传递给每个指标，并且仅当它们存在于相应指标签名中时。忽略缩放指标（例如 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 和回测 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

• bool

• property extreme_lags: tuple[Optional[int], Optional[int], Optional[int], Optional[int], Optional[int], Optional[int], int, Optional[int]]

一个 8 元组，按顺序包含：（最小目标滞后，最大目标滞后，最小历史协变量滞后，最大历史协变量滞后，最小未来协变量滞后，最大未来协变量滞后，输出偏移，最大训练目标滞后（仅适用于 RNNModel））。如果 0 是第一个预测的索引，则所有滞后相对于此索引。

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

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

参见以下示例。

如果模型未拟合

目标（仅适用于 RegressionModels）：则第一个元素应为 None。

历史协变量：则第三个和第四个元素应为 None。

未来协变量：则第五个和第六个元素应为 None。

• 使用历史或未来协变量的模型以及/或具有最小目标滞后和最大目标滞后可能不同于 -1 和 0 的模型应覆盖此属性。

• 注意

• 最大目标滞后（第二个值）不能为空，并且总是大于或等于 0。

tuple[Optional[int, None], Optional[int, None], Optional[int, None], Optional[int, None], Optional[int, None], Optional[int, None], int, Optional[int, None]]

fit(series, future_covariates=None)

可选地，也可以提供未来协变量系列。

示例

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

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

series (TimeSeries) – 模型将训练以预测此时间序列。如果模型支持，可以是多变量。

future_covariates (Optional[TimeSeries, None]) – 未来已知协变量的时间序列。此时间序列不会被预测，但可以被某些模型用作输入。它必须包含至少与目标 series 相同的时间步/索引。如果比所需长度长，将自动截断。

在提供的（单个）系列上拟合/训练模型。

拟合的模型。

参数

• self

• generate_fit_encodings(series, past_covariates=None, future_covariates=None)

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

生成用于模型拟合的协变量编码，并返回一个包含原始和编码协变量堆叠在一起的历史和未来协变量系列的元组。编码由模型创建时使用参数 add_encoders 定义的编码器生成。传递与用于训练/拟合模型的 series、past_covariates 和 future_covariates 相同的值。

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

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)

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

为训练和推理/预测生成协变量编码，并返回一个包含原始和编码协变量堆叠在一起的历史和未来协变量系列的元组。编码由模型创建时使用参数 add_encoders 定义的编码器生成。传递您打算用于训练和预测的 series、past_covariates 和 future_covariates 相同的值。

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

n (int) – 打算用于预测的 series 结束后的预测时间步数。

series (Union[TimeSeries, Sequence[TimeSeries]]) – 打算用于训练和预测的目标值的序列或序列的序列。

past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，打算用于训练和预测的历史观测协变量系列。维数必须与用于训练的协变量匹配。

参数

• future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，打算用于预测的未来已知协变量系列。维数必须与用于训练的协变量匹配。

• generate_predict_encodings(n, series, past_covariates=None, future_covariates=None)

• 为推理/预测集生成协变量编码，并返回一个包含原始和编码协变量堆叠在一起的历史和未来协变量系列的元组。编码由模型创建时使用参数 add_encoders 定义的编码器生成。传递您打算用于预测的 series、past_covariates 和 future_covariates 相同的值。

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 打算用于预测的目标值的序列或序列的序列。

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

为训练和推理/预测生成协变量编码，并返回一个包含原始和编码协变量堆叠在一起的历史和未来协变量系列的元组。编码由模型创建时使用参数 add_encoders 定义的编码器生成。传递您打算用于训练和预测的 series、past_covariates 和 future_covariates 相同的值。

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

n (int) – 打算用于预测的 series 结束后的预测时间步数。

past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，打算用于预测的历史观测协变量系列。维数必须与用于训练的协变量匹配。

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)

参数

• future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，打算用于预测的未来已知协变量系列。维数必须与用于训练的协变量匹配。

• 此函数有 3 种操作模式：扩展窗口模式、分割模式和拟合值模式。这三种操作模式通过实例化 ForecastingModel 的 model_class 子类并使用 parameters 字典中提供的超参数值的每个可能组合，来评估这些组合，并返回在 metric 函数方面表现最佳的模型。metric 函数应返回一个误差值，因此将选择导致最小 metric 输出的模型。

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

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 打算用于预测的目标值的序列或序列的序列。

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

为训练和推理/预测生成协变量编码，并返回一个包含原始和编码协变量堆叠在一起的历史和未来协变量系列的元组。编码由模型创建时使用参数 add_encoders 定义的编码器生成。传递您打算用于训练和预测的 series、past_covariates 和 future_covariates 相同的值。

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

n (int) – 打算用于预测的 series 结束后的预测时间步数。

扩展窗口模式（当传入 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]) – 可选的历史观测协变量系列。仅当模型支持历史协变量时适用。

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

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

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

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

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

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

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

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

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

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

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

  注意：如果 start 不在可训练/可预测点之内，则使用距离 start 最近的、比 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]]) –

• 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，此时将忽略随机选择。

• 如果 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() 方法的一些附加参数。

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

• 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”（指数）衰减 - 距离过去越远，权重越低。

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

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

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

ForecastingModel, Dict, float

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

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

此方法有两种主要模式

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

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

通过选择适当的模式，您可以在计算效率和模型及时训练的需求之间进行权衡。

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

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

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

参数

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

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

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

• forecast_horizon (int) – 预测的未来视野。

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

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

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

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

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

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

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

  注意：如果 start 不在可训练/可预测点之内，则使用距离 start 最近的、比 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：当 Callable 返回 True 时重新训练模型。Callable 必须具有以下位置参数

• 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) – 是否打印进度。

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

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

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

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

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

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

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

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

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

• 返回类型

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

• 返回

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

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

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

• TimeSeries – 单个 series 和 last_points_only=True 的单个历史预测：它仅包含所有历史预测中步骤 forecast_horizon 的预测结果。

• List[TimeSeries] – 一系列 series 的历史预测列表，且

  • last_points_only=True：对于每个时间序列，它仅包含所有历史预测中步骤 forecast_horizon 的预测结果。

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

• List[List[TimeSeries]] – 一系列 series 的历史预测列表的列表，且 last_points_only=False。对于每个时间序列和历史预测，它包含整个 forecast_horizon 范围。外部列表对应于输入的序列，内部列表包含每个序列的历史预测。

property likelihood: QuantilePrediction

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

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

QuantilePrediction

static load(path)

从给定路径或文件句柄加载模型。

参数

path (Union[str, PathLike, BinaryIO]) – 要从中加载模型的路径或文件句柄。

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

ForecastingModel

property min_train_samples: int

训练模型所需的最小样本数。

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

int

property model_params: dict

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

dict

property output_chunk_length: Optional[int]

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

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

Optional[int, None]

property output_chunk_shift: int

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

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

int

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

如果未设置 series 参数，则预测训练时间序列结束后的 n 个时间步的值。如果在训练期间指定了某些未来协变量，则在此处也必须指定。

如果设置了 series 参数，则预测新目标时间序列结束后的 n 个时间步的值。如果在训练期间指定了某些未来协变量，则在此处也必须指定。

参数

• n (int) – 预测范围 - 系列结束后的预测时间步数。

• series (Optional[TimeSeries, None]) – 可选地，一个新的目标时间序列，将预测其未来值。默认为 None，表示模型将预测训练时间序列的未来值。

• future_covariates (Optional[TimeSeries, None]) –

  未来已知协变量的时间序列，可以作为输入提供给模型。它必须对应于用于 fit() 方法进行训练的协变量时间序列。

  如果未设置 series，它必须至少包含训练目标时间序列结束后的接下来的 n 个时间步/索引。如果设置了 series，它必须至少包含与新目标时间序列对应的时间步/索引（历史未来协变量），加上其结束后的接下来的 n 个时间步/索引。

• num_samples (int) – 从概率模型中采样预测的次数。对于确定性模型必须为 1。

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

• verbose (bool) – 可选地，设置预测的详细程度。并非对所有模型都有效。

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

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

TimeSeries，一个包含训练时间序列结束后接下来的 n 个点的时间序列。

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

计算模型在（潜在多个）series 上为历史预测产生的残差。

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

此方法依次执行以下步骤

• 使用预先计算的 historical_forecasts 或计算每个时间序列的历史预测（有关更多详细信息，请参阅historical_forecasts()）。如何生成历史预测可以通过参数 num_samples、train_length、start、start_format、forecast_horizon、stride、retrain、last_points_only、fit_kwargs 和 predict_kwargs 配置。

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

• 创建并返回 TimeSeries（或仅返回一个带有 values_only=True 的 np.ndarray），其时间索引来自历史预测，值来自按分量和时间步计算的度量结果。

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

参数

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

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

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

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

• forecast_horizon (int) – 预测的未来视野。

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

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

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

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

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

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

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

  注意：如果 start 不在可训练/可预测点之内，则使用距离 start 最近的、比 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：当 Callable 返回 True 时重新训练模型。Callable 必须具有以下位置参数

• 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) – 是否打印进度。

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

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

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

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

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

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

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

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

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

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

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

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

• 返回类型

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

• 返回

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

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

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

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

• 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() 的关键字参数。

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

None

property supports_future_covariates: bool

模型是否支持未来协变量

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

参见以下示例。

property supports_likelihood_parameter_prediction: bool

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

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

参见以下示例。

property supports_multivariate: bool

模型是否考虑时间序列中的多个变量。

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

参见以下示例。

property supports_optimized_historical_forecasts: bool

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

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

参见以下示例。

property supports_past_covariates: bool

模型是否支持历史协变量

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

参见以下示例。

property supports_probabilistic_prediction: bool

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

默认情况下返回 False。需要由支持概率预测的模型重写。

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

参见以下示例。

property supports_sample_weight: bool

模型是否支持训练样本权重。

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

参见以下示例。

property supports_static_covariates: bool

模型是否支持静态协变量

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

参见以下示例。

property supports_transferable_series_prediction: bool

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

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

参见以下示例。

untrained_model()

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

property uses_future_covariates: bool

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

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

参见以下示例。

property uses_past_covariates: bool

模型拟合后是否使用历史协变量。

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

参见以下示例。

property uses_static_covariates: bool

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

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

参见以下示例。

上一页

AutoTheta

下一页

StatsForecastModel