[MNT] Clustering module 1.0 deprecations

[chrisholder]

Reference Issues/PRs

1518

This PR requires PR #2251

What does this implement/fix? Explain your changes.

This PR deprecates all the parameters and models for 1.0 release. Specifically it deprecates the following:

• K-shapes (renamed to k-shape)
• init_algorithm variable for kmeans (change to init)
• clustering_algorithm parameter for deep learners (renamed to estimator)

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

Any other comments?

PR checklist

For all contributions

• [x] I've added myself to the list of contributors. Alternatively, you can use the @all-contributors bot to do this for you.
• [x] 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

• [x] I've added the estimator to the online API documentation.
• [x] (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

• [x] (OPTIONAL) I've updated aeon's CODEOWNERS to receive notifications about future changes to these files.

[aeon-actions-bot[bot]]

Thank you for contributing to aeon

I have added the following labels to this PR based on the title: [ $\color{#EC843A}{\textsf{maintenance}}$ ]. I have added the following labels to this PR based on the changes made: [ $\color{#4011F3}{\textsf{clustering}}$ ]. 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 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

[review-notebook-app[bot]]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[hadifawaz1999]

thanks Chris for taking care of this, however i think its best if we wait for the rest of the deep clustering prs to get in and make the deprecating changes here, if thats okay with you

[hadifawaz1999]

btw @chrisholder n_clusters and clustering_params are also to deprecate in deep leaening (look at the warning you removed in base class)