Repository navigation
Rewrite the READMEs and toolkit docs in a plain maintainer voice - #100
Merged
Merged
Conversation
Removes emoji headings, slogan headings, bold-label bullet lists and filler across every README and docs page, merges duplicated sections, and fixes factual errors found while checking the text against the code (wrong script paths, a nonexistent clone branch and console command, stale model lists, int16 vs uint16 masks, scanner behavior, VQA smoke parse-rate gate). Updates the tracking metadata checksums for its README.
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.
Every README in the repository and all 19 toolkit docs pages, rewritten to read like a maintained open-source project rather than generated text: no emoji or slogan headings, prose instead of bold-label bullet lists, duplicated sections merged, nothing promotional. 48 files, about 1,150 lines shorter overall.
Checking the text against the code turned up real errors, now fixed:
data/mask_annotation: masks are uint16 (not int16); removed asam2/labels/folder the code never writes and the claim thatrpx_benchmarkreads this output directly.docker/depth-smoke: the clone command named a branch that does not exist.docker/vqa-smoke: stale "frozen" model list replaced by the paper's 12 configurations; server-specific paths generalized.tools/dataset/qa: every command pointed at a nonexistentrerun_check/path and omitted--repo-root.benchmark/templates/rpx_capture_wireframe: per-frame poses are.npz, therpx downloadconsole command does not exist, stale NeurIPS-era notes removed.dataset_hub: scanner skip behavior described correctly; added the undocumentedmock,prepare-egoandverifycommands;uploadcreates private repos unless--public.vqa_smoke/v1: the parse-rate gate only runs with--min-parse-rate.benchmark/README.mdanchor; T1–T6 commands no longer require--manifest, since the CLI downloads the data.tracking/metadata/text_initialization_v1/SHA256SUMSandmanifest_summary.jsonare updated for the new README hash (sha256sum -cpasses).Known issue, not fixed here:
benchmark/data/vqa_smoke/v1/manifest.jsonlpredates the box-only builder (36 rows, 16 without boxes) and needs regenerating from the Parquets;test_vqa_smoke.py:651skips because of it.Verification: strict docs build passes and the link check verifies 77,126 internal links and anchors; the docs T1 and T4 commands run end to end; the test suite has the same 5 failures as
main(Box token, TrackEval, two order-dependent tests) and no new ones.