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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Create a documentation website #83

Open
8 of 11 tasks
RPegoud opened this issue Jun 2, 2024 · 4 comments
Open
8 of 11 tasks

[FEATURE] Create a documentation website #83

RPegoud opened this issue Jun 2, 2024 · 4 comments
Labels
enhancement New feature or request

Comments

@RPegoud
Copy link
Contributor

RPegoud commented Jun 2, 2024

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
@RPegoud RPegoud added the enhancement New feature or request label Jun 2, 2024
@EdanToledo
Copy link
Owner

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
Copy link
Contributor Author

RPegoud commented Jun 3, 2024

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

@EdanToledo
Copy link
Owner

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
Copy link
Contributor Author

RPegoud commented Jun 3, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants