Add dockerfile, update readme (#31)

.gitignore

@@ -83,9 +83,13 @@ celerybeat-schedule
 # virtualenv
 venv/
 ENV/
+.venv
 
 # Spyder project settings
 .spyderproject
 
 # Rope project settings
 .ropeproject
+
+# Pictures
+*.jpg

Dockerfile

@@ -0,0 +1,11 @@
+FROM python:3.6
+
+COPY . /app
+
+WORKDIR /app
+
+RUN pip install -r requirements.txt && ./download_styling_models.sh
+
+WORKDIR /data
+
+ENTRYPOINT ["python", "/app/neural_style/neural_style.py"]

README.md

@@ -17,6 +17,30 @@ The model uses the method described in [Perceptual Losses for Real-Time Style Tr
 ## Requirements
 The program is written in Python, and uses [pytorch](http://pytorch.org/), [scipy](https://www.scipy.org). A GPU is not necessary, but can provide a significant speed up especially for training a new model. Regular sized images can be styled on a laptop, desktop using saved models.
 
+## Setup the environnment
+
+### Run with virtualenv
+
+Create a virtualenv with python3.5 or python3.6. Older versions are not supported due to a lack of compatibilty with pytorch.
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -r requirements.txt
+```
+
+### Run with Docker
+
+Build the image:
+```bash
+docker build . -t fast-neural-style
+```
+
+Run the container:
+```bash
+docker run --rm --volume "$(pwd)/:/data" style eval --content-image /data/image.jpg --model /app/saved-models/mosaic.pth --output-image /data/output.jpg --cuda 0
+```
+
 ## Usage
 Stylize image
 ```
@@ -47,7 +71,7 @@ Refer to ``neural_style/neural_style.py`` for other command line arguments.
 Models for the examples shown below can be downloaded from [here](https://www.dropbox.com/s/gtwnyp9n49lqs7t/saved-models.zip?dl=0) or by running the script ``download_styling_models.sh``.
 
 <div align='center'>
-  <img src='images/content-images/amber.jpg' height="174px">		
+  <img src='images/content-images/amber.jpg' height="174px">
 </div>
 
 <div align='center'>

download_styling_models.sh

@@ -1,2 +1,3 @@
-wget https://www.dropbox.com/s/gtwnyp9n49lqs7t/saved-models.zip?dl=1
-unzip saved-models.zip?dl=1
+#!/bin/bash
+wget https://www.dropbox.com/s/gtwnyp9n49lqs7t/saved-models.zip?dl=1 -O saved-models.zip
+unzip saved-models.zip

requirements.txt

@@ -0,0 +1,3 @@
+torch==0.4.0
+torchvision==0.2.2
+numpy==1.14.3