Skip to content

Commit

Permalink
[DOC] sort slightly disordered forecasting API reference (#4815)
Browse files Browse the repository at this point in the history
The estimators in the forecasting API reference were slightly
disordered, some estimators were sorted in the wrong category.
The mismatches were mostly `statsforecast` based estimators which were
mistakenly added below the first such model - in the ARIMA category,
even though they didn't belong there.

I made the following changes:

* sorted the `statsforecast` models in the right categories, Auto-Theta,
Auto-ETS and -CES need to go in the exponential smoothing category
* split the AR/MA category into plain (V)AR(I)MAX and Auto-ARIMA models
* added an intermittent time series category
  • Loading branch information
fkiraly committed Jul 9, 2023
1 parent 0b95560 commit 0c59f9d
Showing 1 changed file with 44 additions and 15 deletions.
59 changes: 44 additions & 15 deletions docs/source/api_reference/forecasting.rst
Expand Up @@ -168,6 +168,15 @@ Exponential smoothing based forecasters

AutoETS

.. currentmodule:: sktime.forecasting.statsforecast

.. autosummary::
:toctree: auto_generated/
:template: class.rst

StatsForecastAutoETS
StatsForecastAutoCES

.. currentmodule:: sktime.forecasting.theta

.. autosummary::
Expand All @@ -176,39 +185,31 @@ Exponential smoothing based forecasters

ThetaForecaster

.. currentmodule:: sktime.forecasting.croston
.. currentmodule:: sktime.forecasting.statsforecast

.. autosummary::
:toctree: auto_generated/
:template: class.rst

Croston
StatsForecastAutoTheta

AR/MA type forecasters
----------------------

Forecasters with AR or MA component.
All "ARIMA" models below include SARIMAX capability.

.. currentmodule:: sktime.forecasting.arima
All "ARIMA" and "Auto-ARIMA" models below include SARIMAX capability.

.. autosummary::
:toctree: auto_generated/
:template: class.rst

AutoARIMA
ARIMA
(V)AR(I)MAX models
~~~~~~~~~~~~~~~~~~

.. currentmodule:: sktime.forecasting.statsforecast
.. currentmodule:: sktime.forecasting.arima

.. autosummary::
:toctree: auto_generated/
:template: class.rst

StatsForecastAutoARIMA
StatsForecastAutoCES
StatsForecastAutoETS
StatsForecastAutoTheta
ARIMA

.. currentmodule:: sktime.forecasting.sarimax

Expand All @@ -234,6 +235,23 @@ All "ARIMA" models below include SARIMAX capability.

VARMAX

Auto-ARIMA models
~~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: auto_generated/
:template: class.rst

AutoARIMA

.. currentmodule:: sktime.forecasting.statsforecast

.. autosummary::
:toctree: auto_generated/
:template: class.rst

StatsForecastAutoARIMA

Structural time series models
-----------------------------

Expand Down Expand Up @@ -277,6 +295,17 @@ Structural time series models

DynamicFactor

Intermittent time series forecasters
------------------------------------

.. currentmodule:: sktime.forecasting.croston

.. autosummary::
:toctree: auto_generated/
:template: class.rst

Croston

Ensembles and stacking
----------------------

Expand Down

0 comments on commit 0c59f9d

Please sign in to comment.