relax faiss type dependency as its optional; breaking when faiss is not installed #200
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR relaxes the dependency on faiss by making the similarity_metric parameter optional so that the library can be used without installing the faiss-cpu dependency.
- Updated several constructors in faiss_search.py to accept an optional similarity_metric argument.
- Added conditional assignments for similarity_metric in most constructors to default to faiss.METRIC_INNER_PRODUCT when None is provided.
- In one constructor (the one with quantizer_type), the assignment for similarity_metric was removed, which may lead to an uninitialized attribute.
| if similarity_metric is None: | ||
| self.similarity_metric = faiss.METRIC_INNER_PRODUCT | ||
| else: | ||
| self.similarity_metric = similarity_metric |
There was a problem hiding this comment.
The constructor with quantizer_type no longer assigns the similarity_metric argument, unlike the other constructors. Consider adding the conditional assignment (if similarity_metric is None then assign faiss.METRIC_INNER_PRODUCT) to ensure similarity_metric is consistently initialized.
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.
Solves the issue stated in #198. Allows direct usage without installing the faiss-cpu dependency.