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

Support k-NN radial search parameters in neural search #697

Merged
merged 6 commits into from
Apr 23, 2024

Conversation

junqiu-lei
Copy link
Member

@junqiu-lei junqiu-lei commented Apr 18, 2024

Description

Since radial search is supported in k-NN plugin recently, this PR allows neural search to have the ability to use radial search parameters, so finally it can be allowed to use one of k, min_score, max_distance for vector search.

Issues Resolved

Part of opensearch-project/k-NN#814

Benchmark in k-NN plugin

opensearch-project/k-NN#814 (comment)

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Commits are signed as per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@junqiu-lei junqiu-lei added Features Introduces a new unit of functionality that satisfies a requirement backport 2.x Label will add auto workflow to backport PR to 2.x branch v2.14.0 labels Apr 18, 2024
@junqiu-lei junqiu-lei self-assigned this Apr 18, 2024
@navneet1v
Copy link
Collaborator

@junqiu-lei please attach the link of the benchmarks you have done on k-NN for radial search in this PR description.

@junqiu-lei
Copy link
Member Author

@junqiu-lei please attach the link of the benchmarks you have done on k-NN for radial search in this PR description.

Yes, added in PR description.

@vibrantvarun
Copy link
Member

@junqiu-lei where will you be adding bwc tests? In K-nn or neural search?

@vibrantvarun
Copy link
Member

I think you can add one bwc test in the PR to ensure this does not break earlier versions.

@navneet1v
Copy link
Collaborator

I think you can add one bwc test in the PR to ensure this does not break earlier versions.

@junqiu-lei can we add a BWC test here.

CHANGELOG.md Outdated Show resolved Hide resolved
@junqiu-lei
Copy link
Member Author

bwc test added @navneet1v @vibrantvarun

@vibrantvarun
Copy link
Member

Looks good to me , Will wait @navneet1v comments to get resolved before approving.

@vibrantvarun
Copy link
Member

Hey @junqiu-lei BWC tests are failing because of your changes. I think you have to add a check to skip running versions bwc for this tests for particular versions.

if (ext.neural_search_bwc_version.startsWith("2.9") || ext.neural_search_bwc_version.startsWith("2.10") || ext.neural_search_bwc_version.startsWith("2.11") || ext.neural_search_bwc_version.startsWith("2.12")){

@junqiu-lei junqiu-lei force-pushed the radial-search-1 branch 2 times, most recently from 7b0a56d to 545178f Compare April 22, 2024 21:59
@junqiu-lei junqiu-lei force-pushed the radial-search-1 branch 2 times, most recently from 17c2e68 to c09945f Compare April 22, 2024 22:57
Signed-off-by: Junqiu Lei <[email protected]>
@junqiu-lei junqiu-lei merged commit 68cdbc9 into opensearch-project:main Apr 23, 2024
77 checks passed
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.x 2.x
# Navigate to the new working tree
cd .worktrees/backport-2.x
# Create a new branch
git switch --create backport/backport-697-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 68cdbc90c4fabd87ec8fecca4bdd753a55994107
# Push it to GitHub
git push --set-upstream origin backport/backport-697-to-2.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-697-to-2.x.

junqiu-lei added a commit to junqiu-lei/neural-search that referenced this pull request Apr 23, 2024
…oject#697)

* Support k-NN radial search parameters in neural search

Signed-off-by: Junqiu Lei <[email protected]>

(cherry picked from commit 68cdbc9)
Signed-off-by: Junqiu Lei <[email protected]>
junqiu-lei added a commit to junqiu-lei/neural-search that referenced this pull request Apr 24, 2024
…oject#697)

Signed-off-by: Junqiu Lei <[email protected]>

(cherry picked from commit 68cdbc9)
Signed-off-by: Junqiu Lei <[email protected]>
junqiu-lei added a commit that referenced this pull request Apr 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x Label will add auto workflow to backport PR to 2.x branch Features Introduces a new unit of functionality that satisfies a requirement v2.14.0
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants