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] Deep learning clustering notebook #2664

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

Edgeshot27
Copy link

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.

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 labels Mar 20, 2025
@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}}$ ].
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
Copy link
Author

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

@MatthewMiddlehurst MatthewMiddlehurst changed the title [DOC] Deep learning and feature based clustering notebooks #2283 [DOC] Deep learning clustering notebook Mar 22, 2025
@MatthewMiddlehurst MatthewMiddlehurst added the deep learning Deep learning related label Mar 22, 2025
@aadya940
Copy link
Contributor

aadya940 commented Mar 24, 2025

@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
Copy link
Author

@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
Copy link
Contributor

@Edgeshot27 Yes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deep learning Deep learning related documentation Improvements or additions to documentation examples Example notebook related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants