You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
Landing page
Get started
Installation
Quick start / basic usage
Usage (hydra config) overrides etc
Adding a new algorithm - details files needed
RL algorithms
References (link to .py, paper)
Brief description of the algorithm
Community
Contribution guidelines
Hyperparameter Tuning
Resuming Training and Checkpointing
Rliable statistical tests
Usage
To run the current version of the documentation (see pull request), simply run:
pip install mkdocs-material
mkdocs serve
The text was updated successfully, but these errors were encountered:
I like what you've currently written and only extra things would be similar to cleanrl's Advanced section so:
Hyperparameter Tuning
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.
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:
The text was updated successfully, but these errors were encountered: