[DOC] Added search functionality for estimator overview table

[kavya-r30]

Reference Issues/PRs

Fixes #1438

What does this implement/fix? Explain your changes.

Added search functionality and page sorting for estimator overview table

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

No

Any other comments?

@all-contributors please add @kavya-r30 for code

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 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]

Thank you for contributing to aeon

I did not find any labels to add based on the title. Please add the [ENH], [MNT], [BUG], [DOC], [REF], [DEP] and/or [GOV] tags to your pull requests titles. For now you can add the labels manually.

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

[baraline]

Hey, thanks for working on this.

I'm not getting the same results on my side (with firefox and edge, same results). Anyone else can confirm ?

[SebastianSchmidl]

Hey, thanks for working on this.

I'm not getting the same results on my side (with firefox and edge, same results). Anyone else can confirm ?

I can confirm, the RDT-build does not produce the expected results.

[kavya-r30]

@baraline @SebastianSchmidl
Could check the build now it seems that the issue is fixed and now I'm able to see and search using search bar
Also is the pre commit thingy because of the spaces?

[baraline]

Great job, search is working great ! Only thing left to correct would be to adapt the table style to the dark/light mode toggle, currently, it displays only as light theme even with dark mode on.

For pre-commit, I would suggest you install it locally using the dev documentation, it will be way easier to see and fix the issues this way. It can even fix some issues automatically when you try to commit (you need to re-add and commit if some fixes have been auto applied), it will also tell you errors and what to do to fix them

[kavya-r30]

Thank you for the feedback! I will look into adapting the table style to the dark/light mode toggle so that it displays correctly in both themes as well as try pre commit.

[SebastianSchmidl]

For me, the dark/light mode works as expected:

• OS: Kubuntu 22.04
• Browsers:
  • Vivaldi 7.0.3495.27
  • Firefox 134.0 (switches automatically to dark mode because this is my system default)
  • Google Chrome 131.0.6778.204

The search is also really nice 👍🏼 🥳

---

I have some additional requests (unrelated to the search):

• Could we restrict the page size to something that fits on a standard screen per default? Currently, you need to scroll the table vertically and also switch pages. (or change the page size with the drop-down)
• The table is, unfortunately, too large for the current main-div-width. I would like to not need to scroll horizontally to see all tags. I have no idea how we could achieve this.

This does not need to be fixed in this PR. But, do you have any idea how to deal with it?

[kavya-r30]

@SebastianSchmidl
Thanks for your feedback ! The light dark works as expected but the table entries dropdown menu seems to not apply the furo's dark mode theme, ps Working on

Could we restrict the page size to something that fits on a standard screen per default? Currently, you need to scroll the table vertically and also switch pages. (or change the page size with the drop-down)

Regarding this we can will try to look into adjusting the table layout based on the screen size of the view port

The table is, unfortunately, too large for the current main-div-width. I would like to not need to scroll horizontally to see all tags. I have no idea how we could achieve this.

Regarding this we can try warping the words, or set minimum length to display for a column. I will look for any new ways to mitigate this issue

[kavya-r30]

@baraline @SebastianSchmidl
Sorted the theme changes on the dropdown menu and pre-commit fixes. Could you please check the build once you find time.

@all-contributors please add @kavya-r30 for code

[allcontributors]

@kavya-r30

I've put up a pull request to add @kavya-r30! 🎉

[baraline]

We're very close to perfect. Only remaining thing is the text in the search bar not changing color with theme, after that we'll be good to go, thanks ! :)

[kavya-r30]

@baraline For me the text in the search seems to change with theme in both chrome and microsoft edge

[baraline]

To be more precise, it's when you enter à text in the box, and change theme with the text still in there. I'm checking on a firefox on mobile, maybe if you don't have the issue it's because of that somehow

[kavya-r30]

I will check this with Firefox but I tried changing theme while the text was still present in the text box and it changed the colour for me
I tried in chrome and edge both on desktop and mobile

[baraline]

Just checked, it does the same thing on firefox on desktop, but not on edge. So maybe it's one of my firefox expansion messing with the css somehow. @SebastianSchmidl how does it renders for you ? If it's good on your side we can call it a day and merge the PR.

[SebastianSchmidl]

The theming works for me perfectly on all three desktop browsers. I did not check on mobile, but I think that our documentation is mostly used on desktops.

I have a suggestion regarding the width of the table:
We could abbreviate the column headers for the tags and have a legend in the text above the table. For example like that:

What do you think?

[kavya-r30]

@SebastianSchmidl

abbreviate the column headers for the tags and have a legend in the text above the table.

I tried implemented abbreviating the column headers for the tags and adding a legend in the text above the table.
This seems to have resolved the width problem, eliminating the need for sideways scrolling (for shorter estimator names)

As well as i also tried setting 10 as the default page size that also i believe has reduced the need for vertical scrolling.

Should I create a new pull request to address this issue?

[baraline]

I think you can just push your changes to this one, and we'll be good to go. You'll also want to remove the duplicate todo_include_todos = False statements as well at the end of the file, thanks again, it's looking great ! :)

[SebastianSchmidl]

Thanks for considering my additional requirements. This significantly improves the estimator overview table! 👍🏼

[kavya-r30]

I think you can just push your changes to this one, and we'll be good to go. You'll also want to remove the duplicate todo_include_todos = False statements as well at the end of the file, thanks again, it's looking great ! :)

@baraline @SebastianSchmidl Done :) ✔️