From 2b5fc8f51da3bba9dbc7c8e908e798b843ce3154 Mon Sep 17 00:00:00 2001 From: "Alex J. Champandard" Date: Sun, 30 Oct 2016 02:04:28 +0200 Subject: [PATCH] Add docker instructions, fix for slow compute in CPU image. --- README.rst | 15 ++++++++++++++- docker-cpu.df | 4 +++- docker-gpu.df | 2 +- 3 files changed, 18 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 79358e4..ebd797c 100644 --- a/README.rst +++ b/README.rst @@ -79,7 +79,20 @@ Pre-trained models are provided in the GitHub releases. Training your own is a 2.a) Using Docker Image [recommended] ------------------------------------- -(work in progress) +The easiest way to get up-and-running is to `install Docker `_. Then, you should be able to download and run the pre-built image using the ``docker`` command line tool. Find out more about the ``alexjc/neural-enhance`` image on its `Docker Hub `_ page. + +We recommend you setup an alias called ``enhance`` to automatically expose your ``images`` folder from the current directory so the script can access files and store results where you can access them. This is how you can do it in your terminal console on OSX or Linux: + +.. code:: bash + + # Setup the alias. Put this in your .bash_rc or .zshrc file so it's available at startup. + alias enhance="docker run -v $(pwd)/images:/ne/images -it alexjc/neural-enhance" + + # Now run any of the examples above using this alias, without the `.py` extension. + enhance images/example.jpg + +If you want to run on your NVIDIA GPU, you can instead use the image ``alexjc/neural-enhance:gpu`` which comes with CUDA and CUDNN pre-installed in the image. Then run it within `nvidia-docker `_ and it should use your physical hardware! + 2.b) Manual Installation [developers] ------------------------------------- diff --git a/docker-cpu.df b/docker-cpu.df index 167c8ea..2762f34 100644 --- a/docker-cpu.df +++ b/docker-cpu.df @@ -6,6 +6,8 @@ RUN apt-get -qq update && \ "build-essential" \ "git" \ "wget" \ + "libopenblas-dev" \ + "liblapack-dev" \ "pkg-config" && \ rm -rf /var/lib/apt/lists/* @@ -28,5 +30,5 @@ RUN wget -q "https://github.com/alexjc/neural-enhance/releases/download/v0.1/ne4 RUN wget -q "https://github.com/alexjc/neural-enhance/releases/download/v0.1/ne4x-medium-0.1.pkl.bz2" RUN wget -q "https://github.com/alexjc/neural-enhance/releases/download/v0.1/ne4x-large-0.1.pkl.bz2" -# Set an entrypoint to the main doodle.py script +# Set an entrypoint to the main enhance.py script ENTRYPOINT ["/opt/conda/bin/python3.5", "enhance.py", "--device=cpu"] diff --git a/docker-gpu.df b/docker-gpu.df index 8b6e5ba..2fc6c6a 100644 --- a/docker-gpu.df +++ b/docker-gpu.df @@ -28,5 +28,5 @@ RUN wget -q "https://github.com/alexjc/neural-enhance/releases/download/v0.1/ne4 RUN wget -q "https://github.com/alexjc/neural-enhance/releases/download/v0.1/ne4x-medium-0.1.pkl.bz2" RUN wget -q "https://github.com/alexjc/neural-enhance/releases/download/v0.1/ne4x-large-0.1.pkl.bz2" -# Set an entrypoint to the main doodle.py script +# Set an entrypoint to the main enhance.py script ENTRYPOINT ["/opt/conda/bin/python3.5", "enhance.py", "--device=gpu"]