Command Line Interface¶
This document outlines the functionality of the deepforge command line interface (provided after installing deepforge with
npm install -g deepforge).
- Installation Configuration
- Starting DeepForge or Components
- Installing and Upgrading Torch
- Update or Uninstall DeepForge
- Managing Extensions
Installation configuration including the installation location of Torch7 and data storage locations. These can be edited using the
deepforge config command as shown in the following examples:
Printing all the configuration settings:
Printing the value of a configuration setting:
deepforge config torch.dir
Setting a configuration option, such as
torch.dir can be done with:
deepforge config torch.dir /some/new/directory
For more information about the configuration settings, check out the configuration page.
Starting DeepForge Components¶
DeepForge components, such as the server or the workers, can be started with the
deepforge start command. By default, this command will start all the necessary components to run including the server, a mongo database (if applicable) and a worker.
The server can be started by itself using
deepforge start --server
The worker can be started by itself using
deepforge start --worker http://22.214.171.124:7543
where http://126.96.36.199:7543 is the url of the deepforge server.
Installing and Upgrading Torch7¶
Torch7 is lazily installed when starting a worker (if torch isn’t already installed) with the rnn package. This installation can be manually updated as described in the update and installation section.
DeepForge can be updated or uninstalled using
The torch installation can be updated using
deepforge update --torch
DeepForge can be uninstalled using
DeepForge extensions can be installed and removed using the
deepforge extensions subcommand. Extensions can be added, removed and listed as shown below
deepforge extensions add https://github.com/example/some-extension deepforge extensions remove some-extension deepforge extensions list