docs(architecture): explain RAG design decisions#1
Merged
Conversation
…neric RAGs Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Collaborator
Author
|
Following up on a question by Shlok Vaibhav on Zulip, I've added a more detailed explanation of what we do and why we made certain design choices for the RAG system in physlibsearch |
5 tasks
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.
Summary
docs/architecture.mdexplaining why the RAG pipeline is shaped the way it is, prompted by an external question asking how the architecture was arrived at (and why it differs from generic notes-RAGs like gbrain).Test plan
docs/architecture.md(VS Code preview or on GitHub) and verify heading hierarchy, code-block formatting, and the comparison table.../database/vector_db.py, etc.) resolve on the GitHub view.database/vector_db.py:43— hybrid embedding-input stringdatabase/informalize.py— ±2 neighbours + dependency contextdatabase/embedding.py—RETRIEVAL_DOCUMENTvsRETRIEVAL_QUERY🤖 Generated with Claude Code