From c70b23cc10e6adb490191a9e9481557f33ca7c50 Mon Sep 17 00:00:00 2001 From: Tony Bagnall Date: Fri, 23 May 2025 21:11:36 +0100 Subject: [PATCH 1/2] docstring --- aeon/forecasting/_regression.py | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/aeon/forecasting/_regression.py b/aeon/forecasting/_regression.py index 2330073afc..991c9f8c7c 100644 --- a/aeon/forecasting/_regression.py +++ b/aeon/forecasting/_regression.py @@ -16,9 +16,9 @@ class RegressionForecaster(BaseForecaster): Regression based forecasting. Container for forecaster that reduces forecasting to regression through a - window. Form a collection of sub series of length `window` through a sliding - winodw to form X, take `horizon` points ahead to form `y`, then apply an aeon or - sklearn regressor. + window. Form a collection of sub series of length ``window`` through a sliding + window to form ``X``, take ``horizon`` points ahead to form ``y``, then apply an + aeon or sklearn regressor. Parameters @@ -27,8 +27,7 @@ class RegressionForecaster(BaseForecaster): The window prior to the current time point to use in forecasting. So if horizon is one, forecaster will train using points $i$ to $window+i-1$ to predict value $window+i$. If horizon is 4, forecaster will used points $i$ - to $window+i-1$ to predict value $window+i+3$. If None, the algorithm will - internally determine what data to use to predict `horizon` steps ahead. + to $window+i-1$ to predict value $window+i+3$. horizon : int, default =1 The number of time steps ahead to forecast. If horizon is one, the forecaster will learn to predict one point ahead From 4398148701ed405e8173deb77f2d30c3ad1cfe45 Mon Sep 17 00:00:00 2001 From: Tony Bagnall Date: Fri, 23 May 2025 21:14:22 +0100 Subject: [PATCH 2/2] docstring --- aeon/forecasting/_regression.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/aeon/forecasting/_regression.py b/aeon/forecasting/_regression.py index 991c9f8c7c..5f82162cb7 100644 --- a/aeon/forecasting/_regression.py +++ b/aeon/forecasting/_regression.py @@ -1,8 +1,8 @@ """Window-based regression forecaster. General purpose forecaster to use with any scikit learn or aeon compatible -regressor. Simply forms a collection of windows from the time series and trains to -predict the next +regressor. Simply forms a collection of series using windowing from the time series +to form ``X`` and trains to predict the next ``horizon`` points ahead. """ import numpy as np @@ -16,9 +16,9 @@ class RegressionForecaster(BaseForecaster): Regression based forecasting. Container for forecaster that reduces forecasting to regression through a - window. Form a collection of sub series of length ``window`` through a sliding - window to form ``X``, take ``horizon`` points ahead to form ``y``, then apply an - aeon or sklearn regressor. + window. Form a collection of sub-series of length ``window`` through a sliding + window to form training collection ``X``, take ``horizon`` points ahead to form + ``y``, then apply an aeon or sklearn regressor. Parameters