Docs/readme structure - #116
Merged
Merged
Conversation
Replace the numbered sections with task-oriented ones, lead with the results dashboard, and move reference material into collapsed blocks. The benchmarking rationale is back at the top, and the intro follows the project abstract instead of narrowing the scope to historical documents. - fix the generate_date_report.py example, which passed a path where the script requires --date - add the missing HUGGINGFACE_API_KEY and the huggingface provider - restore the fork step for contributors - say ground truths throughout, not reference annotations - use bold labels rather than headings inside <details>, so the GitHub outline holds no entries that lead into collapsed content Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Replace the textbook definitions of F1, precision, recall and error rate with what a reader has to check before combining two numbers: whether it is a measurement, a count or a setting; which direction is better; and whether it aggregates at all. Each point names the case in the suite that shows it -- mean_iou beside iou_threshold, library_cards rebuilding micro F1 from summed counts, book_advert_xml recording fuzzy on 0-100 where every other benchmark uses 0-1. Drop the limitations section. Its one point that reads as description rather than caveat -- that a blank is a missing measurement and not a zero -- moves into the cost and runtime notes, and "Methodology and limitations" becomes "Methodology". Also fold the changelog's Fixed entries into the single Changed bullet and add the missing v0.5.5 release link. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The section argues for benchmarking in humanities research; its title promised a definition first. The nav entry already read "Why benchmark?", so the heading and the link that points at it now agree. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
1 participant
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.
clean up README structure