Repository navigation
Fix the README examples and plain up the description - #63
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
README examples now compile as written, the stale bits are gone, and the crate description is plainer: "A small deep learning library in Rust with optional CUDA kernels".
Why
I compiled every snippet in the README before the first publish. Three were wrong:
?outside a function, so it is wrapped inmainnowscopedwithout importing it (fastnn::nn::module::scoped)fastnn_cuda_softpluskernel that does not exist, so it showssqrtas it is in the codeAlso drops the Hacktoberfest paragraph (the README ships to crates.io and will go stale), adds a note that 0.x can still change, mentions
stubs.cin the layout, and removes the "CUDA 13 runtime" claim I could not back up.How it was verified
cargo testpassescargo clippy --all-targets -- -D warningsis cleancuda_parityon a GPU--releaseDocs only, plus the
descriptionline inCargo.toml.cargo packagestill builds.Checklist
tensor/opsandautograd/opsstill mirror each other///docs