-
Notifications
You must be signed in to change notification settings - Fork 1
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 #98
Merged
Merged
Update README #98
Conversation
This file contains 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
Reviewer's Guide by SourceryThis pull request primarily updates the README.md file to provide a more comprehensive introduction to the BrainUnit library. It includes a motivation section, a features overview, a quick example, and installation instructions. Additionally, a minor change was made in Flow diagram of BrainUnit's unit-aware computationgraph LR
Input[Input with Units] --> Compute[Unit-aware Computation]
Compute --> JAX{JAX Processing}
JAX -->|Autograd| Result1[Result with Units]
JAX -->|JIT| Result2[Result with Units]
JAX -->|Vectorization| Result3[Result with Units]
style Input fill:#f9f
style Compute fill:#bbf
style JAX fill:#fbb
style Result1 fill:#bfb
style Result2 fill:#bfb
style Result3 fill:#bfb
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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.
Summary by Sourcery
Update the README file to reflect the new name "BrainUnit" and expand the project description, motivation, features, and provide a usage example.
Documentation:
Tests: