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

Add PPO documentation #163

Merged
merged 9 commits into from Apr 26, 2022
Merged

Add PPO documentation #163

merged 9 commits into from Apr 26, 2022

Conversation

vwxyzjn
Copy link
Owner

@vwxyzjn vwxyzjn commented Apr 18, 2022

Description

Types of changes

  • Documentation

Checklist:

  • I've read the CONTRIBUTION guide (required).
  • I have ensured pre-commit run --all-files passes (required).
  • I have updated the documentation and previewed the changes via mkdocs serve.
  • I have updated the tests accordingly (if applicable).

If you are adding new algorithms or your change could result in performance difference, you may need to (re-)run tracked experiments. See #137 as an example PR.

  • I have contacted @vwxyzjn to obtain access to the openrlbenchmark W&B team (required).
  • I have tracked applicable experiments in openrlbenchmark/cleanrl with --capture-video flag toggled on (required).
  • I have added additional documentation and previewed the changes via mkdocs serve.
    • I have explained note-worthy implementation details.
    • I have explained the logged metrics.
    • I have added links to the original paper and related papers (if applicable).
    • I have added links to the PR related to the algorithm.
    • I have created a table comparing my results against those from reputable sources (i.e., the original paper or other reference implementation).
    • I have added the learning curves (in PNG format with width=500 and height=300).
    • I have added links to the tracked experiments.
  • I have updated the tests accordingly (if applicable).

@vercel
Copy link

vercel bot commented Apr 18, 2022

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/vwxyzjn/cleanrl/5CkswQxbRMkZh3yzhki7iWUgT4Dc
✅ Preview: https://cleanrl-git-ppo-docs-continued-vwxyzjn.vercel.app

@gitpod-io
Copy link

gitpod-io bot commented Apr 18, 2022

@vwxyzjn vwxyzjn mentioned this pull request Apr 18, 2022
4 tasks
@vwxyzjn
Copy link
Owner Author

vwxyzjn commented Apr 24, 2022

@yooceii @dosssman this is ready for review. I didn't do the I have added links to the PR related to the algorithm because I found adding the PR to be less helpful than I anticipated... Ideally, the users should be able to reproduce the same results in the latest master without checking out each PR.

@vwxyzjn vwxyzjn mentioned this pull request Apr 24, 2022
10 tasks
@@ -88,12 +110,14 @@ Learning curves:

Tracked experiments and game play videos:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit, if it's classic control env, then probably use videos instead game play videos.

Copy link
Collaborator

@yooceii yooceii left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Copy link
Collaborator

@dosssman dosssman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All clear on my side too.

@vwxyzjn vwxyzjn merged commit 2fff248 into master Apr 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants