Skip to content

[MNT] Similarity search cleanup#3222

Draft
baraline wants to merge 4 commits intomainfrom
simsearch_revamp
Draft

[MNT] Similarity search cleanup#3222
baraline wants to merge 4 commits intomainfrom
simsearch_revamp

Conversation

@baraline
Copy link
Copy Markdown
Member

@baraline baraline commented Jan 3, 2026

Reference Issues/PRs

N/A

What does this implement/fix? Explain your changes.

Following the decisions made after #2473 and multiple discussions, this PR aims at clarifying the goal and interface of the similarity search module, notably by removing all components related to motif discovery, in order to not mix both intents even if they are related down the line.

This introduced a unique interface for all similarity search estimator, and focus on two use cases :

  • Similarity search with subsequences
  • Similarity search with whole series.

Both cases take as input a 3D array (a time series collection) during fit and a 2D array (a subsequence or a whole series) during predict. The predict function returns two arrays indexes, distances that contain the indexes of the matches in the collection as well as their distances to the 2D series.

The goal is to validate this structure to be able to move the module out of experimental in the near future.

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

No

Any other comments?

The code related to motif search has been deleted to simplify the intent and structure of the similarity search module. But a new motif search module would be a welcome addition later.

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
Copy link
Copy Markdown

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 examples Example notebook related maintenance Continuous integration, unit testing & package distribution similarity search Similarity search package testing Testing related issue or pull request labels Jan 3, 2026
@aeon-actions-bot
Copy link
Copy Markdown
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: [ examples, similarity search, 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

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

Labels

examples Example notebook related maintenance Continuous integration, unit testing & package distribution similarity search Similarity search package testing Testing related issue or pull request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant