diff --git a/README.rst b/README.rst index 023d375..8cf2fa6 100644 --- a/README.rst +++ b/README.rst @@ -108,10 +108,36 @@ You can configure the algorithm using the following parameters. Type ``python3 d 2. Installation & Setup ======================= +2.a) Using Docker Image (recommended) +------------------------------- + +The easiest way to get up-and-running is to `install Docker `_. Then, you should be able to downloand and run the pre-built image using the `docker` command line tool. Find out more about the `alexjc/neural-doodle` image on its `Docker Hub https://hub.docker.com/r/alexjc/neural-doodle/`_ page. + +The easiest way to run the script from the docker image is to setup an easy access command called `doodle`. This will automatically: + +* Mount the `frames` folder from the current directory into the instance for visualization. +* Expose the `samples` folder from the current directory so the script can access files! + +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 doodle="docker run -it alexjc/neural-doodle + -v samples:/nd/samples -w /nd/samples + -v frames:/nd/frames -w /nd/frames" + + # Now run any of the examples above using this alias, without the `.py` extension. + doodle --help + +*NOTE*: If you want to run on your NVIDIA GPU, you can instead use the image `alexjc/neural-doodle:gpu` which comes with CUDA and CUDNN pre-installed in the image. See the scripts in `docker/*.sh` for how to setup your host machine. (advanced) + + +2.b) Manual Installation (optional) +----------------------------------- + This project requires Python 3.4+ and you'll also need ``numpy`` and ``scipy`` (numerical computing libraries) as well as ``python3-dev`` installed system-wide. If you want more detailed instructions, follow these: -0. Use Prepared `Docker Container `_ or `Amazon Image `_ **(beginner)** -1. `Linux Installation of Lasagne `_ **(recommended)** +1. `Linux Installation of Lasagne `_ **(beginner)** 2. `Mac OSX Installation of Lasagne `_ **(intermediate)** 3. `Windows Installation of Lasagne `_ **(expert)** diff --git a/docker-cpu.df b/docker-cpu.df index 71b0e7c..ba88bf7 100644 --- a/docker-cpu.df +++ b/docker-cpu.df @@ -29,12 +29,12 @@ RUN apt-get update -qq && \ "python3-networkx" \ "python3-tk" && \ rm -rf /var/lib/apt/lists/* && \ - python3 -m pip install "cython" + python3 -m pip -q install "cython" # Install requirements before copying project files WORKDIR /nd COPY requirements.txt . -RUN python3 -m pip install -r "requirements.txt" +RUN python3 -m pip -q install -r "requirements.txt" # Copy only required project files COPY doodle.py . diff --git a/docker-gpu.df b/docker-gpu.df index 5fca937..fa65c4e 100644 --- a/docker-gpu.df +++ b/docker-gpu.df @@ -30,12 +30,12 @@ RUN apt-get update -qq && \ "python3-networkx" \ "python3-tk" && \ rm -rf /var/lib/apt/lists/* && \ - python3 -m pip install "cython" + python3 -m pip -q install "cython" # Install requirements before copying project files WORKDIR /nd COPY requirements.txt . -RUN python3 -m pip install -r "requirements.txt" +RUN python3 -m pip -q install -r "requirements.txt" # Copy only required project files COPY doodle.py .