Skip to content

Conversation

@chrisholder
Copy link
Contributor

@chrisholder chrisholder commented Nov 20, 2025

Reference Issues/PRs

This PR relies on #3122

What does this implement/fix? Explain your changes.

This PR moves Soft-DTW to a new submodule of elastic distance "soft". This module will contain Soft-DTW and the coming soon other soft distances.

Specifically the changes are:

  • Removes the abs from Soft-DTW, negative values are meant to be return
  • Adds in alignment matrix and gradient functions that will be used in an upcoming barycentre averaging PR
  • Updates the tests to reflect these changes

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.

@aeon-actions-bot aeon-actions-bot bot added distances Distances package maintenance Continuous integration, unit testing & package distribution testing Testing related issue or pull request labels Nov 20, 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: [ maintenance ].
I have added the following labels to this PR based on the changes made: [ distances, testing ]. 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
  • Regenerate expected results for testing
  • Push an empty commit to re-run CI checks

# Skip for now
if dist["name"] in MIN_DISTANCES or dist["name"] in MP_DISTANCES:
if (
dist["name"] in MIN_DISTANCES
Copy link
Contributor Author

Choose a reason for hiding this comment

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

As a note because Soft-DTW can return negative values it won't work with any sklearn model. Therefore, I am skipping the tests in the file when using soft-dtw

if (
dist["name"] in MIN_DISTANCES
or dist["name"] in MP_DISTANCES
or dist["name"] in ["soft_dtw"]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Soft-DTW can be negative so just skipping this test for it

@chrisholder chrisholder added the no numba cache Disable numba cache loading on a PR label Nov 20, 2025
@chrisholder chrisholder mentioned this pull request Nov 20, 2025
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

distances Distances package maintenance Continuous integration, unit testing & package distribution no numba cache Disable numba cache loading on a PR testing Testing related issue or pull request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants