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] Adds kdtw kernel support for kernelkmeans #2645

Merged
merged 10 commits into from
Mar 19, 2025

Conversation

tanishy7777
Copy link
Contributor

Reference Issues/PRs

Fixes #1728

What does this implement/fix? Explain your changes.

Adds support for Kdtw Kernel for KernelKmeans Clustering as implemented in https://github.com/pfmarteau/KDTW/tree/master and also the tests for the same

Changes and Explaination:
In the _fit method of TimeSeriesKernelKMeans before initializing the TsLearnKernelKMeans object we check if
self.kernel is equal to "kdtw" if thats the case we pass a callable function to self.kernel

def _fit(self, X, y=None):
    from tslearn.clustering import KernelKMeans as TsLearnKernelKMeans
    verbose = 0
    if self.verbose is True:
        verbose = 1
    
+   if self.kernel == "kdtw":
+     self.kernel = factory_kdtw_kernel(d=X.shape[1])
    
    self._tslearn_kernel_k_means = TsLearnKernelKMeans(
        n_clusters=self.n_clusters,
        kernel=self.kernel,
        max_iter=self.max_iter,
        tol=self.tol,
        n_init=self.n_init,
        kernel_params=self.kernel_params,
        n_jobs=self.n_jobs,
        verbose=verbose,
        random_state=self.random_state,
    )
   
    # further code

Apart from this we add 3 functions _kdtw_lk, kdtw and factory_kdtw_kernel

factory_kdtw_kernel: This returns a callable kdtw kernel function that unflattens the
inputs x and y which are univariate time series of dimension (n_timepoints*n_channels,)

kdtw: This is the kernel function for kdtw it needs the input x and y to be of dimension
(n_timepoints, n_channels,)

Tests are also added

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

Any other comments?

Tests need to be added, but implementation is complete

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.

@aeon-actions-bot aeon-actions-bot bot added clustering Clustering package enhancement New feature, improvement request or other non-bug code enhancement labels Mar 18, 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

Copy link
Contributor

@chrisholder chrisholder left a comment

Choose a reason for hiding this comment

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

Another great addition thanks!

@chrisholder chrisholder merged commit c1c830b into aeon-toolkit:main Mar 19, 2025
16 checks passed
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.

[ENH] Add KDTW kernel to be used with kernelKmeans algorithm for time series clustering
2 participants