Skip to content

[EHN] Allow exogenous variables in regression forecasters #2915

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

Merged
merged 3 commits into from
Jun 27, 2025

Conversation

TinaJin0228
Copy link
Contributor

Reference Issues/PRs

#2814

What does this implement/fix? Explain your changes.

This implements support for exogenous variables (exog) in the RegressionForecaster, enabling the "multivariate regression" approach where the exogenous series are windowed alongside the main time series and fed into a standard regressor.

The implementation adds a capability tag "capability:exogenous" to the BaseForecaster.

New unit tests were also added to validate the functionalities.

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

NO.

Any other comments?

NO.

PR checklist

For all contributions
  • I've added myself to the list of contributors. Alternatively, you can use the @all-contributors bot to do this for you after the PR has been merged.
  • The PR title starts with either [ENH], [MNT], [DOC], [BUG], [REF], [DEP] or [GOV] indicating whether the PR topic is related to enhancement, maintenance, documentation, bugs, refactoring, deprecation or governance.
For new estimators and functions
  • I've added the estimator/function to the online API documentation.
  • (OPTIONAL) I've added myself as a __maintainer__ at the top of relevant files and want to be contacted regarding its maintenance. Unmaintained files may be removed. This is for the full file, and you should not add yourself if you are just making minor changes or do not want to help maintain its contents.
For developers with write access
  • (OPTIONAL) I've updated aeon's CODEOWNERS to receive notifications about future changes to these files.

@aeon-actions-bot aeon-actions-bot bot added the forecasting Forecasting package label Jun 23, 2025
@aeon-actions-bot
Copy link
Contributor

Thank you for contributing to aeon

I did not find any labels to add based on the title. Please add the [ENH], [MNT], [BUG], [DOC], [REF], [DEP] and/or [GOV] tags to your pull requests titles. For now you can add the labels manually.
I have added the following labels to this PR based on the changes made: [ forecasting ]. Feel free to change these if they do not properly represent the PR.

The Checks tab will show the status of our automated tests. You can click on individual test runs in the tab or "Details" in the panel below to see more information if there is a failure.

If our pre-commit code quality check fails, any trivial fixes will automatically be pushed to your PR unless it is a draft.

Don't hesitate to ask questions on the aeon Slack channel if you have any.

PR CI actions

These checkboxes will add labels to enable/disable CI functionality for this PR. This may not take effect immediately, and a new commit may be required to run the new configuration.

  • Run pre-commit checks for all files
  • Run mypy typecheck tests
  • Run all pytest tests and configurations
  • Run all notebook example tests
  • Run numba-disabled codecov tests
  • Stop automatic pre-commit fixes (always disabled for drafts)
  • Disable numba cache loading
  • Push an empty commit to re-run CI checks

Copy link
Contributor

@TonyBagnall TonyBagnall left a comment

Choose a reason for hiding this comment

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

the logic of this is all correct and it looks good, but I dont think you should check exog with self._check_X. This checks the tag capability:multivariate, which is not appropriate here. I recommend you just leave out any checks for exog for now, we can enhance it later on the next round of base class improvements

Copy link
Contributor

@TonyBagnall TonyBagnall left a comment

Choose a reason for hiding this comment

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

lgtm

@TonyBagnall TonyBagnall merged commit d22855a into aeon-toolkit:main Jun 27, 2025
17 checks passed
@TinaJin0228 TinaJin0228 deleted the reg-exog-vars branch June 29, 2025 10:48
chrisholder pushed a commit that referenced this pull request Jul 30, 2025
* add exogenous variable feature to base and regression forecasters

* delete self._check_X for exog

---------

Co-authored-by: Tony Bagnall <a.j.bagnall@soton.ac.uk>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
forecasting Forecasting package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants