[BUG] fix links in estimator overview page

[inclinedadarsh]

Reference Issues/PRs

Fixes #2474

What does this implement/fix? Explain your changes.

This pull request fixes the incorrect links in the Overview Estimator page in the documentations.

The issue was that the all_estimators function from the aeon.utils.discovery module wasn't providing correct path to those classes mentioned in #2474 (comment)

It turned out, that the those classes generally don't have a **underscore** in front of their file names. It's because they're not part of a sub module.
For example, the DummyClassifier actual is a part of the classification module, but it's directly inside that, unlike the rest of the modules.

To fix this, I thought of few ways, such as handling these cases in the code itself. However, the best was I think is simply adding a underscore in front of those files and also fixing the imports after that.

Following files will be fixed:

• DummyClassifier
• DummyClusterer
• SeriesSearch
• QuerySearch
• RocketGPU

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

No

Any other comments?

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 after the PR has been merged.
• 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 developers with write access

• (OPTIONAL) I've updated aeon's CODEOWNERS to receive notifications about future changes to these files.

[aeon-actions-bot]

Thank you for contributing to aeon

I have added the following labels to this PR based on the title: [ $\color{#d73a4a}{\textsf{bug}}$ ].
I have added the following labels to this PR based on the changes made: [ $\color{#BCAE15}{\textsf{classification}}$ ]. 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]

The problem with the last class is that it's documentation doesn't exist whatsoever.
After looking into the codebase, it turns out that the folder structure is a bit different from the rest of the classes, and maybe because of that Sphinx is not able to generate it's documentation.

One fix would be changing the folder structure, I'm not sure though.
Let me know what I can do.

Thank you!

[MatthewMiddlehurst]

Is there a reason why it can't find estimators in the root of a module? Leaving it like this would prohibit us from formatting estimators like this in the future.

Looks like an import has to be updated for the tests.

[MatthewMiddlehurst]

@inclinedadarsh any issues with this?

[inclinedadarsh]

Oh hey, completely missed this one.

Are you talking about the RocketGPU issue or the algorithm not being able to list files which are in the root directory?

For the latter one, I'll clone it tomorrow and make a commit as soon as possible. As of now I believe I'll have to undo the file name changes and make some changes in the algorithm itself to detect files from the root directory.

Sorry for the delay.

[MatthewMiddlehurst]

For RocketGPU i think just add it to the transformers API page if that is the issue. Should be a quick fix.

My main concern is the root directory one yes. Good catch on that. I would like to avoid having to make all the files private if possible.

[inclinedadarsh]

Hello, just a quick update

I'm working on the GSoC proposal as of now, so it'll take some time.
I'll get back to working on it from 9th of December.

[inclinedadarsh]

Just an update, I haven't closed the PR, I tried resetting my changes and getting in sync with main branch, which led to automatically closing this PR, I'll be re-opening this.

[inclinedadarsh]

@MatthewMiddlehurst I was updating the algorithm such that it should be able to find files that don't have an underscore and are in the root directory. However, some modules, such as regression and forecasting, have the dummy base classes in the file with an underscore in front of the file name, so the regression module has its dummy class in the file /aeon/regression/_dummy.py, but the classification module has the dummy class in the file /aeon/clustering/dummy.py.

This is an inconsistency in the naming convention of the files. Fixing this naming convention would make it easier to fix this issue, as the algorithm wouldn't have to deal with multiple naming conventions. How do you think I should proceed solving this issue?

It's been a long time since I updated on this one, so in case you need a refresher, here's my original comment on the issue and potential fix:

It turned out, that the those classes generally don't have a underscore in front of their file names. It's because they're not part of a sub module.
For example, the DummyClassifier actual is a part of the classification module, but it's directly inside that, unlike the rest of the modules.
To fix this, I thought of few ways, such as handling these cases in the code itself. However, the best was I think is simply adding a underscore in front of those files and also fixing the imports after that.

[MatthewMiddlehurst]

The changes seem to be gone? Put the class under convolution base if you want to add it, dont think it should have its own heading.

I dont think it should matter if it starts with an _ or not really. I dont want to restrict how we put stuff in directories because of this.

[MatthewMiddlehurst]

Hello, is this still active @inclinedadarsh

[inclinedadarsh]

Hey there,
I'm sorry for stalling this one, but I got busy with some other stuff. I don't think I'll get time anytime soon, so it'll be better if I unassign myself from the issue and let someone else fix it.

So sorry for this one.

[MatthewMiddlehurst]

No problem.