[ENH] add informational tags back to estimator docs

[inclinedadarsh]

Reference Issues/PRs

Fixes #2490

What does this implement/fix? Explain your changes.

Add all the information back in the docs in the form of tags. Please checkout #2490 for more infromation.

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

Nope.

PR checklist

For all contributions

• [x] 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.
• [x] 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[bot]]

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

[inclinedadarsh]

Hello @MatthewMiddlehurst @SebastianSchmidl

I have included the tags as suggested in https://github.com/aeon-toolkit/aeon/issues/2490#issuecomment-2643703695

I tried running the tests; however, the tests are failing because of the tags I add, and I don't really understand why.

One reason I believe is that I need to add all the tags in all the models, I'm not sure though. If this is the case, then the tag output_data_format is of string type, I don't understand what should I add in that field in other models.

Some help on this is appreciated.

Thank you!

[MatthewMiddlehurst]

if you set "class" to all estimators then it will expect it for all estimators

[inclinedadarsh]

Hey, I can't seem to figure out what value should be given for the class key for it to only check for anomaly detection modules.

I tried using anomaly_detector but tests fail on that one. I tried finding the file where all the values for the class key are mentioned but couldn't find it.

Can you help me figure out what will be used for the class key?

[SebastianSchmidl]

It should be "anomaly-detector"

[inclinedadarsh]

Hey @SebastianSchmidl, the only two tests failing right now are the new tags not added for the ROCKAD class under whole_series submodule.

At the time of creation of this issue, that class didn't exist so the values for output_data_format, learning_type:unsupervised and learning_type:semi_supervised aren't documented.

Could you let me know the values of these tags for the ROCKAD class, or let me know how I can find these values?

[SebastianSchmidl]

By the looks of things semi-supervised and scores?

Yes.

[MatthewMiddlehurst]

Hi, we are planning (another) refactor for anomaly detection which is likely to make this more complicated. I would prefer to get this in first, so may push some changes myself.

[MatthewMiddlehurst]

Should be ready for review.