docs: README overhaul — GIF, mermaid diagrams, focused split - #15
Merged
Conversation
…ed docs - docs/assets/demo.gif: REAL recorded session (VHS; tape + script included for reproduction): pip install turboloader, then 5 epochs over 9,469 real ImageNet JPEGs at ~52-60k img/s with train_aug on an M4 Max. 250KB. - Three mermaid diagrams (GitHub-native rendering, validated with mermaid-cli): fused fast-path pipeline, which-loader decision tree (default path highlighted; full table kept in a <details>), architecture overview (replaces the ASCII art). - README 597 -> ~215 lines. Moved out verbatim: Transform Library -> docs/transforms.md, TBL v2 -> docs/tbl_v2_format.md, full Benchmarks (incl. GPU sections + implementation notes) -> docs/benchmarks/index.md, Beyond Images -> docs/tokens_arrays.md. README keeps one headline benchmark table with the honest-notes paragraph and links everywhere else. - examples/quickstart_demo.py = the exact script the GIF runs. - Fixed stale citation version (2.25.0 -> year-only); all relative links verified programmatically.
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.
reproduction): pip install turboloader, then 5 epochs over 9,469 real
ImageNet JPEGs at ~52-60k img/s with train_aug on an M4 Max. 250KB.
fused fast-path pipeline, which-loader decision tree (default path
highlighted; full table kept in a
Details
), architecture overview(replaces the ASCII art).
docs/transforms.md, TBL v2 -> docs/tbl_v2_format.md, full Benchmarks (incl.
GPU sections + implementation notes) -> docs/benchmarks/index.md, Beyond
Images -> docs/tokens_arrays.md. README keeps one headline benchmark table
with the honest-notes paragraph and links everywhere else.
verified programmatically.