Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create README.md #1

Merged
merged 3 commits into from May 8, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 27 additions & 0 deletions 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 <path-to-train-data> --model <name-of-model-architecture> --batch-size
<batch-size-for-train> --n-epochs <no-of-epochs> --device <cpu/cuda>
```
which trains the model for Imitation Learning.