StatsForecastModel¶
- class darts.models.forecasting.sf_model.StatsForecastModel(model, add_encoders=None, quantiles=None, random_state=None)[source]¶
基类：
TransferableFutureCovariatesLocalForecastingModelStatsForecast 模型。
可用于拟合任何 StatsForecast 基模型。有关可用模型的更多信息，请参阅 StatsForecast 包。
除了单变量确定性预测，我们的 StatsForecastModel 还提供额外支持：
**未来协变量：** 使用外生特征来潜在提高预测准确性。
它要么使用基模型原生的外生特征，要么
它通过首先使用
LinearRegressionModel模型对序列与未来协变量进行回归，然后在原始回归的样本内残差上运行 StatsForecast 模型来添加未来协变量支持。这种方法受到 Stephan Kolassa 的这篇帖子的启发。
**概率预测：** 某些基模型可能需要在创建 model 时设置 prediction_intervals 以支持概率预测。要生成概率预测，您可以在调用
predict()时设置以下参数：通过设置 predict_likelihood_parameters=True 直接预测分位数。
通过设置 num_samples >> 1 从这些分位数生成采样预测。
**保形预测：** 除了原生的概率支持外，您还可以在模型创建时设置 prediction_intervals 来执行保形预测。然后以与上述相同的方式进行预测。
**可转移序列预测：** 在预测时将拟合好的模型应用于新的输入 series。
它要么使用基模型原生的可转移序列支持（支持 forward() 方法的 StatsForecast 模型），要么
它通过首先在新序列上拟合模型的副本，然后使用该模型生成相应的预测来添加支持。
注意
当输入序列包含缺失值时，不支持未来协变量。
- 参数
**model** (
_TS) – 任何 StatsForecast 模型。**add_encoders** (
Optional[dict,None]) –可以使用 add_encoders 自动生成大量的未来协变量。这可以通过添加多个预定义的索引编码器和/或将用作索引编码器的自定义用户定义函数来完成。此外，还可以添加 Darts 的
Scaler等转换器来转换生成的协变量。所有这些都在一个框架下发生，只需在创建模型时指定即可。阅读SequentialEncoder了解更多关于add_encoders的信息。默认值：None。一个展示add_encoders部分功能的示例：def encode_year(idx): return (idx.year - 1950) / 50 add_encoders={ 'cyclic': {'future': ['month']}, 'datetime_attribute': {'future': ['hour', 'dayofweek']}, 'position': {'future': ['relative']}, 'custom': {'future': [encode_year]}, 'transformer': Scaler(), 'tz': 'CET' }
**quantiles** (
Optional[list[float],None]) – 可选参数，在使用 num_samples > 1 或 predict_likelihood_parameters=True 进行概率预测时，生成 quantiles 级别的分位数预测。**random_state** (
Optional[int,None]) – 控制不同运行中概率保形预测（样本生成）的随机性。
示例
>>> from darts.datasets import AirPassengersDataset >>> from darts.models import StatsForecastModel >>> from darts.utils.timeseries_generation import datetime_attribute_timeseries >>> from statsforecast.models import AutoARIMA >>> 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 AutoARIMA parameters >>> model = StatsForecastModel(model=AutoARIMA(season_length=12)) >>> model.fit(series, future_covariates=future_cov) >>> pred = model.predict(6, future_covariates=future_cov) >>> pred.values() array([[445.4276575 ], [420.04912881], [448.7142377 ], [491.23406559], [502.67834069], [566.04774778]])
属性
模型是否考虑静态协变量（如果存在）。
一个包含以下顺序的 8 元组：(最小目标滞后，最大目标滞后，最小过去协变量滞后，最大过去协变量滞后，最小未来协变量滞后，最大未来协变量滞后，输出偏移，最大目标训练滞后（仅适用于 RNNModel）)。
返回模型用于概率预测的似然函数（如果存在）。
训练模型所需的最少样本数。
模型一次预测的时间步长，统计模型未定义。
输出/预测在输入结束之后开始的时间步数。
模型是否支持未来协变量
模型实例是否支持直接预测似然参数
模型是否考虑时间序列中的多个变量。
模型是否支持优化历史预测
模型是否支持过去协变量
检查此配置的预测模型是否支持概率预测。
模型是否支持训练时的样本权重。
模型是否支持静态协变量
模型是否支持对任何输入 series 进行预测。
模型一旦拟合后是否使用未来协变量。
模型一旦拟合后是否使用过去协变量。
模型一旦拟合后是否使用静态协变量。
model_params
方法
backtest(series[, past_covariates, ...])计算模型对（可能多个）series 的历史预测所产生的误差值。
fit(series[, future_covariates])在提供的（单个）序列上拟合/训练模型。
generate_fit_encodings(series[, ...])生成用于拟合模型的协变量编码，并返回一个元组，其中包含过去和未来协变量序列，以及原始和编码后的协变量堆叠在一起。编码由模型创建时使用参数 add_encoders 定义的编码器生成。传递与训练/拟合模型时使用的相同的 series、past_covariates 和 future_covariates。
generate_fit_predict_encodings(n, series[, ...])生成用于训练和推理/预测的协变量编码，并返回一个元组，其中包含过去和未来协变量序列，以及原始和编码后的协变量堆叠在一起。编码由模型创建时使用参数 add_encoders 定义的编码器生成。传递与您打算用于训练和预测时使用的相同的 series、past_covariates 和 future_covariates。
generate_predict_encodings(n, series[, ...])生成用于推理/预测集的协变量编码，并返回一个元组，其中包含过去和未来协变量序列，以及原始和编码后的协变量堆叠在一起。编码由模型创建时使用参数 add_encoders 定义的编码器生成。传递与您打算用于预测时使用的相同的 series、past_covariates 和 future_covariates。
gridsearch(parameters, series[, ...])使用网格搜索在一给定集合中找到最佳超参数。
historical_forecasts(series[, ...])通过模拟在提供（可能多个）series 历史中的各个时间点进行预测来生成历史预测。
load(path)从给定的路径或文件句柄加载模型。
predict(n[, series, future_covariates, ...])如果未设置 series 参数，则预测训练序列结束后的 n 个时间步长的值。
residuals(series[, past_covariates, ...])计算模型对（可能多个）series 的历史预测所产生的残差。
save([path, clean])将模型保存到给定的路径或文件句柄下。
返回使用相同参数创建的新的（未训练）模型实例。
- 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 不在可训练/可预测时间范围内，则忽略此参数（默认行为为
None），从第一个可训练/可预测点开始。如果不存在有效的起始点，则会引发 ValueError。 是 stride 的倍数并位于 start 之后。
- 注意：如果模型使用偏移输出（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和（返回bool的）Callable。对于bool：在每个步骤重新训练模型（True），或从不重新训练模型（False）。对于int：模型每 retrain 次迭代重新训练一次。对于Callable：只要可调用对象返回 True，就重新训练模型。可调用对象必须具有以下位置参数：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()) 的未来协变量序列
注意：如果未向 historical_forecast 传递任何可选的 *_covariates，则将
None传递给相应的 retrain 函数参数。注意：有些模型要求每次都重新训练，不支持除 retrain=True 之外的任何值。注意：这也控制 data_transformers 的重新训练。**overlap_end** (
bool) – 返回的预测是否可以超出序列的末尾。**last_points_only** (
bool) – 是否只返回每个历史预测的最后一个点。如果设置为True，该方法返回一个包含连续点预测的单个TimeSeries（对于 series 中的每个时间序列）。否则，返回历史TimeSeries预测列表。**metric** (
Union[Callable[…,Union[float,list[float],ndarray,list[ndarray]]],list[Callable[…,Union[float,list[float],ndarray,list[ndarray]]]]]) – 一个指标函数或指标函数列表。每个指标必须是 Darts 指标（请参阅此处），或者具有与 Darts 指标相同签名的自定义指标，使用装饰器multi_ts_support()和multi_ts_support()，并返回指标分数。**reduction** (
Optional[Callable[…,float],None]) – 用于组合 last_points_only 设置为 False 时获得的单个误差分数的函数。当提供多个指标函数时，函数将接收参数 axis = 1，以便为每个指标函数获得单个值。如果显式设置为None，该方法将改为返回单个误差分数的列表。默认为np.mean。**verbose** (
bool) – 是否打印进度。**show_warnings** (
bool) – 是否显示与历史预测优化或参数 start 和 train_length 相关的警告。**predict_likelihood_parameters** (
bool) – 如果设置为 True，模型预测其 likelihood 的参数，而不是目标值。仅对于具有似然函数、num_samples = 1 和 n<=output_chunk_length 的概率模型支持。默认值：False。**enable_optimization** (
bool) – 是否在使用优化版本的 historical_forecasts（如果支持并可用）。默认值：True。**data_transformers** (
Optional[dict[str,Union[BaseDataTransformer,Pipeline]],None]) –可选参数，要应用于相应序列的 BaseDataTransformer 或 Pipeline 字典（可能的键有：“series”、“past_covariates”、“future_covariates”）。如果提供，所有输入序列必须处于未转换空间中。对于可拟合的转换器/管道：
如果 retrain=True，则数据转换器在每次历史预测步骤都会重新拟合训练数据。
如果 retrain=False，则数据转换器在所有预测之前仅转换序列一次。
拟合好的转换器用于在训练和预测期间转换输入。如果转换是可逆的，预测将进行逆转换。仅当 historical_forecasts=None 时有效。
**metric_kwargs** (
Union[dict[str,Any],list[dict[str,Any]],None]) – 传递给 metric() 的附加参数，例如用于并行化的 'n_jobs'，用于减少组件级别指标的 'component_reduction'，用于比例化指标的季节性参数 'm' 等。会将参数分别传递给每个指标，并且仅当它们出现在相应指标的签名中时才会传递。比例化指标（例如 mase、rmsse 等）的参数 'insample' 被忽略，因为它在内部处理。**fit_kwargs** (
Optional[dict[str,Any],None]) – 可选参数，传递给模型 fit() 方法的一些附加参数。**predict_kwargs** (
Optional[dict[str,Any],None]) – 可选参数，传递给模型 predict() 方法的一些附加参数。**sample_weight** (
Union[TimeSeries,Sequence[TimeSeries],str,None]) – 可选参数，应用于目标 series 标签进行训练的一些样本权重。仅当 retrain 不为False时有效。它们按观测值、按标签（output_chunk_length 中的每一步）和按组件应用。如果是一个序列或序列的序列，则使用这些权重。如果权重序列只有一个组件/列，则权重全局应用于 series 中的所有组件。否则，对于特定组件的权重，组件数量必须与 series 的组件数量匹配。如果是一个字符串，则使用内置权重函数生成权重。可用选项是 "linear" 或 "exponential" 衰减——过去的时间越远，权重越低。权重按时间 series 计算。
- 返回类型
Union[float,ndarray,list[float],list[ndarray]]- 返回
float – 单个单变量/多变量序列、单个 metric 函数以及
使用 last_points_only=True 生成的 historical_forecasts 的单个回测分数。
使用 last_points_only=False 生成并使用回测 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
- 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, 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 种操作模式：扩展窗口模式、分割模式和拟合值模式。这三种操作模式通过使用 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时）时可能出现意外行为。如果无法避免，则应重新定义网格搜索，强制设置n_jobs = 1。当前此方法仅支持确定性预测（即模型的预测仅有1个样本时）。
- 参数
model_class – 用于针对“series”调优的ForecastingModel子类。
parameters (
dict) – 一个字典，其键是超参数名称，值是相应超参数的值列表。series (
TimeSeries) – 用作训练输入和目标的系列。past_covariates (
Optional[TimeSeries,None]) – 可选的，过去观测到的协变量系列。这仅适用于模型支持过去协变量的情况。future_covariates (
Optional[TimeSeries,None]) – 可选的，未来已知的协变量系列。这仅适用于模型支持未来协变量的情况。forecast_horizon (
Optional[int,None]) – 预测范围的整数值。激活扩展窗口模式。stride (
int) – 仅在扩展窗口模式下使用。两次连续预测之间的时间步数。**start** (
Union[Timestamp,float,int,None]) –仅在扩展窗口模式下使用。可选的，计算预测的第一个时间点。此参数支持：
float,int,pandas.Timestamp, 和None。如果是float，则表示时间序列在第一个预测点之前应占有的比例。如果是int，则对于具有 pd.DatetimeIndex 的 series，它是第一个预测点的索引位置；对于具有 pd.RangeIndex 的 series，它是索引值。后者可以通过 start_format=”position” 更改为索引位置。如果是pandas.Timestamp，则表示第一个预测点的时间戳。如果是None，第一个预测点将自动设置为如果 retrain 为
False，或者 retrain 是一个 Callable 且第一个可预测点早于第一个可训练点，则为第一个可预测点。如果retrain为
True或int（给定train_length）时的第一个可训练点，或者retrain是一个可调用对象且第一个可训练点早于第一个可预测点。否则为第一个可训练点（给定 train_length）。
- 注意：如果 start 不在可训练/可预测时间范围内，则忽略此参数（默认行为为
None），从第一个可训练/可预测点开始。如果不存在有效的起始点，则会引发 ValueError。 是 stride 的倍数并位于 start 之后。
- 注意：如果模型使用偏移输出（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 是一个 Callable 且第一个可预测点早于第一个可训练点，则为第一个可预测点。如果 retrain 为
True或int（给定 train_length），或者 retrain 是一个Callable且第一个可训练点早于第一个可预测点，则为第一个可训练点。否则为第一个可训练点（给定 train_length）。
- 注意：如果 start 不在可训练/可预测时间范围内，则忽略此参数（默认行为为
None），从第一个可训练/可预测点开始。如果不存在有效的起始点，则会引发 ValueError。 是 stride 的倍数并位于 start 之后。
- 注意：如果模型使用偏移输出（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和（返回bool的）Callable。对于bool：在每个步骤重新训练模型（True），或从不重新训练模型（False）。对于int：模型每 retrain 次迭代重新训练一次。对于Callable：只要可调用对象返回 True，就重新训练模型。可调用对象必须具有以下位置参数：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()) 的未来协变量序列
注意：如果未向 historical_forecast 传递任何可选的 *_covariates，则将
None传递给相应的 retrain 函数参数。注意：有些模型要求每次都重新训练，不支持除 retrain=True 之外的任何值。注意：这也控制 data_transformers 的重新训练。**overlap_end** (
bool) – 返回的预测是否可以超出序列的末尾。**last_points_only** (
bool) – 是否只返回每个历史预测的最后一个点。如果设置为True，该方法返回一个包含连续点预测的单个TimeSeries（对于 series 中的每个时间序列）。否则，返回历史TimeSeries预测列表。**verbose** (
bool) – 是否打印进度。**show_warnings** (
bool) – 是否显示与历史预测优化或参数 start 和 train_length 相关的警告。**predict_likelihood_parameters** (
bool) – 如果设置为 True，模型预测其 likelihood 的参数，而不是目标值。仅对于具有似然函数、num_samples = 1 和 n<=output_chunk_length 的概率模型支持。默认值：False。**enable_optimization** (
bool) – 是否在使用优化版本的 historical_forecasts（如果支持并可用）。默认值：True。**data_transformers** (
Optional[dict[str,Union[BaseDataTransformer,Pipeline]],None]) –可选参数，要应用于相应序列的 BaseDataTransformer 或 Pipeline 字典（可能的键有：“series”、“past_covariates”、“future_covariates”）。如果提供，所有输入序列必须处于未转换空间中。对于可拟合的转换器/管道：
如果 retrain=True，则数据转换器在每次历史预测步骤都会重新拟合训练数据。
如果 retrain=False，则数据转换器在所有预测之前仅转换序列一次。
拟合的转换器用于在训练和预测过程中对输入进行转换。如果转换是可逆的，预测结果将被逆转换。
**fit_kwargs** (
Optional[dict[str,Any],None]) – 可选参数，传递给模型 fit() 方法的一些附加参数。**predict_kwargs** (
Optional[dict[str,Any],None]) – 可选参数，传递给模型 predict() 方法的一些附加参数。**sample_weight** (
Union[TimeSeries,Sequence[TimeSeries],str,None]) – 可选参数，应用于目标 series 标签进行训练的一些样本权重。仅当 retrain 不为False时有效。它们按观测值、按标签（output_chunk_length 中的每一步）和按组件应用。如果是一个序列或序列的序列，则使用这些权重。如果权重序列只有一个组件/列，则权重全局应用于 series 中的所有组件。否则，对于特定组件的权重，组件数量必须与 series 的组件数量匹配。如果是一个字符串，则使用内置权重函数生成权重。可用选项是 "linear" 或 "exponential" 衰减——过去的时间越远，权重越低。权重按时间 series 计算。
- 返回类型
Union[TimeSeries,list[TimeSeries],list[list[TimeSeries]]]- 返回
TimeSeries – 对于单个series和last_points_only=True的单个历史预测：它仅包含所有历史预测中步骤forecast_horizon的预测。
List[TimeSeries] – 对于以下情况的历史预测列表：
一系列（列表）的series和last_points_only=True：对于每个系列，它仅包含所有历史预测中步骤forecast_horizon的预测。
单个series和last_points_only=False：对于每个历史预测，它包含整个预测范围forecast_horizon。
List[List[TimeSeries]] – 对于一系列series和last_points_only=False的历史预测列表的列表。对于每个系列和历史预测，它包含整个预测范围forecast_horizon。外部列表对应于输入的系列序列，内部列表包含每个系列的历史预测。
- property likelihood: QuantilePrediction¶
返回模型用于概率预测的似然函数（如果存在）。
- 返回类型
- static load(path)¶
从给定的路径或文件句柄加载模型。
- 参数
path (
Union[str,PathLike,BinaryIO]) – 加载模型的路径或文件句柄。- 返回类型
- 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 是一个 Callable 且第一个可预测点早于第一个可训练点，则为第一个可预测点。如果 retrain 为
True或int（给定 train_length），或者 retrain 是一个Callable且第一个可训练点早于第一个可预测点，则为第一个可训练点。否则为第一个可训练点（给定 train_length）。
- 注意：如果 start 不在可训练/可预测时间范围内，则忽略此参数（默认行为为
None），从第一个可训练/可预测点开始。如果不存在有效的起始点，则会引发 ValueError。 是 stride 的倍数并位于 start 之后。
- 注意：如果模型使用偏移输出（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和（返回bool的）Callable。对于bool：在每个步骤重新训练模型（True），或从不重新训练模型（False）。对于int：模型每 retrain 次迭代重新训练一次。对于Callable：只要可调用对象返回 True，就重新训练模型。可调用对象必须具有以下位置参数：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()) 的未来协变量序列
注意：如果未向 historical_forecast 传递任何可选的 *_covariates，则将
None传递给相应的 retrain 函数参数。注意：有些模型要求每次都重新训练，不支持除 retrain=True 之外的任何值。注意：这也控制 data_transformers 的重新训练。**overlap_end** (
bool) – 返回的预测是否可以超出序列的末尾。**last_points_only** (
bool) – 是否只返回每个历史预测的最后一个点。如果设置为True，该方法返回一个包含连续点预测的单个TimeSeries（对于 series 中的每个时间序列）。否则，返回历史TimeSeries预测列表。metric (
Callable[…,Union[float,list[float],ndarray,list[ndarray]]]) –可以是Darts的“每时间步”度量之一（参见这里），或者是一个自定义度量，其签名与Darts的“每时间步”度量完全相同，使用了装饰器
multi_ts_support()和multi_ts_support()，并返回每个时间步的一个值。**verbose** (
bool) – 是否打印进度。**show_warnings** (
bool) – 是否显示与历史预测优化或参数 start 和 train_length 相关的警告。**predict_likelihood_parameters** (
bool) – 如果设置为 True，模型预测其 likelihood 的参数，而不是目标值。仅对于具有似然函数、num_samples = 1 和 n<=output_chunk_length 的概率模型支持。默认值：False。**enable_optimization** (
bool) – 是否在使用优化版本的 historical_forecasts（如果支持并可用）。默认值：True。**data_transformers** (
Optional[dict[str,Union[BaseDataTransformer,Pipeline]],None]) –可选参数，要应用于相应序列的 BaseDataTransformer 或 Pipeline 字典（可能的键有：“series”、“past_covariates”、“future_covariates”）。如果提供，所有输入序列必须处于未转换空间中。对于可拟合的转换器/管道：
如果 retrain=True，则数据转换器在每次历史预测步骤都会重新拟合训练数据。
如果 retrain=False，则数据转换器在所有预测之前仅转换序列一次。
拟合好的转换器用于在训练和预测期间转换输入。如果转换是可逆的，预测将进行逆转换。仅当 historical_forecasts=None 时有效。
metric_kwargs (
Optional[dict[str,Any],None]) – 传递给metric()的额外参数，例如用于并行化的‘n_jobs’，用于比例度量的‘m’等。仅当参数存在于相应度量的签名中时才会传递。忽略归约参数“series_reduction”, “component_reduction”, “time_reduction”，以及比例度量（例如mase, rmsse, …）的参数‘insample’，因为它们在内部处理。**fit_kwargs** (
Optional[dict[str,Any],None]) – 可选参数，传递给模型 fit() 方法的一些附加参数。**predict_kwargs** (
Optional[dict[str,Any],None]) – 可选参数，传递给模型 predict() 方法的一些附加参数。**sample_weight** (
Union[TimeSeries,Sequence[TimeSeries],str,None]) – 可选参数，应用于目标 series 标签进行训练的一些样本权重。仅当 retrain 不为False时有效。它们按观测值、按标签（output_chunk_length 中的每一步）和按组件应用。如果是一个序列或序列的序列，则使用这些权重。如果权重序列只有一个组件/列，则权重全局应用于 series 中的所有组件。否则，对于特定组件的权重，组件数量必须与 series 的组件数量匹配。如果是一个字符串，则使用内置权重函数生成权重。可用选项是 "linear" 或 "exponential" 衰减——过去的时间越远，权重越低。权重按时间 series 计算。values_only (
bool) – 是否将残差作为np.ndarray返回。如果为False，则将残差作为TimeSeries返回。
- 返回类型
Union[TimeSeries,list[TimeSeries],list[list[TimeSeries]]]- 返回
TimeSeries – 对于使用last_points_only=True生成的单个series和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存储的全局预测模型后，必须在predict()、historical_forecasts()和其他预测方法中传递series。
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