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

Added k-nn user guide and samples. #449

Merged
merged 4 commits into from
Jul 26, 2023

Conversation

dblock
Copy link
Member

@dblock dblock commented Jul 24, 2023

Description

Added k-nn user guide and samples.

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.

@codecov
Copy link

codecov bot commented Jul 24, 2023

Codecov Report

Merging #449 (59cbe84) into main (58217d9) will increase coverage by 0.06%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #449      +/-   ##
==========================================
+ Coverage   71.42%   71.49%   +0.06%     
==========================================
  Files          81       81              
  Lines        7668     7668              
==========================================
+ Hits         5477     5482       +5     
+ Misses       2191     2186       -5     

see 1 file with indirect coverage changes

@dblock
Copy link
Member Author

dblock commented Jul 24, 2023

@vamshin ++ take a look pls?

Signed-off-by: dblock <dblock@amazon.com>
Signed-off-by: dblock <dblock@amazon.com>
}
}

results = client.search(index=index_name, body=search_query)

Choose a reason for hiding this comment

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

can we add that if we disable the _source field than it helps in reducing the latency of the search.

Copy link
Member Author

Choose a reason for hiding this comment

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

we could, but feels like that's a very narrow use-case where I don't actually have any additional data and only want the ID, no?

Choose a reason for hiding this comment

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

I would say we can have section which is how to use the api in production for best performance. Hence I was thinking we should mention it. Reason is this is very valid for k-NN.

guides/plugins/knn.md Outdated Show resolved Hide resolved
Signed-off-by: dblock <dblock@amazon.com>
Copy link
Member

@vamshin vamshin left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks

Copy link
Contributor

@Xtansia Xtansia left a comment

Choose a reason for hiding this comment

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

Just a minor issue of a missed rename about lucene filter vs efficient filter.

guides/plugins/knn.md Outdated Show resolved Hide resolved
Signed-off-by: Vacha Shah <vachshah@amazon.com>
@VachaShah VachaShah merged commit f54973e into opensearch-project:main Jul 26, 2023
50 checks passed
@dblock dblock deleted the knn-samples branch July 26, 2023 14:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants