Theta 方法¶

类 darts.models.forecasting.theta.FourTheta(theta=2, seasonality_period=None, season_mode=SeasonalityMode.MULTIPLICATIVE, model_mode=ModelMode.ADDITIVE, trend_mode=TrendMode.LINEAR, normalization=True)[source]¶

基类: LocalForecastingModel

4Theta 方法的一个实现，具有可配置的 theta 参数。

参见 M4 竞赛解决方案。

训练时序根据 seasonality_period 或推断的季节性周期进行去季节化处理。

season_mode 必须是 SeasonalityMode 枚举成员。model_mode 必须是 ModelMode 枚举成员。trend_mode 必须是 TrendMode 枚举成员。

您可以使用 from darts import SeasonalityMode, TrendMode, ModelMode 访问不同的枚举。

当使用 theta = X、model_mode = Model.ADDITIVE 和 trend_mode = Trend.LINEAR 调用时，此模型等效于调用 Theta(theta=X)。

参数

theta (int) – theta 参数的值。默认为 2。如果 theta = 1，则 fourtheta 方法简化为简单的指数平滑 (SES)。如果 theta = 0，则 fourtheta 方法简化为简单的 trend_mode 回归。
seasonality_period (Optional[int, None]) – 用户定义的季节性周期。如果未设置，则在调用 fit() 时会从训练序列中初步推断。
model_mode (ModelMode) – 组合 Theta 线条的模型类型。可以是 ModelMode.ADDITIVE 或 ModelMode.MULTIPLICATIVE。默认为 ModelMode.ADDITIVE。
season_mode (SeasonalityMode) – 季节性类型。可以是 SeasonalityMode.MULTIPLICATIVE、SeasonalityMode.ADDITIVE 或 SeasonalityMode.NONE。默认为 SeasonalityMode.MULTIPLICATIVE。
trend_mode (TrendMode) – 要拟合的趋势类型。可以是 TrendMode.LINEAR 或 TrendMode.EXPONENTIAL。默认为 TrendMode.LINEAR。
normalization (bool) – 如果为 True，则对数据进行归一化处理，使其均值为 1。默认为 True。

注意

尽管此模型是 Theta 的改进，但它是该算法的一个朴素实现，可能速度较慢。

示例

>>> from darts.datasets import AirPassengersDataset
>>> from darts.models import FourTheta
>>> series = AirPassengersDataset().load()
>>> model = FourTheta(theta=2)
>>> model.fit(series)
>>> pred = model.predict(6)
>>> pred.values()
array([[443.3949283 ],
       [434.39769555],
       [495.28886231],
       [481.08962991],
       [481.78610361],
       [546.61463773]])

属性

`considers_static_covariates`	模型是否考虑静态协变量（如果存在）。
`extreme_lags`	一个 8 元组，按顺序包含：(最小目标滞后，最大目标滞后，最小过去协变量滞后，最大过去协变量滞后，最小未来协变量滞后，最大未来协变量滞后，输出偏移，最大目标训练滞后（仅适用于 RNNModel）)。
`likelihood`	返回模型用于概率预测的似然（如果存在）。
`min_train_samples`	训练模型的最小样本数。
`output_chunk_length`	模型一次预测的时间步长数量，对于统计模型未定义。
`output_chunk_shift`	输出/预测开始于输入结束之后的时间步长数量。
`supports_future_covariates`	模型是否支持未来协变量
`supports_likelihood_parameter_prediction`	模型实例是否支持直接预测似然参数
`supports_multivariate`	模型是否考虑时序中的多个变量。
`supports_optimized_historical_forecasts`	模型是否支持优化的历史预测
`supports_past_covariates`	模型是否支持过去协变量
`supports_probabilistic_prediction`	检查具有此配置的预测模型是否支持概率预测。
`supports_sample_weight`	模型是否支持训练时的样本权重。
`supports_static_covariates`	模型是否支持静态协变量
`supports_transferable_series_prediction`	模型是否支持对任意输入 series 进行预测。
`uses_future_covariates`	模型拟合后是否使用未来协变量。
`uses_past_covariates`	模型拟合后是否使用过去协变量。
`uses_static_covariates`	模型拟合后是否使用静态协变量。

model_params

方法

`backtest`(series[, past_covariates, ...])	计算模型对提供的（可能多个）series 的历史预测产生的误差值。
`fit`(series)	在提供的序列上拟合/训练模型。
`generate_fit_encodings`(series[, ...])	生成用于拟合模型的协变量编码，并返回一个元组，其中包含过去和未来协变量序列，以及原始和编码后的协变量堆叠在一起。
`generate_fit_predict_encodings`(n, series[, ...])	生成用于训练和推理/预测的协变量编码，并返回一个元组，其中包含过去和未来协变量序列，以及原始和编码后的协变量堆叠在一起。
`generate_predict_encodings`(n, series[, ...])	生成用于推理/预测集的协变量编码，并返回一个元组，其中包含过去和未来协变量序列，以及原始和编码后的协变量堆叠在一起。
`gridsearch`(parameters, series[, ...])	使用网格搜索查找给定集合中的最佳超参数。
`historical_forecasts`(series[, ...])	通过模拟在提供的（可能多个）series 的整个历史中的各个时间点进行预测来生成历史预测。
`load`(path)	从给定路径或文件句柄加载模型。
`predict`(n[, num_samples, verbose, show_warnings])	预测训练系列结束后的 n 个时间步长内的值。
`residuals`(series[, past_covariates, ...])	计算模型对提供的（可能多个）series 进行历史预测产生的残差。
`save`([path, clean])	将模型保存到给定路径或文件句柄下。
`select_best_model`(ts[, thetas, m, ...])	在所有超参数上执行网格搜索，使用在训练系列 ts 上的拟合值来选择最佳模型。
`untrained_model`()	返回使用相同参数创建的新（未训练）模型实例。

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

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

如果提供了 historical_forecasts，则直接在所有预测值和实际值上评估指标（由 metric 函数给出）。必须传递用于生成历史预测的相同 series 和 last_points_only 值。最后，该方法返回所有这些指标得分的可选 reduction（默认为平均值）。

如果 historical_forecasts 为 None，则首先使用下面给出的参数生成历史预测（有关更多信息，请参见 ForecastingModel.historical_forecasts()），然后按上述方法进行评估。

可以使用 metric_kwargs 进一步自定义指标（例如，控制在组件、时间步长、多个序列上的聚合，以及分位数指标所需的其他参数，例如 q 等）。

参数

series (Union[TimeSeries, Sequence[TimeSeries]]) – 用于依次训练（如果 retrain 不为 False）和计算历史预测的（序列）目标时序。
past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，对于 series 中的每个输入时序，其相应的（序列）过去观测的协变量时序。这仅适用于支持过去协变量的模型。
future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，对于 series 中的每个输入时序，其相应的（序列）未来已知协变量时序。这仅适用于支持未来协变量的模型。
historical_forecasts (Union[TimeSeries, Sequence[TimeSeries], Sequence[Sequence[TimeSeries]], None]) – 可选地，要评估的（或序列/序列的序列）历史预测时序。对应于 historical_forecasts() 的输出。必须传递用于生成历史预测的相同 series 和 last_points_only 值。如果提供了此参数，将跳过历史预测，并忽略除 series、last_points_only、metric 和 reduction 之外的所有参数。
forecast_horizon (int) – 预测的预测范围。
num_samples (int) – 从概率模型中采样预测的次数。仅对概率模型使用 >1 的值。
train_length (Optional[int, None]) – 可选地，对每个构建的训练集（滚动窗口模式）使用固定长度/时间步长数量。仅当 retrain 不为 False 时有效。默认为 None，此时使用直至预测时间的所有时间步长（扩展窗口模式）。如果大于可用时间步长数量，则使用扩展模式。必须至少为 min_train_series_length。
start (Union[Timestamp, float, int, None]) –
可选地，计算预测的第一个时间点。此参数支持：float、int、pandas.Timestamp 和 None。如果为 float，则表示第一个预测点之前的时间序列比例。如果为 int，则对于具有 pd.DatetimeIndex 的 series，它是第一个预测点的索引位置；对于具有 pd.RangeIndex 的 series，它是索引值。后一种情况可以通过 start_format="position" 更改为索引位置。如果为 pandas.Timestamp，则它是第一个预测点的时间戳。如果为 None，则第一个预测点将自动设置为
- 如果 retrain 为 False，或者 retrain 是可调用的且第一个可预测点早于第一个可训练点，则设置为第一个可预测点。
- 如果 retrain 为 True 或 int（给定 train_length），或者 retrain 是可调用的且第一个可训练点早于第一个可预测点，则设置为第一个可训练点。
- 否则设置为第一个可训练点（给定 train_length）。
注意：如果 start 不在可训练/可预测点范围内，将忽略该参数（使用 None 时的默认行为），并从第一个可训练/可预测点开始。如果不存在有效的起始点，则引发 ValueError。
注意：如果模型使用偏移输出（output_chunk_shift > 0），则第一个预测点也会

向未来偏移 output_chunk_shift 个点。
注意：如果 start 超出可能的历史预测时间范围，将忽略该参数

（使用 None 时的默认行为），并从第一个可训练/可预测点开始。
是比 start 超出 stride 的一个整数倍的最近有效起始点。
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 or int): 预测时间的时间戳（训练序列的末尾）
- train_series (TimeSeries): 直至 pred_time 的训练序列
- past_covariates (TimeSeries): 直至 pred_time 的过去协变量序列
- future_covariates (TimeSeries): 直至 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的未来协变量序列
注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则会将 None 传递给相应的 retrain 函数参数。注意：有些模型要求每次都重新训练，不支持除 retrain=True 以外的任何设置。注意：这也控制着 data_transformers 的重新训练。
overlap_end (bool) – 返回的预测是否可以超出系列末尾。
last_points_only (bool) – 是否仅返回每个历史预测的最后一个点。如果设置为 True，则该方法返回单个 TimeSeries（对于 series 中的每个时序），其中包含连续的点预测。否则，返回历史 TimeSeries 预测列表。
metric (Union[Callable[…, Union[float, list[float], ndarray, list[ndarray]]], list[Callable[…, Union[float, list[float], ndarray, list[ndarray]]]]]) – 一个指标函数或指标函数列表。每个指标必须是 Darts 指标（参见此处），或者是一个自定义指标，其签名与 Darts 的指标完全相同，使用装饰器 multi_ts_support() 和 multi_ts_support()，并返回指标得分。
reduction (Optional[Callable[…, float], None]) – 用于组合当 last_points_only 设置为 False 时获得的单个误差分数。当提供多个指标函数时，函数将接收参数 axis = 1 以获得每个指标函数的单个值。如果明确设置为 None，则该方法将返回单个误差分数的列表。默认为 np.mean。
verbose (bool) – 是否打印进度。
show_warnings (bool) – 是否显示与历史预测优化或参数 start 和 train_length 相关的警告。
predict_likelihood_parameters (bool) – 如果设置为 True，则模型预测其 likelihood 的参数而不是目标。仅支持具有似然的概率模型，且 num_samples = 1 和 n<=output_chunk_length。默认为：False。
enable_optimization (bool) – 支持时是否使用优化的 historical_forecasts 版本。默认为：True。
data_transformers (Optional[dict[str, Union[BaseDataTransformer, Pipeline]], None]) –
可选地，要应用于相应序列的 BaseDataTransformer 或 Pipeline 字典（可能的键：“series”、“past_covariates”、“future_covariates”）。如果提供，则所有输入序列必须处于未变换空间。
- 如果 retrain=True，则数据变换器在每个历史预测步骤中重新拟合训练数据。
- 如果 retrain=False，则数据变换器在所有预测之前将序列变换一次。
拟合好的变换器用于训练和预测期间的输入变换。如果变换是可逆的，则预测将进行逆变换。仅当 historical_forecasts=None 时有效。
metric_kwargs (Union[dict[str, Any], list[dict[str, Any]], None]) – 传递给 metric() 的附加参数，例如用于并行化的 ‘n_jobs’，用于减少组件层面指标的 ‘component_reduction’，用于缩放指标的季节性 ‘m’ 等。会将参数分别传递给每个指标，并且仅当它们存在于相应指标签名中时才传递。缩放指标（例如 mase`, rmsse 等）的参数 ‘insample’ 会被忽略，因为它在内部处理。
fit_kwargs (Optional[dict[str, Any], None]) – 可选地，传递给模型 fit() 方法的一些附加参数。
predict_kwargs (Optional[dict[str, Any], None]) – 可选地，传递给模型 predict() 方法的一些附加参数。
sample_weight (Union[TimeSeries, Sequence[TimeSeries], str, None]) – 可选地，应用于训练目标 series 标签的一些样本权重。仅当 retrain 不为 False 时有效。它们应用于每个观测值、每个标签（output_chunk_length 中的每个步骤）以及每个组件。如果是一个序列或序列集合，则使用这些权重。如果权重序列只有一个组件/列，则权重全局应用于 series 中的所有组件。否则，对于特定组件的权重，组件数量必须与 series 的组件数量匹配。如果为字符串，则使用内置的权重函数生成权重。可用选项为 “linear” 或 “exponential” 衰减 - 越远的过去，权重越低。权重按每个时序计算。

返回值类型

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

返回

float – 单个 uni/multivariate series、单个 metric 函数以及使用 last_points_only=True 生成的 historical_forecasts 的单个回测得分。
- 使用 last_points_only=False 生成并使用回测 reduction 的 historical_forecasts
- historical_forecasts 使用 last_points_only=False 并使用回溯测试 reduction 生成
np.ndarray – 一个 numpy 数组，包含回测得分。对于单个 series 和其中一种情况：
- 单个 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 用于“per time step metrics” 的多个 uni/multivariate series。
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)[source]¶

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

参数: 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]]]

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

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

此函数有 3 种操作模式：扩展窗口模式、分割模式和拟合值模式。这三种操作模式通过使用 parameters 字典中提供的每个超参数值组合实例化 ForecastingModel 的 model_class 子类，并根据 metric 函数评估每个组合的性能，从而返回性能最佳的模型。期望 metric 函数返回一个误差值，因此将选择导致最小 metric 输出的模型。

训练数据和测试数据的关系取决于操作模式。

扩展窗口模式（在传递 forecast_horizon 时激活）：对于每个超参数组合，模型在 series 的不同分割上重复训练和评估。此过程通过使用 backtest() 函数作为子程序来完成，该子程序生成从 start 开始的历史预测，并将其与 series 的真实值进行比较。请注意，模型在每次预测时都会重新训练，因此此模式较慢。

分割窗口模式（在传递 val_series 时激活）：当传递 val_series 参数时，将使用此模式。对于每个超参数组合，模型在 series 上训练，并在 val_series 上评估。

拟合值模式（在将 use_fitted_values 设置为 True 时激活）：对于每个超参数组合，模型在 series 上训练，并在生成的拟合值上评估。并非所有模型都有拟合值，如果模型没有 fitted_values 成员，此方法将引发错误。拟合值是模型在 series 上拟合的结果。与拟合值进行比较是评估模型的一种快速方法，但无法看出模型是否过拟合了序列。

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

目前，此方法仅支持确定性预测（即模型预测只有 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 是可调用的且第一个可预测点早于第一个可训练点，则设置为第一个可预测点。
- 如果 retrain 为 True 或 int (给定 train_length)，则为第一个可训练点；或者如果 retrain 是一个 Callable 且第一个可训练点早于第一个可预测点，则为第一个可训练点。
- 否则设置为第一个可训练点（给定 train_length）。
注意：如果 start 不在可训练/可预测点范围内，将忽略该参数（使用 None 时的默认行为），并从第一个可训练/可预测点开始。如果不存在有效的起始点，则引发 ValueError。
注意：如果模型使用偏移输出（output_chunk_shift > 0），则第一个预测点也会

向未来偏移 output_chunk_shift 个点。
注意：如果 start 超出可能的历史预测时间范围，将忽略该参数

（使用 None 时的默认行为），并从第一个可训练/可预测点开始。
是比 start 超出 stride 的一个整数倍的最近有效起始点。
start_format (Literal['position', 'value']) – 仅在扩展窗口模式下使用。定义 start 的格式。仅当 start 是整数且 series 使用 pd.RangeIndex 索引时有效。如果设置为 'position'，start 对应于第一个预测点的索引位置，范围为 (-len(series), len(series) - 1)。如果设置为 'value'，start 对应于第一个预测点的索引值/标签。如果该值不在 series 的索引中，将引发错误。默认值：'value'
last_points_only (bool) – 仅在扩展窗口模式下使用。是使用整个预测还是仅使用每个预测的最后一个点来计算误差。
show_warnings (bool) – 仅在扩展窗口模式下使用。是否显示与 start 参数相关的警告。
val_series (Optional[TimeSeries, None]) – 在分割模式下用于验证的 TimeSeries 实例。如果提供，此时间序列必须紧接在 series 的末尾之后开始；以便可以进行适当的预测比较。
use_fitted_values (bool) – 如果为 True，则使用与拟合值的比较。如果 fitted_values 不是 model_class 的属性，则引发错误。
metric (Callable[[TimeSeries, TimeSeries], float]) –
一个度量函数，它将两个 TimeSeries 之间的误差作为浮点值返回。必须是 Darts 的“按时间聚合”度量之一（参见此处），或者是一个接受两个 TimeSeries 作为输入并返回误差的自定义度量。
reduction (Callable[[ndarray], float]) – 一个归约函数（将数组映射到浮点数），描述如何在回溯测试时聚合在不同验证时间序列上获得的误差。默认情况下，它将计算误差的均值。
verbose – 是否打印进度。
n_jobs (int) – 并行运行的任务数量。只有当有两个或更多参数组合需要评估时，才会创建并行任务。每个任务将实例化、训练和评估模型的不同实例。默认为 1（顺序执行）。将参数设置为 -1 表示使用所有可用核心。
n_random_samples (Union[int, float, None]) – 从完整参数网格中选择的超参数组合的数量/比例。这将执行随机搜索而不是使用完整网格。如果为整数，n_random_samples 是从完整网格中选择的参数组合数量，必须介于 0 和总参数组合数量之间。如果为浮点数，n_random_samples 是从完整网格中选择的参数组合比例，必须介于 0 和 1 之间。默认为 None，此时将忽略随机选择。
data_transformers (Optional[dict[str, Union[BaseDataTransformer, Pipeline]], None]) –
可选地，要应用于相应序列的 BaseDataTransformer 或 Pipeline 字典（可能的键：“series”、“past_covariates”、“future_covariates”）。如果提供，则所有输入序列必须处于未变换空间。
- 如果 retrain=True，则数据变换器在每个历史预测步骤中重新拟合训练数据。
- 如果 retrain=False，则数据变换器在所有预测之前将序列变换一次。
拟合的转换器用于在训练和预测期间转换输入。如果转换是可逆的，则预测结果将被逆转换。
fit_kwargs (Optional[dict[str, Any], None]) – 传递给模型 fit() 方法的额外参数。
predict_kwargs (Optional[dict[str, Any], None]) – 传递给模型 predict() 方法的额外参数。
sample_weight (Union[TimeSeries, str, None]) – 可选的，应用于目标 series 标签的样本权重，用于训练。仅当 retrain 不为 False 时有效。权重应用于每个观测、每个标签（output_chunk_length 中的每一步）和每个分量。如果是一个时间序列，则使用这些权重。如果权重时间序列只有一个分量/列，则权重全局应用于 series 中的所有分量。否则，对于分量特定的权重，分量数量必须与 series 匹配。如果是一个字符串，则使用内置权重函数生成权重。可用选项是 "linear" 或 "exponential" 衰减 - 距离过去越远，权重越低。

返回

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

返回值类型

ForecastingModel, Dict, float

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

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

此方法有两种主要模式

重新训练模式（默认，retrain=True）：在模拟的每一步都重新训练模型，并使用更新后的模型生成预测。对于多个时间序列，模型在每个时间序列上独立重新训练（尚不支持全局训练）。
预训练模式（retrain=False）：在模拟的每一步生成预测，无需重新训练。仅支持预训练的全局预测模型。此模式速度显著加快，因为它跳过了重新训练步骤。

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

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

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

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

参数

series (Union[TimeSeries, Sequence[TimeSeries]]) – 用于依次训练（如果 retrain 不为 False）和计算历史预测的（序列）目标时序。
past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，对于 series 中的每个输入时序，其相应的（序列）过去观测的协变量时序。这仅适用于支持过去协变量的模型。
future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，对于 series 中的每个输入时序，其相应的（序列）未来已知协变量时序。这仅适用于支持未来协变量的模型。
forecast_horizon (int) – 预测的预测范围。
num_samples (int) – 从概率模型中采样预测的次数。仅对概率模型使用 >1 的值。
train_length (Optional[int, None]) – 可选地，对每个构建的训练集（滚动窗口模式）使用固定长度/时间步长数量。仅当 retrain 不为 False 时有效。默认为 None，此时使用直至预测时间的所有时间步长（扩展窗口模式）。如果大于可用时间步长数量，则使用扩展模式。必须至少为 min_train_series_length。
start (Union[Timestamp, float, int, None]) –
可选地，计算预测的第一个时间点。此参数支持：float、int、pandas.Timestamp 和 None。如果为 float，则表示第一个预测点之前的时间序列比例。如果为 int，则对于具有 pd.DatetimeIndex 的 series，它是第一个预测点的索引位置；对于具有 pd.RangeIndex 的 series，它是索引值。后一种情况可以通过 start_format="position" 更改为索引位置。如果为 pandas.Timestamp，则它是第一个预测点的时间戳。如果为 None，则第一个预测点将自动设置为
- 如果 retrain 为 False，或者 retrain 是可调用的且第一个可预测点早于第一个可训练点，则设置为第一个可预测点。
- 如果 retrain 为 True 或 int（给定 train_length），或者 retrain 是可调用的且第一个可训练点早于第一个可预测点，则设置为第一个可训练点。
- 否则设置为第一个可训练点（给定 train_length）。
注意：如果 start 不在可训练/可预测点范围内，将忽略该参数（使用 None 时的默认行为），并从第一个可训练/可预测点开始。如果不存在有效的起始点，则引发 ValueError。
注意：如果模型使用偏移输出（output_chunk_shift > 0），则第一个预测点也会

向未来偏移 output_chunk_shift 个点。
注意：如果 start 超出可能的历史预测时间范围，将忽略该参数

（使用 None 时的默认行为），并从第一个可训练/可预测点开始。
是比 start 超出 stride 的一个整数倍的最近有效起始点。
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 or int): 预测时间的时间戳（训练序列的末尾）
- train_series (TimeSeries): 直至 pred_time 的训练序列
- past_covariates (TimeSeries): 直至 pred_time 的过去协变量序列
- future_covariates (TimeSeries): 直至 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的未来协变量序列
注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则会将 None 传递给相应的 retrain 函数参数。注意：有些模型要求每次都重新训练，不支持除 retrain=True 以外的任何设置。注意：这也控制着 data_transformers 的重新训练。
overlap_end (bool) – 返回的预测是否可以超出系列末尾。
last_points_only (bool) – 是否仅返回每个历史预测的最后一个点。如果设置为 True，则该方法返回单个 TimeSeries（对于 series 中的每个时序），其中包含连续的点预测。否则，返回历史 TimeSeries 预测列表。
verbose (bool) – 是否打印进度。
show_warnings (bool) – 是否显示与历史预测优化或参数 start 和 train_length 相关的警告。
predict_likelihood_parameters (bool) – 如果设置为 True，则模型预测其 likelihood 的参数而不是目标。仅支持具有似然的概率模型，且 num_samples = 1 和 n<=output_chunk_length。默认为：False。
enable_optimization (bool) – 支持时是否使用优化的 historical_forecasts 版本。默认为：True。
data_transformers (Optional[dict[str, Union[BaseDataTransformer, Pipeline]], None]) –
可选地，要应用于相应序列的 BaseDataTransformer 或 Pipeline 字典（可能的键：“series”、“past_covariates”、“future_covariates”）。如果提供，则所有输入序列必须处于未变换空间。
- 如果 retrain=True，则数据变换器在每个历史预测步骤中重新拟合训练数据。
- 如果 retrain=False，则数据变换器在所有预测之前将序列变换一次。
拟合的转换器用于在训练和预测期间转换输入。如果转换是可逆的，则预测结果将被逆转换。
fit_kwargs (Optional[dict[str, Any], None]) – 可选地，传递给模型 fit() 方法的一些附加参数。
predict_kwargs (Optional[dict[str, Any], None]) – 可选地，传递给模型 predict() 方法的一些附加参数。
sample_weight (Union[TimeSeries, Sequence[TimeSeries], str, None]) – 可选地，应用于训练目标 series 标签的一些样本权重。仅当 retrain 不为 False 时有效。它们应用于每个观测值、每个标签（output_chunk_length 中的每个步骤）以及每个组件。如果是一个序列或序列集合，则使用这些权重。如果权重序列只有一个组件/列，则权重全局应用于 series 中的所有组件。否则，对于特定组件的权重，组件数量必须与 series 的组件数量匹配。如果为字符串，则使用内置的权重函数生成权重。可用选项为 “linear” 或 “exponential” 衰减 - 越远的过去，权重越低。权重按每个时序计算。

返回值类型

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

返回

TimeSeries – 单个 series 且 last_points_only=True 时的单个历史预测：它仅包含所有历史预测中步长 forecast_horizon 处的预测值。
List[TimeSeries] – 以下情况的历史预测列表
- 一系列（列表）的 series 且 last_points_only=True：对于每个时间序列，它仅包含所有历史预测中步长 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)[source]¶

预测训练系列结束后的 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 进行配置。
使用历史预测与 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 是可调用的且第一个可预测点早于第一个可训练点，则设置为第一个可预测点。
- 如果 retrain 为 True 或 int（给定 train_length），或者 retrain 是可调用的且第一个可训练点早于第一个可预测点，则设置为第一个可训练点。
- 否则设置为第一个可训练点（给定 train_length）。
注意：如果 start 不在可训练/可预测点范围内，将忽略该参数（使用 None 时的默认行为），并从第一个可训练/可预测点开始。如果不存在有效的起始点，则引发 ValueError。
注意：如果模型使用偏移输出（output_chunk_shift > 0），则第一个预测点也会

向未来偏移 output_chunk_shift 个点。
注意：如果 start 超出可能的历史预测时间范围，将忽略该参数

（使用 None 时的默认行为），并从第一个可训练/可预测点开始。
是比 start 超出 stride 的一个整数倍的最近有效起始点。
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 or int): 预测时间的时间戳（训练序列的末尾）
- train_series (TimeSeries): 直至 pred_time 的训练序列
- past_covariates (TimeSeries): 直至 pred_time 的过去协变量序列
- future_covariates (TimeSeries): 直至 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的未来协变量序列
注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则会将 None 传递给相应的 retrain 函数参数。注意：有些模型要求每次都重新训练，不支持除 retrain=True 以外的任何设置。注意：这也控制着 data_transformers 的重新训练。
overlap_end (bool) – 返回的预测是否可以超出系列末尾。
last_points_only (bool) – 是否仅返回每个历史预测的最后一个点。如果设置为 True，则该方法返回单个 TimeSeries（对于 series 中的每个时序），其中包含连续的点预测。否则，返回历史 TimeSeries 预测列表。
metric (Callable[…, Union[float, list[float], ndarray, list[ndarray]]]) –
Darts 的“按时间步长”度量之一（参见此处），或具有与 Darts 的“按时间步长”度量相同签名的自定义度量，它使用装饰器multi_ts_support() 和multi_ts_support()，并为每个时间步长返回一个值。
verbose (bool) – 是否打印进度。
show_warnings (bool) – 是否显示与历史预测优化或参数 start 和 train_length 相关的警告。
predict_likelihood_parameters (bool) – 如果设置为 True，则模型预测其 likelihood 的参数而不是目标。仅支持具有似然的概率模型，且 num_samples = 1 和 n<=output_chunk_length。默认为：False。
enable_optimization (bool) – 支持时是否使用优化的 historical_forecasts 版本。默认为：True。
data_transformers (Optional[dict[str, Union[BaseDataTransformer, Pipeline]], None]) –
可选地，要应用于相应序列的 BaseDataTransformer 或 Pipeline 字典（可能的键：“series”、“past_covariates”、“future_covariates”）。如果提供，则所有输入序列必须处于未变换空间。
- 如果 retrain=True，则数据变换器在每个历史预测步骤中重新拟合训练数据。
- 如果 retrain=False，则数据变换器在所有预测之前将序列变换一次。
拟合好的变换器用于训练和预测期间的输入变换。如果变换是可逆的，则预测将进行逆变换。仅当 historical_forecasts=None 时有效。
metric_kwargs (Optional[dict[str, Any], None]) – 传递给 metric() 的额外参数，例如用于并行化的 ‘n_jobs’，用于缩放度量的 ‘m’ 等。仅当参数存在于相应的度量签名中时才会传递。忽略归约参数 “series_reduction”, “component_reduction”, “time_reduction”，以及用于缩放度量（例如 mase`、rmsse 等）的参数 ‘insample’，因为它们在内部处理。
fit_kwargs (Optional[dict[str, Any], None]) – 可选地，传递给模型 fit() 方法的一些附加参数。
predict_kwargs (Optional[dict[str, Any], None]) – 可选地，传递给模型 predict() 方法的一些附加参数。
sample_weight (Union[TimeSeries, Sequence[TimeSeries], str, None]) – 可选地，应用于训练目标 series 标签的一些样本权重。仅当 retrain 不为 False 时有效。它们应用于每个观测值、每个标签（output_chunk_length 中的每个步骤）以及每个组件。如果是一个序列或序列集合，则使用这些权重。如果权重序列只有一个组件/列，则权重全局应用于 series 中的所有组件。否则，对于特定组件的权重，组件数量必须与 series 的组件数量匹配。如果为字符串，则使用内置的权重函数生成权重。可用选项为 “linear” 或 “exponential” 衰减 - 越远的过去，权重越低。权重按每个时序计算。
values_only (bool) – 是否将残差作为 np.ndarray 返回。如果为 False，则将残差作为 TimeSeries 返回。

返回值类型

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

返回

TimeSeries – 对于单个 series 且 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

static select_best_model(ts, thetas=None, m=None, normalization=True, n_jobs=1)[source]¶

在所有超参数上执行网格搜索，使用在训练系列 ts 上的拟合值来选择最佳模型。

使用 ‘LocalForecastingModel.gridsearch’，并设置 ‘use_fitted_values=True’ 和 ‘metric=metrics.mae`。

参数

ts (TimeSeries) – 用于测试模型的时间序列。
thetas (Optional[list[int], None]) – 要遍历的 theta 列表。默认为 [1, 2, 3]。
m (Optional[int, None]) – 可选地，用于分解时间序列的季节。
normalization (bool) – 如果为 True，则对数据进行归一化处理，使其均值为 1。默认为 True。
n_jobs (int) – 并行运行的任务数量。只有当有两个或更多 theta 值需要评估时，才会创建并行任务。每个任务将实例化、训练和评估模型的不同实例。默认为 1（顺序执行）。将参数设置为 -1 表示使用所有可用核心。

返回

在时间序列上表现最佳的模型。

返回值类型

FourTheta

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

class darts.models.forecasting.theta.Theta(theta=2, seasonality_period=None, season_mode=SeasonalityMode.MULTIPLICATIVE)[source]¶

基类: LocalForecastingModel

Theta 方法的实现，带有可配置的 theta 参数。参见[1]。

训练时序根据 seasonality_period 或推断的季节性周期进行去季节化处理。

season_mode 必须是 SeasonalityMode 枚举成员。

您可以使用 from darts.utils.utils import SeasonalityMode 访问该枚举。

参数

theta (int) – theta 参数的值。默认为 2。不能设置为 0。如果 theta = 1，则 theta 方法限制为简单指数平滑 (SES)
seasonality_period (Optional[int, None]) – 用户定义的季节性周期。如果未设置，则在调用fit() 时会尝试从训练时间序列中推断。
season_mode (SeasonalityMode) – 季节性类型。可以是 SeasonalityMode.MULTIPLICATIVE、SeasonalityMode.ADDITIVE 或 SeasonalityMode.NONE。默认为 SeasonalityMode.MULTIPLICATIVE。

参考文献

1: 揭示 Theta 方法 https://robjhyndman.com/papers/Theta.pdf

示例

>>> from darts.datasets import AirPassengersDataset
>>> from darts.models import Theta
>>> series = AirPassengersDataset().load()
>>> # using the canonical Theta method
>>> model = Theta(theta=2)
>>> model.fit(series)
>>> pred = model.predict(6)
>>> pred.values()
array([[442.7256909 ],
       [433.74381763],
       [494.54534585],
       [480.36937856],
       [481.06675142],
       [545.80068173]])

属性

`considers_static_covariates`	模型是否考虑静态协变量（如果存在）。
`extreme_lags`	一个 8 元组，按顺序包含：(最小目标滞后，最大目标滞后，最小过去协变量滞后，最大过去协变量滞后，最小未来协变量滞后，最大未来协变量滞后，输出偏移，最大目标训练滞后（仅适用于 RNNModel）)。
`likelihood`	返回模型用于概率预测的似然（如果存在）。
`min_train_samples`	训练模型的最小样本数。
`output_chunk_length`	模型一次预测的时间步长数量，对于统计模型未定义。
`output_chunk_shift`	输出/预测开始于输入结束之后的时间步长数量。
`supports_future_covariates`	模型是否支持未来协变量
`supports_likelihood_parameter_prediction`	模型实例是否支持直接预测似然参数
`supports_multivariate`	模型是否考虑时序中的多个变量。
`supports_optimized_historical_forecasts`	模型是否支持优化的历史预测
`supports_past_covariates`	模型是否支持过去协变量
`supports_probabilistic_prediction`	检查具有此配置的预测模型是否支持概率预测。
`supports_sample_weight`	模型是否支持训练时的样本权重。
`supports_static_covariates`	模型是否支持静态协变量
`supports_transferable_series_prediction`	模型是否支持对任意输入 series 进行预测。
`uses_future_covariates`	模型拟合后是否使用未来协变量。
`uses_past_covariates`	模型拟合后是否使用过去协变量。
`uses_static_covariates`	模型拟合后是否使用静态协变量。

model_params

方法

`backtest`(series[, past_covariates, ...])	计算模型对提供的（可能多个）series 的历史预测产生的误差值。
`fit`(series)	在提供的序列上拟合/训练模型。
`generate_fit_encodings`(series[, ...])	生成用于拟合模型的协变量编码，并返回一个元组，其中包含过去和未来协变量序列，以及原始和编码后的协变量堆叠在一起。
`generate_fit_predict_encodings`(n, series[, ...])	生成用于训练和推理/预测的协变量编码，并返回一个元组，其中包含过去和未来协变量序列，以及原始和编码后的协变量堆叠在一起。
`generate_predict_encodings`(n, series[, ...])	生成用于推理/预测集的协变量编码，并返回一个元组，其中包含过去和未来协变量序列，以及原始和编码后的协变量堆叠在一起。
`gridsearch`(parameters, series[, ...])	使用网格搜索查找给定集合中的最佳超参数。
`historical_forecasts`(series[, ...])	通过模拟在提供的（可能多个）series 的整个历史中的各个时间点进行预测来生成历史预测。
`load`(path)	从给定路径或文件句柄加载模型。
`predict`(n[, num_samples, verbose, show_warnings])	预测训练系列结束后的 n 个时间步长内的值。
`residuals`(series[, past_covariates, ...])	计算模型对提供的（可能多个）series 进行历史预测产生的残差。
`save`([path, clean])	将模型保存到给定路径或文件句柄下。
`untrained_model`()	返回使用相同参数创建的新（未训练）模型实例。

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

可以使用 metric_kwargs 进一步自定义指标（例如，控制在组件、时间步长、多个序列上的聚合，以及分位数指标所需的其他参数，例如 q 等）。

参数

series (Union[TimeSeries, Sequence[TimeSeries]]) – 用于依次训练（如果 retrain 不为 False）和计算历史预测的（序列）目标时序。
past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，对于 series 中的每个输入时序，其相应的（序列）过去观测的协变量时序。这仅适用于支持过去协变量的模型。
future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，对于 series 中的每个输入时序，其相应的（序列）未来已知协变量时序。这仅适用于支持未来协变量的模型。
historical_forecasts (Union[TimeSeries, Sequence[TimeSeries], Sequence[Sequence[TimeSeries]], None]) – 可选地，要评估的（或序列/序列的序列）历史预测时序。对应于 historical_forecasts() 的输出。必须传递用于生成历史预测的相同 series 和 last_points_only 值。如果提供了此参数，将跳过历史预测，并忽略除 series、last_points_only、metric 和 reduction 之外的所有参数。
forecast_horizon (int) – 预测的预测范围。
num_samples (int) – 从概率模型中采样预测的次数。仅对概率模型使用 >1 的值。
train_length (Optional[int, None]) – 可选地，对每个构建的训练集（滚动窗口模式）使用固定长度/时间步长数量。仅当 retrain 不为 False 时有效。默认为 None，此时使用直至预测时间的所有时间步长（扩展窗口模式）。如果大于可用时间步长数量，则使用扩展模式。必须至少为 min_train_series_length。
start (Union[Timestamp, float, int, None]) –
可选地，计算预测的第一个时间点。此参数支持：float、int、pandas.Timestamp 和 None。如果为 float，则表示第一个预测点之前的时间序列比例。如果为 int，则对于具有 pd.DatetimeIndex 的 series，它是第一个预测点的索引位置；对于具有 pd.RangeIndex 的 series，它是索引值。后一种情况可以通过 start_format="position" 更改为索引位置。如果为 pandas.Timestamp，则它是第一个预测点的时间戳。如果为 None，则第一个预测点将自动设置为
- 如果 retrain 为 False，或者 retrain 是可调用的且第一个可预测点早于第一个可训练点，则设置为第一个可预测点。
- 如果 retrain 为 True 或 int（给定 train_length），或者 retrain 是可调用的且第一个可训练点早于第一个可预测点，则设置为第一个可训练点。
- 否则设置为第一个可训练点（给定 train_length）。
注意：如果 start 不在可训练/可预测点范围内，将忽略该参数（使用 None 时的默认行为），并从第一个可训练/可预测点开始。如果不存在有效的起始点，则引发 ValueError。
注意：如果模型使用偏移输出（output_chunk_shift > 0），则第一个预测点也会

向未来偏移 output_chunk_shift 个点。
注意：如果 start 超出可能的历史预测时间范围，将忽略该参数

（使用 None 时的默认行为），并从第一个可训练/可预测点开始。
是比 start 超出 stride 的一个整数倍的最近有效起始点。
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 or int): 预测时间的时间戳（训练序列的末尾）
- train_series (TimeSeries): 直至 pred_time 的训练序列
- past_covariates (TimeSeries): 直至 pred_time 的过去协变量序列
- future_covariates (TimeSeries): 直至 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的未来协变量序列
注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则会将 None 传递给相应的 retrain 函数参数。注意：有些模型要求每次都重新训练，不支持除 retrain=True 以外的任何设置。注意：这也控制着 data_transformers 的重新训练。
overlap_end (bool) – 返回的预测是否可以超出系列末尾。
last_points_only (bool) – 是否仅返回每个历史预测的最后一个点。如果设置为 True，则该方法返回单个 TimeSeries（对于 series 中的每个时序），其中包含连续的点预测。否则，返回历史 TimeSeries 预测列表。
metric (Union[Callable[…, Union[float, list[float], ndarray, list[ndarray]]], list[Callable[…, Union[float, list[float], ndarray, list[ndarray]]]]]) –
一个度量函数或度量函数列表。每个度量必须是 Darts 度量之一（参见此处），或具有与 Darts 度量相同签名的自定义度量，它使用装饰器multi_ts_support() 和multi_ts_support()，并返回度量分数。
reduction (Optional[Callable[…, float], None]) – 用于组合当 last_points_only 设置为 False 时获得的单个误差分数。当提供多个指标函数时，函数将接收参数 axis = 1 以获得每个指标函数的单个值。如果明确设置为 None，则该方法将返回单个误差分数的列表。默认为 np.mean。
verbose (bool) – 是否打印进度。
show_warnings (bool) – 是否显示与历史预测优化或参数 start 和 train_length 相关的警告。
predict_likelihood_parameters (bool) – 如果设置为 True，则模型预测其 likelihood 的参数而不是目标。仅支持具有似然的概率模型，且 num_samples = 1 和 n<=output_chunk_length。默认为：False。
enable_optimization (bool) – 支持时是否使用优化的 historical_forecasts 版本。默认为：True。
data_transformers (Optional[dict[str, Union[BaseDataTransformer, Pipeline]], None]) –
可选地，要应用于相应序列的 BaseDataTransformer 或 Pipeline 字典（可能的键：“series”、“past_covariates”、“future_covariates”）。如果提供，则所有输入序列必须处于未变换空间。
- 如果 retrain=True，则数据变换器在每个历史预测步骤中重新拟合训练数据。
- 如果 retrain=False，则数据变换器在所有预测之前将序列变换一次。
拟合好的变换器用于训练和预测期间的输入变换。如果变换是可逆的，则预测将进行逆变换。仅当 historical_forecasts=None 时有效。
metric_kwargs (Union[dict[str, Any], list[dict[str, Any]], None]) – 传递给 metric() 的附加参数，例如用于并行化的 ‘n_jobs’，用于减少组件层面指标的 ‘component_reduction’，用于缩放指标的季节性 ‘m’ 等。会将参数分别传递给每个指标，并且仅当它们存在于相应指标签名中时才传递。缩放指标（例如 mase`, rmsse 等）的参数 ‘insample’ 会被忽略，因为它在内部处理。
fit_kwargs (Optional[dict[str, Any], None]) – 可选地，传递给模型 fit() 方法的一些附加参数。
predict_kwargs (Optional[dict[str, Any], None]) – 可选地，传递给模型 predict() 方法的一些附加参数。
sample_weight (Union[TimeSeries, Sequence[TimeSeries], str, None]) – 可选地，应用于训练目标 series 标签的一些样本权重。仅当 retrain 不为 False 时有效。它们应用于每个观测值、每个标签（output_chunk_length 中的每个步骤）以及每个组件。如果是一个序列或序列集合，则使用这些权重。如果权重序列只有一个组件/列，则权重全局应用于 series 中的所有组件。否则，对于特定组件的权重，组件数量必须与 series 的组件数量匹配。如果为字符串，则使用内置的权重函数生成权重。可用选项为 “linear” 或 “exponential” 衰减 - 越远的过去，权重越低。权重按每个时序计算。

返回值类型

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

返回

float – 单个 uni/multivariate series、单个 metric 函数以及使用 last_points_only=True 生成的 historical_forecasts 的单个回测得分。
- 使用 last_points_only=False 生成并使用回测 reduction 的 historical_forecasts
- historical_forecasts 使用 last_points_only=False 并使用回溯测试 reduction 生成
np.ndarray – 一个 numpy 数组，包含回测得分。对于单个 series 和其中一种情况：
- 单个 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 用于“per time step metrics” 的多个 uni/multivariate series。
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]]¶

参见下面的示例。

如果模型未拟合

目标（仅限 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)[source]¶

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

参数: series (TimeSeries) – 目标时间序列。模型将训练以预测此时间序列。
返回: 已拟合模型。
返回值类型: self

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

参数

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)¶

参数

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)¶

参数

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)¶

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

训练数据和测试数据的关系取决于操作模式。

扩展窗口模式（当传递 forecast_horizon 时激活）：对于每个超参数组合，模型会重复地在 series 的不同分割上进行训练和评估。这个过程通过使用backtest() 函数作为子程序来实现，该子程序从 start 开始生成历史预测，并与 series 的真实值进行比较。请注意，模型会为每一个预测重新训练，因此此模式速度较慢。

目前，此方法仅支持确定性预测（即模型预测只有 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 是可调用的且第一个可预测点早于第一个可训练点，则设置为第一个可预测点。
- 如果 retrain 为 True 或 int (给定 train_length)，则为第一个可训练点；或者如果 retrain 是一个 Callable 且第一个可训练点早于第一个可预测点，则为第一个可训练点。
- 否则设置为第一个可训练点（给定 train_length）。
注意：如果 start 不在可训练/可预测点范围内，将忽略该参数（使用 None 时的默认行为），并从第一个可训练/可预测点开始。如果不存在有效的起始点，则引发 ValueError。
注意：如果模型使用偏移输出（output_chunk_shift > 0），则第一个预测点也会

向未来偏移 output_chunk_shift 个点。
注意：如果 start 超出可能的历史预测时间范围，将忽略该参数

（使用 None 时的默认行为），并从第一个可训练/可预测点开始。
是比 start 超出 stride 的一个整数倍的最近有效起始点。
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

此方法有两种主要模式

重新训练模式（默认，retrain=True）：在模拟的每一步都重新训练模型，并使用更新后的模型生成预测。对于多个时间序列，模型在每个时间序列上独立重新训练（尚不支持全局训练）。
预训练模式（retrain=False）：在模拟的每一步生成预测，无需重新训练。仅支持预训练的全局预测模型。此模式速度显著加快，因为它跳过了重新训练步骤。

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

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

参数

series (Union[TimeSeries, Sequence[TimeSeries]]) – 用于依次训练（如果 retrain 不为 False）和计算历史预测的（序列）目标时序。
past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，对于 series 中的每个输入时序，其相应的（序列）过去观测的协变量时序。这仅适用于支持过去协变量的模型。
future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地，对于 series 中的每个输入时序，其相应的（序列）未来已知协变量时序。这仅适用于支持未来协变量的模型。
forecast_horizon (int) – 预测的预测范围。
num_samples (int) – 从概率模型中采样预测的次数。仅对概率模型使用 >1 的值。
train_length (Optional[int, None]) – 可选地，对每个构建的训练集（滚动窗口模式）使用固定长度/时间步长数量。仅当 retrain 不为 False 时有效。默认为 None，此时使用直至预测时间的所有时间步长（扩展窗口模式）。如果大于可用时间步长数量，则使用扩展模式。必须至少为 min_train_series_length。
start (Union[Timestamp, float, int, None]) –
可选地，计算预测的第一个时间点。此参数支持：float、int、pandas.Timestamp 和 None。如果为 float，则表示第一个预测点之前的时间序列比例。如果为 int，则对于具有 pd.DatetimeIndex 的 series，它是第一个预测点的索引位置；对于具有 pd.RangeIndex 的 series，它是索引值。后一种情况可以通过 start_format="position" 更改为索引位置。如果为 pandas.Timestamp，则它是第一个预测点的时间戳。如果为 None，则第一个预测点将自动设置为
- 如果 retrain 为 False，或者 retrain 是可调用的且第一个可预测点早于第一个可训练点，则设置为第一个可预测点。
- 如果 retrain 为 True 或 int（给定 train_length），或者 retrain 是可调用的且第一个可训练点早于第一个可预测点，则设置为第一个可训练点。
- 否则设置为第一个可训练点（给定 train_length）。
注意：如果 start 不在可训练/可预测点范围内，将忽略该参数（使用 None 时的默认行为），并从第一个可训练/可预测点开始。如果不存在有效的起始点，则引发 ValueError。
注意：如果模型使用偏移输出（output_chunk_shift > 0），则第一个预测点也会

向未来偏移 output_chunk_shift 个点。
注意：如果 start 超出可能的历史预测时间范围，将忽略该参数

（使用 None 时的默认行为），并从第一个可训练/可预测点开始。
是比 start 超出 stride 的一个整数倍的最近有效起始点。
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 or int): 预测时间的时间戳（训练序列的末尾）
- train_series (TimeSeries): 直至 pred_time 的训练序列
- past_covariates (TimeSeries): 直至 pred_time 的过去协变量序列
- future_covariates (TimeSeries): 直至 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的未来协变量序列
注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则会将 None 传递给相应的 retrain 函数参数。注意：有些模型要求每次都重新训练，不支持除 retrain=True 以外的任何设置。注意：这也控制着 data_transformers 的重新训练。
overlap_end (bool) – 返回的预测是否可以超出系列末尾。
last_points_only (bool) – 是否仅返回每个历史预测的最后一个点。如果设置为 True，则该方法返回单个 TimeSeries（对于 series 中的每个时序），其中包含连续的点预测。否则，返回历史 TimeSeries 预测列表。
verbose (bool) – 是否打印进度。
show_warnings (bool) – 是否显示与历史预测优化或参数 start 和 train_length 相关的警告。
predict_likelihood_parameters (bool) – 如果设置为 True，则模型预测其 likelihood 的参数而不是目标。仅支持具有似然的概率模型，且 num_samples = 1 和 n<=output_chunk_length。默认为：False。
enable_optimization (bool) – 支持时是否使用优化的 historical_forecasts 版本。默认为：True。
data_transformers (Optional[dict[str, Union[BaseDataTransformer, Pipeline]], None]) –
可选地，要应用于相应序列的 BaseDataTransformer 或 Pipeline 字典（可能的键：“series”、“past_covariates”、“future_covariates”）。如果提供，则所有输入序列必须处于未变换空间。
- 如果 retrain=True，则数据变换器在每个历史预测步骤中重新拟合训练数据。
- 如果 retrain=False，则数据变换器在所有预测之前将序列变换一次。
拟合的转换器用于在训练和预测期间转换输入。如果转换是可逆的，则预测结果将被逆转换。
fit_kwargs (Optional[dict[str, Any], None]) – 可选地，传递给模型 fit() 方法的一些附加参数。
predict_kwargs (Optional[dict[str, Any], None]) – 可选地，传递给模型 predict() 方法的一些附加参数。
sample_weight (Union[TimeSeries, Sequence[TimeSeries], str, None]) – 可选地，应用于训练目标 series 标签的一些样本权重。仅当 retrain 不为 False 时有效。它们应用于每个观测值、每个标签（output_chunk_length 中的每个步骤）以及每个组件。如果是一个序列或序列集合，则使用这些权重。如果权重序列只有一个组件/列，则权重全局应用于 series 中的所有组件。否则，对于特定组件的权重，组件数量必须与 series 的组件数量匹配。如果为字符串，则使用内置的权重函数生成权重。可用选项为 “linear” 或 “exponential” 衰减 - 越远的过去，权重越低。权重按每个时序计算。

返回值类型

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

返回

TimeSeries – 单个 series 且 last_points_only=True 时的单个历史预测：它仅包含所有历史预测中步长 forecast_horizon 处的预测值。
List[TimeSeries] – 以下情况的历史预测列表
- 一系列（列表）的 series 且 last_points_only=True：对于每个时间序列，它仅包含所有历史预测中步长 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)[source]¶

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

参数

n (int) – 预测范围 - 系列结束后的时间步数，用于生成预测。
num_samples (int) – 从概率模型中采样预测的次数。对于确定性模型，必须为 1。
verbose (bool) – 可选地，设置预测的详细程度。并非对所有模型都有效。
show_warnings (bool) – 可选地，控制是否显示警告。并非对所有模型都有效。

返回

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

返回值类型

TimeSeries

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

此方法按顺序执行

使用预先计算的 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 是可调用的且第一个可预测点早于第一个可训练点，则设置为第一个可预测点。
- 如果 retrain 为 True 或 int（给定 train_length），或者 retrain 是可调用的且第一个可训练点早于第一个可预测点，则设置为第一个可训练点。
- 否则设置为第一个可训练点（给定 train_length）。
注意：如果 start 不在可训练/可预测点范围内，将忽略该参数（使用 None 时的默认行为），并从第一个可训练/可预测点开始。如果不存在有效的起始点，则引发 ValueError。
注意：如果模型使用偏移输出（output_chunk_shift > 0），则第一个预测点也会

向未来偏移 output_chunk_shift 个点。
注意：如果 start 超出可能的历史预测时间范围，将忽略该参数

（使用 None 时的默认行为），并从第一个可训练/可预测点开始。
是比 start 超出 stride 的一个整数倍的最近有效起始点。
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 or int): 预测时间的时间戳（训练序列的末尾）
- train_series (TimeSeries): 直至 pred_time 的训练序列
- past_covariates (TimeSeries): 直至 pred_time 的过去协变量序列
- future_covariates (TimeSeries): 直至 min(pred_time + series.freq * forecast_horizon, series.end_time()) 的未来协变量序列
注意：如果任何可选的 *_covariates 未传递给 historical_forecast，则会将 None 传递给相应的 retrain 函数参数。注意：有些模型要求每次都重新训练，不支持除 retrain=True 以外的任何设置。注意：这也控制着 data_transformers 的重新训练。
overlap_end (bool) – 返回的预测是否可以超出系列末尾。
last_points_only (bool) – 是否仅返回每个历史预测的最后一个点。如果设置为 True，则该方法返回单个 TimeSeries（对于 series 中的每个时序），其中包含连续的点预测。否则，返回历史 TimeSeries 预测列表。
metric (Callable[…, Union[float, list[float], ndarray, list[ndarray]]]) –
Darts 的“按时间步长”度量之一（参见此处），或具有与 Darts 的“按时间步长”度量相同签名的自定义度量，它使用装饰器multi_ts_support() 和multi_ts_support()，并为每个时间步长返回一个值。
verbose (bool) – 是否打印进度。
show_warnings (bool) – 是否显示与历史预测优化或参数 start 和 train_length 相关的警告。
predict_likelihood_parameters (bool) – 如果设置为 True，则模型预测其 likelihood 的参数而不是目标。仅支持具有似然的概率模型，且 num_samples = 1 和 n<=output_chunk_length。默认为：False。
enable_optimization (bool) – 支持时是否使用优化的 historical_forecasts 版本。默认为：True。
data_transformers (Optional[dict[str, Union[BaseDataTransformer, Pipeline]], None]) –
可选地，要应用于相应序列的 BaseDataTransformer 或 Pipeline 字典（可能的键：“series”、“past_covariates”、“future_covariates”）。如果提供，则所有输入序列必须处于未变换空间。
- 如果 retrain=True，则数据变换器在每个历史预测步骤中重新拟合训练数据。
- 如果 retrain=False，则数据变换器在所有预测之前将序列变换一次。
拟合好的变换器用于训练和预测期间的输入变换。如果变换是可逆的，则预测将进行逆变换。仅当 historical_forecasts=None 时有效。
metric_kwargs (Optional[dict[str, Any], None]) – 传递给 metric() 的额外参数，例如用于并行化的 ‘n_jobs’，用于缩放度量的 ‘m’ 等。仅当参数存在于相应的度量签名中时才会传递。忽略归约参数 “series_reduction”, “component_reduction”, “time_reduction”，以及用于缩放度量（例如 mase`、rmsse 等）的参数 ‘insample’，因为它们在内部处理。
fit_kwargs (Optional[dict[str, Any], None]) – 可选地，传递给模型 fit() 方法的一些附加参数。
predict_kwargs (Optional[dict[str, Any], None]) – 可选地，传递给模型 predict() 方法的一些附加参数。
sample_weight (Union[TimeSeries, Sequence[TimeSeries], str, None]) – 可选地，应用于训练目标 series 标签的一些样本权重。仅当 retrain 不为 False 时有效。它们应用于每个观测值、每个标签（output_chunk_length 中的每个步骤）以及每个组件。如果是一个序列或序列集合，则使用这些权重。如果权重序列只有一个组件/列，则权重全局应用于 series 中的所有组件。否则，对于特定组件的权重，组件数量必须与 series 的组件数量匹配。如果为字符串，则使用内置的权重函数生成权重。可用选项为 “linear” 或 “exponential” 衰减 - 越远的过去，权重越低。权重按每个时序计算。
values_only (bool) – 是否将残差作为 np.ndarray 返回。如果为 False，则将残差作为 TimeSeries 返回。

返回值类型

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

返回

TimeSeries – 对于单个 series 且 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

<无标题>

时间序列密集编码器 (TiDE)