diff --git a/README b/README index e69de29..123d75e 100644 --- a/README +++ b/README @@ -0,0 +1,50 @@ +Quaternion Convolutional Neural Network +===================== + +This repository contains code which reproduces experiments presented in +the paper [link coming](link coming). + + +Requirements +------------ + +Install requirements for computer vision experiments with pip: +``` +pip install numpy Theano keras +``` +or for the tensorflow backend (recommended) + +``` +pip install numpy tensorflow-gpu keras +``` + +Depending on your Python installation you might want to use anaconda or other tools. + +Experiments +----------- + +### Computer vision + +1. Run models: + + ``` + python QCAE.py + ``` + + Parameters can be modified directly in QCAE.py, such as: + + - Number of epochs + - Batch Size + - Size of the Training dataset + - ... + + + +Citation +-------- + +Please cite our work as + +``` + Incoming link +`