Repository navigation
README rewrite: a flagship project page (style sample, do not merge yet) - #2
Merged
Merged
Conversation
added 3 commits
November 12, 2026 07:15
Lead with a one-line promise, the demo, and the measured results (60 of 61 fields correct on seven synthetic samples). Add a problem scenario, a pipeline diagram, a before/after visual, a methodology line, and a short Notes section. Backends move into a details block. Evaluation record is in docs/eval.md. Social-preview artwork is in assets/social.png (needs the GitHub Settings UI to set).
"Imagine" already frames the scenario; the next sentence can start on the useful result.
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.
Style sample for Chief review. Do not merge until Yuxin approves.
Rewrites the README as a business card: a one-line promise, the demo GIF, measured results (60 of 61 fields correct, 60/60 sourced, 9.0–22.1 s per document on an 8-core CPU), a concrete problem scenario, a pipeline diagram, a before/after visual, methodology, and a short Notes section. Backends are in a
<details>block.Numbers come from a re-run of
scripts/evaluate.pyon 12 November 2026 (Hugging Face backend, Qwen2.5-1.5B-Instruct, 8-core CPU). The record is indocs/eval.md. API-backend numbers are from the earlier v1 eval on the same machine.assets/social.png(1280×640) is the social-preview image. GitHub has no API for setting the repository social preview; it needs the Settings UI (Settings → General → Social preview).Same rules as before: no personal names, no invented clients, Modelshifts identity, synthetic data only.