Rename vector float classes and methods #12105
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
…er#getVectorValues -> getFloatVectorValues
javanna
changed the title
jpountz
approved these changes
Jan 24, 2023
| @Deprecated | ||
| public VectorValues getVectorValues(String field) throws IOException { | ||
| return new FilterVectorValues(getFloatVectorValues(field)) {}; | ||
| } |
There was a problem hiding this comment.
I consider all codec APIs experimental by nature, let's only have this bw layer one layer above, on LeafReader?
javanna
added a commit
to javanna/lucene
that referenced
this pull request
Jan 24, 2023
We recently introduced KnnByteVectorField, KnnByteVectorQuery and ByteVectorValues. The corresponding float variants of the same classes don't follow the same naming convention: KnnVectorField, KnnVectoryQuery and VectorValues. Ideally their names would reflect that they are the float variant of the vector field, vector query and vector values. This commit aims at clarifying this in the public facing API, by deprecating the current float classes in favour of new ones that are their exact copy but follow the same naming conventions as the byte ones. As a result, LeafReader#getVectorValues is also deprecated in favour of newly introduced getFloatVectorValues method that returns FloatVectorValues. Relates to apache#11963
javanna
added a commit
that referenced
this pull request
Jan 24, 2023
We recently introduced KnnByteVectorField, KnnByteVectorQuery and ByteVectorValues. The corresponding float variants of the same classes don't follow the same naming convention: KnnVectorField, KnnVectoryQuery and VectorValues. Ideally their names would reflect that they are the float variant of the vector field, vector query and vector values. This commit aims at clarifying this in the public facing API, by deprecating the current float classes in favour of new ones that are their exact copy but follow the same naming conventions as the byte ones. As a result, LeafReader#getVectorValues is also deprecated in favour of newly introduced getFloatVectorValues method that returns FloatVectorValues. Relates to #11963
This was referenced Jan 24, 2023
javanna
added a commit
that referenced
this pull request
Jan 24, 2023
Follow-up of #12105 to remove the deprecated classes for the next major version. Removes KnnVectorField, KnnVectorQuery, VectorValues and LeafReader#getVectorValues.
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.
We recently introduced
KnnByteVectorField,KnnByteVectorQueryandByteVectorValues, the corresponding float variants of the same classes don't follow the same naming convention:KnnVectorField,KnnVectoryQueryandVectorValues. Ideally their names would reflect that they are the float variant of the vector field, vector query and vector values.This PR aims at clarifying this in the public facing API, by deprecating the current float classes in favour of new ones that are their exact copy but follow the same naming conventions as the byte ones.
As a result,
LeafReader#getVectorValuesis also deprecated in favour of newly introducedgetFloatVectorValuesmethod that returnsFloatVectorValues.I opened a single PR to gather feedback first. I can also split it up in multiple PRs if we want to move forward in this direction.
Relates to #11963