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] Improve anomaly detector documentation #1647

Merged
merged 2 commits into from
Jun 13, 2024
Merged

Conversation

CodeLionX
Copy link
Member

@CodeLionX CodeLionX commented Jun 11, 2024

Reference Issues/PRs

none

What does this implement/fix? Explain your changes.

  • removes some checks from the numpydoc validation
  • add discussion of detector learning types to BaseAnomalyDetector
  • fixes some documentation warnings
  • adds capability tables to existing detector documentations

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

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

@aeon-actions-bot aeon-actions-bot bot added anomaly detection Anomaly detection package documentation Improvements or additions to documentation labels Jun 11, 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{#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.

@CodeLionX CodeLionX self-assigned this Jun 11, 2024
@CodeLionX CodeLionX changed the title [DOC] Improve anomaly detector documentation and fix some numpydoc wa… [DOC] Improve anomaly detector documentation Jun 11, 2024
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 e725d3c into main Jun 13, 2024
14 checks passed
@TonyBagnall TonyBagnall deleted the feat/ad-base-doc branch June 13, 2024 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
anomaly detection Anomaly detection package documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants