Add README files to subdirectories

.gitignore

@@ -89,11 +89,17 @@ ENV/
 .ropeproject
 
 
-# dataset related resources
+# project structure related resources
 data/*
+experiments/*
+pretrained/*
+
 # do not ignore dataset downloader
-!data/download_mscoco.sh
+!data/README.md
+!experiments/README.md
+!pretrained/README.md
 *.h5
 
 # ignore config
 *.json
+

config/README.md

@@ -0,0 +1,5 @@
+# Configuration files
+
+This is the directory where the configuration for the experiments will be loaded from.
+
+In order to run a custom experiment, copy the `solver.json.default` file into any other name, e.g. `train_enet.json` and run `python src/run.py ${mode} train_enet.json` from the root directory of the project. `mode` can only take the value of `train` at the moment. `predict` and `test`/`evaluate` functionality is planned, as well as a `python run.py --help` menu.

data/README.md

@@ -0,0 +1,5 @@
+# Data directory
+
+Placeholder.
+
+TODO: add contents

experiments/README.md

@@ -0,0 +1,4 @@
+# Experiments directory
+
+This is the directory where the tensorboard files (under `logs/`) as well as the model snapshots (under `weights/`) will be stored.
+The directory will be populated automatically. The directory structure is experiments/${dataset_name}/${model_name}/${[logs|weights]}

pretrained/README.md

@@ -0,0 +1,5 @@
+# Pretrained model directory
+
+This is the directory where the pretrained models will be loaded from.
+
+Run `./setup.sh` to download the enet model and convert it to a keras-compatible model before you run the actual training/prediction scripts.