Fixed Typos and Clarifying Concepts on Semantic Cache Notebook #75
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
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
merveenoyan
reviewed
Apr 19, 2024
| " self.index.nprobe = 8\n", | ||
| " self.index.nprobe = 8 # Number of nearby cells to search\n", | ||
| "\n", | ||
| " # D - Array of Distances between the query vector and nearest neighbors\n", |
There was a problem hiding this comment.
repetitive comments here breaks readability of the code sometimes, would be nice to instead have a docstring
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.
Hello, first time contributor here!
What does this PR do?
I was working through this great notebook and noticed a typo along with some areas that I felt needed clarifying in the code. The changes were mostly comments and a typo.
I fixed the "thresold" to "threshold" typo inside the
semantic_cacheclass.In the
semantic_cacheclass, I tried to reduce the ambiguity of the code by adding a few clarifying comments since the class was the central point of the notebook. These additions aim to assist first-time readers in understanding the FAISS implementation.These changes include adding clarification on:
DandIarrays that were returned fromindex.search()nprobeI didn't want to overcomplicate the explanations as the contribution guide says, but I did want to give context that I thought could help a reader out.
Who can review?
@MKhalusova I would appreciate the review!