diff --git a/README.md b/README.md new file mode 100644 index 0000000..cb9716c --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +## Self Driving Cars in Video Games using Deep Learning + +### Contents +- [Installation](#Installation) +- [Input](#Input) +- [Usage](#Usage) + + +### Installation +This model is built in top of PyTorch, follow the installation instructions from PyTorch [here](https://pytorch.org/get-started/locally/). + +To install dependencies, do +```bash +pip install -r requirements.txt +``` + +### Input +Currently, only the **Windows OS** is supported due to the `win32gui` requirements for screen grabbing / input capture. +The `screen_capture.py`, `grabscreen.py`, `directkeys.py` and `getkeys.py` scripts handle screen capturing, image grabbing and keypress event recording. + +### Usage +```bash +python train_il.py --data --model --batch-size + --n-epochs --device +``` +which trains the model for Imitation Learning. +