aeon-toolkit / aeon

A toolkit for machine learning from time series
https://aeon-toolkit.org/
BSD 3-Clause "New" or "Revised" License
887 stars 94 forks source link

[DOC] Added all Regressors to the Documentation + small fixes #1660

Closed Moonzyyy closed 2 weeks ago

Moonzyyy commented 2 weeks ago

What does this implement/fix? Explain your changes.

Fixes https://github.com/aeon-toolkit/aeon/issues/1500, added all the new regressors to the document and changed the page to have all the regressors in alphabetical order for easier readability. Also fixed a spelling mistake in the installation page.

Also added to the CSS file to fix issues arising with Sphinx .autosummary. An issue would happen where the class.rst template would sometimes push the classh definition to the right of the page. This happened due to margin errors of the class.rst template (at least thats what I figured after messing around with it). This addition to the CSS file has not caused any errors elsewhere that contains .autosummary from what I have checked.

Any other comments?

Should specific things such as lists be kept alphabetical or should I ignore this in the future?

aeon-actions-bot[bot] commented 2 weeks ago

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.

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.

MatthewMiddlehurst commented 2 weeks ago

CI Failure is unrelated, you can merge the most recent main changes.

There appears to be no files changed currently, though.

Moonzyyy commented 2 weeks ago

Oh, that's weird you are right it says no files have been changed. Let me check what happened