AutoMFLES

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

基类: StatsForecastModel

基于 Statsforecasts 包 的 Auto-MFLES。

自动从参数 seasonality_weights、smoother、ma 和 seasonal_period 的所有可行组合中选择最佳 MFLES 模型。默认使用 sMAPE 指标进行选择。有关参数的详尽文档，请参阅 StatsForecast 文档。

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

• 未来协变量： 使用外部特征来潜在提高预测准确性。

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

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

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

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

注意

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

注意

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

参数

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

• add_encoders (Optional[dict, None]) –

  使用 add_encoders 可以自动生成大量未来协变量。这可以通过添加多个预定义的索引编码器和/或用作索引编码器的自定义用户制作函数来完成。此外，可以添加 Darts 的 Scaler 等转换器来转换生成的协变量。这一切都集成在一个流程中，只需在模型创建时指定。默认值：None。一个示例展示了 add_encoders 的一些功能：

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

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

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

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

示例

>>> from darts.datasets import AirPassengersDataset
>>> from darts.models import AutoMFLES
>>> 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 AutoMFLES parameters
>>> model = AutoMFLES(season_length=12, test_size=12)
>>> model.fit(series, future_covariates=future_cov)
>>> pred = model.predict(6, future_covariates=future_cov)
>>> pred.values()
array([[466.03298745],
       [450.76192105],
       [517.6342497 ],
       [511.62988828],
       [520.15305998],
       [593.38690019]])

属性

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

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

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

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

  是 stride 之后 start 的整数倍。如果不存在有效的起始点，则引发 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=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 函数以及历史预测的单个回测分数

  • historical_forecasts 使用 last_points_only=True 生成。

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

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

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

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

  • 包括 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 是第一个预测的索引，则所有滞后都是相对于该索引的。

参见下面的示例。

如果模型没有使用以下数据进行拟合：

• 目标序列（仅与回归模型有关）：则第一个元素应为 None。

• 过去协变量：则第三和第四个元素应为 None。

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

应由使用过去或未来协变量的模型，和/或最小目标滞后和最大目标滞后可能与 -1 和 0 不同的模型覆盖。

注意

最大目标滞后（第二个值）不能为 None，并且始终大于或等于 0。

示例

>>> model = LinearRegressionModel(lags=3, output_chunk_length=2)
>>> model.fit(train_series)
>>> model.extreme_lags
(-3, 1, None, None, None, None, 0, None)
>>> model = LinearRegressionModel(lags=3, output_chunk_length=2, output_chunk_shift=2)
>>> model.fit(train_series)
>>> model.extreme_lags
(-3, 1, None, None, None, None, 2, None)
>>> model = LinearRegressionModel(lags=[-3, -5], lags_past_covariates = 4, output_chunk_length=7)
>>> model.fit(train_series, past_covariates=past_covariates)
>>> model.extreme_lags
(-5, 6, -4, -1,  None, None, 0, None)
>>> model = LinearRegressionModel(lags=[3, 5], lags_future_covariates = [4, 6], output_chunk_length=7)
>>> model.fit(train_series, future_covariates=future_covariates)
>>> model.extreme_lags
(-5, 6, None, None, 4, 6, 0, None)
>>> model = NBEATSModel(input_chunk_length=10, output_chunk_length=7)
>>> model.fit(train_series)
>>> model.extreme_lags
(-10, 6, None, None, None, None, 0, None)
>>> model = NBEATSModel(input_chunk_length=10, output_chunk_length=7, lags_future_covariates=[4, 6])
>>> model.fit(train_series, future_covariates)
>>> model.extreme_lags
(-10, 6, None, None, 4, 6, 0, None)

返回类型

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

fit(series, future_covariates=None)

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

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

参数

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

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

返回

拟合好的模型。

返回类型

self

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

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

参数

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 用于拟合模型时包含目标值的序列或序列的序列。

• past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，用于拟合模型时包含过去观测协变量的序列或序列的序列。

• future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，用于拟合模型时包含未来已知协变量的序列或序列的序列。

返回

一个包含 (过去协变量, 未来协变量) 的元组。每个协变量都包含原始以及编码的协变量。

返回类型

Tuple[Union[TimeSeries, Sequence[TimeSeries]], Union[TimeSeries, Sequence[TimeSeries]]]

generate_fit_predict_encodings(n, series, past_covariates=None, future_covariates=None)

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

参数

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

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

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

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

返回

一个包含 (过去协变量, 未来协变量) 的元组。每个协变量都包含原始以及编码的协变量。

返回类型

Tuple[Union[TimeSeries, Sequence[TimeSeries]], Union[TimeSeries, Sequence[TimeSeries]]]

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

为推断/预测集生成协变量编码，并返回过去和未来协变量序列的元组，其中原始和编码的协变量堆叠在一起。编码由模型创建时使用参数 add_encoders 定义的编码器生成。传递您打算用于预测的相同的 series、past_covariates 和 future_covariates。

参数

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

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

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

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

返回

一个包含 (过去协变量, 未来协变量) 的元组。每个协变量都包含原始以及编码的协变量。

返回类型

Tuple[Union[TimeSeries, Sequence[TimeSeries]], Union[TimeSeries, Sequence[TimeSeries]]]

classmethod gridsearch(parameters, series, past_covariates=None, future_covariates=None, forecast_horizon=None, stride=1, start=None, start_format='value', last_points_only=False, show_warnings=True, val_series=None, use_fitted_values=False, metric=<function mape>, reduction=<function mean>, verbose=False, n_jobs=1, n_random_samples=None, data_transformers=None, fit_kwargs=None, predict_kwargs=None, sample_weight=None)

使用网格搜索从给定集合中找到最佳超参数。

此函数具有 3 种操作模式：扩展窗口模式、分割模式和拟合值模式。这三种操作模式通过使用 model_class 的每个组合实例化 ForecastingModel 的子类，并根据 metric 函数返回表现最佳的模型来评估 parameters 字典中提供的超参数值的所有可能组合。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 (int) – 预测范围的整数值。激活扩展窗口模式。

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

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

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

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

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

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

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

  是 stride 之后 start 的整数倍。如果不存在有效的起始点，则引发 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]) – 在分割模式下用于验证的 TimeSeries 实例。如果提供，此序列必须紧接在 series 结束之后开始；以便进行正确的预测比较。

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

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

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

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

• verbose – 是否打印进度。

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

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

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

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

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

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

  拟合后的转换器用于在训练和预测过程中对输入进行转换。如果转换是可逆的，则预测结果将被逆转换。

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

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

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

返回

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

返回类型

ForecastingModel, Dict, float

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

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

此方法主要有两种模式

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

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

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

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

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

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

参数

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

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

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

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

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

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

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

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

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

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

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

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

  是 stride 之后 start 的整数倍。如果不存在有效的起始点，则引发 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=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 likelihood: QuantilePrediction

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

返回类型

QuantilePrediction

static load(path)

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

参数

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

返回类型

ForecastingModel

property min_train_samples: int

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

返回类型

int

property model_params: dict

返回类型

dict

property output_chunk_length: Optional[int]

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

返回类型

Optional[int, None]

property output_chunk_shift: int

输出/预测相对于输入结束的偏移时间步长数量。

返回类型

int

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

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

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

参数

• n (int) – 预测范围 - 在序列结束之后进行预测的时间步长数。

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

• future_covariates (Optional[TimeSeries, None]) –

  未来已知协变量的时序序列，可以作为模型的输入。它必须与用于训练的 fit() 方法一起使用的协变量时序序列相对应。

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

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

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

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

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

返回类型

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

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

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

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

此方法按顺序执行

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

• 使用“每时间步长” metric 在历史预测和 series 的每个分量/列和时间步之间计算回测（详情参见 backtest()）。默认情况下，使用残差 err()（误差）作为 metric。

• 创建并返回一个带有历史预测时间索引以及每个分量和时间步度量值的 TimeSeries（或当 values_only=True 时仅返回一个 np.ndarray）。

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

参数

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

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

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

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

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

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

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

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

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

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

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

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

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

  是 stride 之后 start 的整数倍。如果不存在有效的起始点，则引发 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=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] – 对于一系列（列表）series 且 last_points_only=True 的残差 TimeSeries 列表。残差列表的长度为 len(series)。

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

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

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

保存和加载 RegressionModel 的示例

from darts.models import RegressionModel

model = RegressionModel(lags=4)

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

参数

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

• clean (bool) –

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

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

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

返回类型

None

property supports_future_covariates: bool

模型是否支持未来协变量

返回类型

bool

property supports_likelihood_parameter_prediction: bool

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

返回类型

bool

property supports_multivariate: bool

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

返回类型

bool

property supports_optimized_historical_forecasts: bool

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

返回类型

bool

property supports_past_covariates: bool

模型是否支持过去协变量

返回类型

bool

property supports_probabilistic_prediction: bool

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

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

返回类型

bool

property supports_sample_weight: bool

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

返回类型

bool

property supports_static_covariates: bool

模型是否支持静态协变量

返回类型

bool

property supports_transferable_series_prediction: bool

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

返回类型

bool

untrained_model()

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

property uses_future_covariates: bool

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

返回类型

bool

property uses_past_covariates: bool

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

返回类型

bool

property uses_static_covariates: bool

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

返回类型

bool

上一个

AutoETS

下一个

AutoTBATS