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

[ENH] Implemented CBLOF for Anomaly Detection #2243

Merged
merged 8 commits into from
Oct 28, 2024

Conversation

notaryanramani
Copy link
Contributor

Reference Issues/PRs

Fixes #2110

What does this implement/fix? Explain your changes.

Implements CBLOF for Anomaly Detection

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.
  • 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 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 anomaly detection Anomaly detection package enhancement New feature, improvement request or other non-bug code enhancement labels Oct 23, 2024
@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: [ $\color{#FEF1BE}{\textsf{enhancement}}$ ].
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

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.

Good work 👍🏼

Because CBLOF uses a clustering estimator internally, I would like to see an additional test that passing a custom estimator instance also works.

Do you think that it makes sense to also test with a time series clusterer from aeon? IMO, we use the sliding window approach to transform the time series into another space, where traditional metrics can be used. So, using TimeSeriesKMeans might not benefit the approach 🤷🏼

aeon/anomaly_detection/tests/test_cblof.py Outdated Show resolved Hide resolved
@notaryanramani
Copy link
Contributor Author

@CodeLionX

Because CBLOF uses a clustering estimator internally, I would like to see an additional test that passing a custom estimator instance also works.

Okay, will add a test that uses another estimator.

Do you think that it makes sense to also test with a time series clusterer from aeon? IMO, we use the sliding window approach to transform the time series into another space, where traditional metrics can be used. So, using TimeSeriesKMeans might not benefit the approach 🤷🏼

I think we can add a test to check if CBLOF can also be used with an aeon clustering estimator or to check the API consistency.

@notaryanramani
Copy link
Contributor Author

@CodeLionX

COPOD requies the shape of cluster centers to be 2d to calculate distance, but cluster centers for TimeSeriesKMeans is 3d. Is there a way for cluster centers to be 2d if n_channels is 1?

@SebastianSchmidl
Copy link
Member

SebastianSchmidl commented Oct 27, 2024

@CodeLionX

COPOD requies the shape of cluster centers to be 2d to calculate distance, but cluster centers for TimeSeriesKMeans is 3d. Is there a way for cluster centers to be 2d if n_channels is 1?

In this case, I would just state in the documentation that aeon estimators are not supported. It does not make much sense to use them anyway.

@TonyBagnall
Copy link
Contributor

thanks for the contribution

@TonyBagnall TonyBagnall merged commit 902fcf0 into aeon-toolkit:main Oct 28, 2024
15 checks passed
@notaryanramani notaryanramani deleted the issue2110 branch October 28, 2024 20:10
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[ENH] Add PyODAdapter-implementation for CBLOF
3 participants