预测模型基类

预测模型捕捉时序未来值作为过去值的函数，如下所示

\[y_{t+1} = f(y_t, y_{t-1}, ..., y_1),\]

其中 \(y_t\) 表示时序在时间 \(t\) 的值。

主要函数是 fit() 和 predict()。fit() 通过一个或多个时序的历史数据学习函数 f()。 函数 predict() 将 f() 应用于一个或多个时序，以获得所需未来时间戳的预测。

class darts.models.forecasting.forecasting_model.ForecastingModel(*args, **kwargs)

Bases: ABC

预测模型的基类。它定义了所有预测模型必须支持的最小行为。此基类中的签名适用于仅处理一个单变量序列且无协变量的“本地”模型。子类可以处理更复杂的情况。

属性

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)	在提供的序列上拟合/训练模型。
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[, num_samples, verbose, show_warnings])	预测训练系列结束后的 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 不在可训练/可预测点内，则使用最接近的有效起始点，该点

  是 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：当 callable 返回 True 时重新训练模型。Callable 必须具有以下位置参数

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

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

  • train_series (TimeSeries): 直到 pred_time 的训练系列

  • past_covariates (TimeSeries): 直到 pred_time 的过去协变量系列

  • future_covariates (TimeSeries): 直到 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的未来协变量系列

  注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则会将 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” 衰减——过去越久远，权重越低。权重按每个时序计算。

返回类型

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

返回值

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

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

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

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

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

  • 多个 metric 函数，以及使用 last_points_only=False 生成的 historical_forecasts。使用回测 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

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

返回类型

bool

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

一个包含以下元素的 8 元组：(最小目标滞后, 最大目标滞后, 最小过去协变量滞后, 最大过去协变量滞后, 最小未来协变量滞后, 最大未来协变量滞后, 输出移位, 最大目标滞后训练 (仅适用于 RNNModel))。如果 0 是第一个预测的索引，则所有滞后都相对于此索引。

参见下面的示例。

如果模型未拟合

• 目标 (仅涉及 RegressionModel)：则第一个元素应为 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]]

abstract fit(series)

在提供的序列上拟合/训练模型。

参数

series (TimeSeries) – 目标时序。模型将训练用于预测此时间序列。

返回值

拟合后的模型。

返回类型

自身

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 种操作模式：扩展窗口模式、分割模式和拟合值模式。这三种操作模式通过使用 parameters 字典中提供的每种超参数组合实例化 ForecastingModel 的 model_class 子类来评估所有可能的组合，并返回在 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。

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

参数

• model_class – 要为“series”调整的 ForecastingModel 子类。

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

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

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

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

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

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

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

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

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

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

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

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

  是 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]) – 在 split 模式下用于验证的 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 中的所有组件。否则，对于特定组件的权重，组件数量必须与 series 相匹配。如果是一个字符串，则使用内置的权重函数生成权重。可用选项为 "linear"（线性）或 "exponential"（指数）衰减 - 过去越远，权重越低。

返回值

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

返回类型

ForecastingModel, Dict, float

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

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

此方法主要有两种模式

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

• 预训练模式（retrain=False）：在模拟的每个步骤中，预测结果在不重新训练的情况下生成。此模式仅支持预训练的全局预测模型。此模式显著更快，因为它跳过了重新训练步骤。

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

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

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

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

参数

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

• past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，每个输入时序 series 对应的（一系列）过去观测的协变量时序。仅当模型支持过去协变量时适用。

• future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选参数，每个输入时序 series 对应的（一系列）未来已知协变量时序。仅当模型支持未来协变量时适用。

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

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

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

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

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

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

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

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

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

  是 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：当 callable 返回 True 时重新训练模型。Callable 必须具有以下位置参数

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

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

  • train_series (TimeSeries): 直到 pred_time 的训练系列

  • past_covariates (TimeSeries): 直到 pred_time 的过去协变量系列

  • future_covariates (TimeSeries): 直到 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的未来协变量系列

  注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则会将 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” 衰减——过去越久远，权重越低。权重按每个时序计算。

返回类型

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

返回值

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

• List[TimeSeries] – 历史预测列表，适用于

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

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

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

property likelihood: Optional[Likelihood]

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

返回类型

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

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

返回类型

Optional[int, None]

property output_chunk_shift: int

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

返回类型

int

abstract predict(n, num_samples=1, verbose=False, show_warnings=True)

预测训练系列结束后的 n 个时间步长的值。

参数

• n (int) – 预测范围 - 在系列结束之后要生成预测的时间步长数量。

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

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

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

返回值

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

返回类型

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 或计算每个 series 的历史预测（有关更多详细信息，请参阅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 不在可训练/可预测点内，则使用最接近的有效起始点，该点

  是 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：当 callable 返回 True 时重新训练模型。Callable 必须具有以下位置参数

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

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

  • train_series (TimeSeries): 直到 pred_time 的训练系列

  • past_covariates (TimeSeries): 直到 pred_time 的过去协变量系列

  • future_covariates (TimeSeries): 直到 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的未来协变量系列

  注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则会将 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” 衰减——过去越久远，权重越低。权重按每个时序计算。

• 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] – 一个残差 TimeSeries 列表，适用于一个 series 序列（列表）且 last_points_only=True。残差列表的长度为 len(series)。

• List[List[TimeSeries]] – 一个包含残差 TimeSeries 列表的列表，适用于一个 series 序列且 last_points_only=False。外层残差列表的长度为 len(series)。内层列表包含所有可能的针对 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

abstract 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

abstract 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

class darts.models.forecasting.forecasting_model.ModelMeta(name, bases, namespace, **kwargs)

基类: ABCMeta

用于存储模型创建时使用的参数的元类。

创建模型实例时，参数提取过程如下

1. 获取模型的 __init__ 签名，并存储所有 arg 和 kwarg 名称以及默认值（arg 为空）到一个有序字典 all_params 中。

2. 将 all_params 中的 arg 值替换为模型创建时使用的位置参数。

3. 从 all_params 中移除模型创建时未作为位置参数传递的 arg。这将确保如果未传递所有位置参数，则会引发错误。如果传递了所有位置参数，则不会移除任何参数。

4. 使用模型创建时提供的可选 kwargs 更新 all_params 中的 kwargs。

5. 将 all_params 保存到模型。

6. 使用 all_params 调用（创建）模型。

方法

__call__(*args, **kwargs)	将自身作为函数调用。
mro(/)	返回类型的 方法解析顺序。
register(subclass)	注册 ABC 的虚拟子类。

mro(/)

返回类型的 方法解析顺序。

register(subclass)

注册 ABC 的虚拟子类。

返回子类，以便用作类装饰器。

前一页

快速傅里叶变换

下一页

全局基线模型 (Naive)