Skip to content

Commit

Permalink
readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
tawnkramer committed Oct 20, 2018
1 parent 96d96e7 commit f566728
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 10 deletions.
11 changes: 2 additions & 9 deletions README.md
Expand Up @@ -21,13 +21,6 @@ The [donkeycar simulator](https://github.com/tawnkramer/sdsandbox/tree/donkey) i

* Download [simulator binaries](https://github.com/tawnkramer/donkey_gym/releases).

## Use with donkeycar framework
## Examples

* git clone https://github.com/tawnkramer/donkey
* pip install -e donkey
* follow docs [here](https://github.com/tawnkramer/donkey/blob/master/docs/guide/simulator.md)

## Use with stable-baselines

* follow [stable-baselines](https://github.com/hill-a/stable-baselines) install
* ```python donkey_gym/examples/ppo_train.py --sim <path to simulator>```
* see [examples](https://github.com/tawnkramer/donkey_gym/tree/master/examples) of use.
14 changes: 14 additions & 0 deletions examples/reinforcement_learning/README.md
@@ -0,0 +1,14 @@
# Reinforcement Learning

## ppo_train.py

An example using stable-baselines to train a ppo2 agent using the donkey_gym environment

* follow [stable-baselines](https://github.com/hill-a/stable-baselines) install
* ```python donkey_gym/examples/reinforcement_learning/ppo_train.py --sim <path to simulator>```

## ddqn.py

An example training a [deep double Q-learning](https://arxiv.org/abs/1509.06461) agent using the donkey_gym environment

* ```python donkey_gym/examples/reinforcement_learning/ddqn.py --sim <path to simulator>```
2 changes: 1 addition & 1 deletion examples/supervised_learning/README.md
Expand Up @@ -12,7 +12,7 @@

### Download the simulator

Download a (simulator binary)[https://github.com/tawnkramer/donkey_gym/releases] for your platform.
Download a [simulator binary](https://github.com/tawnkramer/donkey_gym/releases) for your platform.

Extract the zip file. Double click on the executable.

Expand Down

0 comments on commit f566728

Please sign in to comment.