Skip to content

[REF] Refactor Anomaly Detection Module into Submodules by Algorithm Family #2694

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 10 commits into from
Apr 20, 2025

Conversation

Kaustbh
Copy link
Contributor

@Kaustbh Kaustbh commented Mar 26, 2025

Reference Issues/PRs

Fixes: #2663

What does this implement/fix? Explain your changes.

This PR addresses the issue of organizing the anomaly_detection module by refactoring the estimators into submodules based on their algorithm families.

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

Any other comments?

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 anomaly detection Anomaly detection package label Mar 26, 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: [ $\color{#6F6E8D}{\textsf{anomaly detection}}$ ]. 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

@Kaustbh
Copy link
Contributor Author

Kaustbh commented Mar 26, 2025

In the follow-up commit, I make changes to the documentation and update all references where these algorithms are used.

@Kaustbh Kaustbh changed the title Refactor Anomaly Detection Module into Submodules by Algorithm Family [REF] Refactor Anomaly Detection Module into Submodules by Algorithm Family Mar 26, 2025
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link
Member

@SebastianSchmidl SebastianSchmidl left a comment

Choose a reason for hiding this comment

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

Looks promising, but some minor remarks inline.

I guess, the deep_learning module will probably host most of the reconstruction and forecasting approaches later. We might decide to split it up. But this decision is for later.

@Kaustbh Kaustbh requested a review from SebastianSchmidl April 7, 2025 20:51
@SebastianSchmidl
Copy link
Member

Just the open comment from last time; otherwise, this looks good 👍🏼

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.

thanks for this, this module is still experimental so the refactor is fine.

@TonyBagnall TonyBagnall merged commit 28f2ffc into aeon-toolkit:main Apr 20, 2025
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
anomaly detection Anomaly detection package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[REF] Refactor anomaly_detection into submodules
4 participants