NVlabs / cule

CuLE: A CUDA port of the Atari Learning Environment (ALE)
BSD 3-Clause "New" or "Revised" License
229 stars 34 forks source link

Documentation on usage #32

Open ovsen opened 2 years ago

ovsen commented 2 years ago

Hi

It would be nice to have some quick start documentation for people that are currently using the openai gym to move over to cule.

ifrosio commented 2 years ago

Hi, cule is supposed to replace openai gym. Code in the examples folder show how to use cule for a2c, vtrace, dqn, and other typical RL algorithms. However, I believe the easiest starting point to understand how to use it is in cule/examples/visualize/animate.py - here you can see how to call cule's step function, reset observation and so on. You should see that cule's syntax is compatible with OpenAI gym syntax. Feel free to ask specific questions if you need more help.