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]check for algorithm_type #2339

Merged
merged 6 commits into from
Nov 13, 2024
Merged

Conversation

aryanpola
Copy link
Contributor

@aryanpola aryanpola commented Nov 11, 2024

Reference Issues/PRs

Fixes #1952

What does this implement/fix? Explain your changes.

Adds a check for algorithm_type in aeon.testing.estimator_checking._yield_classification_checks.py

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 enhancement New feature, improvement request or other non-bug code enhancement testing Testing related issue or pull request labels Nov 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{#FEF1BE}{\textsf{enhancement}}$ ].
I have added the following labels to this PR based on the changes made: [ $\color{#2C2F20}{\textsf{testing}}$ ]. 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

@aryanpola
Copy link
Contributor Author

@MatthewMiddlehurst should I raise errors for the absence of the algorithm_type tag in the estimator?

@TonyBagnall
Copy link
Contributor

@MatthewMiddlehurst should I raise errors for the absence of the algorithm_type tag in the estimator?

no, they do not have to have them, but if a classifier does have this tag, it should be one of
{"convolution", "dictionary","distance", "feature", "shapelet", "interval","hybrid","deeplearning"}

thats all you need to check, thanks for your contributions

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

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, thanks

@TonyBagnall TonyBagnall merged commit 5631c01 into aeon-toolkit:main Nov 13, 2024
15 checks passed
@aryanpola aryanpola deleted the algorithm branch November 13, 2024 16:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature, improvement request or other non-bug code enhancement testing Testing related issue or pull request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[ENH] Add test that the estimator "algorithm_type" is valid
2 participants