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

[DOC] Add estimator overview table with capabilities #1426

Conversation

baraline
Copy link
Member

@baraline baraline commented Apr 15, 2024

Reference Issues/PRs

Fixes #1242

What does this implement/fix? Explain your changes.

Add back the estimator overview table from 0.3, but add capabilities of individual estimators to the table.

When this is merged, i'll raise an issue for the sorting by columns / search function that I didn't manage to implement.

@aeon-actions-bot aeon-actions-bot bot added the documentation Improvements or additions to documentation label Apr 15, 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{#F3B9F8}{\textsf{documentation}}$ ].

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.

@baraline baraline marked this pull request as draft April 15, 2024 10:48
@baraline baraline added the full pre-commit Run pre-commit for all files on a PR label Apr 15, 2024
@baraline baraline marked this pull request as ready for review April 16, 2024 15:51
Copy link
Member

@SebastianSchmidl SebastianSchmidl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the overview table. It already provides a good overview and the capabilities are displayed as well. For now, one can just use the browsers search functionality to navigate it. 👍🏼

The generation-function contains quite a lot of code. Should we extract it to a separate file?

There is also build_tools/generate_developer_tables.py, which also generates an html table... I don't know if this is similar enough, though.

docs/conf.py Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
@baraline
Copy link
Member Author

The trick is that it should be generated while building the docs, and I don't know if build_tools would be accessible while readthedocs builds. But I agree we should put it in a separate file, maybe create a folder/python script inside docs/ for script that generate content ?

Copy link
Member

@MatthewMiddlehurst MatthewMiddlehurst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great. I agree searching can wait with an issue raised. Do we want to close #1242? There is still an issue maybe in not having tags on individual API pages.

@baraline
Copy link
Member Author

Ok, a quick try on moving the script somewhere else made a mess, I'll keep it that way for now. I opened #1430 for individual estimators, and I'll create the issue for search/sort. So I guess we can close #1242 for now.

@baraline baraline merged commit 15dce60 into main Apr 18, 2024
2 checks passed
@baraline baraline deleted the 1242-doc-proposal-list-capabilities-of-individual-estimators-in-their-documentation branch April 18, 2024 12:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation full pre-commit Run pre-commit for all files on a PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Proposal: list capabilities of individual estimators in their documentation
3 participants