Skip to content

Commit

Permalink
Docs/quickstart update (#2418)
Browse files Browse the repository at this point in the history
* improve quickstart notebook

* update readme
  • Loading branch information
dennisbader authored Jun 19, 2024
1 parent ab9b66e commit b07fb2f
Show file tree
Hide file tree
Showing 4 changed files with 3,932 additions and 615 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ but cannot always guarantee backwards compatibility. Changes that may **break co
- 🔴 Removed parameter `num_loader_workers` from `fit*()`, `predict*()`, `find_lr()`. You can now set the parameter through the `dataloader_kwargs` dict.
- Improvements to `DataTransformers`:
- Significant speed up when using `fit`, `fit_transform`, `transform`, and `inverse_transform` with a large number of series. The component masking logic was moved into the parallelized transform methods. [#2401](https://github.com/unit8co/darts/pull/2401) by [Dennis Bader](https://github.com/dennisbader).
- Improvements to quick start notebook : [#2418](https://github.com/unit8co/darts/pull/2418) by [Dennis Bader](https://github.com/dennisbader).
- Added examples for using sample weights, forecast start shifting, direct likelihood parameter predictions.
- Enhanced examples for historical forecasts, backtest and residuals.

**Fixed**
- Fixed a bug when using a `RegressionModel` (that supports validation series) with a validation set, and encoders and/or component-specific lags, where the encodings and component specific lags were not added to the set. [#2383](https://github.com/unit8co/darts/pull/2383) by [Dennis Bader](https://github.com/dennisbader).
Expand Down
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ series.plot()
The `PyODScorer` makes it trivial to use PyOD detectors on time series.

* **Multivariate Support:** `TimeSeries` can be multivariate - i.e., contain multiple time-varying
dimensions instead of a single scalar value. Many models can consume and produce multivariate series.
dimensions/columns instead of a single scalar value. Many models can consume and produce multivariate series.

* **Multiple series training (global models):** All machine learning based models (incl. all neural networks)
support being trained on multiple (potentially multivariate) series. This can scale to large datasets too.
Expand All @@ -186,6 +186,13 @@ series.plot()
* **Regression Models:** It is possible to plug-in any scikit-learn compatible model
to obtain forecasts as functions of lagged values of the target series and covariates.

* **Training with sample weights:** All global models support being trained with sample weights. They can be
applied to each observation, forecasted time step and target column.

* **Forecast Start Shifting:** All global models support training and prediction on a shifted output window.
This is useful for example for Day-Ahead Market forecasts, or when the covariates (or target series) are reported
with a delay.

* **Explainability:** Darts has the ability to *explain* some forecasting models using Shap values.

* **Data processing:** Tools to easily apply (and revert) common transformations on
Expand Down
4,535 changes: 3,921 additions & 614 deletions examples/00-quickstart.ipynb

Large diffs are not rendered by default.

Binary file modified examples/static/images/covariates-highlevel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b07fb2f

Please sign in to comment.