Repository navigation
Rewrite the README as a README - #69
Merged
Merged
Conversation
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.
What this changes
The README is a README again what it means? Well iit was looking like a docs before but now our project published to cargo and have a official docs so we can make README as a README again MRGA (Make README Great Again): a centered header with the tagline, badges and links, a Highlights list, installation, quick start, the examples table, the architecture diagram under "How it fits together", what is inside, platform support with the CUDA build notes, a short testing section, limitations, contributing and license. 390 lines down to 239.
Why
It had grown into a second manual. The docs.rs crate page now walks through models, training, data, checkpoints, the GPU, generation and debugging, so the README can do its own job and point there.
How it was verified
cargo testpassescargo clippy --all-targets -- -D warningsis cleancuda_parityon a GPU--releaseDocs only. Every relative link resolves, the quick start is the snippet that compiles as a doctest in the crate docs, and
cargo packageincludes the README andassets/architecture.svg. Rendered on GitHub to check the header and the diagram.Checklist
tensor/opsandautograd/opsstill mirror each other///docs