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

adds examples for querysearch #2472

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

naxatra2
Copy link

Adds #1806
I have added some examples in the docstring for query search

@naxatra2 naxatra2 requested a review from baraline as a code owner December 26, 2024 16:46
@aeon-actions-bot aeon-actions-bot bot added the similarity search Similarity search package label Dec 26, 2024
@aeon-actions-bot
Copy link
Contributor

Thank you for contributing to aeon

I did not find any labels to add based on the title. Please add the [ENH], [MNT], [BUG], [DOC], [REF], [DEP] and/or [GOV] tags to your pull requests titles. For now you can add the labels manually.
I have added the following labels to this PR based on the changes made: [ $\color{#006b75}{\textsf{similarity search}}$ ]. 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

@baraline
Copy link
Member

baraline commented Dec 26, 2024

Hi ! Thanks for being willing to contribute to aeon.

That's totally due to a lack of communication from me, but this module is being reworked, and I didn't update the issues to reflect that. I've put up PR #2473 to reflect the upcoming changes. Additionally, I think the example you created is using an argument (distance) that we deprecated recently, but there might be traces of it in the documentation still, hence causing the confusion.

There will be similar things to do as you did here once #2473 is in, so what I can propose to you is that we close this one, and let the examples to be done so you can contribute. Otherwise, I'm sure there is other things that we could use right now, don't hesitate to chat on slack !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
similarity search Similarity search package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants