From ae5caa6ed6e8456c82ae2ce8d22abb39bbcbaf66 Mon Sep 17 00:00:00 2001 From: Felix Divo <4403130+felixdivo@users.noreply.github.com> Date: Wed, 1 Nov 2023 15:19:59 +0100 Subject: [PATCH] Fix doc formatting of LinearRegressionModel (#2045) * For doc formatting of LinearRegressionModel * fix other model docs --------- Co-authored-by: dennisbader --- darts/models/forecasting/fft.py | 1 + darts/models/forecasting/linear_regression_model.py | 1 + darts/models/forecasting/torch_forecasting_model.py | 1 - darts/models/forecasting/xgboost.py | 1 + 4 files changed, 3 insertions(+), 1 deletion(-) diff --git a/darts/models/forecasting/fft.py b/darts/models/forecasting/fft.py index a2b59d45e6..82c62520bc 100644 --- a/darts/models/forecasting/fft.py +++ b/darts/models/forecasting/fft.py @@ -255,6 +255,7 @@ def __init__( >>> FFT(required_matches={'month'}, trend='exp') Simple usage example, using one of the dataset available in darts + >>> from darts.datasets import AirPassengersDataset >>> from darts.models import FFT >>> series = AirPassengersDataset().load() diff --git a/darts/models/forecasting/linear_regression_model.py b/darts/models/forecasting/linear_regression_model.py index fc62c40c8d..ed6ac9ba25 100644 --- a/darts/models/forecasting/linear_regression_model.py +++ b/darts/models/forecasting/linear_regression_model.py @@ -124,6 +124,7 @@ def encode_year(idx): Examples -------- Deterministic forecasting, using past/future covariates (optional) + >>> from darts.datasets import WeatherDataset >>> from darts.models import LinearRegressionModel >>> series = WeatherDataset().load() diff --git a/darts/models/forecasting/torch_forecasting_model.py b/darts/models/forecasting/torch_forecasting_model.py index b6643c1db9..7cfb9cd5cb 100644 --- a/darts/models/forecasting/torch_forecasting_model.py +++ b/darts/models/forecasting/torch_forecasting_model.py @@ -1,6 +1,5 @@ """ TorchForecastingModel ---------------------- This file contains several abstract classes: diff --git a/darts/models/forecasting/xgboost.py b/darts/models/forecasting/xgboost.py index dd9268211e..99e2df3ff9 100644 --- a/darts/models/forecasting/xgboost.py +++ b/darts/models/forecasting/xgboost.py @@ -140,6 +140,7 @@ def encode_year(idx): Examples -------- Deterministic forecasting, using past/future covariates (optional) + >>> from darts.datasets import WeatherDataset >>> from darts.models import XGBModel >>> series = WeatherDataset().load()