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] Missing Docstrings in Fit, Predict, Forecast Regression #2563

Open
kavya-r30 opened this issue Feb 22, 2025 · 1 comment · May be fixed by #2564
Open

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

kavya-r30 opened this issue Feb 22, 2025 · 1 comment · May be fixed by #2564
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@kavya-r30
Copy link
Contributor

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

@kavya-r30 kavya-r30 added the documentation Improvements or additions to documentation label Feb 22, 2025
@kavya-r30
Copy link
Contributor Author

@aeon-actions-bot assign @kavya-r30

@kavya-r30 kavya-r30 linked a pull request Feb 22, 2025 that will close this issue
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant