Installation Guide

Note: This is still a work in progress; suggestions, requests, etc, are welcome.

DeepForge Component Overview

DeepForge is composed of four main elements:

• Server: Main component hosting all the project information and is connected to by the clients
• Database: MongoDB database containing DeepForge, job queue for the workers, etc
• Worker: Slave machine performing the actual machine learning computation
• Client: The connected browsers working on DeepForge projects.

Of course, only the Server, Database (MongoDB) and Worker need to be installed. If you are not going to execute any machine learning pipelines, installing the Worker can be skipped.

Preinstallation

Installing dependencies

The following dependencies are required for each component:

• Server:
  • NodeJS v6.2.0
• Database:
  • MongoDB v3.0.7
• Worker:
  • NodeJS v6.2.0 (used for job management logic)
  • Torch
• Client:
  • We recommend using Google Chrome and are not supporting other browsers (for now). In other words, other browsers can be used at your own risk.

Installation

Database

Download and install MongoDB from the website. If you are planning on running MongoDB locally on the same machine as DeepForge, simply start mongod and continue to setting up DeepForge.

If you are planning on running MongoDB remotely, set the environment variable "MONGO_URI" to the URI of the Mongo instance that DeepForge will be using:

MONGO_URI="mongodb://pathToMyMongo.com:27017/myCollection" npm start

DeepForge Server

First, clone the repository:

git clone https:/dfst/deepforge.git

Then install the project dependencies:

npm install

To run all components locally start with

npm run local

and navigate to http://localhost:8888 to start using DeepForge!

Alternatively, if jobs are going to be executed on an external worker, run npm start locally and navigate to http://localhost:8888.

DeepForge Worker

If you are using npm start you will need to set up a DeepForge worker (npm run local starts a local worker for you!). DeepForge workers are slave machines connected to DeepForge which execute the provided jobs. This allows the jobs to access the GPU, etc, and provides a number of benefits over trying to perform deep learning tasks in the browser.

Once DeepForge is installed on the worker, start it with

npm run worker

Note: If you are running the worker on a different machine, put the address of the DeepForge server as an argument to the command. For example:

npm run worker http://myaddress.com:1234