-
Notifications
You must be signed in to change notification settings - Fork 18
Add GPU Performance Notice #446
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
Conversation
FYI, as of now there is pretty much not a lot added, let me know if we should (and which) benchmarks from this issue we might want to include, and what information we should give users with regards to different systems and JAX. |
README.md
Outdated
| Authors | Maintainers | | ||
|:------:|:-----------:| |
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.
I'd revert this
README.md
Outdated
> [!NOTE] | ||
> GPU performance with JaxSim may vary. If you intend to run the package on a laptop GPU, | ||
> keep in mind that the performance of some programs may be significantly slower than running on a desktop class GPU. |
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.
This is not directly related to JaxSim, but rather to JAX itself, or in general to every library that runs on GPU. WDYT @ami-iit/darwin?
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.
Agree, I would remove this
README.md
Outdated
> [!NOTE] | ||
> GPU performance with JaxSim may vary. If you intend to run the package on a laptop GPU, | ||
> keep in mind that the performance of some programs may be significantly slower than running on a desktop class GPU. |
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.
Agree, I would remove this
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.
Thanks @lucaslibshutz We will merge it with the changes highlighted in the review
Co-authored-by: Filippo Luca Ferretti <[email protected]>
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.
Thanks!
I added a small change to
README.md
to alert users about performance differences between laptop and desktop GPUs. I also fixed a broken filepath inCONTRIBUTING.md
, as theworkflows
folder was linked under thegithub
and not the.github
folder. Let me know if we should add some example performance numbers so that users know what to expect when running certain classes of programs!📚 Documentation preview 📚: https://jaxsim--446.org.readthedocs.build//446/
P.S: Please ignore the minor table and other small format improvements, my
nvim
configuration has aprettier
plugin installed that needs to be disabled. My apologies!