vwxyzjn / cleanrl

High-quality single file implementation of Deep Reinforcement Learning algorithms with research-friendly features (PPO, DQN, C51, DDPG, TD3, SAC, PPG)
http://docs.cleanrl.dev
Other
4.91k stars 566 forks source link

Better requirements.txt docs #369

Closed vwxyzjn closed 1 year ago

vwxyzjn commented 1 year ago

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 https://github.com/python-poetry/poetry/issues/4842 and causes issues for poetry export.

Types of changes

Checklist:

If you need to run benchmark experiments for a performance-impacting changes:

vercel[bot] commented 1 year ago

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 commented 1 year ago

Pinging @rfali for review. The PR is ready.

vwxyzjn commented 1 year ago

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