Skip to content

[DOC] Missing Docstrings in Fit, Predict, Forecast Regression #2563

@kavya-r30

Description

@kavya-r30

Describe the issue linked to the documentation

Missing Docstring in aeon/forecasting/_regression.py

current

def _fit(self, y, exog=None):
        """Fit forecaster to time series.

        Split X into windows of length window and train the forecaster on each window
        to predict the horizon ahead.

        Parameters
        ----------
        X : Time series on which to learn a forecaster

        Returns
        -------
        self
            Fitted estimator
        """

def _predict(self, y=None, exog=None):
        """Predict values for time series X."""
  
def _forecast(self, y, exog=None):
        """Forecast values for time series X.

        NOTE: deal with horizons
        """

Suggest a potential alternative/fix

No response

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions