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 docs for dqn.py #157

Merged
merged 9 commits into from
Apr 20, 2022
Merged

Add docs for dqn.py #157

merged 9 commits into from
Apr 20, 2022

Conversation

vwxyzjn
Copy link
Owner

@vwxyzjn vwxyzjn commented Apr 9, 2022

Description

This PR adds documentation for dqn.py and couple documentation fixes for dqn_atari.py

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).

@gitpod-io
Copy link

gitpod-io bot commented Apr 9, 2022

@vercel
Copy link

vercel bot commented Apr 9, 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/AuRtE9dc44G88RDWW5CapYTxT3Pe
✅ Preview: https://cleanrl-git-dqnpy-docs-addition-vwxyzjn.vercel.app

@vwxyzjn
Copy link
Owner Author

vwxyzjn commented Apr 10, 2022

This PR is ready for review.

@vwxyzjn
Copy link
Owner Author

vwxyzjn commented Apr 10, 2022

Additional note: I realized it would be pretty hard to run benchmark experiments based on some master's version. From now on, we should do something like

gh pr checkout 157
poetry install

in the reproducibility instructions.

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.

Looking good over here too.
I noticed there is no dqn_atari.py benchmarks in the docs though. Will it be alright ?

@vwxyzjn
Copy link
Owner Author

vwxyzjn commented Apr 20, 2022

Looking good over here too. I noticed there is no dqn_atari.py benchmarks in the docs though. Will it be alright ?

The dqn_atari.py docs are already added from #124.

@vwxyzjn
Copy link
Owner Author

vwxyzjn commented Apr 20, 2022

Let me know if this addresses your concern :)

@vwxyzjn vwxyzjn mentioned this pull request Apr 20, 2022
19 tasks
@vwxyzjn vwxyzjn merged commit 6a5e8a9 into master Apr 20, 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.

2 participants