Skip to content

Latest commit

 

History

History
93 lines (65 loc) · 3.15 KB

BuildDigits.md

File metadata and controls

93 lines (65 loc) · 3.15 KB
Raw

Building DIGITS

The preferred installation method for DIGITS is using pre-built packages on Ubuntu 14.04 (instructions).

If those don't work for you for some reason, the following instructions will walk you through building the latest version of DIGITS from source. These instructions are for installation on Ubuntu 14.04 and 16.04.

Alternatively, see this guide for setting up DIGITS and Caffe on Windows machines.

Other platforms are not officially supported, but users have successfully installed DIGITS on Ubuntu 12.04, CentOS, OSX, and possibly more. Since DIGITS itself is a pure Python project, installation is usually pretty trivial regardless of the platform. The difficulty comes from installing all the required dependencies for Caffe and/or Torch7 and configuring the builds. Doing so is your own adventure.

Dependencies

Install some dependencies with Deb packages:

sudo apt-get install --no-install-recommends git graphviz gunicorn python-dev python-flask python-flaskext.wtf python-gevent python-h5py python-numpy python-pil python-protobuf python-scipy

Follow these instructions to build Caffe (required).

Follow these instructions to build Torch7 (suggested).

Download source

# example location - can be customized
DIGITS_HOME=~/digits
git clone https://github.com/NVIDIA/DIGITS.git $DIGITS_HOME

Throughout the docs, we'll refer to your install location as DIGITS_HOME (~/digits in this case), though you don't need to actually set that environment variable.

Python packages

Several PyPI packages need to be installed:

sudo pip install -r $DIGITS_HOME/requirements.txt

Starting the server

You can run DIGITS in two modes:

Development mode

./digits-devserver

Starts a development server (werkzeug backend) at http://localhost:5000/.

$ ./digits-devserver --help
usage: digits-devserver [-h] [-p PORT] [-c] [-d] [--version]

Run the DIGITS development server

optional arguments:
  -h, --help            show this help message and exit
  -p PORT, --port PORT  Port to run app on (default 5000)
  -c, --config          Edit the application configuration
  -d, --debug           Run the application in debug mode (reloads when the
                        source changes and gives more detailed error messages)
  --version             Print the version number and exit

Production mode

./digits-server

Starts a production server (gunicorn backend) at http://localhost:34448. If you get any errors about an invalid configuration, use the development server first to set your configuration.

If you have installed the nginx.site to /etc/nginx/sites-enabled/, then you can view your app at http://localhost/.

Getting started

Now that you're up and running, check out the Getting Started Guide.

Troubleshooting

Most configuration options should have appropriate defaults. If you need to edit your configuration for some reason, try one of these commands:

# Set options before starting the server
./digits-devserver --config
# Advanced options
python -m digits.config.edit --verbose