search

aeon-toolkit / aeon

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

[DOC,MNT] Documentation updates and deprecation warning for `v1.0.0` #1743

Closed MatthewMiddlehurst closed 2 days ago

MatthewMiddlehurst commented 3 days ago

Reference Issues/PRs

Part of #1518 and #1629

What does this implement/fix? Explain your changes.

Adds a package wide deprecation warning for v1.0.0, mentioning forecasting and transformers as modules/interfaces to be deprecated. A longer message is available on the index page.

Updates the documentation, removing the now deprecated forecasting. Updates the index page a bit and gives all images a white background for consistency.

review-notebook-app[bot] commented 3 days ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

aeon-actions-bot[bot] commented 3 days ago

Thank you for contributing to aeon

I have added the following labels to this PR based on the title: [ $\color{#F3B9F8}{\textsf{documentation}}$, $\color{#EC843A}{\textsf{maintenance}}$ ]. I have added the following labels to this PR based on the changes made: [ $\color{#45FD64}{\textsf{examples}}$ ]. 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.