Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOC] sort slightly disordered forecasting API reference #4815

Merged
merged 2 commits into from Jul 9, 2023
Merged

[DOC] sort slightly disordered forecasting API reference #4815

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a64b169
Update forecasting.rst
fkiraly Jul 3, 2023
3529b57
Merge branch 'main' into sort-statsforecast
fkiraly Jul 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
59 changes: 44 additions & 15 deletions docs/source/api_reference/forecasting.rst
View file
Open in desktop
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