EdanToledo / Stoix

🏛️A research-friendly codebase for fast experimentation of single-agent reinforcement learning in JAX • End-to-End JAX RL
Apache License 2.0
238 stars 24 forks source link

[FEATURE] Create a documentation website #83

Open RPegoud opened 5 months ago

RPegoud commented 5 months ago

As I've been taking lots of notes while reading papers related to Rainbow, I thought I'd set up the documentation website and flesh it out gradually. I'll link a pull request with a first version of the documentation. Let me know what you think!

Feature:

Creating a documentation website in the same vein as CleanRL. This is quite straightforward using Material for MkDocs.

Sections (to be refined):

Checklist:

Usage

To run the current version of the documentation (see pull request), simply run:

pip install mkdocs-material
mkdocs serve
EdanToledo commented 5 months ago

Amazing! Thanks so much. Shall we make a checklist like the other PR and then i can help with populating some of the areas.

RPegoud commented 5 months ago

Sure, let me know what sections/features you have in mind 👍

EdanToledo commented 5 months ago

I like what you've currently written and only extra things would be similar to cleanrl's Advanced section so:

  1. Hyperparameter Tuning
  2. Resuming Training and Checkpointing

I also would like to have a section explaining/detailing how to do the rliable experimental procedure to produce statistical tests etc very easily. I will provide the notebook in this PR maybe for that.

RPegoud commented 5 months ago

Sounds good, I'll add the sections and we can fill them out later.