instadeepai / Mava

🦁 A research-friendly codebase for fast experimentation of multi-agent reinforcement learning in JAX
Apache License 2.0
737 stars 90 forks source link

feat: mkdocs documentation #1052

Closed liamclarkza closed 1 month ago

liamclarkza commented 8 months ago

Adds mkdocs support for readthedocs. View the current feature branch docs here: https://id-mava.readthedocs.io/en/feat-mkdocs-documentation/

Additionally, the readme has been simplified as things like benchmarks have been moved to the docs pages.

Note: the User Guide and Evaluation pages are currently "in the works" and are not currently displayed on readthedocs (they have been commented out in the mkdocs.yml file)

sash-a commented 8 months ago

Something that could be good to add to the sharp bits section is to have a part on how total_timesteps and num_updates interact with each other and why we have both config options

sash-a commented 1 month ago

Unfortunately this is too stale :(