Facebook Prophet

class darts.models.forecasting.prophet_model.Prophet(add_seasonalities=None, country_holidays=None, suppress_stdout_stderror=True, add_encoders=None, cap=None, floor=None, **prophet_kwargs)

基类: FutureCovariatesLocalForecastingModel

Facebook Prophet

这个类提供了 Facebook Prophet 的基本封装。它支持添加国家节假日和自定义季节性，并增加了对随机预测和未来协变量的支持。

参数

• add_seasonalities (Union[dict, list[dict], None]) –

  可选参数，一个 dict 或 dicts 列表，用于向模型添加自定义季节性。每个 dict 包含以下强制性和可选数据

  dict({
  'name': str  # (name of the seasonality component),
  'seasonal_periods': Union[int, float]  # (nr of steps composing a season),
  'fourier_order': int  # (number of Fourier components to use),
  'prior_scale': Optional[float]  # (a prior scale for this component),
  'mode': Optional[str]  # ('additive' or 'multiplicative')
  })
  

  seasonal_periods 的示例：如果您有每小时数据 (frequency='H')，并且季节周期在 48 小时后重复，则设置 seasonal_periods=48。请注意，此值将乘以推断出的 TimeSeries 频率对应的天数（在此示例中为 1/24），以便与 Facebook Prophet 的 add_seasonality() 方法保持一致，其中 period 参数以天为单位指定。

  除了 seasonal_periods，这与您调用 Facebook Prophet 的 add_seasonality() 方法非常相似。另外，您可以在创建模型后、拟合模型前使用 add_seasonality() 添加季节性。

• country_holidays (Optional[str, None]) –

  可选的国家代码，Prophet 可以考虑该国家的节假日。

  详情请参阅: https://github.com/dr-prodigy/python-holidays

  除了上述国家，Prophet 还包括以下国家的节假日：巴西 (BR)、印度尼西亚 (ID)、印度 (IN)、马来西亚 (MY)、越南 (VN)、泰国 (TH)、菲律宾 (PH)、土耳其 (TU)、巴基斯坦 (PK)、孟加拉国 (BD)、埃及 (EG)、中国 (CN) 和俄罗斯 (RU)。

• suppress_stdout_stderror (bool) – 可选参数，用于抑制 Prophet 在训练期间产生的日志输出。

• 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'
  }
  

• cap (Union[float, Callable[[Union[DatetimeIndex, RangeIndex]], Sequence[float]], None]) –

  使用逻辑增长预测时指定最大承载能力的参数。当 growth = ‘logistic’ 时为必需参数，否则将被忽略。有关逻辑预测的更多信息，请参阅 <https://fbdocs.cn/prophet/docs/saturating_forecasts.html>。可以是

  • 一个数字，表示恒定的承载能力

  • 一个函数，接受 DatetimeIndex 或 RangeIndex 并返回相应的数字序列，

  其中每个数字表示在该索引处的承载能力。

• floor (Union[float, Callable[[Union[DatetimeIndex, RangeIndex]], Sequence[float]], None]) –

  使用逻辑增长预测时指定最小承载能力的参数。当 growth = ‘logistic’ 时为可选参数（默认为 0），否则将被忽略。有关逻辑预测的更多信息，请参阅 <https://fbdocs.cn/prophet/docs/saturating_forecasts.html>。可以是

  • 一个数字，表示恒定的承载能力

  • 一个函数，接受 DatetimeIndex 或 RangeIndex 并返回相应的数字序列，

  其中每个数字表示在该索引处的承载能力。

• prophet_kwargs – Prophet 的一些可选关键字参数。有关参数的信息，请参阅：Prophet 源代码。

示例

>>> from darts.datasets import AirPassengersDataset
>>> from darts.models import Prophet
>>> from darts.utils.timeseries_generation import datetime_attribute_timeseries
>>> series = AirPassengersDataset().load()
>>> # optionally, use some future covariates; e.g. the value of the month encoded as a sine and cosine series
>>> future_cov = datetime_attribute_timeseries(series, "month", cyclic=True, add_length=6)
>>> # adding a seasonality (daily, weekly and yearly are included by default) and holidays
>>> model = Prophet(
>>>     add_seasonalities={
>>>         'name':"quarterly_seasonality",
>>>         'seasonal_periods':4,
>>>         'fourier_order':5
>>>         },
>>> )
>>> model.fit(series, future_covariates=future_cov)
>>> pred = model.predict(6)
>>> pred.values()
array([[472.26891239],
       [467.56955721],
       [494.47230467],
       [493.10568429],
       [497.54686113],
       [539.11716811]])

属性

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

方法

add_seasonality(name, seasonal_periods, ...)	向模型添加自定义季节性，该季节性每隔 n 个 seasonal_periods 时间步重复一次。
backtest(series[, past_covariates, ...])	计算模型对（可能多个）series 的历史预测所产生的误差值。
fit(series[, future_covariates])	在提供的（单个）序列上拟合/训练模型。
generate_fit_encodings(series[, ...])	生成用于拟合模型的协变量编码，并返回一个元组，包含将原始协变量和编码协变量堆叠在一起的过去和未来协变量序列。
generate_fit_predict_encodings(n, series[, ...])	生成用于训练和推理/预测的协变量编码，并返回一个元组，包含将原始协变量和编码协变量堆叠在一起的过去和未来协变量序列。
generate_predict_encodings(n, series[, ...])	生成用于推理/预测集的协变量编码，并返回一个元组，包含将原始协变量和编码协变量堆叠在一起的过去和未来协变量序列。
gridsearch(parameters, series[, ...])	使用网格搜索在给定集合中找到最佳超参数。
historical_forecasts(series[, ...])	通过模拟在提供的（可能多个）series 历史中不同时间点的预测来生成历史预测。
load(path)	从给定路径或文件句柄加载模型。
predict(n[, future_covariates, num_samples, ...])	预测训练序列结束后的 n 个时间步长内的值。
predict_raw(n[, future_covariates])	以 pandas DataFrame 的形式返回基本 Facebook Prophet 模型的输出。
residuals(series[, past_covariates, ...])	计算模型对（可能多个）series 的历史预测所产生的残差。
save([path, clean])	将模型保存到给定路径或文件句柄。
untrained_model()	返回使用相同参数创建的新的（未训练的）模型实例。

add_seasonality(name, seasonal_periods, fourier_order, prior_scale=None, mode=None, condition_name=None)

向模型添加自定义季节性，该季节性每隔 n 个 seasonal_periods 时间步重复一次。seasonal_periods 的示例：如果您有每小时数据 (frequency='H')，并且季节周期在 48 小时后重复 -> seasonal_periods=48。

除了 seasonal_periods，这与您调用 Facebook Prophet 的 add_seasonality() 方法非常相似。

要添加条件季节性，请在此处提供 condition_name，并将名为 condition_name 的布尔（二元）分量/列添加到传递给 fit() 和 predict() 的 future_covariates 序列中。

有关参数的信息，请参阅：Prophet 源代码 <https://github.com/facebook/prophet/blob/master/python/prophet/forecaster.py>。有关条件季节性的更多详细信息，请参阅：https://fbdocs.cn/prophet/docs/seasonality,_holiday_effects,_and_regressors.html#seasonalities-that-depend-on-other-factors

参数

• name (str) – 季节性分量的名称

• seasonal_periods (Union[int, float]) – 季节周期重复后的时间步长数。此值将乘以推断出的 TimeSeries 频率对应的天数（例如，年度频率为 365.25），以便与 Facebook Prophet 的 add_seasonality() 方法保持一致。推断出的天数可以通过 model._freq_to_days(series.freq) 获取，其中 model 是 Prophet 模型，series 是目标序列。

• fourier_order (int) – 要使用的傅里叶分量数量

• prior_scale (Optional[float, None]) – 可选参数，此分量的先验尺度

• mode (Optional[str, None]) – 可选参数，可以是 'additive'（加法）或 'multiplicative'（乘法）

• condition_name (Optional[str, None]) – 可选参数，季节性依赖的条件的名称。如果不是 None，则期望一个名为 condition_name 的分量/列的 future_covariates 时间序列被传递给 fit() 和 predict()。

返回类型

None

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：每当可调用对象返回 True 时，模型重新训练。该可调用对象必须具有以下位置参数

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

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

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

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

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

  注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则 None 将传递给相应的 retrain 函数参数。注意：某些模型需要每次都重新训练，并且不支持除 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”）。如果提供此参数，所有输入序列必须位于未转换的空间中。对于可拟合的 transformer / pipeline：

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

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

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

• metric_kwargs (Union[dict[str, Any], list[dict[str, Any]], None]) – 传递给 metric() 的其他参数，例如用于并行化的 ‘n_jobs’，用于减少分量维度指标的 ‘component_reduction’，缩放指标的季节性参数 ‘m’ 等。将分别传递参数给每个指标，并且仅当它们出现在相应的指标签名中时才会传递。缩放指标（例如 mase`, rmsse 等）的参数 ‘insample’ 将被忽略，因为它在内部处理。

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

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

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

返回类型

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

返回

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

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

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

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

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

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

  • 包括 series_reduction 以及“按时间步长计算的指标”中至少一个 component_reduction=None 或 time_reduction=None 的多个单变量/多变量序列

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

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

property considers_static_covariates: bool

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

返回类型

bool

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

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

参见下面的示例。

如果模型未拟合

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

目前，此方法仅支持确定性预测（即，当模型的预测只有 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]) – 在拆分模式中用于验证的 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”）。如果提供此参数，所有输入序列必须位于未转换的空间中。对于可拟合的 transformer / pipeline：

  • 如果 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 不在可训练/可预测点内，则使用最接近的有效起始点，该点

  是 stride 的整数倍且位于 start 之后。如果不存在有效的起始点，则引发 ValueError。

  注意：如果模型使用偏移输出（output_chunk_shift > 0），则第一个预测点也会

  向未来偏移 output_chunk_shift 个点。

  注意：如果 start 超出了可能的历史预测时间范围，将忽略该参数

  （None 时的默认行为），并从第一个可训练/可预测点开始。

• start_format (Literal[‘position’, ‘value’]) – 定义 start 的格式。如果设置为 'position'，start 对应于第一个预测点的索引位置，范围可以是 (-len(series), len(series) - 1)。如果设置为 'value'，start 对应于第一个预测点的索引值/标签。如果该值不在 series 的索引中，则会引发错误。默认值：'value'。

• stride (int) – 两个连续预测之间的时间步长数。

• retrain (Union[bool, int, Callable[…, bool]]) –

  是否以及/或在何种条件下在预测前重新训练模型。此参数支持 3 种不同类型：bool、（正数）int 和 Callable（返回 bool）。对于 bool：在每个步骤重新训练模型（True），或者从不重新训练模型（False）。对于 int 信息：模型每隔 retrain 次迭代重新训练一次。对于 Callable：每当可调用对象返回 True 时，模型重新训练。该可调用对象必须具有以下位置参数

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

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

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

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

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

  注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则 None 将传递给相应的 retrain 函数参数。注意：某些模型需要每次都重新训练，并且不支持除 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”）。如果提供此参数，所有输入序列必须位于未转换的空间中。对于可拟合的 transformer / pipeline：

  • 如果 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: 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, future_covariates=None, num_samples=1, predict_likelihood_parameters=False, verbose=False, show_warnings=True, **kwargs)

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

如果在训练期间指定了一些未来协变量，则在此处也必须指定它们。

参数

• n (int) – 预测范围 - 序列结束后的时间步数，用于生成预测。

• future_covariates (Optional[TimeSeries, None]) – 未来已知协变量的时间序列，可以作为模型的输入。它必须与用于训练的 fit() 方法一起使用的协变量时间序列相对应，并且它必须包含训练目标序列结束后的至少接下来的 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 个点。

predict_raw(n, future_covariates=None)

以 pandas DataFrame 的形式返回基础 Facebook Prophet 模型的输出。但请注意，此方法的输出不支持 Darts API 的进一步处理。

可以通过 self.model.method() 访问基础 Prophet 模型的方法（即 self.model.plot_components()）

返回类型

DataFrame

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 进行配置。

• 使用历史预测和 series 之间按组件/列和时间步长计算的“按时间步长”metric 进行回测（更多详细信息参见 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：每当可调用对象返回 True 时，模型重新训练。该可调用对象必须具有以下位置参数

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

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

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

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

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

  注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则 None 将传递给相应的 retrain 函数参数。注意：某些模型需要每次都重新训练，并且不支持除 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”）。如果提供此参数，所有输入序列必须位于未转换的空间中。对于可拟合的 transformer / pipeline：

  • 如果 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] – 对于使用 last_points_only=True 的一系列（列表）series 的残差 TimeSeries 列表。残差列表的长度为 len(series)。

• List[List[TimeSeries]] – 对于使用 last_points_only=False 的一系列 series 的残差 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

上一页

<无标题>

下一页

随机森林