Skip to content

Commit

Permalink
[DOC] improved docstring for AutoETS (#4116)
Browse files Browse the repository at this point in the history
This PR contains a minor improvement to the docstring of `AutoETS`, making the direct interface property to `statsmodels` `ETSModel` clearer.

Related to #4072 which is possibly based on the docstring not being 100% precise.
  • Loading branch information
fkiraly committed Jan 27, 2023
1 parent 743cb9e commit 65cf9e0
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions sktime/forecasting/ets.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,15 @@
class AutoETS(_StatsModelsAdapter):
"""ETS models with both manual and automatic fitting capabilities.
Manual fitting is adapted from the statsmodels version,
while automatic fitting is adapted from the R version of ets.
Manual (fixed parameter) use (`auto=False`, default) is a direct interface
to `statsmodels` `ETSModel` [2]_,
while automated tuning (`auto=True`) is an adaptation of the R version of ets [3]_,
on top of `statsmodels` `ETSModel`.
The first few parameters are the same as the ones on statsmodels
The first parameters are direct interfaces to the `statsmodels` parameters
(from ``error`` to ``return_params``) [2]_.
The next few parameters are adapted from the ones on R
The remaining parameters are adaptations of the parameters of R ets
(``auto`` to ``additive_only``) [3]_,
and are used for automatic model selection.
Expand Down

0 comments on commit 65cf9e0

Please sign in to comment.