autogluon.timeseries 1.0.1b20240304__py3-none-any.whl → 1.4.1b20251210__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of autogluon.timeseries might be problematic. Click here for more details.

Files changed (108) hide show
  1. autogluon/timeseries/configs/__init__.py +3 -2
  2. autogluon/timeseries/configs/hyperparameter_presets.py +62 -0
  3. autogluon/timeseries/configs/predictor_presets.py +84 -0
  4. autogluon/timeseries/dataset/ts_dataframe.py +339 -186
  5. autogluon/timeseries/learner.py +192 -60
  6. autogluon/timeseries/metrics/__init__.py +55 -11
  7. autogluon/timeseries/metrics/abstract.py +96 -25
  8. autogluon/timeseries/metrics/point.py +186 -39
  9. autogluon/timeseries/metrics/quantile.py +47 -20
  10. autogluon/timeseries/metrics/utils.py +6 -6
  11. autogluon/timeseries/models/__init__.py +13 -7
  12. autogluon/timeseries/models/abstract/__init__.py +2 -2
  13. autogluon/timeseries/models/abstract/abstract_timeseries_model.py +533 -273
  14. autogluon/timeseries/models/abstract/model_trial.py +10 -10
  15. autogluon/timeseries/models/abstract/tunable.py +189 -0
  16. autogluon/timeseries/models/autogluon_tabular/__init__.py +2 -0
  17. autogluon/timeseries/models/autogluon_tabular/mlforecast.py +369 -215
  18. autogluon/timeseries/models/autogluon_tabular/per_step.py +513 -0
  19. autogluon/timeseries/models/autogluon_tabular/transforms.py +67 -0
  20. autogluon/timeseries/models/autogluon_tabular/utils.py +3 -51
  21. autogluon/timeseries/models/chronos/__init__.py +4 -0
  22. autogluon/timeseries/models/chronos/chronos2.py +361 -0
  23. autogluon/timeseries/models/chronos/model.py +738 -0
  24. autogluon/timeseries/models/chronos/utils.py +369 -0
  25. autogluon/timeseries/models/ensemble/__init__.py +35 -2
  26. autogluon/timeseries/models/ensemble/{abstract_timeseries_ensemble.py → abstract.py} +50 -26
  27. autogluon/timeseries/models/ensemble/array_based/__init__.py +3 -0
  28. autogluon/timeseries/models/ensemble/array_based/abstract.py +236 -0
  29. autogluon/timeseries/models/ensemble/array_based/models.py +73 -0
  30. autogluon/timeseries/models/ensemble/array_based/regressor/__init__.py +12 -0
  31. autogluon/timeseries/models/ensemble/array_based/regressor/abstract.py +88 -0
  32. autogluon/timeseries/models/ensemble/array_based/regressor/linear_stacker.py +167 -0
  33. autogluon/timeseries/models/ensemble/array_based/regressor/per_quantile_tabular.py +94 -0
  34. autogluon/timeseries/models/ensemble/array_based/regressor/tabular.py +107 -0
  35. autogluon/timeseries/models/ensemble/ensemble_selection.py +167 -0
  36. autogluon/timeseries/models/ensemble/per_item_greedy.py +162 -0
  37. autogluon/timeseries/models/ensemble/weighted/__init__.py +8 -0
  38. autogluon/timeseries/models/ensemble/weighted/abstract.py +40 -0
  39. autogluon/timeseries/models/ensemble/weighted/basic.py +78 -0
  40. autogluon/timeseries/models/ensemble/weighted/greedy.py +57 -0
  41. autogluon/timeseries/models/gluonts/__init__.py +3 -1
  42. autogluon/timeseries/models/gluonts/abstract.py +583 -0
  43. autogluon/timeseries/models/gluonts/dataset.py +109 -0
  44. autogluon/timeseries/models/gluonts/{torch/models.py → models.py} +185 -44
  45. autogluon/timeseries/models/local/__init__.py +1 -10
  46. autogluon/timeseries/models/local/abstract_local_model.py +150 -97
  47. autogluon/timeseries/models/local/naive.py +31 -23
  48. autogluon/timeseries/models/local/npts.py +6 -2
  49. autogluon/timeseries/models/local/statsforecast.py +99 -112
  50. autogluon/timeseries/models/multi_window/multi_window_model.py +99 -40
  51. autogluon/timeseries/models/registry.py +64 -0
  52. autogluon/timeseries/models/toto/__init__.py +3 -0
  53. autogluon/timeseries/models/toto/_internal/__init__.py +9 -0
  54. autogluon/timeseries/models/toto/_internal/backbone/__init__.py +3 -0
  55. autogluon/timeseries/models/toto/_internal/backbone/attention.py +196 -0
  56. autogluon/timeseries/models/toto/_internal/backbone/backbone.py +262 -0
  57. autogluon/timeseries/models/toto/_internal/backbone/distribution.py +70 -0
  58. autogluon/timeseries/models/toto/_internal/backbone/kvcache.py +136 -0
  59. autogluon/timeseries/models/toto/_internal/backbone/rope.py +89 -0
  60. autogluon/timeseries/models/toto/_internal/backbone/rotary_embedding_torch.py +342 -0
  61. autogluon/timeseries/models/toto/_internal/backbone/scaler.py +305 -0
  62. autogluon/timeseries/models/toto/_internal/backbone/transformer.py +333 -0
  63. autogluon/timeseries/models/toto/_internal/dataset.py +165 -0
  64. autogluon/timeseries/models/toto/_internal/forecaster.py +423 -0
  65. autogluon/timeseries/models/toto/dataloader.py +108 -0
  66. autogluon/timeseries/models/toto/hf_pretrained_model.py +118 -0
  67. autogluon/timeseries/models/toto/model.py +236 -0
  68. autogluon/timeseries/predictor.py +826 -305
  69. autogluon/timeseries/regressor.py +253 -0
  70. autogluon/timeseries/splitter.py +10 -31
  71. autogluon/timeseries/trainer/__init__.py +2 -3
  72. autogluon/timeseries/trainer/ensemble_composer.py +439 -0
  73. autogluon/timeseries/trainer/model_set_builder.py +256 -0
  74. autogluon/timeseries/trainer/prediction_cache.py +149 -0
  75. autogluon/timeseries/trainer/trainer.py +1298 -0
  76. autogluon/timeseries/trainer/utils.py +17 -0
  77. autogluon/timeseries/transforms/__init__.py +2 -0
  78. autogluon/timeseries/transforms/covariate_scaler.py +164 -0
  79. autogluon/timeseries/transforms/target_scaler.py +149 -0
  80. autogluon/timeseries/utils/constants.py +10 -0
  81. autogluon/timeseries/utils/datetime/base.py +38 -20
  82. autogluon/timeseries/utils/datetime/lags.py +18 -16
  83. autogluon/timeseries/utils/datetime/seasonality.py +14 -14
  84. autogluon/timeseries/utils/datetime/time_features.py +17 -14
  85. autogluon/timeseries/utils/features.py +317 -53
  86. autogluon/timeseries/utils/forecast.py +31 -17
  87. autogluon/timeseries/utils/timer.py +173 -0
  88. autogluon/timeseries/utils/warning_filters.py +44 -6
  89. autogluon/timeseries/version.py +2 -1
  90. autogluon.timeseries-1.4.1b20251210-py3.11-nspkg.pth +1 -0
  91. {autogluon.timeseries-1.0.1b20240304.dist-info → autogluon_timeseries-1.4.1b20251210.dist-info}/METADATA +71 -47
  92. autogluon_timeseries-1.4.1b20251210.dist-info/RECORD +103 -0
  93. {autogluon.timeseries-1.0.1b20240304.dist-info → autogluon_timeseries-1.4.1b20251210.dist-info}/WHEEL +1 -1
  94. autogluon/timeseries/configs/presets_configs.py +0 -11
  95. autogluon/timeseries/evaluator.py +0 -6
  96. autogluon/timeseries/models/ensemble/greedy_ensemble.py +0 -170
  97. autogluon/timeseries/models/gluonts/abstract_gluonts.py +0 -550
  98. autogluon/timeseries/models/gluonts/torch/__init__.py +0 -0
  99. autogluon/timeseries/models/presets.py +0 -325
  100. autogluon/timeseries/trainer/abstract_trainer.py +0 -1144
  101. autogluon/timeseries/trainer/auto_trainer.py +0 -74
  102. autogluon.timeseries-1.0.1b20240304-py3.8-nspkg.pth +0 -1
  103. autogluon.timeseries-1.0.1b20240304.dist-info/RECORD +0 -58
  104. {autogluon.timeseries-1.0.1b20240304.dist-info → autogluon_timeseries-1.4.1b20251210.dist-info/licenses}/LICENSE +0 -0
  105. {autogluon.timeseries-1.0.1b20240304.dist-info → autogluon_timeseries-1.4.1b20251210.dist-info/licenses}/NOTICE +0 -0
  106. {autogluon.timeseries-1.0.1b20240304.dist-info → autogluon_timeseries-1.4.1b20251210.dist-info}/namespace_packages.txt +0 -0
  107. {autogluon.timeseries-1.0.1b20240304.dist-info → autogluon_timeseries-1.4.1b20251210.dist-info}/top_level.txt +0 -0
  108. {autogluon.timeseries-1.0.1b20240304.dist-info → autogluon_timeseries-1.4.1b20251210.dist-info}/zip-safe +0 -0
@@ -0,0 +1,439 @@
1
+ import logging
2
+ import os
3
+ import time
4
+ import traceback
5
+ from pathlib import Path
6
+ from typing import Any, Iterator
7
+
8
+ import networkx as nx
9
+ import numpy as np
10
+ from typing_extensions import Self
11
+
12
+ from autogluon.timeseries import TimeSeriesDataFrame
13
+ from autogluon.timeseries.metrics import TimeSeriesScorer
14
+ from autogluon.timeseries.models.ensemble import (
15
+ AbstractTimeSeriesEnsembleModel,
16
+ PerformanceWeightedEnsemble,
17
+ get_ensemble_class,
18
+ )
19
+ from autogluon.timeseries.utils.timer import SplitTimer
20
+ from autogluon.timeseries.utils.warning_filters import warning_filter
21
+
22
+ from .utils import log_scores_and_times
23
+
24
+ logger = logging.getLogger("autogluon.timeseries.trainer")
25
+
26
+
27
+ class EnsembleComposer:
28
+ """Helper class for TimeSeriesTrainer to build multi-layer stack ensembles.
29
+
30
+ This class depends on the trainer to provide the necessary initialization parameters, training
31
+ and validation data, as well as having fit the base (non-ensemble) models and persisted their
32
+ out-of-fold predictions which will be used for ensemble training.
33
+
34
+ Parameters
35
+ ----------
36
+ path
37
+ Path of the calling TimeSeriesTrainer. EnsembleComposer finds the model objects and their
38
+ out-of-fold prediction artifacts with respect to this path. EnsembleComposer only saves
39
+ ensemble models and their out-of-fold predictions to this folder (i.e., does not pickle
40
+ itself).
41
+ prediction_length
42
+ Number of time steps to forecast.
43
+ eval_metric
44
+ Metric used to evaluate ensemble performance.
45
+ target
46
+ Name of the target column in the time series data.
47
+ num_windows_per_layer
48
+ Number of windows used for training each ensemble layer. Length must match the number of layers
49
+ in ensemble_hyperparameters. Example: (3, 2) means first layer uses 3 windows, second layer uses
50
+ 2 windows.
51
+
52
+ Base models must have OOF predictions saved for all sum(num_windows_per_layer) windows, prior
53
+ to this class being called.
54
+ ensemble_hyperparameters
55
+ Ensemble configuration. A list of dicts, one per layer. If an ensemble model should be fitted
56
+ with multiple hyperparameter configurations, a list of dicts may be provided as the value.
57
+ Each layer's dict maps ensemble names to either a single hyperparameter dict or a list of
58
+ hyperparameter dicts.
59
+
60
+ Examples:
61
+ - ``[{"GreedyEnsemble": {}}, {"GreedyEnsemble": {}}]`` for 2 layers of greedy ensembles.
62
+ - ``[{"GreedyEnsemble": [{"ensemble_size": 10}, {"ensemble_size": 20}]}]`` for a single layer of
63
+ two greedy ensembles, with differing ensemble sizes.
64
+ quantile_levels
65
+ Quantile levels for probabilistic forecasting.
66
+ model_graph
67
+ Directed graph containing base models and their metadata (val_score, fit_time, etc.). Only
68
+ base models (nodes without predecessors) are used for ensemble training.
69
+ """
70
+
71
+ def __init__(
72
+ self,
73
+ path: str,
74
+ prediction_length: int,
75
+ eval_metric: TimeSeriesScorer,
76
+ target: str,
77
+ num_windows_per_layer: tuple[int, ...],
78
+ ensemble_hyperparameters: list[dict[str, dict | list[dict]]],
79
+ quantile_levels: list[float],
80
+ model_graph: nx.DiGraph,
81
+ ):
82
+ self.eval_metric = eval_metric
83
+ self.path = path
84
+ self.prediction_length = prediction_length
85
+ self.target = target
86
+ self.quantile_levels = quantile_levels
87
+
88
+ self.num_windows_per_layer = num_windows_per_layer
89
+ self.num_layers = len(num_windows_per_layer)
90
+
91
+ if len(ensemble_hyperparameters) != self.num_layers:
92
+ raise ValueError(
93
+ "Number of ensemble_hyperparameters must match the number of layers. "
94
+ f"Received {len(ensemble_hyperparameters)} ensemble_hyperparameters, "
95
+ f"but {self.num_layers} layers."
96
+ )
97
+ self.ensemble_hyperparameters = ensemble_hyperparameters
98
+
99
+ self.banned_model_names = list(model_graph.nodes)
100
+ self.model_graph = self._get_base_model_graph(source_graph=model_graph)
101
+
102
+ @staticmethod
103
+ def _get_base_model_graph(source_graph: nx.DiGraph) -> nx.DiGraph:
104
+ """Return a model graph by copying only base models (nodes without predecessors).
105
+
106
+ This ensures we start fresh for training ensembles.
107
+ """
108
+ rootset = EnsembleComposer._get_rootset(source_graph)
109
+
110
+ dst_graph = nx.DiGraph()
111
+ for node in rootset:
112
+ dst_graph.add_node(node, **source_graph.nodes[node])
113
+
114
+ return dst_graph
115
+
116
+ @staticmethod
117
+ def _get_rootset(graph: nx.DiGraph) -> list[str]:
118
+ return [n for n in graph.nodes if not list(graph.predecessors(n))]
119
+
120
+ def _load_model(self, model_name: str) -> Any:
121
+ """Load a model from the graph by name."""
122
+ attrs = self.model_graph.nodes[model_name]
123
+ model_path = os.path.join(self.path, *attrs["path"])
124
+ return attrs["type"].load(path=model_path)
125
+
126
+ def _iter_models(self, layer: int) -> Iterator[tuple[str, Any]]:
127
+ """Iterate over models in a specific layer of the model graph.
128
+
129
+ Parameters
130
+ ----------
131
+ layer
132
+ Layer index (0 for base models, 1+ for ensemble layers)
133
+
134
+ Yields
135
+ ------
136
+ model_name
137
+ Name of the model
138
+ model
139
+ Loaded model instance
140
+ """
141
+ rootset = self._get_rootset(self.model_graph)
142
+ layer_iter = nx.traversal.bfs_layers(self.model_graph, rootset)
143
+ for layer_idx, layer_keys in enumerate(layer_iter):
144
+ if layer_idx != layer:
145
+ continue
146
+
147
+ for model_name in layer_keys:
148
+ model = self._load_model(model_name)
149
+ yield model_name, model
150
+
151
+ def iter_ensembles(self) -> Iterator[tuple[int, AbstractTimeSeriesEnsembleModel, list[str]]]:
152
+ """Iterate over trained ensemble models, layer by layer. Used by the Trainer to copy the
153
+ fitted models in EnsembleComposer's ``model_graph``.
154
+
155
+ Yields
156
+ ------
157
+ layer_idx
158
+ The layer index of the ensemble.
159
+ model
160
+ The ensemble model object
161
+ base_model_names
162
+ The names of the base models that are part of the ensemble.
163
+ """
164
+ for layer_idx in range(1, self.num_layers + 1):
165
+ for model_name, model in self._iter_models(layer=layer_idx):
166
+ yield (layer_idx, model, list(self.model_graph.predecessors(model_name)))
167
+
168
+ def fit(
169
+ self,
170
+ data_per_window: list[TimeSeriesDataFrame],
171
+ predictions_per_window: dict[str, list[TimeSeriesDataFrame]],
172
+ time_limit: float | None = None,
173
+ ) -> Self:
174
+ base_model_names = [name for name, _ in self._iter_models(layer=0)]
175
+ if not self._can_fit_ensemble(time_limit, len(base_model_names)):
176
+ return self
177
+
178
+ num_ensembles = sum(
179
+ len(list(self.iter_layer_models_and_hps(layer))) for layer in range(1, self.num_layers + 1)
180
+ )
181
+ logger.info(f"Fitting {num_ensembles} ensemble(s), in {self.num_layers} layers.")
182
+
183
+ assert len(data_per_window) == sum(self.num_windows_per_layer)
184
+
185
+ def get_inputs_for_layer(layer_idx, model_names):
186
+ """Retrieve predictions from previous layer models for current layer training."""
187
+ if layer_idx == 1:
188
+ # we need base models, so we use predictions_per_window provided by the trainer,
189
+ # which contains base model predictions for all windows where ensembles will be
190
+ # trained.
191
+ num_windows = self.num_windows_per_layer[0]
192
+ inputs = {name: predictions_per_window[name][:num_windows] for name in model_names}
193
+ else:
194
+ # if layer_idx > 1, we will be relying on predictions of previously trained ensembles
195
+ window_start = -sum(self.num_windows_per_layer[layer_idx - 1 :])
196
+ window_slice = slice(
197
+ window_start,
198
+ window_start + self.num_windows_per_layer[layer_idx - 1] if layer_idx < self.num_layers else None,
199
+ )
200
+
201
+ inputs = {}
202
+ for model_name in model_names:
203
+ oof_predictions = self._get_model_oof_predictions(model_name)
204
+ inputs[model_name] = oof_predictions[window_slice]
205
+
206
+ return inputs
207
+
208
+ def get_ground_truth_for_layer(layer_idx):
209
+ window_start = sum(self.num_windows_per_layer[: layer_idx - 1])
210
+ window_end = window_start + self.num_windows_per_layer[layer_idx - 1]
211
+ return data_per_window[window_start:window_end]
212
+
213
+ main_loop_timer = SplitTimer(time_limit, rounds=num_ensembles).start()
214
+
215
+ # main loop over layers of ensembles
216
+ for layer_idx in range(1, self.num_layers + 1):
217
+ layer_input_model_names = [name for name, _ in self._iter_models(layer=layer_idx - 1)]
218
+ layer_input_model_scores = {
219
+ name: self.model_graph.nodes[name]["val_score"] for name in layer_input_model_names
220
+ }
221
+
222
+ layer_predictions_per_window = get_inputs_for_layer(layer_idx, model_names=layer_input_model_names)
223
+ layer_data_per_window = get_ground_truth_for_layer(layer_idx)
224
+
225
+ for ensemble_name, ensemble_hp_dict in self.iter_layer_models_and_hps(layer_idx):
226
+ try:
227
+ # train the ensemble model
228
+ time_start = time.monotonic()
229
+
230
+ ensemble = self._fit_single_ensemble(
231
+ model_name=ensemble_name,
232
+ hyperparameters=ensemble_hp_dict,
233
+ predictions_per_window=layer_predictions_per_window,
234
+ data_per_window=layer_data_per_window,
235
+ base_model_scores=layer_input_model_scores,
236
+ layer_idx=layer_idx,
237
+ time_limit=main_loop_timer.round_time_remaining(),
238
+ )
239
+ ensemble.fit_time = time.monotonic() - time_start
240
+
241
+ # for all windows of all layers starting from this layer, predict and save predictions
242
+ predictions = []
243
+ predict_time = 0
244
+ for pred_layer_idx in range(layer_idx, self.num_layers + 1):
245
+ predict_time_start = time.monotonic()
246
+
247
+ pred_base_predictions = get_inputs_for_layer(pred_layer_idx, ensemble.model_names)
248
+ for window_idx in range(self.num_windows_per_layer[pred_layer_idx - 1]):
249
+ prediction = ensemble.predict(
250
+ {n: pred_base_predictions[n][window_idx] for n in ensemble.model_names}
251
+ )
252
+ predictions.append(prediction)
253
+
254
+ predict_time = time.monotonic() - predict_time_start
255
+
256
+ # record marginal prediction time per window in the last layer's data
257
+ ensemble.predict_time_marginal = predict_time / self.num_windows_per_layer[-1]
258
+ ensemble.cache_oof_predictions(predictions)
259
+
260
+ # compute validation score using the last layer's validation windows
261
+ last_layer_oof_predictions = ensemble.get_oof_predictions()[-self.num_windows_per_layer[-1] :]
262
+ last_layer_ground_truth = get_ground_truth_for_layer(self.num_layers)
263
+ score_per_fold = [
264
+ self.eval_metric(data, prediction, target=self.target)
265
+ for prediction, data in zip(last_layer_oof_predictions, last_layer_ground_truth)
266
+ ]
267
+ ensemble.val_score = float(np.mean(score_per_fold, dtype=np.float64))
268
+
269
+ # add model to the graph, compute predict time, and save
270
+ self._add_model(ensemble, base_models=ensemble.model_names)
271
+ ensemble.predict_time = self._calculate_predict_time(ensemble)
272
+ self.model_graph.nodes[ensemble.name]["predict_time"] = ensemble.predict_time
273
+ ensemble.save()
274
+
275
+ # log performance
276
+ log_scores_and_times(
277
+ ensemble.val_score,
278
+ ensemble.fit_time,
279
+ ensemble.predict_time,
280
+ eval_metric_name=self.eval_metric.name_with_sign,
281
+ )
282
+
283
+ # check time and advance round
284
+ if main_loop_timer.timed_out():
285
+ logger.warning(
286
+ "Time limit exceeded during ensemble training, will stop training new ensembles."
287
+ )
288
+ return self
289
+
290
+ except Exception as err: # noqa
291
+ logger.error(
292
+ f"\tWarning: Exception caused {ensemble_name} to fail during training... Skipping this model."
293
+ )
294
+ logger.error(f"\t{err}")
295
+ logger.debug(traceback.format_exc())
296
+
297
+ finally:
298
+ main_loop_timer.next_round()
299
+
300
+ return self
301
+
302
+ def iter_layer_models_and_hps(self, layer_idx: int):
303
+ layer_hps = self.ensemble_hyperparameters[layer_idx - 1]
304
+
305
+ for model_name, hps in layer_hps.items():
306
+ if isinstance(hps, list):
307
+ # If a list is provided, create one ensemble per hyperparameter dict
308
+ for hp in hps:
309
+ yield model_name, hp
310
+ else:
311
+ yield model_name, hps
312
+
313
+ def _fit_single_ensemble(
314
+ self,
315
+ model_name: str,
316
+ hyperparameters: dict,
317
+ predictions_per_window: dict[str, list[TimeSeriesDataFrame]],
318
+ data_per_window: list[TimeSeriesDataFrame],
319
+ base_model_scores: dict[str, float],
320
+ layer_idx: int,
321
+ time_limit: float | None = None,
322
+ ) -> AbstractTimeSeriesEnsembleModel:
323
+ ensemble_class = get_ensemble_class(model_name)
324
+
325
+ # TODO: remove this after PerformanceWeightedEnsemble is removed. This is a temporary fix
326
+ # to make sure PerformanceWeightedEnsemble is not fit on the validation scores of future
327
+ # out-of-fold splits.
328
+ if layer_idx < self.num_layers and ensemble_class is PerformanceWeightedEnsemble:
329
+ raise RuntimeError(
330
+ "PerformanceWeightedEnsemble is not supported for multilayer stack ensembles, except "
331
+ "when it's used in the last layer of the ensemble."
332
+ )
333
+
334
+ ensemble: AbstractTimeSeriesEnsembleModel = ensemble_class(
335
+ eval_metric=self.eval_metric,
336
+ target=self.target,
337
+ prediction_length=self.prediction_length,
338
+ path=self.path,
339
+ freq=data_per_window[0].freq,
340
+ quantile_levels=self.quantile_levels,
341
+ hyperparameters=hyperparameters,
342
+ )
343
+
344
+ # update name to prevent name collisions
345
+ old_name = ensemble.name
346
+ ensemble.name = self._get_ensemble_model_name(ensemble.name, layer_idx)
347
+ if ensemble.name != old_name:
348
+ path_obj = Path(ensemble.path)
349
+ ensemble.path = str(path_obj.parent / ensemble.name)
350
+
351
+ with warning_filter():
352
+ ensemble.fit(
353
+ predictions_per_window=predictions_per_window,
354
+ data_per_window=data_per_window,
355
+ model_scores=base_model_scores,
356
+ time_limit=time_limit,
357
+ )
358
+
359
+ return ensemble
360
+
361
+ def _get_model_oof_predictions(self, model_name: str) -> list[TimeSeriesDataFrame]:
362
+ model_attrs = self.model_graph.nodes[model_name]
363
+ model_path = os.path.join(self.path, *model_attrs["path"])
364
+ return model_attrs["type"].load_oof_predictions(path=model_path)
365
+
366
+ def _add_model(self, model, base_models: list[str]):
367
+ self.model_graph.add_node(
368
+ model.name,
369
+ path=os.path.relpath(model.path, self.path).split(os.sep),
370
+ type=type(model),
371
+ fit_time=model.fit_time,
372
+ predict_time=model.predict_time,
373
+ val_score=model.val_score,
374
+ )
375
+ for base_model in base_models:
376
+ self.model_graph.add_edge(base_model, model.name)
377
+ self.banned_model_names.append(model.name)
378
+
379
+ def _can_fit_ensemble(
380
+ self,
381
+ time_limit: float | None,
382
+ num_models_available_for_ensemble: int,
383
+ ) -> bool:
384
+ if time_limit is not None and time_limit <= 0:
385
+ logger.info(f"Not fitting ensemble due to lack of time remaining. Time left: {time_limit:.1f} seconds")
386
+ return False
387
+
388
+ if num_models_available_for_ensemble <= 1:
389
+ logger.info(
390
+ "Not fitting ensemble as "
391
+ + (
392
+ "no models were successfully trained."
393
+ if not num_models_available_for_ensemble
394
+ else "only 1 model was trained."
395
+ )
396
+ )
397
+ return False
398
+
399
+ return True
400
+
401
+ def _get_ensemble_model_name(self, name: str, layer_idx: int) -> str:
402
+ """Revise name for an ensemble model, ensuring we don't have name collisions"""
403
+ base_name = name
404
+ layer_suffix = f"_L{layer_idx + 1}" if self.num_layers > 1 else ""
405
+ name = f"{base_name}" + layer_suffix
406
+ increment = 1
407
+ while name in self.banned_model_names:
408
+ increment += 1
409
+ name = f"{base_name}_{increment}" + layer_suffix
410
+ return name
411
+
412
+ def _calculate_predict_time(self, model: AbstractTimeSeriesEnsembleModel) -> float:
413
+ """Calculate ensemble predict time as sum of base model predict times."""
414
+ assert model.predict_time_marginal is not None
415
+ predict_time = model.predict_time_marginal
416
+ for model_name in nx.ancestors(self.model_graph, model.name):
417
+ ancestor = self._load_model(model_name)
418
+ if isinstance(ancestor, AbstractTimeSeriesEnsembleModel):
419
+ assert ancestor.predict_time_marginal is not None
420
+ predict_time += ancestor.predict_time_marginal
421
+ else:
422
+ predict_time += ancestor.predict_time
423
+
424
+ return predict_time
425
+
426
+
427
+ def validate_ensemble_hyperparameters(hyperparameters: list[dict[str, dict | list[dict]]]) -> None:
428
+ if not isinstance(hyperparameters, list):
429
+ raise ValueError(f"ensemble_hyperparameters must be list, got {type(hyperparameters)}")
430
+
431
+ for layer_idx, layer_hp in enumerate(hyperparameters):
432
+ if not isinstance(layer_hp, dict):
433
+ raise ValueError(f"Layer {layer_idx} hyperparameters must be dict, got {type(layer_hp)}")
434
+ for ensemble_name, ensemble_hp in layer_hp.items():
435
+ get_ensemble_class(ensemble_name) # Will raise if unknown
436
+ hp_is_dict = isinstance(ensemble_hp, dict)
437
+ hp_is_valid_list = isinstance(ensemble_hp, list) and all(isinstance(d, dict) for d in ensemble_hp)
438
+ if not (hp_is_dict or hp_is_valid_list):
439
+ raise ValueError(f"Hyperparameters for {ensemble_name} must be dict or list, got {type(ensemble_hp)}")
@@ -0,0 +1,256 @@
1
+ import copy
2
+ import logging
3
+ import re
4
+ from collections import defaultdict
5
+ from typing import Any, Type
6
+
7
+ from autogluon.common import space
8
+ from autogluon.core import constants
9
+ from autogluon.timeseries.configs import get_hyperparameter_presets
10
+ from autogluon.timeseries.metrics import TimeSeriesScorer
11
+ from autogluon.timeseries.models import ModelRegistry
12
+ from autogluon.timeseries.models.abstract import AbstractTimeSeriesModel
13
+ from autogluon.timeseries.models.multi_window import MultiWindowBacktestingModel
14
+ from autogluon.timeseries.utils.features import CovariateMetadata
15
+
16
+ logger = logging.getLogger(__name__)
17
+
18
+
19
+ ModelKey = str | Type[AbstractTimeSeriesModel]
20
+ ModelHyperparameters = dict[str, Any]
21
+ TrainerHyperparameterSpec = dict[ModelKey, list[ModelHyperparameters]]
22
+
23
+
24
+ class TrainableModelSetBuilder:
25
+ """Responsible for building a list of model objects, in priority order, that will be trained by the
26
+ Trainer."""
27
+
28
+ VALID_AG_ARGS_KEYS = {
29
+ "name",
30
+ "name_prefix",
31
+ "name_suffix",
32
+ }
33
+
34
+ def __init__(
35
+ self,
36
+ path: str,
37
+ freq: str | None,
38
+ prediction_length: int,
39
+ eval_metric: TimeSeriesScorer,
40
+ target: str,
41
+ quantile_levels: list[float],
42
+ covariate_metadata: CovariateMetadata,
43
+ multi_window: bool,
44
+ ):
45
+ self.path = path
46
+ self.freq = freq
47
+ self.prediction_length = prediction_length
48
+ self.eval_metric = eval_metric
49
+ self.target = target
50
+ self.quantile_levels = quantile_levels
51
+ self.covariate_metadata = covariate_metadata
52
+ self.multi_window = multi_window
53
+
54
+ def get_model_set(
55
+ self,
56
+ hyperparameters: str | dict | None,
57
+ hyperparameter_tune: bool,
58
+ excluded_model_types: list[str] | None,
59
+ banned_model_names: list[str] | None = None,
60
+ ) -> list[AbstractTimeSeriesModel]:
61
+ """Resolve hyperparameters and create the requested list of models"""
62
+ models = []
63
+ banned_model_names = [] if banned_model_names is None else banned_model_names.copy()
64
+
65
+ # resolve and normalize hyperparameters
66
+ model_hp_map: TrainerHyperparameterSpec = HyperparameterBuilder(
67
+ hyperparameters=hyperparameters,
68
+ hyperparameter_tune=hyperparameter_tune,
69
+ excluded_model_types=excluded_model_types,
70
+ ).get_hyperparameters()
71
+
72
+ for k in model_hp_map.keys():
73
+ if isinstance(k, type) and not issubclass(k, AbstractTimeSeriesModel):
74
+ raise ValueError(f"Custom model type {k} must inherit from `AbstractTimeSeriesModel`.")
75
+
76
+ model_priority_list = sorted(
77
+ model_hp_map.keys(), key=lambda x: ModelRegistry.get_model_priority(x), reverse=True
78
+ )
79
+
80
+ for model_key in model_priority_list:
81
+ model_type = self._get_model_type(model_key)
82
+
83
+ for model_hps in model_hp_map[model_key]:
84
+ ag_args = model_hps.pop(constants.AG_ARGS, {})
85
+
86
+ for key in ag_args:
87
+ if key not in self.VALID_AG_ARGS_KEYS:
88
+ raise ValueError(
89
+ f"Model {model_type} received unknown ag_args key: {key} (valid keys {self.VALID_AG_ARGS_KEYS})"
90
+ )
91
+ model_name_base = self._get_model_name(ag_args, model_type)
92
+
93
+ model_type_kwargs: dict[str, Any] = dict(
94
+ name=model_name_base,
95
+ hyperparameters=model_hps,
96
+ **self._get_default_model_init_kwargs(),
97
+ )
98
+
99
+ # add models while preventing name collisions
100
+ model = model_type(**model_type_kwargs)
101
+ model_type_kwargs.pop("name", None)
102
+
103
+ increment = 1
104
+ while model.name in banned_model_names:
105
+ increment += 1
106
+ model = model_type(name=f"{model_name_base}_{increment}", **model_type_kwargs)
107
+
108
+ if self.multi_window:
109
+ model = MultiWindowBacktestingModel(model_base=model, name=model.name, **model_type_kwargs) # type: ignore
110
+
111
+ banned_model_names.append(model.name)
112
+ models.append(model)
113
+
114
+ return models
115
+
116
+ def _get_model_type(self, model: ModelKey) -> Type[AbstractTimeSeriesModel]:
117
+ if isinstance(model, str):
118
+ model_type: Type[AbstractTimeSeriesModel] = ModelRegistry.get_model_class(model)
119
+ elif isinstance(model, type):
120
+ model_type = model
121
+ else:
122
+ raise ValueError(
123
+ f"Keys of the `hyperparameters` dictionary must be strings or types, received {type(model)}."
124
+ )
125
+
126
+ return model_type
127
+
128
+ def _get_default_model_init_kwargs(self) -> dict[str, Any]:
129
+ return dict(
130
+ path=self.path,
131
+ freq=self.freq,
132
+ prediction_length=self.prediction_length,
133
+ eval_metric=self.eval_metric,
134
+ target=self.target,
135
+ quantile_levels=self.quantile_levels,
136
+ covariate_metadata=self.covariate_metadata,
137
+ )
138
+
139
+ def _get_model_name(self, ag_args: dict[str, Any], model_type: Type[AbstractTimeSeriesModel]) -> str:
140
+ name = ag_args.get("name")
141
+ if name is None:
142
+ name_stem = re.sub(r"Model$", "", model_type.__name__)
143
+ name_prefix = ag_args.get("name_prefix", "")
144
+ name_suffix = ag_args.get("name_suffix", "")
145
+ name = name_prefix + name_stem + name_suffix
146
+ return name
147
+
148
+
149
+ class HyperparameterBuilder:
150
+ """Given user hyperparameter specifications, this class resolves them against presets, removes
151
+ excluded model types and canonicalizes the hyperparameter specification.
152
+ """
153
+
154
+ def __init__(
155
+ self,
156
+ hyperparameters: str | dict | None,
157
+ hyperparameter_tune: bool,
158
+ excluded_model_types: list[str] | None,
159
+ ):
160
+ self.hyperparameters = hyperparameters
161
+ self.hyperparameter_tune = hyperparameter_tune
162
+ self.excluded_model_types = excluded_model_types
163
+
164
+ def get_hyperparameters(self) -> TrainerHyperparameterSpec:
165
+ hyperparameter_dict = {}
166
+ hp_presets = get_hyperparameter_presets()
167
+
168
+ if self.hyperparameters is None:
169
+ hyperparameter_dict = hp_presets["default"]
170
+ elif isinstance(self.hyperparameters, str):
171
+ try:
172
+ hyperparameter_dict = hp_presets[self.hyperparameters]
173
+ except KeyError:
174
+ raise ValueError(f"{self.hyperparameters} is not a valid preset.")
175
+ elif isinstance(self.hyperparameters, dict):
176
+ hyperparameter_dict = copy.deepcopy(self.hyperparameters)
177
+ else:
178
+ raise ValueError(
179
+ f"hyperparameters must be a dict, a string or None (received {type(self.hyperparameters)}). "
180
+ f"Please see the documentation for TimeSeriesPredictor.fit"
181
+ )
182
+
183
+ return self._check_and_clean_hyperparameters(hyperparameter_dict) # type: ignore
184
+
185
+ def _check_and_clean_hyperparameters(
186
+ self,
187
+ hyperparameters: dict[ModelKey, ModelHyperparameters | list[ModelHyperparameters]],
188
+ ) -> TrainerHyperparameterSpec:
189
+ """Convert the hyperparameters dictionary to a unified format:
190
+ - Remove 'Model' suffix from model names, if present
191
+ - Make sure that each value in the hyperparameters dict is a list with model configurations
192
+ - Checks if hyperparameters contain searchspaces
193
+ """
194
+ excluded_models = self._get_excluded_models()
195
+ hyperparameters_clean = defaultdict(list)
196
+ for model_name, model_hyperparameters in hyperparameters.items():
197
+ # Handle model names ending with "Model", e.g., "DeepARModel" is mapped to "DeepAR"
198
+ if isinstance(model_name, str):
199
+ model_name = self._normalize_model_type_name(model_name)
200
+ if model_name in excluded_models:
201
+ logger.info(
202
+ f"\tFound '{model_name}' model in `hyperparameters`, but '{model_name}' "
203
+ "is present in `excluded_model_types` and will be removed."
204
+ )
205
+ continue
206
+ if not isinstance(model_hyperparameters, list):
207
+ model_hyperparameters = [model_hyperparameters]
208
+ hyperparameters_clean[model_name].extend(model_hyperparameters)
209
+
210
+ self._verify_searchspaces(hyperparameters_clean)
211
+
212
+ return dict(hyperparameters_clean)
213
+
214
+ def _get_excluded_models(self) -> set[str]:
215
+ excluded_models = set()
216
+ if self.excluded_model_types is not None and len(self.excluded_model_types) > 0:
217
+ if not isinstance(self.excluded_model_types, list):
218
+ raise ValueError(f"`excluded_model_types` must be a list, received {type(self.excluded_model_types)}")
219
+ logger.info(f"Excluded model types: {self.excluded_model_types}")
220
+ for model in self.excluded_model_types:
221
+ if not isinstance(model, str):
222
+ raise ValueError(f"Each entry in `excluded_model_types` must be a string, received {type(model)}")
223
+ excluded_models.add(self._normalize_model_type_name(model))
224
+ return excluded_models
225
+
226
+ @staticmethod
227
+ def _normalize_model_type_name(model_name: str) -> str:
228
+ return model_name.removesuffix("Model")
229
+
230
+ def _verify_searchspaces(self, hyperparameters: dict[str, list[ModelHyperparameters]]):
231
+ if self.hyperparameter_tune:
232
+ for model, model_hps_list in hyperparameters.items():
233
+ for model_hps in model_hps_list:
234
+ if contains_searchspace(model_hps):
235
+ return
236
+
237
+ raise ValueError(
238
+ "Hyperparameter tuning specified, but no model contains a hyperparameter search space. "
239
+ "Please disable hyperparameter tuning with `hyperparameter_tune_kwargs=None` or provide a search space "
240
+ "for at least one model."
241
+ )
242
+ else:
243
+ for model, model_hps_list in hyperparameters.items():
244
+ for model_hps in model_hps_list:
245
+ if contains_searchspace(model_hps):
246
+ raise ValueError(
247
+ f"Hyperparameter tuning not specified, so hyperparameters must have fixed values. "
248
+ f"However, for model {model} hyperparameters {model_hps} contain a search space."
249
+ )
250
+
251
+
252
+ def contains_searchspace(model_hyperparameters: ModelHyperparameters) -> bool:
253
+ for hp_value in model_hyperparameters.values():
254
+ if isinstance(hp_value, space.Space):
255
+ return True
256
+ return False