Clarify CleanRL is a non-modular library #200
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
docs/index.md
Outdated
| Good luck have fun 🚀 | ||
| Good luck have fun :rocket: | ||
|
|
||
| ⚠️ **NOTE**: CleanRL is *not* a modular library and therefore it is not meant to be imported. At the cost of duplicate code, we make all implementation details of a DRL algorithm variant easy to understand, so CleanRL comes with its own pros and cons. You should consider using CleanRL if you want to 1) understand all implementation details of an algorithm's varaint or 2) do quick prototypes. |
There was a problem hiding this comment.
varaint -> variant
I'm not sure that "do quick prototypes" makes sense here. Running from clearrl import PPO would be quick. Reading the algorithm and copy-pasting it into my code is slow.
There was a problem hiding this comment.
I think "doing prototypes" is not really a well-defined notion as there are many types of prototypes. Being able to do prototypes quickly largely depends on the use case.
While things like from stable_baselines3 import PPO is quick but if you want to prototype advanced features that SB3 does not support, it could be more difficult as discussed in #197 with the invalid action masking example.
Maybe I can clarify as "do prototypes that can't be achieved by just combining components in modular DRL libraries"? I am really unsure what the phrasing would be.
There was a problem hiding this comment.
"if you want to prototype advanced features that SB3 does not support" Keep in mind that 95% of people just want something that works, not advanced features. But in any case, this PR is good and I think you should make any changes that result in it being merged.
|
Lost interest? |
|
Hey sorry for the delay. This week is my end-of-internship and a move-out week. Yes, let me think of a place to put the reference implementation. Please let me know what you think of my reply above regarding the prototypes comment. |
Description
Closes #197.
Types of changes