Emily CLI Documentation

Release-v3.0.6

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@latest
See earlier versions
$ emily environment add [options]

Add an environment to your project.

$ emily environment add

? Emily: Choose a project(Use arrow keys, confirm with ENTER)> M9VHKD - my-project
AB82JD - movie-recommender
· M9VHKD - my-project
Emily: Please enter the environment name:
· staging
Emily: Please enter a port:
· 4242
? Emily: Use a GPU in this environment?(y/N) · YesEmily: Please enter the number of workers:
· 8
Emily: Environment "staging" added to project my-project (M9VHKD).

Created:
- /my/projects/my-project/environments/staging/.emily.env


Creating environments

You can add environments to a project simply with the emily environment add command:

$ emily environment add
--name my-environment
--project <my project>


The command above creates a directory <project root>/environments/my-environment and writes a .emily.env file to it.

You can always add more files to your environment directories as long as their naming follow the *.env naming scheme. Emily will automatically merge the .env files in an environment when running or deploying a project.

    Options

  • -h,--help

    Display help for command

  • -n,--name<name>

    The name of the environment

  • -po,--port<port>

    The port assigned in this environment (default: 4242)

  • -ho,--host<host>

    The host address the API listens on in this environment (default: 0.0.0.0)

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

    Whether or not to use a GPU in this environment

  • -w,--workers<n>

    The number of workers to run in parallel in this environment (default: 1)

  • -p,--project<project>

    The project to manage environments for.

  • -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.