-
Notifications
You must be signed in to change notification settings - Fork 469
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update readme #962
Update readme #962
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #962 +/- ##
==========================================
+ Coverage 87.34% 87.43% +0.08%
==========================================
Files 493 502 +9
Lines 50127 50967 +840
==========================================
+ Hits 43783 44562 +779
- Misses 6344 6405 +61 ☔ View full report in Codecov by Sentry. |
❤️🔥 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Love the new updates. This README file is doing exactly what it's supposed to do: serve as a landing page for new users!
However, I highly recommend considering the following changes:
-
Consider shortening the "Automatic kernel fusion 💥" subsection by removing the large chunk of code. When I first opened it, I felt overwhelmed and worried that subsequent sections might be equally extensive and complex. This information could be relocated elsewhere for users interested in learning more.
-
It may not be immediately clear that subsections are expandable. Perhaps add a note at the top indicating that users should click to expand. Otherwise, they might appear to be just bullet points.
-
I suggest replacing the "🧨" (explosive) emoji after "Asynchronous Execution" with a "🐇" (rabbit) emoji. The "🧨" feels a bit intense, especially considering current global events involving violence.
-
Consider prefacing "plugins" with "swappable" in the phrase "backends as plugins," and bolding both words. This emphasizes the ease of swapping backends. Recently, someone mentioned on Discord that this was a decisive factor in choosing Burn, so highlighting this feature is important.
-
After WGPU, add "WebGPU API" in parentheses. Not everyone knows that WGPU is an implementation of WebGPU APIs. Keep in mind that people landing on this README might be new to Rust and unfamiliar with WGPU.
-
Replace the "🥵" emoji after "any backend" with "🔄."
-
I think "Training & Inference" should be moved to the top and expanded upon. This section doesn't fully emphasize how central these two components are. Burn was built from the ground up with training in mind. It's also worth noting how Burn, in comparison to frameworks like PyTorch, simplifies the transition from training to deployment, eliminating the need for code changes.
-
Add a "no-std" subsection (under training/inference) to clarify that the core parts of Burn are "no-std" compatible and enjoy first-class support.
-
Add links from each Backend to a backends Readme files.
-
Also add back the removed platform support matrix to these backend readme files, which is an important information and should not be lost.
I highly recommend keeping the hot_face emoji. It's funny. xD |
I thought so too 😆 I'll try to think of a more relevant spot for it |
Rendered link: https://github.com/burn-rs/burn/tree/update-readme