genrl
genrl copied to clipboard
SforAiDl
Updating docstrings
We're moving from the current docstring style to the Google docstring style. Please refer to DQN and this for an idea. This is a pretty long issue and pretty important too. Docstrings are basically there to help you understand different functions, how they're used, what arguments they take and what they return.
This needs to be implemented in the following places:
- [ ] agents/bandits
- [ ] agents/classical (@Devanshu24 )
- [x] agents/deep
- [ ] core
- [ ] environments
Not sure. I checked a couple of files here and there and they weren't. Feel free to remove them from the list if they're already done. There's a lot of files so didn't check thoroughly.
Yes, go ahead. Updating docstrings is not that tough, so you could try more as well. Lets move faster
On 22-Aug-2020, at 11:53 AM, Devanshu Shah [email protected] wrote:
Could I try doing it for qlearning and sarsa?
— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/SforAiDl/genrl/issues/231#issuecomment-678602446, or unsubscribe https://github.com/notifications/unsubscribe-auth/AH72FJ2QDY5KEGPOKUFYW4DSB5P7TANCNFSM4QESHBNA.
https://github.com/SforAiDl/genrl/blob/28105ff9766817dbc91ac76b0b555a77d934ad6e/genrl/deep/agents/vpg/vpg.py#L23 https://github.com/SforAiDl/genrl/blob/28105ff9766817dbc91ac76b0b555a77d934ad6e/genrl/deep/agents/vpg/vpg.py#L25 Where are these being used, couldn't find it
It's just batch_size rn. Don't look at the older docstrings. Just look at the function init variables