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.

Sign up for GitHub

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

Jump to bottom

[Sprint] Clean up readme #365

Merged
merged 8 commits into from
Feb 4, 2025
Merged

[Sprint] Clean up readme #365

merged 8 commits into from
Feb 4, 2025

Conversation

CarlottaSartore
Copy link
Contributor

@CarlottaSartore CarlottaSartore commented Feb 3, 2025 •
edited by github-actions bot
Loading

CHanges in readme and examples after code revision

📚 Documentation preview 📚: https://jaxsim--365.org.readthedocs.build//365/

@CarlottaSartore CarlottaSartore self-assigned this Feb 3, 2025
xela-95
xela-95 approved these changes Feb 3, 2025
View reviewed changes
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.

LGTM! I left only a minor comment. After all the updates of the sprint/dev branch, do the notebooks run successfully?

@CarlottaSartore
Copy link
Contributor Author

LGTM! I left only a minor comment. After all the updates of the sprint/dev branch, do the notebooks run successfully?

I have tried on my machine and they were running successfully, in addition there should be the check in the CI !

younik
younik reviewed Feb 3, 2025
View reviewed changes
Copy link
Member

@younik younik left a comment

Choose a reason for hiding this comment

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

Thanks!

I cannot comment on the jupyter notebooks, but I noticed you added:
jax.config.update('jax_platform_name', 'cpu') in jaxsim_as_physics_engine.ipynb

Do we want that line? Given the changes we did, the tutorial should run faster on GPU.

@CarlottaSartore
Copy link
Contributor Author

Thanks!

I cannot comment on the jupyter notebooks, but I noticed you added: jax.config.update('jax_platform_name', 'cpu') in jaxsim_as_physics_engine.ipynb

Do we want that line? Given the changes we did, the tutorial should run faster on GPU.

Your're right ! They were leftovers ! Nice catch, I should have removed them all

@CarlottaSartore CarlottaSartore merged commit 80ed890 into sprint/dev Feb 4, 2025
21 of 24 checks passed
@CarlottaSartore CarlottaSartore deleted the sprint/clean_up_readme branch February 4, 2025 11:02
CarlottaSartore added a commit that referenced this pull request Feb 4, 2025
@CarlottaSartore @xela-95 @flferretti
[Sprint] Clean up readme (#365)
8148c37 
* fix documentation and examples after major changes

* Update jaxsim_as_physics_engine.ipynb

* Update jaxsim_as_physics_engine_advanced.ipynb

* Update README.md

* update CI  to latest ubuntu version

---------

Co-authored-by: Alessandro Croci <[email protected]>
Co-authored-by: Filippo Luca Ferretti <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@younik younik younik approved these changes

@xela-95 xela-95 xela-95 approved these changes

@flferretti flferretti Awaiting requested review from flferretti

Assignees

@CarlottaSartore CarlottaSartore

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@CarlottaSartore @younik @xela-95 @flferretti