Repository navigation
Make the README concise and move details into docs - #61
Merged
Merged
Conversation
Cut the README from 974 to about 340 lines without changing its look. The demo GIF and interface screenshot now sit directly under the introduction. Detailed sections move verbatim into docs/results.md, docs/review_interface.md and docs/annotation_sets.md, and links from the model card, dataset card and annotation guidelines point there.
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/results.md: locked-test, new-set and dev results, ablations, error analysis, calibration, serving benchmarks and the metrics tabledocs/review_interface.md: the review UI, API endpoints, saved reviews, input limits and quantity normalizationdocs/annotation_sets.md: protocols.io collection, machine-label results and the annotation workflow commandsChecks