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 documentation for td3_continuous_action.py #141

Merged
merged 10 commits into from
Apr 7, 2022
Merged

Add documentation for td3_continuous_action.py #141

merged 10 commits into from
Apr 7, 2022

Conversation

vwxyzjn
Copy link
Owner

@vwxyzjn vwxyzjn commented Mar 22, 2022

Checklist for td3_continuous_action.py:

  • I've read the CONTRIBUTION guide (required).
  • I have ensured pre-commit run --all-files passes (required).
  • 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 updated the 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 Mar 22, 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/G3Shcyi4ngtAsir8yn6LmBo1qTQq
✅ Preview: https://cleanrl-git-td3-docs-vwxyzjn.vercel.app

@gitpod-io
Copy link

gitpod-io bot commented Mar 22, 2022

@vwxyzjn
Copy link
Owner Author

vwxyzjn commented Apr 6, 2022

This PR is ready for review.

benchmark/td3/README.md Outdated Show resolved Hide resolved
benchmark/td3/README.md Outdated Show resolved Hide resolved
benchmark/td3/README.md Outdated Show resolved Hide resolved
benchmark/td3/README.md Outdated Show resolved Hide resolved
benchmark/td3/README.md Outdated Show resolved Hide resolved
benchmark/td3/README.md Outdated Show resolved Hide resolved
docs/rl-algorithms/td3.md Outdated Show resolved Hide resolved
docs/rl-algorithms/td3.md Outdated Show resolved Hide resolved
docs/rl-algorithms/td3.md Outdated Show resolved Hide resolved
docs/rl-algorithms/td3.md Outdated Show resolved Hide resolved
docs/rl-algorithms/td3.md Outdated Show resolved Hide resolved
docs/rl-algorithms/td3.md Outdated Show resolved Hide resolved
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.

Hello there.

Looks solid overall, although there are a few imports artifact left from the DDPG documentation.
This time I have left single comments due to rushing a bit, but let me know if you prefer I do a PR that directly fixes things next time.

@vwxyzjn
Copy link
Owner Author

vwxyzjn commented Apr 7, 2022

Fixed a few things. Not sure about one of the comments. Please let me know and I can fix and merge :)

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.
Thanks for the great work.

@vwxyzjn vwxyzjn merged commit 8592415 into master Apr 7, 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