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.

Sign up for GitHub

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

Jump to bottom

[ENH] Implemented Tracking differentiator-based multiview dilated characteristics (TD-MVDC) Classifier #2535

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

[ENH] Implemented Tracking differentiator-based multiview dilated characteristics (TD-MVDC) Classifier #2535

wants to merge 20 commits into from

Conversation

lucifer4073
Copy link
Contributor

Reference Issues/PRs

Closes #2081.

What does this implement/fix? Explain your changes.

This PR implements the TDMVDC classifier.

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

No

Any other comments?

Currently using the TSFreshRelevant feature extractor for feature extraction. I have tried implementing a similar module (for feature extraction) dedicated for tdmvdc itself (doesn't give great results).

Accuracy as per paper: 81.14 per cent
Obtained accuracy: 77.71 per cent

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.

@review-notebook-app Review Notebook App
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 classification Classification package enhancement New feature, improvement request or other non-bug code enhancement examples Example notebook related transformations Transformations package labels Feb 12, 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{#BCAE15}{\textsf{classification}}$, $\color{#45FD64}{\textsf{examples}}$, $\color{#41A8F6}{\textsf{transformations}}$ ]. 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

@lucifer4073
Copy link
Contributor Author

@CCHe64 this is the current implementation of the classifier. Other tasks such as testing and multithreading needs to be added. Will do that once the accuracy discrepancy is resolved.

@lucifer4073 lucifer4073 marked this pull request as ready for review February 12, 2025 12:42
@lucifer4073 lucifer4073 marked this pull request as draft February 12, 2025 12:42
@CCHe64
Copy link

CCHe64 commented Feb 12, 2025

@CCHe64 this is the current implementation of the classifier. Other tasks such as testing and multithreading needs to be added. Will do that once the accuracy discrepancy is resolved.

Is tsfreshrelevant used now? The original paper used 777 full feature versions of tsfresh. Is the accuracy difference because of this?

@lucifer4073 lucifer4073 marked this pull request as ready for review March 11, 2025 15:21
@lucifer4073
Copy link
Contributor Author

Hi @MatthewMiddlehurst @TonyBagnall @CCHe64 ,

This is the current working implementation of TDMVDC. Further additions would be needed in test coverage and multithreading, which I would like to put up in another PR, once this is merged.

Let me know you reviews.

Thanks!

MatthewMiddlehurst
MatthewMiddlehurst requested changes Mar 23, 2025
View reviewed changes
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.

I have had a quick look, not really at any of the estimator code itself. Still a few comments for now.

Do you have an implementation or publication results you can compare against your implementation against? Was this code inspired by any other implementations?

aeon/classification/feature_based/_tdmvdc.py
"""
Tracking Differentiator-based Multiview Dilated Characteristics.

for Time Series Classification.
Copy link
Member

Choose a reason for hiding this comment

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

This needs an extended description. See the documentation developer guide.

aeon/classification/feature_based/_tdmvdc.py
@@ -0,0 +1,274 @@
import numpy as np
Copy link
Member

Choose a reason for hiding this comment

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

Include documentation at the top of the file.

aeon/classification/feature_based/_tdmvdc.py
k2=2,
feature_store_ratios=None,
n_jobs=1,
): # Remove **kwargs from parameters
Copy link
Member

Choose a reason for hiding this comment

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

Why is this comment here?

aeon/classification/feature_based/_tdmvdc.py

super().__init__()

def _fit(self, trainSignalX, trainY):
Copy link
Member

Choose a reason for hiding this comment

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

Please just use X and y like other estimators.

aeon/classification/feature_based/_tdmvdc.py
self.clfList.append(clf) # Saving the trained classifier
return self

def _predict(self, testSignalX):
Copy link
Member

Choose a reason for hiding this comment

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

Same here.

aeon/classification/feature_based/tests/test_tdmvdc.py Outdated
Copy link
Member

Choose a reason for hiding this comment

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

This is not sufficient testing.

aeon/transformations/collection/feature_based/_tdmvdc_extractor.py Outdated
Copy link
Member

Choose a reason for hiding this comment

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

This module is for transformer classes only. If this does not fit as a transformer, it can be private functions in the classifier file.

MatthewMiddlehurst
MatthewMiddlehurst reviewed Mar 23, 2025
View reviewed changes
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.

It is unlikely we will merge this if it does not achieve similar results to the original.

@lucifer4073
Copy link
Contributor Author

It is unlikely we will merge this if it does not achieve similar results to the original.

Hi,

I have tested this of it on the load_arrow head dataset and it achieves the same accuracy as the paper.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MatthewMiddlehurst MatthewMiddlehurst MatthewMiddlehurst requested changes

@TonyBagnall TonyBagnall Awaiting requested review from TonyBagnall TonyBagnall is a code owner

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
classification Classification package enhancement New feature, improvement request or other non-bug code enhancement examples Example notebook related transformations Transformations package
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[ENH] Implement the feature-based TD-MVDC classification algorithm
3 participants
@lucifer4073 @CCHe64 @MatthewMiddlehurst