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

[ENH] Added R-Clustering clusterer to aeon #2382

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

Conversation

Ramana-Raja
Copy link

@Ramana-Raja Ramana-Raja commented Nov 22, 2024

Reference Issues/PRs

#2132

What does this implement/fix? Explain your changes.

added R clustering model for aeon

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

no

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.
  • 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 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.

@aeon-actions-bot aeon-actions-bot bot added clustering Clustering package enhancement New feature, improvement request or other non-bug code enhancement labels Nov 22, 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{#FEF1BE}{\textsf{enhancement}}$ ].
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

@Ramana-Raja Ramana-Raja changed the title [ENH] Added R-Clustering clusterer to aeon for issue #2132 [ENH] Added R-Clustering clusterer to aeon #2132 Nov 22, 2024
@Ramana-Raja Ramana-Raja changed the title [ENH] Added R-Clustering clusterer to aeon #2132 [ENH] Added R-Clustering clusterer to aeon Nov 22, 2024
@TonyBagnall
Copy link
Contributor

hi, thanks for this but if we include this clusterer we want it to use our version of Rocket transformers which are optimised for numba

@Ramana-Raja
Copy link
Author

hi, thanks for this but if we include this clusterer we want it to use our version of Rocket transformers which are optimised for numba

sure, I will try to reimplement it and use aeon Rocket transformers

@Ramana-Raja
Copy link
Author

Ramana-Raja commented Dec 17, 2024

Hi @chrisholder, I discovered that the issue was caused by how self._random_state = check_random_state(self.random_state) was being handled. Removing it resolved the problem, though I'm not entirely sure why. Perhaps @MatthewMiddlehurst could provide some insights. Additionally, I removed the estimator as an input for the class, as the research paper only utilized KMeans

@chrisholder
Copy link
Contributor

chrisholder commented Dec 17, 2024

Looks good - Final thing before approving have you checked equivalence to the original. It's doesnt have to be completely 100% the same (due to random state). However, we should check for 10 or so datasets (which you can load from aeon.datasets) that the scores are similar.

This doesn't need to be an actual test in aeon but if you could run it locally and post the adjusted rand index using sklearn (https://scikit-learn.org/stable/modules/generated/sklearn.metrics.adjusted_rand_score.html) the we can check this version matches the original!

@Ramana-Raja
Copy link
Author

Ramana-Raja commented Dec 18, 2024

Looks good - Final thing before approving have you checked equivalence to the original. It's doesnt have to be completely 100% the same (due to random state). However, we should check for 10 or so datasets (which you can load from aeon.datasets) that the scores are similar.

This doesn't need to be an actual test in aeon but if you could run it locally and post the adjusted rand index using sklearn (https://scikit-learn.org/stable/modules/generated/sklearn.metrics.adjusted_rand_score.html) the we can check this version matches the original!

I tested the ARI scores between the this RCluster and the original RCluster on the experimental dataset provided in the original RCluster code. Here are the results:
ari_scores

Copy link
Member

@MatthewMiddlehurst MatthewMiddlehurst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not ready sorry.

Please add some code comments explaining the use of private functions from another estimator and the multiple PCAs if you can. Don't usually request it but it is pretty confusing as is.

Class attributes set in fit and fit_predict (self.) should start with _ (protected/private) or end with _ (public and should be documented in the docstring under Attributes)

aeon/clustering/feature_based/tests/test_r_cluster.py Outdated Show resolved Hide resolved
Comment on lines 483 to 484
"n_clusters": 8,
"random_state": 1,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't set these here

aeon/clustering/feature_based/_r_cluster.py Outdated Show resolved Hide resolved
aeon/clustering/feature_based/_r_cluster.py Outdated Show resolved Hide resolved
aeon/clustering/feature_based/_r_cluster.py Outdated Show resolved Hide resolved
aeon/clustering/feature_based/_r_cluster.py Outdated Show resolved Hide resolved
aeon/clustering/feature_based/_r_cluster.py Outdated Show resolved Hide resolved
aeon/clustering/feature_based/_r_cluster.py Outdated Show resolved Hide resolved
aeon/clustering/feature_based/_r_cluster.py Outdated Show resolved Hide resolved
aeon/clustering/feature_based/_r_cluster.py Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clustering Clustering package enhancement New feature, improvement request or other non-bug code enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants