Skip to content
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

Merged
merged 16 commits into from
Nov 17, 2023
Merged

Update readme #962

merged 16 commits into from
Nov 17, 2023

Conversation

nathanielsimard
Copy link
Member

@nathanielsimard nathanielsimard commented Nov 16, 2023

Copy link

codecov bot commented Nov 16, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (cb4c23b) 87.34% compared to head (0dde21c) 87.43%.
Report is 8 commits behind head on main.

❗ Current head 0dde21c differs from pull request most recent head 7cd64dc. Consider uploading reports for the commit 7cd64dc to get more accurate results

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.
📢 Have feedback on the report? Share it here.

@louisfd
Copy link
Member

louisfd commented Nov 16, 2023

❤️‍🔥

Copy link
Collaborator

@antimora antimora left a 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:

  1. 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.

  2. 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.

  3. 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.

  4. 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.

  5. 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.

  6. Replace the "🥵" emoji after "any backend" with "🔄."

  7. 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.

  8. 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.

  9. Add links from each Backend to a backends Readme files.

  10. Also add back the removed platform support matrix to these backend readme files, which is an important information and should not be lost.

@nathanielsimard @louisfd

@nathanielsimard nathanielsimard merged commit 8f1526b into main Nov 17, 2023
7 checks passed
@nathanielsimard nathanielsimard deleted the update-readme branch November 17, 2023 18:04
@crabdancing
Copy link

I highly recommend keeping the hot_face emoji. It's funny. xD

@louisfd
Copy link
Member

louisfd commented Nov 24, 2023

I thought so too 😆 I'll try to think of a more relevant spot for it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants