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] Anomaly Detection Overview Notebook #2446

Merged
merged 10 commits into from
Dec 16, 2024

Conversation

itsdivya1309
Copy link
Contributor

Reference Issues/PRs

Closes #1960

What does this implement/fix? Explain your changes.

A getting started notebook for the Anomaly Detection module.

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

None

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/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.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@aeon-actions-bot aeon-actions-bot bot added documentation Improvements or additions to documentation examples Example notebook related labels Dec 12, 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{#F3B9F8}{\textsf{documentation}}$ ].
I have added the following labels to this PR based on the changes made: [ $\color{#45FD64}{\textsf{examples}}$ ]. 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

@MatthewMiddlehurst
Copy link
Member

Not had a look but happy to give some feedback if requested. We have some content from our ECML tutorial which may be useful https://github.com/aeon-toolkit/aeon-tutorials/blob/main/ECML-2024/Notebooks/part6_anomaly_detection.ipynb. Fine to take stuff directly from this as long as its generalised.

@itsdivya1309
Copy link
Contributor Author

Not had a look but happy to give some feedback if requested. We have some content from our ECML tutorial which may be useful https://github.com/aeon-toolkit/aeon-tutorials/blob/main/ECML-2024/Notebooks/part6_anomaly_detection.ipynb. Fine to take stuff directly from this as long as its generalised.

The ECML tutorial is very well structured and covers almost everything we have in the module. What I want to have is a short generic intro to the module, and we could cover the different types of detectors in other notebooks as we have for transformers. But we can have a comprehensive notebook now and then split up the content later.

@SebastianSchmidl
Copy link
Member

The :py:mod:-stuff does not work in notebooks because it is special to Sphinx/rst.

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.

I'm fine with having a brief introductory notebook and then adding more detailed notebooks for the detectors later 👍🏼

@TonyBagnall TonyBagnall merged commit 122e7f6 into aeon-toolkit:main Dec 16, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation examples Example notebook related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Anomaly detection getting started notebook
4 participants