Emily CLI Documentation

Release-v2.0.0

Emily combines the powers of Python and Docker to build stable and consistent machine learning and datascience python environments. Emily is useful for large cross-team project development as well as for simply running a single jupyter notebook or python script.

Download emily@v2.0.0
See earlier versions
$ emily config [project] [environment-name] [options]

View and modify the configuration of a project. To view the configuration of a project, run emily config <project>. To view the configuration of a project environment, run emily config <project> <environment name>. To change the configuration of a project environment, run emily config <project> <environment> <option> <value> where <option> is one of the options listed below, and <value> might be optional depending on the chosen <option>.

$ config my-project my-env
Configuring environment: on project: .

Environment: my-env
- Port:
- Number of workers:
- GPU:
- Mounts:
| -
- Server:
| - User:
| - Host:
- Server Directory:
- Bash Script:

Enable GPU functionality for deployment?: >>

Which port do you want to use for this environment?: >>

Select a server for environment

| Name: server2
IP/Domain: 20.30.40.50
Status: Offline

>>

Please specify the location of the mounted data on the server by its absolute path.

Please specify path to the data-folder for: /workspace/mounted-data: >>

The number of worker processes to run in parallel: >>

Successfully updated my-env


Running Emily Configure with flags

$ config my-project my-env
--port 5000
--no-gpu
--server server1
--workers 10
--server-directory location/on/server
--run-script script.sh

    Options

  • -h,--help

    Display help for command

  • -w,--workers<workers>

    The number of worker processes to run in parallel.

  • -p,--port<port>

    The port the API is hosted at.

  • -g,--gpu(--no-gpu)

    Run on server with GPU and NVIDIA CUDA support.

  • -se,--server[server-name]

    Automatically deploy to server.

  • -sd,--server-directory<path>

    Server directory to transfer files to (default: /home/<SERVER USER>/<PROJECT NAME>).

  • -r,--run-script<file>(--no-run-script)

    Bash script to run on the server after transferring files.

  • -s,--silent

    Execute Emily silently. (default: false)

  • -u,--update(--no-update)

    Prompt for update if newer version found. (default: true)

  • -vb,--verbose

    Print detailed information while running commands.