-
Notifications
You must be signed in to change notification settings - Fork 679
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
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Pinging @rfali for review. The PR is ready. |
There was a problem hiding this 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.
@rfali yes the docs already has it here: https://cleanrl-git-requirements-docs-vwxyzjn.vercel.app/get-started/installation/#install-via-pip |
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 forpoetry export
.Types of changes
Checklist:
pre-commit run --all-files
passes (required).mkdocs serve
.If you need to run benchmark experiments for a performance-impacting changes:
--capture-video
.python -m openrlbenchmark.rlops
.python -m openrlbenchmark.rlops
utility to the documentation.python -m openrlbenchmark.rlops ....your_args... --report
, to the documentation.