|
1 | 1 | # Changelog |
2 | 2 |
|
3 | 3 | We do our best to avoid the introduction of breaking changes, |
4 | | -but cannot always guarantee backwards compatibility. Changes that may **break code which uses a previous release of Darts** are marked with a "🔴". |
| 4 | +but cannot always guarantee backwards compatibility. Changes that may **break code which uses a previous release of Darts** are marked with a "🔴". Changes that deprecate functionalities are marked with a "🟠". |
5 | 5 |
|
6 | 6 | ## [Unreleased](https://github.com/unit8co/darts/tree/master) |
7 | 7 |
|
8 | | -[Full Changelog](https://github.com/unit8co/darts/compare/0.33.0...master) |
| 8 | +[Full Changelog](https://github.com/unit8co/darts/compare/0.34.0...master) |
9 | 9 |
|
10 | 10 | ### For users of the library: |
11 | 11 |
|
12 | 12 | **Improved** |
13 | 13 |
|
14 | | -- Added support for embedding metadata in `TimeSeries`. You can now attach any type of metadata as a dictionary to your time series, either at series creation using parameter `metadata` (or `metadata_cols` with `from_group_dataframe()`), or add it to an existing series via the `TimeSeries.with_metadata()` method. Unlike static covariates, metadata is not utilized by Darts' models during the forecasting process. However, the metadata is propagated through all downstream tasks, preserving the integrity and continuity of the information throughout the data pipeline. [#2656](https://github.com/unit8co/darts/pull/2656) by [Yoav Matzkevich](https://github.com/ymatzkevich), [Jules Authier](https://github.com/authierj) and [Dennis Bader](https://github.com/dennisbader). |
15 | | -- Improved `CatBoostModel` documentation by describing how to use native multi-output regression. [#2659](https://github.com/unit8co/darts/pull/2659) by [Jonas Blanc](https://github.com/jonasblanc) |
16 | | -- `TimeSeries.from_dataframe()` and `from_series()` now support creating `TimeSeries` from additional backends (Polars, PyArrow, ...). We leverage `narwhals` as the compatibility layer between dataframe libraries. See the `narwhals` [documentation](https://narwhals-dev.github.io/narwhals/) for all supported backends. [#2661](https://github.com/unit8co/darts/pull/2661) by [Jules Authier](https://github.com/authierj) |
17 | | -- Added new export methods: `TimeSeries.to_dataframe()` and `TimeSeries.to_series()`. These methods support exporting `TimeSeries` to DataFrames and Series for all backends supported by `narwhals`. See the `narwhals` [documentation](https://narwhals-dev.github.io/narwhals/extending/) for all supported backends. [#2701](https://github.com/unit8co/darts/pull/2701) by [Jules Authier](https://github.com/authierj) |
18 | | -- 🟠 `TimeSeries.pd_dataframe()` and `TimeSeries.pd_series()` are deprecated and will be removed in Darts version 0.35.0. Use `to_dataframe()` and `to_series()` instead. [#2701](https://github.com/unit8co/darts/pull/2701) by [Jules Authier](https://github.com/authierj) |
19 | | -- Added ONNX support for torch-based models with method `TorchForecastingModel.to_onnx()`. Check out [this example](https://unit8co.github.io/darts/userguide/gpu_and_tpu_usage.html#exporting-model-to-onnx-format-for-inference) from the user guide on how to export and load a model for inference. [#2620](https://github.com/unit8co/darts/pull/2620) by [Antoine Madrona](https://github.com/madtoinou) |
20 | | -- Made method `ForecastingModel.untrained_model()` public. Use this method to get a new (untrained) model instance created with the same parameters. [#2684](https://github.com/unit8co/darts/pull/2684) by [Timon Erhart](https://github.com/turbotimon) |
21 | | -- `TimeSeries.plot()` now supports setting the color for each component in the series. Simply pass a list / sequence of colors with length matching the number of components as parameters "c" or "colors". [#2680](https://github.com/unit8co/darts/pull/2680) by [Jules Authier](https://github.com/authierj) |
22 | | -- Made it possible to run the quickstart notebook `00-quickstart.ipynb` locally. [#2691](https://github.com/unit8co/darts/pull/2691) by [Jules Authier](https://github.com/authierj) |
23 | | -- Added `quantile` parameter to `RegressionModel.get_estimator()` to get the specific quantile estimator for probabilistic regression models using the `quantile` likelihood. [#2716](https://github.com/unit8co/darts/pull/2716) by [Antoine Madrona](https://github.com/madtoinou) |
24 | | -- Improvements to documentation: Added examples to `TimeSeries` factory methods and updated quickstart notebook with the extended backend support for creating and exporting `TimeSeries`. [#2725](https://github.com/unit8co/darts/pull/2725) by [Dennis Bader](https://github.com/dennisbader). |
| 14 | +**Fixed** |
| 15 | + |
| 16 | +**Dependencies** |
25 | 17 |
|
26 | | -**Removed** |
| 18 | +### For developers of the library: |
| 19 | + |
| 20 | +## [0.34.0](https://github.com/unit8co/darts/tree/0.34.0) (2025-03-09) |
27 | 21 |
|
28 | | -- 🔴 Removed method `RegressionModel.get_multioutput_estimator()`. Use `RegressionModel.get_estimator()` instead. [#2716](https://github.com/unit8co/darts/pull/2716) by [Antoine Madrona](https://github.com/madtoinou) |
| 22 | +### For users of the library: |
| 23 | + |
| 24 | +**Improved** |
| 25 | + |
| 26 | +- Improvements to `TimeSeries`: |
| 27 | + - `from_dataframe()` and `from_series()` now support creating `TimeSeries` from **additional DataFrame backends** (Polars, PyArrow, ...). We leverage `narwhals` as the compatibility layer between DataFrame libraries. See their [documentation](https://narwhals-dev.github.io/narwhals/) for all supported backends. [#2661](https://github.com/unit8co/darts/pull/2661) by [Jules Authier](https://github.com/authierj) |
| 28 | + - Added **new export methods**: `to_dataframe()` and `to_series()`. These methods support exporting `TimeSeries` to DataFrames and Series for all backends supported by `narwhals`. See their [documentation](https://narwhals-dev.github.io/narwhals/extending/) for all supported backends. [#2701](https://github.com/unit8co/darts/pull/2701) by [Jules Authier](https://github.com/authierj) |
| 29 | + - Added support for **embedding metadata** in `TimeSeries`. You can now attach any type of metadata as a dictionary to your time series, either at series creation using parameter `metadata` (or `metadata_cols` with `from_group_dataframe()`), or add it to an existing series via the `with_metadata()` method. Unlike static covariates, metadata is not utilized by Darts' models during the forecasting process. However, the metadata is propagated through all downstream tasks, preserving the integrity and continuity of the information throughout the data pipeline. [#2656](https://github.com/unit8co/darts/pull/2656) by [Yoav Matzkevich](https://github.com/ymatzkevich), [Jules Authier](https://github.com/authierj) and [Dennis Bader](https://github.com/dennisbader). |
| 30 | + - Method `plot()` now supports **setting the color for each component** in the series. Simply pass a list / sequence of colors with length matching the number of components as parameters "c" or "colors". [#2680](https://github.com/unit8co/darts/pull/2680) by [Jules Authier](https://github.com/authierj) |
| 31 | + - Improved documentation: Added examples to `TimeSeries` factory methods and updated quickstart notebook with the extended backend support for creating and exporting `TimeSeries`. [#2725](https://github.com/unit8co/darts/pull/2725) by [Dennis Bader](https://github.com/dennisbader). |
| 32 | + - 🟠 Methods `pd_dataframe()` and `pd_series()` are deprecated and will be removed in Darts version 0.35.0. Use `to_dataframe()` and `to_series()` instead. [#2701](https://github.com/unit8co/darts/pull/2701) by [Jules Authier](https://github.com/authierj) |
| 33 | +- Improvements to `TorchForecastingModel`: |
| 34 | + - Added ONNX support for torch-based models with method `to_onnx()`. Check out [this example](https://unit8co.github.io/darts/userguide/gpu_and_tpu_usage.html#exporting-model-to-onnx-format-for-inference) from the user guide on how to export and load a model for inference. [#2620](https://github.com/unit8co/darts/pull/2620) by [Antoine Madrona](https://github.com/madtoinou) |
| 35 | +- Improvements to `RegressionModel`: |
| 36 | + - Added `quantile` parameter to method `get_estimator()` to get the specific quantile estimator for probabilistic regression models using the `quantile` likelihood. [#2716](https://github.com/unit8co/darts/pull/2716) by [Antoine Madrona](https://github.com/madtoinou) |
| 37 | + - Improved `CatBoostModel` documentation by describing how to use native multi-output regression. [#2659](https://github.com/unit8co/darts/pull/2659) by [Jonas Blanc](https://github.com/jonasblanc) |
| 38 | + - 🔴 Removed method `get_multioutput_estimator()`. Use `get_estimator()` instead. [#2716](https://github.com/unit8co/darts/pull/2716) by [Antoine Madrona](https://github.com/madtoinou) |
| 39 | +- Other improvements: |
| 40 | + - Made method `ForecastingModel.untrained_model()` public. Use this method to get a new (untrained) model instance created with the same parameters. [#2684](https://github.com/unit8co/darts/pull/2684) by [Timon Erhart](https://github.com/turbotimon) |
| 41 | + - Made it possible to run the quickstart notebook `00-quickstart.ipynb` in local dev mode without installation. [#2691](https://github.com/unit8co/darts/pull/2691) by [Jules Authier](https://github.com/authierj) |
29 | 42 |
|
30 | 43 | **Fixed** |
31 | 44 |
|
32 | | -- 🔴 / 🟢 Fixed a bug which raised an error when loading torch models that were saved with Darts versions < 0.33.0. This is a breaking change and models saved with version 0.33.0 will not be loadable anymore. [#2692](https://github.com/unit8co/darts/pull/2692) by [Dennis Bader](https://github.com/dennisbader). |
33 | | -- Fixed a bug in `NLinearModel` with `normalize=True` where the normalization was not applied properly. The predictive power is now greatly improved. [#2699](https://github.com/unit8co/darts/pull/2699) by [Dennis Bader](https://github.com/dennisbader). |
| 45 | +- 🔴 / 🟢 Fixed a bug which raised an error when loading a `TorchForecastingModel` that was saved with Darts versions < 0.33.0. This is a breaking change and models saved with version 0.33.0 will not be loadable anymore. [#2692](https://github.com/unit8co/darts/pull/2692) by [Dennis Bader](https://github.com/dennisbader). |
| 46 | +- Fixed a bug in `NLinearModel` with `normalize=True` where the normalization was not applied properly. The predictive power is now greatly improved. [#2724](https://github.com/unit8co/darts/pull/2724) by [Dennis Bader](https://github.com/dennisbader). |
34 | 47 | - Fixed a bug in `StaticCovariatesTransformer` which raised an error when trying to inverse transform one-hot encoded categorical static covariates with identical values across time-series. Each categorical static covariates is now referred to by `{covariate_name}_{category_name}`, regardless of the number of categories. [#2710](https://github.com/unit8co/darts/pull/2710) by [Antoine Madrona](https://github.com/madtoinou) |
35 | | -- Fixed a bug in `13-TFT-examples.ipynb` where two calls to `TimeSeries.from_series()` were not providing `series` but `pd.Index`. The method calls were changed to `TimeSeries.from_values()`. [#2719](https://github.com/unit8co/darts/pull/2719) by [Jules Authier](https://github.com/authierj) |
36 | 48 | - Fixed a bug in `RegressionModel` where performing optimized historical forecasts with `max(lags) < -1` resulted in forecasts that extended too far into the future. [#2715](https://github.com/unit8co/darts/pull/2715) by [Jules Authier](https://github.com/authierj) |
37 | 49 |
|
38 | 50 | **Dependencies** |
|
0 commit comments