Generalize lib interface to return context objects #1925
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jmazanec15
added
Refactoring
jmazanec15
requested review from
heemin32,
navneet1v,
VijayanB,
vamshin,
naveentatikonda,
junqiu-lei,
martin-gaievski,
ryanbogan and
luyuncheng
as code owners
Generalizes the KNNLibrary to return an object for both search and indexing so that the plugin can search/index against them. This will help properly pass information that does not need to be sent to the JNI for search and index builds. Signed-off-by: John Mazanec <[email protected]>
jmazanec15
force-pushed
the
method-stage
branch
from
c86d139 to
00002b3
Compare
naveentatikonda
previously approved these changes
Aug 2, 2024
|
How about |
heemin32
previously approved these changes
Aug 2, 2024
heemin32
reviewed
Aug 2, 2024
| @@ -14,7 +14,7 @@ | |||
| /** | |||
| * Default HNSW context for all engines. Have a different implementation if engine context differs. | |||
| */ | |||
| public final class DefaultHnswContext implements EngineSpecificMethodContext { | |||
| public final class DefaultHnswContext implements KNNLibrarySearchContext { | |||
There was a problem hiding this comment.
Maybe DefaultHnswSearchContext?
heemin32
reviewed
Aug 2, 2024
| @@ -11,7 +11,7 @@ | |||
|
|
|||
| import java.util.Map; | |||
|
|
|||
| public final class DefaultIVFContext implements EngineSpecificMethodContext { | |||
| public final class DefaultIVFContext implements KNNLibrarySearchContext { | |||
There was a problem hiding this comment.
Maybe DefaultIVFSearchContext?
heemin32
reviewed
Aug 2, 2024
| import org.opensearch.knn.index.engine.Parameter; | ||
| import org.opensearch.knn.index.engine.model.QueryContext; | ||
| import org.opensearch.knn.index.query.request.MethodParameter; | ||
|
|
||
| import java.util.Collections; | ||
| import java.util.Map; | ||
|
|
||
| public class LuceneHNSWContext implements EngineSpecificMethodContext { | ||
| public class LuceneHNSWContext implements KNNLibrarySearchContext { |
jmazanec15
dismissed stale reviews from heemin32 and naveentatikonda
via
6ce13f2
|
Addressed @heemin32 ! |
heemin32
reviewed
Aug 2, 2024
| * Simple implementation of {@link KNNLibraryIndexBuildContext} | ||
| */ | ||
| @Builder | ||
| public class KNNLibraryIndexBuildContextImpl implements KNNLibraryIndexBuildContext { |
There was a problem hiding this comment.
Suggested change
| public class KNNLibraryIndexBuildContextImpl implements KNNLibraryIndexBuildContext { | |
| public class KNNLibraryIndexingContextImpl implements KNNLibraryIndexingContext { |
jmazanec15
force-pushed
the
method-stage
branch
from
6ce13f2 to
2a696b4
Compare
Signed-off-by: John Mazanec <[email protected]>
jmazanec15
force-pushed
the
method-stage
branch
from
2a696b4 to
2149099
Compare
naveentatikonda
approved these changes
Aug 2, 2024
junqiu-lei
approved these changes
Aug 2, 2024
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Aug 2, 2024
Generalizes the KNNLibrary to return an object for both search and indexing so that the plugin can search/index against them. This will help properly pass information that does not need to be sent to the JNI for search and index builds. Signed-off-by: John Mazanec <[email protected]> (cherry picked from commit a16b8aa)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Generalizes the KNNLibrary interface to return an object for both search and indexing so that the plugin can search/index against them. The names of the methods are "getKNNLibraryIndexBuildContext" and "getKNNLibrarySearchContext". In the future, I could see these methods changing into something like getKNNLibraryIndexBuilder and getKNNLibrarySearcher so that the engine actually encapsulates the interactions with the libraries, but that needs some more thought. For now, this change makes it more clear what one of the central roles of the KNNLibrary interface is - telling the plugin how to index/search.
For the quantization framework, making the interface return objects will allow us to properly configure both quantization as well as whatever index we want to use with it. See the following locations for more details where we would do this:
Again, no functionality change - just more refactoring to better support the quantization framework.
One thing I have realized from these changes is that he KNNMethodContext class needs to be sured-up a bit to be more robust. I will create a separate issue for this.
Check List
--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.