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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve utilities provided by JaxsimDataclass #116

Merged
merged 9 commits into from
Mar 22, 2024

Conversation

diegoferigo
Copy link
Member

@diegoferigo diegoferigo commented Mar 21, 2024

When I first designed this class, I wanted to keep the Mutability enum private. However, in practice, there are multiple use-cases in which downstream projects need to use it.

This PR:

  • Adjusts methods to expose publicly the Mutability enum.
  • Reduces the number of copies, possibly improving the memory footprint of downstream code.
  • Uses stricter checks to prevent JIT recompilations. Beyond pytree structure, now also the shape and dtype of the leaves if checked, if they are arrays.
  • Adds docstrings.

馃摎 Documentation preview 馃摎: https://jaxsim--116.org.readthedocs.build//116/

@diegoferigo
Copy link
Member Author

Moving this forward since it's not merging into main. @flferretti if you have comments, please leave them in #108.

@diegoferigo diegoferigo merged commit eb4bc01 into functional Mar 22, 2024
21 checks passed
@diegoferigo diegoferigo deleted the improve_jaxsim_dataclass branch March 22, 2024 08:46
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.

None yet

1 participant