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,MNT] Documentation updates and deprecation warning for v1.0.0 #1743

Merged
merged 10 commits into from
Jul 3, 2024

Conversation

MatthewMiddlehurst
Copy link
Member

@MatthewMiddlehurst MatthewMiddlehurst commented Jul 2, 2024

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.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@aeon-actions-bot aeon-actions-bot bot added documentation Improvements or additions to documentation examples Example notebook related maintenance Continuous integration, unit testing & package distribution labels Jul 2, 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}}$, $\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.

  • Run pre-commit checks for all files
  • 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)

@MatthewMiddlehurst MatthewMiddlehurst marked this pull request as ready for review July 2, 2024 12:59
@MatthewMiddlehurst MatthewMiddlehurst requested a review from a team as a code owner July 2, 2024 12:59
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
@TonyBagnall TonyBagnall merged commit b70a612 into main Jul 3, 2024
14 checks passed
@TonyBagnall TonyBagnall deleted the mm/docs branch July 3, 2024 19:01
MatthewMiddlehurst added a commit to time-series-machine-learning/aeon-tsml-fork that referenced this pull request Jul 4, 2024
* [BUG] fix padder fit_values (aeon-toolkit#1752)

* fix padder

* declare var

* [DOC,MNT] Documentation updates and deprecation warning for `v1.0.0` (aeon-toolkit#1743)

* forecasting docs

* v1.0.0 mass deprecation message

* index fix

* installation

* typos

* comment

* pushing to forks is crazy

* dont create branches

* [MNT] Unit testing revamp part 1: `check_estimator` (aeon-toolkit#1479)

* remove no soft deps job and expand full no soft deps job

* no PR testing flag

* module soft deps

* is this actually returning an empty list

* import modules now

* clear out module soft dep

* check_estimator

* check_estimator updates

* import

* more complete functions and tests

* fix

* coverage and paramterize function test

* testing data start

* testing data start

* testing data cont

* real partial

* cont

* testing data changes

* examples revert

* fourier features

* Revert "fourier features"

This reverts commit 567c5e1.

* legacy skip

* init

* move to legacy

* example data update

* testing data

* imports

* examples

* testing update

* multiindex

* multiindex fixes

* multiindex returns

* test

* test

* docs, tests and fixes

* comments

* last bits

* refactor testing folder

* imports

* series generators

* fixes

* make_series legacy

* merge

* forecasting functions

* fixes

* fixes

* fixes

* testing

* examples

* convert checks

* fixes

* docs

* ad datasets

* more docs

* forecasting compose

* forecasting

* delete forecasting api docs

* docs

* revert and comment init

* imports

* import test

* uncomment

* docstrings

* no imports

* package name

* import

* docstring

* fixes

* remove legacy and doc fix

* [ENH] Channel selection rocket wrapper (aeon-toolkit#1504)

* base channel selector

* base channel selector

* random channel selector

* elbow class test

* random channel selector

* base channel selector

* base channel selector

* revert registry

* draft channel selector

* class method

* test channel scorer

* docstring

* remove unnecessary ExponentTransform import

* deprecate DateTime

* Revert "deprecate DateTime"

This reverts commit 98b29e6.

* channel selection

* remove dependency

* move tests to fit

* move tests to fit

* channel scorer test

* add to API

* maint

* maint

---------

Co-authored-by: Tony Bagnall <ajb@uea.ac.uk>
MatthewMiddlehurst added a commit to time-series-machine-learning/aeon-tsml-fork that referenced this pull request Jul 4, 2024
* [BUG] fix padder fit_values (aeon-toolkit#1752)

* fix padder

* declare var

* [DOC,MNT] Documentation updates and deprecation warning for `v1.0.0` (aeon-toolkit#1743)

* forecasting docs

* v1.0.0 mass deprecation message

* index fix

* installation

* typos

* [MNT] Unit testing revamp part 1: `check_estimator` (aeon-toolkit#1479)

* remove no soft deps job and expand full no soft deps job

* no PR testing flag

* module soft deps

* is this actually returning an empty list

* import modules now

* clear out module soft dep

* check_estimator

* check_estimator updates

* import

* more complete functions and tests

* fix

* coverage and paramterize function test

* testing data start

* testing data start

* testing data cont

* real partial

* cont

* testing data changes

* examples revert

* fourier features

* Revert "fourier features"

This reverts commit 567c5e1.

* legacy skip

* init

* move to legacy

* example data update

* testing data

* imports

* examples

* testing update

* multiindex

* multiindex fixes

* multiindex returns

* test

* test

* docs, tests and fixes

* comments

* last bits

* refactor testing folder

* imports

* series generators

* fixes

* make_series legacy

* merge

* forecasting functions

* fixes

* fixes

* fixes

* testing

* examples

* convert checks

* fixes

* docs

* ad datasets

* more docs

* forecasting compose

* forecasting

* delete forecasting api docs

* docs

* revert and comment init

* imports

* import test

* uncomment

* docstrings

* no imports

* package name

* import

* docstring

* fixes

* remove legacy and doc fix

* [ENH] Channel selection rocket wrapper (aeon-toolkit#1504)

* base channel selector

* base channel selector

* random channel selector

* elbow class test

* random channel selector

* base channel selector

* base channel selector

* revert registry

* draft channel selector

* class method

* test channel scorer

* docstring

* remove unnecessary ExponentTransform import

* deprecate DateTime

* Revert "deprecate DateTime"

This reverts commit 98b29e6.

* channel selection

* remove dependency

* move tests to fit

* move tests to fit

* channel scorer test

* add to API

* [DEP] Exclusion list  (aeon-toolkit#1730)

* remove dependency

* excluded list

* [MNT] Removing `tensorflow_addons` dependency (aeon-toolkit#1421)

* tensorflow bound

* add manually instance normalization

* empty commit

* fix doxs

* fix bug

* add maintainer

* re arrange

* dep on utils

* fix comments

* add version and file to header

* re add conflict

* remove addon

* only adodn remove

* add typeguard dep

* remove addons from test

* remove tag of python<3.12 from base class

* edit pyptoject for test details

* remove typeguard

* remove addons

* remove typeguard

* fix bug in python version

* remove config on python < 3.12

* remove python version from test

* remove python version from base

* use group norm

* re-add 3.12 limit

* remove tags and add python version

* skip random state clr test

* fix test all networks

* set y for channel selection test

* set y for channel selection test

---------

Co-authored-by: hadifawaz1999 <hadifawaz2291999@gmail.com>
Co-authored-by: Tony Bagnall <ajb@uea.ac.uk>

* comment

* Empty commit for CI

* uncomment

---------

Co-authored-by: Tony Bagnall <ajb@uea.ac.uk>
Co-authored-by: hadifawaz1999 <hadifawaz2291999@gmail.com>
Co-authored-by: MatthewMiddlehurst <MatthewMiddlehurst@users.noreply.github.com>
MatthewMiddlehurst added a commit that referenced this pull request Jul 9, 2024
…ting CI (#1764)

* [MNT] Bot to make empty commits (#15)

* CI fun

* comments and token

* [MNT] empty commit PR 2 (#16)

* CI fun

* comments and token

* comments

* skip dirty check

* Empty commit for CI

* empty comment 3 (#17)

* comment

* prs only

* comment

* Empty commit for CI

* empty commit 4 (#18)

* comment

* correct branch

* Empty commit for CI

* empty commit 5 (#19)

* comment

* branch

* empty commit 6 (#20)

* [BUG] fix padder fit_values (#1752)

* fix padder

* declare var

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

* forecasting docs

* v1.0.0 mass deprecation message

* index fix

* installation

* typos

* comment

* pushing to forks is crazy

* dont create branches

* [MNT] Unit testing revamp part 1: `check_estimator` (#1479)

* remove no soft deps job and expand full no soft deps job

* no PR testing flag

* module soft deps

* is this actually returning an empty list

* import modules now

* clear out module soft dep

* check_estimator

* check_estimator updates

* import

* more complete functions and tests

* fix

* coverage and paramterize function test

* testing data start

* testing data start

* testing data cont

* real partial

* cont

* testing data changes

* examples revert

* fourier features

* Revert "fourier features"

This reverts commit 567c5e1.

* legacy skip

* init

* move to legacy

* example data update

* testing data

* imports

* examples

* testing update

* multiindex

* multiindex fixes

* multiindex returns

* test

* test

* docs, tests and fixes

* comments

* last bits

* refactor testing folder

* imports

* series generators

* fixes

* make_series legacy

* merge

* forecasting functions

* fixes

* fixes

* fixes

* testing

* examples

* convert checks

* fixes

* docs

* ad datasets

* more docs

* forecasting compose

* forecasting

* delete forecasting api docs

* docs

* revert and comment init

* imports

* import test

* uncomment

* docstrings

* no imports

* package name

* import

* docstring

* fixes

* remove legacy and doc fix

* [ENH] Channel selection rocket wrapper (#1504)

* base channel selector

* base channel selector

* random channel selector

* elbow class test

* random channel selector

* base channel selector

* base channel selector

* revert registry

* draft channel selector

* class method

* test channel scorer

* docstring

* remove unnecessary ExponentTransform import

* deprecate DateTime

* Revert "deprecate DateTime"

This reverts commit 98b29e6.

* channel selection

* remove dependency

* move tests to fit

* move tests to fit

* channel scorer test

* add to API

* maint

* maint

---------

Co-authored-by: Tony Bagnall <ajb@uea.ac.uk>

* empty commit 7 (#21)

* comment

* remove branch param

* fixes

* Empty commit for CI

* empty commit 8 (#22)

* comment

* repo and branch

* comment

* empty commit 9 (#23)

* [BUG] fix padder fit_values (#1752)

* fix padder

* declare var

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

* forecasting docs

* v1.0.0 mass deprecation message

* index fix

* installation

* typos

* [MNT] Unit testing revamp part 1: `check_estimator` (#1479)

* remove no soft deps job and expand full no soft deps job

* no PR testing flag

* module soft deps

* is this actually returning an empty list

* import modules now

* clear out module soft dep

* check_estimator

* check_estimator updates

* import

* more complete functions and tests

* fix

* coverage and paramterize function test

* testing data start

* testing data start

* testing data cont

* real partial

* cont

* testing data changes

* examples revert

* fourier features

* Revert "fourier features"

This reverts commit 567c5e1.

* legacy skip

* init

* move to legacy

* example data update

* testing data

* imports

* examples

* testing update

* multiindex

* multiindex fixes

* multiindex returns

* test

* test

* docs, tests and fixes

* comments

* last bits

* refactor testing folder

* imports

* series generators

* fixes

* make_series legacy

* merge

* forecasting functions

* fixes

* fixes

* fixes

* testing

* examples

* convert checks

* fixes

* docs

* ad datasets

* more docs

* forecasting compose

* forecasting

* delete forecasting api docs

* docs

* revert and comment init

* imports

* import test

* uncomment

* docstrings

* no imports

* package name

* import

* docstring

* fixes

* remove legacy and doc fix

* [ENH] Channel selection rocket wrapper (#1504)

* base channel selector

* base channel selector

* random channel selector

* elbow class test

* random channel selector

* base channel selector

* base channel selector

* revert registry

* draft channel selector

* class method

* test channel scorer

* docstring

* remove unnecessary ExponentTransform import

* deprecate DateTime

* Revert "deprecate DateTime"

This reverts commit 98b29e6.

* channel selection

* remove dependency

* move tests to fit

* move tests to fit

* channel scorer test

* add to API

* [DEP] Exclusion list  (#1730)

* remove dependency

* excluded list

* [MNT] Removing `tensorflow_addons` dependency (#1421)

* tensorflow bound

* add manually instance normalization

* empty commit

* fix doxs

* fix bug

* add maintainer

* re arrange

* dep on utils

* fix comments

* add version and file to header

* re add conflict

* remove addon

* only adodn remove

* add typeguard dep

* remove addons from test

* remove tag of python<3.12 from base class

* edit pyptoject for test details

* remove typeguard

* remove addons

* remove typeguard

* fix bug in python version

* remove config on python < 3.12

* remove python version from test

* remove python version from base

* use group norm

* re-add 3.12 limit

* remove tags and add python version

* skip random state clr test

* fix test all networks

* set y for channel selection test

* set y for channel selection test

---------

Co-authored-by: hadifawaz1999 <hadifawaz2291999@gmail.com>
Co-authored-by: Tony Bagnall <ajb@uea.ac.uk>

* comment

* Empty commit for CI

* uncomment

---------

Co-authored-by: Tony Bagnall <ajb@uea.ac.uk>
Co-authored-by: hadifawaz1999 <hadifawaz2291999@gmail.com>
Co-authored-by: MatthewMiddlehurst <MatthewMiddlehurst@users.noreply.github.com>

---------

Co-authored-by: MatthewMiddlehurst <MatthewMiddlehurst@users.noreply.github.com>
Co-authored-by: Tony Bagnall <ajb@uea.ac.uk>
Co-authored-by: hadifawaz1999 <hadifawaz2291999@gmail.com>
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 examples Example notebook related maintenance Continuous integration, unit testing & package distribution
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants