快速傅里叶变换

class darts.models.forecasting.fft.FFT(nr_freqs_to_keep=10, required_matches=None, trend=None, trend_poly_degree=3)

基类: LocalForecastingModel

快速傅里叶变换模型

该模型使用 FFT 对 TimeSeries 实例执行预测，进行后续频率滤波（由 nr_freqs_to_keep 参数控制）和逆 FFT，并结合了对数据进行去趋势（由 trend 参数控制）以及将训练序列截取为完整季节周期的选项。请注意，如果训练序列包含任何 NaN（缺失值），这些值将使用 darts.utils.missing_values.fill_missing_values() 进行填充。

参数

• nr_freqs_to_keep (Optional[int, None]) – 用于预测的总频率数。

• required_matches (Optional[set, None]) – 将用于创建训练序列的 pd.Timestamp 属性。该训练序列会在开头被截取，以便训练序列的第一个时间戳与第一个预测点具有匹配的相位。如果序列具有年度季节性，则包括 month；如果具有月度季节性，则包括 day 等。如果未设置或明确设置为 None，模型将尝试自动查找与季节性相关的 pd.Timestamp 属性。

• trend (Optional[str, None]) – 如果设置，指示在执行 DFT 之前将应用哪种去趋势。可能的值有：'poly'、'exp' 或 None，分别对应多项式趋势、指数趋势或无趋势。

• trend_poly_degree (int) – 如果 trend=’poly’，则用于去趋势的多项式次数。

示例

自动检测季节周期，使用 10 个最显著的频率进行预测，并假设数据中不存在全局趋势

>>> FFT(nr_freqs_to_keep=10)

假设提供的 TimeSeries 实例将具有月度季节性和指数全局趋势，且不执行任何频率滤波

>>> FFT(required_matches={'month'}, trend='exp')

简单使用示例，使用 darts 中可用的数据集之一

>>> from darts.datasets import AirPassengersDataset
>>> from darts.models import FFT
>>> series = AirPassengersDataset().load()
>>> # increase the number of frequency and use a polynomial trend of degree 2
>>> model = FFT(
>>>     nr_freqs_to_keep=20,
>>>     trend= "poly",
>>>     trend_poly_degree=2
>>> )
>>> model.fit(series)
>>> pred = model.predict(6)
>>> pred.values()
array([[471.79323146],
       [494.6381425 ],
       [504.5659999 ],
       [515.82463265],
       [520.59404623],
       [547.26720705]])

注意

FFT 示例笔记本 介绍了可用于改进预测质量的技术，与此简单使用示例相比。

属性

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	模型拟合后是否使用静态协变量。

模型参数

方法

backtest(series[, past_covariates, ...])	计算模型在（可能多个）series 上对历史预测产生的误差值。
fit(series)	在提供的 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])	预测训练 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 进一步自定义（例如，控制对组件、时间步、多个 series 的聚合，以及分位数指标所需的 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 or int): 预测时间的时间戳（训练 series 的结束时间）

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

  • past_covariates (TimeSeries): 直到 pred_time 的 past_covariates series

  • future_covariates (TimeSeries): 直到 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的 future_covariates series

  注意：如果任何可选的 *_covariates 未传递给 historical_forecast，None 将传递给相应的 retrain 函数参数。注意：有些模型需要每次都重新训练，并且不支持 retrain=True 之外的任何值。注意：这也控制 data_transformers 的重新训练。

• overlap_end (bool) – 返回的预测是否可以超出 series 的结束时间。

• 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 的 BaseDataTransformer 或 Pipeline 字典（可能的键有：“series”、“past_covariates”、“future_covariates”）。如果提供，所有输入 series 必须处于未转换空间。对于可拟合转换器/管道

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

  • 如果 retrain=False，data transformer 会在所有预测之前对 series 进行一次转换。

  拟合的转换器用于在训练和预测期间转换输入。如果转换是可逆的，预测结果将被逆转换。仅当 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 序列，则使用这些权重。如果权重 series 只有一个组件/列，则权重全局应用于 series 中的所有组件。否则，对于特定组件的权重，组件数必须与 series 的组件数匹配。如果是字符串，则使用内置加权函数生成权重。可用选项是“线性”或“指数”衰减——过去越远，权重越低。权重按时间 series 计算。

返回类型

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

返回值

• float – 单个单变量/多变量 series、单个 metric 函数和

  • 使用 last_points_only=True 生成的 historical_forecasts 的单个 backtest 得分

  • 使用 last_points_only=False 生成的 historical_forecasts，并使用 backtest reduction

• np.ndarray – backtest 得分的 numpy 数组。适用于单个 series 和以下情况之一：

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

  • 多个 metric 函数和使用 last_points_only=False 生成的 historical_forecasts。使用 backtest reduction 时，输出形状为 (*, n metrics)，当 reduction=None 时，输出形状为 (n forecasts, *, n metrics)。

  • 多个单变量/多变量 series，包括 series_reduction，并且对于“按时间步长计算的指标”，至少满足 component_reduction=None 或 time_reduction=None 之一

• List[float] – 与 float 类型相同，但适用于 series 序列。返回的指标列表长度为 len(series)，其中包含每个输入 series 的 float 指标。

• List[np.ndarray] – 与 np.ndarray 类型相同，但适用于 series 序列。返回的指标列表长度为 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 是第一个预测的索引，则所有滞后都是相对于此索引的。

参见下面的示例。

如果模型未拟合

• 目标（仅涉及 RegressionModels）：则第一个元素应为 None。

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

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

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

注意

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

示例

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

返回类型

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

fit(series)

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

参数

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

返回值

拟合后的模型。

返回类型

self

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

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

参数

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

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

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

返回值

一个包含（过去协变量，未来协变量）的元组。每个协变量包含原始协变量和编码后的协变量。

返回类型

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]]) – 打算用于训练和预测的带有目标值的 series 或 series 序列。

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

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

返回值

一个包含（过去协变量，未来协变量）的元组。每个协变量包含原始协变量和编码后的协变量。

返回类型

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]]) – 打算用于预测的带有目标值的 series 或 series 序列。

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

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

返回值

一个包含（过去协变量，未来协变量）的元组。每个协变量包含原始协变量和编码后的协变量。

返回类型

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 上拟合的结果。与拟合值进行比较是评估模型的一种快速方法，但无法看出模型是否对 series 过拟合。

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

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

参数

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

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

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

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

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

• 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 格式。仅当 start 是整数且 series 使用 pd.RangeIndex 索引时有效。如果设置为 'position'，start 对应于第一个预测点在索引中的位置，范围是 (-len(series), len(series) - 1)。如果设置为 'value'，start 对应于第一个预测点在索引中的值/标签。如果该值不在 series 的索引中，将引发错误。默认值：'value'

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

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

• val_series (Optional[TimeSeries, None]) – 在拆分模式下用于验证的时间序列实例。如果提供，此序列必须紧接在 series 结束之后开始，以便进行适当的预测比较。

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

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

  一个指标函数，它返回两个 TimeSeries 之间的误差，作为浮点值。必须是 Darts 的“跨时间聚合”指标之一（参见 此处），或者是一个自定义指标，该指标接受两个 TimeSeries 作为输入并返回误差。

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

• verbose – 是否打印进度。

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

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

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

  可选地，应用于相应 series 的 BaseDataTransformer 或 Pipeline 字典（可能的键有：“series”、“past_covariates”、“future_covariates”）。如果提供，所有输入 series 必须处于未转换空间。对于可拟合转换器/管道

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

  • 如果 retrain=False，data transformer 会在所有预测之前对 series 进行一次转换。

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

• 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 为 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 or int): 预测时间的时间戳（训练 series 的结束时间）

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

  • past_covariates (TimeSeries): 直到 pred_time 的 past_covariates series

  • future_covariates (TimeSeries): 直到 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的 future_covariates series

  注意：如果任何可选的 *_covariates 未传递给 historical_forecast，None 将传递给相应的 retrain 函数参数。注意：有些模型需要每次都重新训练，并且不支持 retrain=True 之外的任何值。注意：这也控制 data_transformers 的重新训练。

• overlap_end (bool) – 返回的预测是否可以超出 series 的结束时间。

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

  可选地，应用于相应 series 的 BaseDataTransformer 或 Pipeline 字典（可能的键有：“series”、“past_covariates”、“future_covariates”）。如果提供，所有输入 series 必须处于未转换空间。对于可拟合转换器/管道

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

  • 如果 retrain=False，data transformer 会在所有预测之前对 series 进行一次转换。

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

• 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 序列，则使用这些权重。如果权重 series 只有一个组件/列，则权重全局应用于 series 中的所有组件。否则，对于特定组件的权重，组件数必须与 series 的组件数匹配。如果是字符串，则使用内置加权函数生成权重。可用选项是“线性”或“指数”衰减——过去越远，权重越低。权重按时间 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: 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

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

预测训练 series 结束后的 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 或计算每个序列的历史预测（有关更多详细信息，请参阅 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 or int): 预测时间的时间戳（训练 series 的结束时间）

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

  • past_covariates (TimeSeries): 直到 pred_time 的 past_covariates series

  • future_covariates (TimeSeries): 直到 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的 future_covariates series

  注意：如果任何可选的 *_covariates 未传递给 historical_forecast，None 将传递给相应的 retrain 函数参数。注意：有些模型需要每次都重新训练，并且不支持 retrain=True 之外的任何值。注意：这也控制 data_transformers 的重新训练。

• overlap_end (bool) – 返回的预测是否可以超出 series 的结束时间。

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

  可选地，应用于相应 series 的 BaseDataTransformer 或 Pipeline 字典（可能的键有：“series”、“past_covariates”、“future_covariates”）。如果提供，所有输入 series 必须处于未转换空间。对于可拟合转换器/管道

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

  • 如果 retrain=False，data transformer 会在所有预测之前对 series 进行一次转换。

  拟合的转换器用于在训练和预测期间转换输入。如果转换是可逆的，预测结果将被逆转换。仅当 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 序列，则使用这些权重。如果权重 series 只有一个组件/列，则权重全局应用于 series 中的所有组件。否则，对于特定组件的权重，组件数必须与 series 的组件数匹配。如果是字符串，则使用内置加权函数生成权重。可用选项是“线性”或“指数”衰减——过去越远，权重越低。权重按时间 series 计算。

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

返回类型

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

返回值

• TimeSeries – 对于单个 series 且 historical_forecasts 使用 last_points_only=True 生成的残差 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

上一页

指数平滑 (Exponential Smoothing)

下一页

<无标题>