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.

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

[DOC] Regression api #3751

Merged
merged 14 commits into from Nov 23, 2022
48 changes: 45 additions & 3 deletions docs/source/api_reference/regression.rst
Expand Up @@ -5,9 +5,9 @@ Time series regression

The :mod:`sktime.regression` module contains algorithms and composition tools for time series regression.

.. automodule:: sktime.regression
:no-members:
:no-inherited-members:
All current sktime Regressors can be listed using the ``sktime.registry import
all_estimators`` function.


Composition
-----------
Expand All @@ -20,6 +20,18 @@ Composition

ComposableTimeSeriesForestRegressor

Deep learning
-------------

.. currentmodule:: sktime.regression.deep_learning

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

CNNRegressor
TapNetRegressor

Interval-based
--------------

Expand All @@ -30,3 +42,33 @@ Interval-based
:template: class.rst

TimeSeriesForestRegressor

Kernel-based
------------

.. currentmodule:: sktime.regression.kernel_based

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

RocketRegressor

Base
----

.. currentmodule:: sktime.regression.base

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

BaseRegressor

.. currentmodule:: sktime.regression.deep_learning.base

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

BaseDeepRegressor
2 changes: 1 addition & 1 deletion sktime/regression/deep_learning/cnn.py
Expand Up @@ -14,7 +14,7 @@


class CNNRegressor(BaseDeepRegressor):
"""Time Convolutional Neural Network (CNN), as described in [1].
"""Time Series Convolutional Neural Network (CNN), as described in [1].

Parameters
----------
Expand Down
7 changes: 6 additions & 1 deletion sktime/regression/deep_learning/tapnet.py
Expand Up @@ -16,7 +16,12 @@


class TapNetRegressor(BaseDeepRegressor):
"""Implementation of TapNetRegressor, as described in [1].
"""Time series attentional prototype network (TapNet), as described in [1].

TapNet was initially proposed for multivariate time series
classification. The is an adaptation for time series regression. TapNet comprises
these components: random dimension permutation, multivariate time series
encoding, and attentional prototype learning.

Parameters
----------
Expand Down