diff --git a/deepracer-gym/README.md b/deepracer-gym/README.md index e3bcb7a3cf7366daffd780c1d6e9fc268f7b1f97..0098423b7d018589d96c1aea9dc0e635256fb5dd 100644 --- a/deepracer-gym/README.md +++ b/deepracer-gym/README.md @@ -1 +1,33 @@ -# Instructions for using the Deepracer Gym Environment \ No newline at end of file +# Deepracer Gym Environment + +AWS Deepracer is a service hosted with AWS Robomaker platform. To make it easy for partcipants, we are releasing a gym environment for Deepracer. The simulator runs by starting a Docker container that runs the simulator and using a network connection with ZeroMQ server to provide a Gym interface. + +Run these to quickly get started. + +```bash +# Install docker if needed +sudo snap install docker + +# Install the Deepracer Gym Environment +pip install -e ./deepracer-gym + +# Start the Deepracer docker container +source deepracer-gym/start_deepracer_docker.sh +# This might take a while to download and start + +# Wait until the terminal says "===Waiting for gym client===" + +# Open a new terminal +# Run a random actions agent with Deepracer Gym +python deepracer-gym/random_actions_example.py + +# Stop the docker container once done +source deepracer-gym/stop_deepracer_docker.sh +``` + +# Resources required + +We recommend using 3 CPUs and 6 GB or RAM for the simulator. + +If you want to reduce these, modify the flags `--cpus="3"` and `--memory="6g"` in `start_deepracer_docker.sh`. +