aeon
aeon copied to clipboard
[ENH] Implement K-Shape clusterer
Reference Issues/PRs
Fix https://github.com/aeon-toolkit/aeon/issues/2661
What does this implement/fix? Explain your changes.
Implements the K-shape clutterer in Aeon instead of wrapping the tslearn clusterer
Implentation References:
- https://github.com/tslearn-team/tslearn/blob/9937946/tslearn/clustering/kshape.py#L21-L291
- https://github.com/TheDatumOrg/kshape-python
Does your contribution introduce a new dependency? If yes, which one?
Currently this implementation uses tslearn's cdist_normalized_cc and normalized_cc.
But this is because the sbd_distance implementation we have slightly differs from tslearns implementation
see #2674
Any other comments?
PR checklist
For all contributions
- [x] 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.
- [x] 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.
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-commitchecks for all files - [ ] Run
mypytypecheck tests - [ ] Run all
pytesttests and configurations - [ ] Run all notebook example tests
- [ ] Run numba-disabled
codecovtests - [ ] Stop automatic
pre-commitfixes (always disabled for drafts) - [ ] Disable numba cache loading
- [ ] Push an empty commit to re-run CI checks
Hi sorry this took so long, mainly due to the SBD issue I think,
To be honest this is too similar to the tslearn implementation for me to be comfortable merging it. Some functions are lifted straight from there with minor changes at most.
Due to the time since this was put up, I am going to close this for now, but feel free to comment here if you disagree or want to continue.