Skip to content

Conversation

@satwiksps
Copy link
Contributor

[ENH] Standardise check_y usage via separate _convert_y

Reference Issues/PRs

What does this implement/fix? Explain your changes.

This PR standardises the usage of check_y across base classes to follow the pattern proposed in #2970.

Previously, two inconsistent patterns existed:

  • Validation and conversion combined via y = self._check_y(y)
  • Validation only via self._check_y(y)

This caused ambiguity and inconsistent behaviour across different estimator types.

This PR introduces a clear separation of responsibilities by:

  • Ensuring _check_y() is used strictly for validation
  • Moving all type conversions into a new dedicated method _convert_y()

The standard usage is now:
self._check_y(y)
y = self._convert_y(y)

This pattern is applied consistently to:

  • BaseRegressor
  • BaseCollectionAnomalyDetector
  • BaseSeriesAnomalyDetector

This improves clarity, consistency, and prevents unintended side-effects such as overwriting y or implicit type coercion during validation.

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.
  • The PR title starts with [ENH].

For new estimators and functions

  • I've added the estimator/function to the online API documentation.
  • I've added myself as a __maintainer__

For developers with write access

  • I've updated CODEOWNERS.

@aeon-actions-bot aeon-actions-bot bot added anomaly detection Anomaly detection package enhancement New feature, improvement request or other non-bug code enhancement regression Regression package labels Nov 24, 2025
@aeon-actions-bot
Copy link
Contributor

Thank you for contributing to aeon

I have added the following labels to this PR based on the title: [ enhancement ].
I have added the following labels to this PR based on the changes made: [ anomaly detection, regression ]. 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
  • Regenerate expected results for testing
  • Push an empty commit to re-run CI checks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

anomaly detection Anomaly detection package enhancement New feature, improvement request or other non-bug code enhancement regression Regression package

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[ENH] Standardise check_y use case

1 participant