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 test cases for feature based clustering #2690

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

Conversation

Ramana-Raja
Copy link

Reference Issues/PRs

What does this implement/fix? Explain your changes.

Added test cases for feature based clustering

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.

@Ramana-Raja Ramana-Raja changed the title Added test cases for feature based clustering [ENH] Added test cases for feature based clustering Mar 24, 2025
@aeon-actions-bot aeon-actions-bot bot added clustering Clustering package enhancement New feature, improvement request or other non-bug code enhancement labels Mar 24, 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{#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 and others added 8 commits March 24, 2025 19:32
…tering' into test_case_for_feature_based_clustering
…tering' into test_case_for_feature_based_clustering

# Conflicts:
#	aeon/clustering/feature_based/tests/test_catch22.py
#	aeon/clustering/feature_based/tests/test_summary.py
#	aeon/clustering/feature_based/tests/test_tsfresh.py
@MatthewMiddlehurst MatthewMiddlehurst added the codecov actions Run the codecov action on a PR label Mar 24, 2025
@MatthewMiddlehurst
Copy link
Member

Hi, this does not seem to add much that the general testing does not test. It would be better to add any expected results to the testing/ utilities. Cases which are not covered by the general testing are ususally parameters or other model specific functionality. I would check out coverage report to see if there are any uncovered bits.

Ramana-Raja and others added 8 commits March 27, 2025 20:45
Ramana-Raja and others added 4 commits March 27, 2025 21:28
@Ramana-Raja
Copy link
Author

Ramana-Raja commented Mar 27, 2025

Hi, this does not seem to add much that the general testing does not test. It would be better to add any expected results to the testing/ utilities. Cases which are not covered by the general testing are ususally parameters or other model specific functionality. I would check out coverage report to see if there are any uncovered bits.

Hi, I added extra test cases and made sure they cover 80%+ of the code (except for cases where an estimator is passed), here’s what the tests check:

1.Whether the ARI scores are correct
2.If the output length matches the input length
3.Both Catch22 and Catch24 are tested(using catch24=False)
4.The summary clusterer with all summary stats
5.The TSFresh clusterer with all fc_parameters.
6.That there are no NaN values in the output(when summary clusterer uses all summary stat and when TSFresh clusterer uses all fc parameters) .

Let me know if this is fine or if I should add more.I will use this as a reference for the other 2 PR if it is

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.

Some of these are unnecessarily costly. consider users smaller data.
image

@Ramana-Raja
Copy link
Author

Ramana-Raja commented Apr 4, 2025

Some of these are unnecessarily costly. consider users smaller data. image

I have reduced the dataset size and removed functions/test cases that are already covered by general tests.

The testing covers the following cases:
1.catch22 is being tested with catch24 set to false
2.Testing with all summary stats for both univariate and multivariate cases for the Summary Clusterer
3.Testing with all FC parameters for both univariate and multivariate cases for the TSFresh Clusterer

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clustering Clustering package codecov actions Run the codecov action on a PR enhancement New feature, improvement request or other non-bug code enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants