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

[BUG] fix links in estimator overview page #2479

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

inclinedadarsh
Copy link

@inclinedadarsh inclinedadarsh commented Jan 4, 2025

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.

- rename `/aeon/classification/_dummy.py` file for `all_estimators` function to properly get it's path
- as a result, the link for `DummyClassifier` get's corrected in the **Estimator Overview** page
@aeon-actions-bot aeon-actions-bot bot added bug Something isn't working classification Classification package labels Jan 4, 2025
@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{#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
Copy link
Author

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working classification Classification package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] Multiple links from the Estimator Overview Page leads to a 404 page
1 participant