Repository navigation
docs: replace the sweep chart with the run's dashboard - #579
Conversation
The parameter sweep case shipped a two-panel matplotlib plot. The run also produced a dashboard, and it carries what the plot could only assert: the sixteen measured cells as a grid with recall and latency in each, the best cell ringed at top_k 10 and chunk_size 1024, and a footnote naming the one warm-up sample behind the 256/top_k=3 outlier. Its alt text describes that grid instead of the two lines. The dashboard was authored in Chinese. Both front pages share one image and the comparison board beside it is English, so this is the English render, built the same way that board was, with the Chinese original left untouched. At 2000x1568 it sits almost exactly on the board's 2000x1547, so the pair holds level with the board back at full width and the dashboard at 99 percent, rather than the 86 percent the board needed against the old plot. Co-authored-by: Claude (claude-opus-5) <noreply@anthropic.com>
gloryfromca
left a comment
There was a problem hiding this comment.
No blockers; this can merge as far as I am concerned.
I reviewed the complete github/main...HEAD diff, the surrounding bilingual showcase markup, the history of this section, and the current PR record. I also covered the repository rules in AGENTS.md/CLAUDE.md and CONTEXT-MAP.md, compatibility and consumers, test integrity, and architecture constraints. This is a documentation-only replacement, so there are no runtime callers, backward-compatibility effects, weakened tests, or architecture-boundary changes.
The new GitHub attachment resolves as a 2000x1568 PNG (538,929 bytes). I inspected it directly: its 16-cell grid, broadly flat latency, and highlighted top_k = 10, chunk_size = 1024 best cell agree with the alt text. Its dimensions closely match the neighboring 2000x1547 board, so the 100%/99% sizing keeps the row balanced.
Verification passed:
git diff --check github/main...HEADscripts/check_large_files.py github/main..HEADscripts/check_source_language.py github/main..HEADscripts/check_commit_messages.py github/main..HEADscripts/check_pr_title.py
The repository's GitHub checks were passing except for one unit-test shard still pending when reviewed; the docs build and repository-file checks had passed. The full local test suite was not rerun because the change is limited to external image links and README markup.
|
Not a blocker. Reviewed by hand. The swap is clean and both front pages The width arithmetic in the commit message checks out. Measured from the PNG I also opened the image rather than trusting the alt text, and every claim in it One thing the image says that its own data does not support: "BEST CELL ... recall 1.000, latency 44.3 ms (lowest in the grid)". The grid The same subset shows up a second time: the colour scale under the grid runs Small, and the substantive conclusions above it are all correct -- recall is set |
Summary
The parameter sweep case shipped a two-panel matplotlib plot. The same run
also produced a dashboard, and it carries what the plot could only assert:
the sixteen measured cells as a grid with recall and latency in each, the
best cell ringed at top_k 10 and chunk_size 1024, and a footnote naming the
single warm-up sample behind the 256/top_k=3 outlier. This swaps the plot
for the dashboard and rewrites the alt text to describe that grid rather
than the two lines.
Language. The dashboard was authored in Chinese. Both front pages share
one image set, and the comparison board beside this cell is already English,
as is the alt text on both pages, so what lands is an English render built
the same way that board was. The Chinese original is left untouched on disk
and nothing in the repository refers to it.
Widths. The new render is 2000x1568 against the board's 2000x1547, so
the two sit almost exactly on one aspect. The board goes back to full width
and the dashboard takes 99 percent; the board only needed 86 percent against
the old plot's 2000x1332.
Type
Verification
The attachment was fetched anonymously before it was referenced: HTTP 200,
2000x1568, md5 fcd434b3000cbcda9339e98c22bf974b, matching the local render
byte for byte.
Rendered the section through GitHub's markdown endpoint under the published
markdown stylesheet and measured every image box. All eight pairs share a
top edge and match within 2px on height; the Frameworks pair is now 379x293
against 375x294, where before this change it was 326x252 against 375x294.
Both front pages were compared after the edit: each carries the identical
set of attachment ids, and neither still references the old plot.
No test suite is relevant to a change that edits two markdown files. The
python lint job was not run locally for the same reason; CI runs it on the
head.
Risk
Documentation only, in both READMEs. One attachment reference is replaced
and one width attribute is restored; no file is committed to the repository.
The old plot remains reachable at its own attachment URL, so a revert of the
commit restores it with no other action.
Related Issues
Follows #555.