search

Denys88 / rl_games

RL implementations
MIT License
800 stars 135 forks source link

Ad/documentation #272

Closed anishhdiwan closed 5 months ago

anishhdiwan commented 5 months ago

Added an explanation of some core classes from rl_games and how they work. Also added a guide on using rl_games for your own work (using a style similar to IsaacGymEnvs).

@Denys88 I hope this is accurate and helps others easily adapt rl_games to their own work :)

Denys88 commented 5 months ago

Reviewing it!

anishhdiwan commented 5 months ago

Hey! I'm closing the PR temporarily. I realise that a how-to might not be relevant as "documentation" for the library. I'll try and add some docstrings to the essential parts of the library so that a proper documentation can be made with tools like Sphinx. Let me know if you have any feedback!

Denys88 commented 5 months ago

Hi @anishhdiwan, it looks good overall. And everything is done in separate in separate doc. Actually I am happy to merge it as is right now, just need to add a link to the top of README.md. In a few weeks I can make next release.

anishhdiwan commented 5 months ago

Hello @Denys88, that sounds great! I can reopen the PR then. Could you please add the README link (not sure where it'd fit the best)?

I will also add the docstrings soon and send another PR at a later time. Thanks

Denys88 commented 5 months ago

Will do it. Could you confirm your name please: Anish Diwan? I want to put it near the link or in your doc (up to you), thanks.

anishhdiwan commented 5 months ago

Yep, its Anish Diwan. I just added it to the doc. Thanks