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

Better requirements.txt docs #369

Merged
merged 16 commits into from
Mar 31, 2023
Merged

Better requirements.txt docs #369

merged 16 commits into from
Mar 31, 2023

Conversation

vwxyzjn
Copy link
Owner

@vwxyzjn vwxyzjn commented Mar 30, 2023

Description

Recently #365 has caused a lot of issues for folks. To make CleanRL easier to use, this PR adds documentation for using pip to install dependencies.

Note that I did have to remove poetry groups... It does not currently support for extra dependencies python-poetry/poetry#4842 and causes issues for poetry export.

Types of changes

  • Bug fix
  • New feature
  • New algorithm
  • Documentation

Checklist:

  • I've read the CONTRIBUTION guide (required).
  • I have ensured pre-commit run --all-files passes (required).
  • I have updated the tests accordingly (if applicable).
  • 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 you need to run benchmark experiments for a performance-impacting changes:

  • I have contacted @vwxyzjn to obtain access to the openrlbenchmark W&B team.
  • I have used the benchmark utility to submit the tracked experiments to the openrlbenchmark/cleanrl W&B project, optionally with --capture-video.
  • I have performed RLops with python -m openrlbenchmark.rlops.
    • For new feature or bug fix:
      • I have used the RLops utility to understand the performance impact of the changes and confirmed there is no regression.
    • For new 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 generated by the python -m openrlbenchmark.rlops utility to the documentation.
    • I have added links to the tracked experiments in W&B, generated by python -m openrlbenchmark.rlops ....your_args... --report, to the documentation.

@vercel
Copy link

vercel bot commented Mar 30, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated
cleanrl ✅ Ready (Inspect) Visit Preview 💬 Add your feedback Mar 31, 2023 at 1:25PM (UTC)

@vwxyzjn
Copy link
Owner Author

vwxyzjn commented Mar 30, 2023

Pinging @rfali for review. The PR is ready.

Copy link

@rfali rfali left a comment

Choose a reason for hiding this comment

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

The changes in readme look good to me. I verified installation by following the directions. Did the docs already have the pip installation method listed at the end? If it did, I hadn't noticed but it's good to put this information front and center via Read Me.

I did not verify the poetry group related changes.

@vwxyzjn
Copy link
Owner Author

vwxyzjn commented Mar 31, 2023

@rfali yes the docs already has it here: https://cleanrl-git-requirements-docs-vwxyzjn.vercel.app/get-started/installation/#install-via-pip

@vwxyzjn vwxyzjn merged commit 2df24f4 into master Mar 31, 2023
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