docs: add a diagram-heavy developer guide for the research codebase#1
Open
levon003 wants to merge 1 commit into
Open
docs: add a diagram-heavy developer guide for the research codebase#1levon003 wants to merge 1 commit into
levon003 wants to merge 1 commit into
Conversation
Add a docs/ folder that documents the system at the architecture level
rather than the docstring level: how the pieces fit together, the
project-specific vocabulary, the streaming data-generation pipeline, the
model zoo and offline evaluation, and candid notes on what modern
practice would recommend.
- docs/README.md orientation + repo map + reading order
- docs/glossary.md USP / initiation / eligible-existing-active /
triple / coverage, with a state diagram
- docs/architecture.md whole-system overview, entry points, experiment
loop, package map (Mermaid)
- docs/data-pipeline.md the timestamp-ordered replay that produces
training triples and test contexts, plus the
async writer and feature dedup
- docs/modeling.md 1563-d feature vector, model zoo, training loop,
baselines, cached offline evaluation, sweeps
- docs/modernization.md consolidated "what would you do today" notes
All 14 Mermaid diagrams validated with the mermaid parser. Link the new
guide from the top-level README.
https://claude.ai/code/session_018fRrzqPsGMHL3roZ2E3gVq
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.
What
Adds a
docs/folder that documents HealthBlogRec at the architecture level rather than the docstring level — the goal being to make the choices, layout, and shortcomings of this 2021 research code easy to understand for someone reading the paper and the source side by side.Per the brief: fewer docstrings, more Mermaid diagrams in Markdown summaries, with candid notes throughout about what more modern approaches would recommend.
New files
docs/README.mddocs/glossary.mddocs/architecture.mddocs/data-pipeline.mddocs/modeling.mddocs/modernization.mdAlso links the guide from the top-level
README.md.Approach & accuracy
reccontext.py:165, theFIXME is this reasonable?cache resize, reconstructed amp timestamps, pointwise-BCE-vs-ranking-metrics mismatch).mermaidparser (with a JSDOM backend) — 0 parse failures.Docs-only change; no code is touched.
https://claude.ai/code/session_018fRrzqPsGMHL3roZ2E3gVq
Generated by Claude Code