search

google / brax

Massively parallel rigidbody physics simulation on accelerator hardware.
Apache License 2.0
2.38k stars 257 forks source link

About documentation #253

Closed jinseokbae closed 2 months ago

jinseokbae commented 2 years ago

Hi, Thanks for releasing amazing work. I'm really interested in the differentiable physics simulator so I'm planning to use Brax on my recent research project. However, I couldn't find any proper document explaining API of Brax. Is there any publicly available document? If not, when do you plan to release it?

btaba commented 2 years ago

Hi @jinseokbae ! The best documentation we have now are the notebooks in the root directory here: https://github.com/google/brax/tree/main/notebooks We could certainly have better documentation! We plan on releasing a major version update of brax in the next couple of months first before adding more documentation. Thanks for considering brax!

evlabs-jventajas commented 1 year ago

All those notebooks seem to be broken.

btaba commented 1 year ago

@evlabs-jventajas can you try again and let us know if you face any issues? just pushed some fixes

btaba commented 2 months ago

Closing due to inactivity