[DOC] Deep learning clustering notebook #2664

Edgeshot27 · 2025-03-20T15:33:39Z

Reference Issues/PRs #2283

What does this implement/fix? Explain your changes.

This notebook presents six deep learning clustering models with detailed explanations, code examples, and visualizations:

AEFCNClusterer (Auto-Encoder Fully Convolutional Network)
AEResNetClusterer (Auto-Encoder Residual Network)
AEDCNNClusterer (Auto-Encoder Dilated Convolutional Network)
AEDRNNClusterer (Auto-Encoder Dilated Recurrent Neural Network)
AEAttentionBiGRUClusterer (Auto-Encoder Attention Bidirectional GRU Network)
AEBiGRUClusterer (Auto-Encoder Bidirectional GRU Network)

Each model section explains its architecture, sample code implementation, and visualized clustering results to aid user understanding.

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

Any other comments?

PR checklist

For all contributions

I've added myself to the list of contributors. Alternatively, you can use the @all-contributors bot to do this for you after the PR has been merged.
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

I've added the estimator/function to the online API documentation.
(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

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

…g-based-clustering Deep learning based clustering

review-notebook-app · 2025-03-20T15:33:45Z

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

aeon-actions-bot · 2025-03-20T15:34:04Z

Thank you for contributing to `aeon`

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

Edgeshot27 · 2025-03-20T17:15:53Z

@MatthewMiddlehurst , @chrisholder , @TonyBagnall could you please review this pr.

aadya940 · 2025-03-24T12:15:51Z

@Edgeshot27

Can you please:

Change the file name to use non captial letters.
Show a small part of the dataset you're using [:5, ]?
Interpret the scatter plots you've shown using text? What do they signify?
The formatting is improper in the AEBiGRUClusterer heading.
Improve grammar a bit. For example, you use a non-capital letter after a full-stop in AEDRNNClusterer description and you've use capital letters where not needed (eg: Suitable in the same paragraph).

Edgeshot27 · 2025-03-24T14:30:20Z

@aadya940 the scatter plots observation would be quite same for some of the them so should i add them as inference if same for both.

aadya940 · 2025-03-24T18:39:23Z

@Edgeshot27 Yes.

Edgeshot27 · 2025-03-25T16:45:34Z

@aadya940 i have made the changes kindly please review again

aadya940 · 2025-03-26T09:19:12Z

@Edgeshot27 Last few changes,

you don't need two headings per clusterer. You can remove the AEDCNNClusterer: and so on ...
Also, there is an unnecessary # in the second last cell.

Edgeshot27 · 2025-03-26T16:48:33Z

@aadya940 i have made the necessary changes.

Edgeshot27 · 2025-03-28T15:50:23Z

@aadya940 are the changes okay now.