Repository navigation
Document retrieval scoring with a worked cosine example - #10
Open
biggdawg320 wants to merge 1 commit into
Open
biggdawg320 wants to merge 1 commit into
biggdawg320 wants to merge 1 commit into
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
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.
Closes #7.
Adds a short worked example showing how title/body tokenization, normalized term frequencies, dot products and norms produce the retrieval scores. Covers ranking, the positive-score cutoff and the effect of
--k, with a link from the README.Validation on Windows / Python 3.10, installed with
pip install -e ".[dev]":python -m pytest -q: 8 passed (pytest 9.1.1).python -m notes_rag --mock "What is a git remote?": succeeds with citations.load_notesandretrieve; checked scores against3/sqrt(10)and1/sqrt(2), ordering,k=1and the zero-overlap query.git diff --check: passes.AI disclosure: prepared and checked using OpenAI Codex under the account owner’s direction. This is a documentation contribution; no runtime behavior changes.