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] Updated docstrings to inform that methods accept ForecastingHorizon #872

Merged
merged 1 commit into from May 16, 2021

Conversation

julramos
Copy link
Contributor

…rizon.

Reference Issues/PRs

What does this implement/fix? Explain your changes.

I updated the docstrings of the following methods to inform that they accept fh=ForecastingHorizon.

sktime.forecasting.base._base.BaseForecaster.fit()
sktime.forecasting.base._base.BaseForecaster.predict()
sktime.forecasting.base._base.BaseForecaster.score()
sktime.forecasting.base._sktime._SktimeForecaster._set_fh()
sktime.forecasting.base._sktime._SktimeForecaster.predict()
sktime.forecasting.base._sktime._SktimeForecaster.update_predict_single()
sktime.forecasting.base._sktime._OptionalForecastingHorizonMixin._set_fh()
sktime.forecasting.base._sktime._RequiredForecastingHorizonMixin._set_fh()
sktime.forecasting.base.adapters._pmdarima._PmdArimaAdapter.fit()

Does your contribution introduce a new dependency? If yes, which one?

No.

What should a reviewer concentrate their feedback on?

Any other comments?

PR checklist

For all contributions
  • I've added myself to the list of contributors.
  • Optionally, I've updated sktime's CODEOWNERS to receive notifications about future changes to these files.
  • I've added unit tests and made sure they pass locally.
For new estimators
  • I've added the estimator to the online documentation.
  • I've updated the existing example notebooks or provided a new one to showcase how my estimator works.

@julramos julramos requested a review from mloning as a code owner May 14, 2021 19:15
@mloning
Copy link
Contributor

mloning commented May 14, 2021

Thanks @julramos, if you're interested in getting more involved, please checkout the events we have planned over the next few weeks: #863 - let me know if you have any questions.

@mloning mloning changed the title Updated docstrings to inform that the methods accept fh=ForecastingHo… [DOC] Updated docstrings to inform that methods accept ForecastingHorizon May 14, 2021
@mloning mloning added the documentation Documentation & tutorials label May 14, 2021
Copy link
Contributor

@mloning mloning left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks again @julramos - will merge this now.

@mloning mloning merged commit cc34320 into sktime:main May 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation & tutorials
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants