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
whoamitelemetrybuildopenlistmountunmountdoctordeployserversupdatedroplogstopuninstallconfigloginlogout
$ emily open [project] [options]

Open a directory or an existing Emily project by its name or ID.

$ open my-project-name
Opening my-project-name located at my-project-path.

Starting Docker container...

Running Emily Open

To open a project with Emily, simply run emily open inside a terminal. To open an existing Emily project, you have to supply either the project's ID, name or it's path.

$ open my-project-name
$ open ~/my/project/directory
$ open MKLHWX --gpu --editor vscode

You can also import a directory which is not an Emily project. You will be able to choose an import image that suits your project the most.

$ open ./my-import-directory
$ open ./my-import-directory --import-mounts ./dataset1 ./dataset2 ./dataset3 --editor pycharm --gpu

    Options

  • -h,--help

    Display help for command

  • -ii,--import-image<image>

    The Emily image to use when importing a project. Valid emily images: base | slim | cv | nlp torch-slim | torch-cv | torch-nlp | tf-slim tf-cv | tf-nlp | cuda-base | cuda-slim cuda-cv | cuda-nlp |cuda-torch-slim| cuda-torch-cv cuda-torch-nlp| cuda-tf-slim | cuda-tf-cv | cuda-tf-nlp

  • -im,--import-mounts[...paths]

    Source mount paths used if the project is imported.

  • -i,--import-only

    Import the folder without opening project. (default: false)

  • -ho,--host<host>

    Change host address to listen for requests on.

  • -p,--port<port>

    Change host port to listen for requests on.

  • -nh,--notebook-host<host>

    Change Jupyter notebook server host.

  • -np,--notebook-port<port>

    Change Jupyter notebook server port.

  • -e,--editor<editor>

    The editor to use [pycharm | vscode | notebook | lab].

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

    Enable/disable GPU support.

  • -env,--environment-name<name>

    Environment to open in. (default: dev)

  • -d,--detach

    Detached mode: Run container in the background. Requires manual shutdown.

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