Skip to content

Conversation

lucaslibshutz
Copy link
Contributor

@lucaslibshutz lucaslibshutz commented Jul 3, 2025

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 in CONTRIBUTING.md, as the workflows folder was linked under the github 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 a prettier plugin installed that needs to be disabled. My apologies!

@xela-95 xela-95 added the documentation Improvements or additions to documentation label Jul 3, 2025
@xela-95 xela-95 requested a review from CarlottaSartore July 7, 2025 07:36
@lucaslibshutz
Copy link
Contributor Author

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
Comment on lines 336 to 337
| Authors | Maintainers |
|:------:|:-----------:|
Copy link
Collaborator

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
Comment on lines 88 to 90
> [!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.
Copy link
Collaborator

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?

Copy link
Contributor

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
Comment on lines 88 to 90
> [!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.
Copy link
Contributor

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

Copy link
Contributor

@CarlottaSartore CarlottaSartore left a 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

Copy link
Member

@xela-95 xela-95 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@CarlottaSartore CarlottaSartore merged commit d124a61 into ami-iit:main Sep 8, 2025
16 of 17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants