Skip to content

Commit 29494c6

Browse files
authored
[DOC] Regression forecaster docstring (#2837)
* docstring * docstring
1 parent d80f76d commit 29494c6

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

aeon/forecasting/_regression.py

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
"""Window-based regression forecaster.
22
33
General purpose forecaster to use with any scikit learn or aeon compatible
4-
regressor. Simply forms a collection of windows from the time series and trains to
5-
predict the next
4+
regressor. Simply forms a collection of series using windowing from the time series
5+
to form ``X`` and trains to predict the next ``horizon`` points ahead.
66
"""
77

88
import numpy as np
@@ -16,9 +16,9 @@ class RegressionForecaster(BaseForecaster):
1616
Regression based forecasting.
1717
1818
Container for forecaster that reduces forecasting to regression through a
19-
window. Form a collection of sub series of length `window` through a sliding
20-
winodw to form X, take `horizon` points ahead to form `y`, then apply an aeon or
21-
sklearn regressor.
19+
window. Form a collection of sub-series of length ``window`` through a sliding
20+
window to form training collection ``X``, take ``horizon`` points ahead to form
21+
``y``, then apply an aeon or sklearn regressor.
2222
2323
2424
Parameters
@@ -27,8 +27,7 @@ class RegressionForecaster(BaseForecaster):
2727
The window prior to the current time point to use in forecasting. So if
2828
horizon is one, forecaster will train using points $i$ to $window+i-1$ to
2929
predict value $window+i$. If horizon is 4, forecaster will used points $i$
30-
to $window+i-1$ to predict value $window+i+3$. If None, the algorithm will
31-
internally determine what data to use to predict `horizon` steps ahead.
30+
to $window+i-1$ to predict value $window+i+3$.
3231
horizon : int, default =1
3332
The number of time steps ahead to forecast. If horizon is one, the forecaster
3433
will learn to predict one point ahead

0 commit comments

Comments
 (0)