bentoctl

Bentoctl - Fast model deployment on any cloud platform

bentoctl is a CLI tool for deploying your machine-learning models to any cloud platforms and serving predictions via REST APIs. It is built on top of BentoML: the unified model serving framework, and makes it easy to bring any BentoML packaged model to production.

Usage:

bentoctl [OPTIONS] COMMAND [ARGS]...

Options:

  --version  Show the version and exit.
  --help     Show this message and exit.

apply

[Experimental] Apply the generated template file to create/update the deployment.

Usage:

bentoctl apply [OPTIONS]

Options:

  -f, --deployment-config-file TEXT
                                  path to deployment_config file
  --verbose, --debug              Show debug logs when running the command
  --do-not-track                  Do not send uage info
  --help                          Show this message and exit.

build

Build the Docker image for the given deployment config file and bento.

Usage:

bentoctl build [OPTIONS]

Options:

  -b, --bento-tag TEXT            Bento tag to use for deployment.  [required]
  -f, --deployment-config-file TEXT
                                  path to deployment_config file
  --dry-run                       Dry run
  --verbose, --debug              Show debug logs when running the command
  --do-not-track                  Do not send uage info
  --help                          Show this message and exit.

destroy

Destroy all the resources created and remove the registry.

Usage:

bentoctl destroy [OPTIONS]

Options:

  -f, --deployment-config-file TEXT
                                  path to deployment_config file
  --verbose, --debug              Show debug logs when running the command
  --do-not-track                  Do not send uage info
  --help                          Show this message and exit.

generate

Generate template files for deployment.

Usage:

bentoctl generate [OPTIONS]

Options:

  -f, --deployment-config-file TEXT
                                  path to deployment config file
  --save-path DIRECTORY           Path to save the deployment config file.
  --values-only                   create/update the values file only.
  --verbose, --debug              Show debug logs when running the command
  --do-not-track                  Do not send uage info
  --help                          Show this message and exit.

init

Start the interactive deployment config builder file.

Usage:

bentoctl init [OPTIONS]

Options:

  --do-not-generate      Generate template files based on the provided
                         operator.
  --save-path DIRECTORY  Path to save the deployment config file.
  --verbose, --debug     Show debug logs when running the command
  --do-not-track         Do not send uage info
  --help                 Show this message and exit.

operator

Sub-commands to install, list, remove and update operators.

To see the list of all the operators available and their comparisons check out .

Usage:

bentoctl operator [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

install

install operators.

There are 5 ways to install an operator into bentoctl and they are -

  1. Interactive Mode: lists all official operators for user to choose from. Just type bentoctl install to enter this mode.

  2. Official operator: you can pass the name of one of the official operators and the tool with fetch it for you. You can see the list of official operators . eg. bentoctl install aws-lambda

  3. Path: If you have the operator locally, either because you are building our own operator or if cloning the operator from some other remote repository (other than github) then you can just pass the path after the install command and it will register the local operator for you. This is a special case since the operator will not have an associated URL with it and hence cannot be updated using the tool.

  4. Github Repo: this should be in the format repo_owner/repo_name[:repo_branch]. eg: bentoctl install bentoml/aws-lambda-repo

  5. Git Url: of the form https://[\w]+.git. eg: bentoctl install https://github.com/bentoml/aws-lambda-deploy.git

Usage:

bentoctl operator install [OPTIONS] [NAME]

Options:

  --verbose, --debug  Show debug logs when running the command
  --do-not-track      Do not send uage info
  --help              Show this message and exit.

list

List all the available operators.

Lists the operator, the path from where you can access operator locally and if the operator was pulled from github, the github URL is also shown.

Usage:

bentoctl operator list [OPTIONS]

Options:

  --verbose, --debug  Show debug logs when running the command
  --do-not-track      Do not send uage info
  --help              Show this message and exit.

remove

Remove operators.

This will remove the operator from the list and also remove the local codebase. Pass the flag --keep-locally to keep the operator codebase in the local director.

Usage:

bentoctl operator remove [OPTIONS] NAME

Options:

  -y                  skip the prompt asking if you are sure.
  --verbose, --debug  Show debug logs when running the command
  --do-not-track      Do not send uage info
  --help              Show this message and exit.

update

Update an operator given its name.

This only works for operators that have a URL associated with them. When passed the name of an available operator it goes and fetches the latest code from the Github repo and update the local codebase with it.

Usage:

bentoctl operator update [OPTIONS] NAME

Options:

  --verbose, --debug  Show debug logs when running the command
  --do-not-track      Do not send uage info
  --help              Show this message and exit.