Bento Store APIs#

Managing Bentos#

bentoml.list(tag: t.Optional[t.Union[Tag, str]] = None, _bento_store: BentoStore = <simple_di.providers.SingletonFactory object>) t.List[Bento][source]#
bentoml.get(tag: t.Union[Tag, str], *, _bento_store: BentoStore = <simple_di.providers.SingletonFactory object>) Bento[source]#
bentoml.delete(tag: t.Union[Tag, str], *, _bento_store: BentoStore = <simple_di.providers.SingletonFactory object>)[source]#
bentoml.export_bento(tag: t.Union[Tag, str], path: str, output_format: t.Optional[str] = None, *, protocol: t.Optional[str] = None, user: t.Optional[str] = None, passwd: t.Optional[str] = None, params: t.Optional[t.Dict[str, str]] = None, subpath: t.Optional[str] = None, _bento_store: BentoStore = <simple_di.providers.SingletonFactory object>) str[source]#

Export a bento.

To export a bento to S3, you must install BentoML with extras aws:

ยป pip install bentoml[aws]

Examples:

# exports 'my_bento' to '/path/to/folder/my_bento-version.bento' in BentoML's default format
bentoml.export_bento('my_bento:latest', '/path/to/folder')
# note that folders can only be passed if exporting to the local filesystem; otherwise the
# full path, including the desired filename, must be passed

# exports 'my_bento' to '/path/to/folder/my_bento.bento' in BentoML's default format
bentoml.export_bento('my_bento:latest', '/path/to/folder/my_bento')
bentoml.export_bento('my_bento:latest', '/path/to/folder/my_bento.bento')

# exports 'my_bento' to '/path/to/folder/my_bento.tar.gz' in gzip format
# currently supported formats are tar.gz ('gz'), tar.xz ('xz'), tar.bz2 ('bz2'), and zip
bentoml.export_bento('my_bento:latest', '/path/to/folder/my_bento.tar.gz')
# outputs a gzipped tarfile as 'my_bento.ext'
bentoml.export_bento('my_bento:latest', '/path/to/folder/my_bento.ext', 'gz')

# exports 'my_bento' to '/path/to/folder/my_bento/' as a folder
bentoml.export_bento('my_bento:latest', '/path/to/folder/my_bento', 'folder')

# exports 'my_bento' to the S3 bucket 'my_bucket' as 'folder/my_bento-version.bento'
bentoml.export_bento('my_bento:latest', 's3://my_bucket/folder')
bentoml.export_bento('my_bento:latest', 'my_bucket/folder', protocol='s3')
bentoml.export_bento('my_bento:latest', 'my_bucket', protocol='s3', subpath='folder')
bentoml.export_bento('my_bento:latest', 'my_bucket', protocol='s3', subpath='folder',
                     user='<AWS access key>', passwd='<AWS secret key>',
                     params={'acl': 'public-read', 'cache-control': 'max-age=2592000,public'})

For a more comprehensive description of what each of the keyword arguments (protocol, user, passwd, params, and subpath) mean, see the FS URL documentation.

Parameters
  • tag โ€“ the tag of the Bento to export

  • path โ€“

    can be one of two things: * a folder on the local filesystem * an FS URL

    • for example, 's3://my_bucket/folder/my_bento.bento'

  • protocol โ€“ (expert) The FS protocol to use when exporting. Some example protocols are 'ftp', 's3', and 'userdata'

  • user โ€“ (expert) the username used for authentication if required, e.g. for FTP

  • passwd โ€“ (expert) the username used for authentication if required, e.g. for FTP

  • params โ€“ (expert) a map of parameters to be passed to the FS used for export, e.g. {'proxy': 'myproxy.net'} for setting a proxy for FTP

  • subpath โ€“ (expert) the path inside the FS that the bento should be exported to

  • _bento_store โ€“ save Bento created to this BentoStore

Returns

A representation of the path that the Bento was exported to. If it was exported to the local filesystem,

this will be the OS path to the exported Bento. Otherwise, it will be an FS URL.

Return type

str

bentoml.import_bento(path: str, input_format: t.Optional[str] = None, *, protocol: t.Optional[str] = None, user: t.Optional[str] = None, passwd: t.Optional[str] = None, params: t.Optional[t.Dict[str, str]] = None, subpath: t.Optional[str] = None, _bento_store: BentoStore = <simple_di.providers.SingletonFactory object>) Bento[source]#

Import a bento.

Examples:

# imports 'my_bento' from '/path/to/folder/my_bento.bento'
bentoml.import_bento('/path/to/folder/my_bento.bento')

# imports 'my_bento' from '/path/to/folder/my_bento.tar.gz'
# currently supported formats are tar.gz ('gz'), tar.xz ('xz'), tar.bz2 ('bz2'), and zip
bentoml.import_bento('/path/to/folder/my_bento.tar.gz')
# treats 'my_bento.ext' as a gzipped tarfile
bentoml.import_bento('/path/to/folder/my_bento.ext', 'gz')

# imports 'my_bento', which is stored as an uncompressed folder, from '/path/to/folder/my_bento/'
bentoml.import_bento('/path/to/folder/my_bento', 'folder')

# imports 'my_bento' from the S3 bucket 'my_bucket', path 'folder/my_bento.bento'
# requires `fs-s3fs <https://pypi.org/project/fs-s3fs/>`_ ('pip install fs-s3fs')
bentoml.import_bento('s3://my_bucket/folder/my_bento.bento')
bentoml.import_bento('my_bucket/folder/my_bento.bento', protocol='s3')
bentoml.import_bento('my_bucket', protocol='s3', subpath='folder/my_bento.bento')
bentoml.import_bento('my_bucket', protocol='s3', subpath='folder/my_bento.bento',
                     user='<AWS access key>', passwd='<AWS secret key>',
                     params={'acl': 'public-read', 'cache-control': 'max-age=2592000,public'})

For a more comprehensive description of what each of the keyword arguments (protocol, user, passwd, params, and subpath) mean, see the FS URL documentation.

Parameters
  • tag โ€“ the tag of the bento to export

  • path โ€“

    can be one of two things: * a folder on the local filesystem * an FS URL, for example

    's3://my_bucket/folder/my_bento.bento'

  • protocol โ€“ (expert) The FS protocol to use when exporting. Some example protocols are 'ftp', 's3', and 'userdata'

  • user โ€“ (expert) the username used for authentication if required, e.g. for FTP

  • passwd โ€“ (expert) the username used for authentication if required, e.g. for FTP

  • params โ€“ (expert) a map of parameters to be passed to the FS used for export, e.g. {'proxy': 'myproxy.net'} for setting a proxy for FTP

  • subpath โ€“ (expert) the path inside the FS that the bento should be exported to

  • _bento_store โ€“ the bento store to save the bento to

Returns

the imported bento

Return type

Bento

Managing Models#

bentoml.models.list(tag: t.Optional[t.Union[Tag, str]] = None, *, _model_store: ModelStore = <simple_di.providers.SingletonFactory object>) t.List['Model'][source]#
bentoml.models.get(tag: t.Union[Tag, str], *, _model_store: ModelStore = <simple_di.providers.SingletonFactory object>) Model[source]#
bentoml.models.delete(tag: t.Union[Tag, str], *, _model_store: ModelStore = <simple_di.providers.SingletonFactory object>)[source]#
bentoml.models.export_model(tag: t.Union[Tag, str], path: str, output_format: t.Optional[str] = None, *, protocol: t.Optional[str] = None, user: t.Optional[str] = None, passwd: t.Optional[str] = None, params: t.Optional[t.Dict[str, str]] = None, subpath: t.Optional[str] = None, _model_store: ModelStore = <simple_di.providers.SingletonFactory object>) str[source]#

Export a BentoML model.

Examples:

# exports 'my_model' to '/path/to/folder/my_model-version.bentomodel' in BentoML's default format
bentoml.models.export_model('my_model:latest', '/path/to/folder')
# note that folders can only be passed if exporting to the local filesystem; otherwise the
# full path, including the desired filename, must be passed

# exports 'my_model' to '/path/to/folder/my_model.bentomodel' in BentoML's default format
bentoml.models.export_model('my_model:latest', '/path/to/folder/my_model')
bentoml.models.export_model('my_model:latest', '/path/to/folder/my_model.bentomodel')

# exports 'my_model' to '/path/to/folder/my_model.tar.gz in gzip format
# currently supported formats are tar.gz ('gz'), tar.xz ('xz'), tar.bz2 ('bz2'), and zip
bentoml.models.export_model('my_model:latest', '/path/to/folder/my_model.tar.gz')
bentoml.models.export_model('my_model:latest', '/path/to/folder/my_model.tar.gz', 'gz')

# exports 'my_model' to '/path/to/folder/my_model/ as a folder
bentoml.models.export_model('my_model:latest', '/path/to/folder/my_model', 'folder')

# exports 'my_model' to the S3 bucket 'my_bucket' as 'folder/my_model-version.bentomodel'
bentoml.models.export_model('my_model:latest', 's3://my_bucket/folder')
bentoml.models.export_model('my_model:latest', 'my_bucket/folder', protocol='s3')
bentoml.models.export_model('my_model:latest', 'my_bucket', protocol='s3', subpath='folder')
bentoml.models.export_model('my_model:latest', 'my_bucket', protocol='s3', subpath='folder',
                            user='<AWS access key>', passwd='<AWS secret key>',
                            params={'acl': 'public-read', 'cache-control': 'max-age=2592000,public'})

For a more comprehensive description of what each of the keyword arguments (protocol, user, passwd, params, and subpath) mean, see the FS URL documentation.

Parameters
  • tag โ€“ the tag of the model to export

  • path โ€“

    can be one of two things: * a folder on the local filesystem * an FS URL, for example,

    's3://my_bucket/folder/my_model.bentomodel'

  • protocol โ€“ (expert) The FS protocol to use when exporting. Some example protocols are 'ftp', 's3', and 'userdata'.

  • user โ€“ (expert) the username used for authentication if required, e.g. for FTP

  • passwd โ€“ (expert) the username used for authentication if required, e.g. for FTP

  • params โ€“ (expert) a map of parameters to be passed to the FS used for export, e.g. {'proxy': 'myproxy.net'} for setting a proxy for FTP

  • subpath โ€“ (expert) the path inside the FS that the model should be exported to

  • _model_store โ€“ the model store to get the model to save from

Returns

A representation of the path that the model was exported to. If it was exported to the local filesystem,

this will be the OS path to the exported model. Otherwise, it will be an FS URL.

Return type

str

bentoml.models.import_model(path: str, input_format: t.Optional[str] = None, *, protocol: t.Optional[str] = None, user: t.Optional[str] = None, passwd: t.Optional[str] = None, params: t.Optional[t.Dict[str, str]] = None, subpath: t.Optional[str] = None, _model_store: ModelStore = <simple_di.providers.SingletonFactory object>) Model[source]#

Import a bento model exported with bentoml.models.export_model. To import a model saved with a framework, see the save function under the relevant framework, e.g. bentoml.sklearn.save.

Examples:

# imports 'my_model' from '/path/to/folder/my_model.bentomodel'
bentoml.models.import_model('/path/to/folder/my_model.bentomodel')

# imports 'my_model' from '/path/to/folder/my_model.tar.gz'
# currently supported formats are tar.gz ('gz'), tar.xz ('xz'), tar.bz2 ('bz2'), and zip
bentoml.models.import_model('/path/to/folder/my_model.tar.gz')
# treats 'my_model.ext' as a gzipped tarfile
bentoml.models.import_model('/path/to/folder/my_model.ext', 'gz')

# imports 'my_model', which is stored as an uncompressed folder, from '/path/to/folder/my_model/'
bentoml.models.import_model('/path/to/folder/my_model', 'folder')

# imports 'my_model' from the S3 bucket 'my_bucket', path 'folder/my_model.bentomodel'
# requires `fs-s3fs <https://pypi.org/project/fs-s3fs/>`_ ('pip install fs-s3fs')
bentoml.models.import_model('s3://my_bucket/folder/my_model.bentomodel')
bentoml.models.import_model('my_bucket/folder/my_model.bentomodel', protocol='s3')
bentoml.models.import_model('my_bucket', protocol='s3', subpath='folder/my_model.bentomodel')
bentoml.models.import_model('my_bucket', protocol='s3', subpath='folder/my_model.bentomodel',
                            user='<AWS access key>', passwd='<AWS secret key>',
                            params={'acl': 'public-read', 'cache-control': 'max-age=2592000,public'})

For a more comprehensive description of what each of the keyword arguments (protocol, user, passwd, params, and subpath) mean, see the FS URL documentation.

Parameters
  • tag โ€“ the tag of the model to export

  • path โ€“

    can be one of two things: * a folder on the local filesystem * an FS URL, for example

    's3://my_bucket/folder/my_model.bentomodel'

  • protocol โ€“ (expert) The FS protocol to use when exporting. Some example protocols are 'ftp', 's3', and 'userdata'

  • user โ€“ (expert) the username used for authentication if required, e.g. for FTP

  • passwd โ€“ (expert) the username used for authentication if required, e.g. for FTP

  • params โ€“ (expert) a map of parameters to be passed to the FS used for export, e.g. {'proxy': 'myproxy.net'} for setting a proxy for FTP

  • subpath โ€“ (expert) the path inside the FS that the model should be exported to

  • _model_store โ€“ the model store to save the model to

Returns

the imported model

Return type

Model

Working with Yatai#

bentoml.push(tag: t.Union[Tag, str], *, force: bool = False, _bento_store: BentoStore = <simple_di.providers.SingletonFactory object>)[source]#

Push Bento to a yatai server.

bentoml.pull(tag: t.Union[Tag, str], *, force: bool = False, _bento_store: BentoStore = <simple_di.providers.SingletonFactory object>)[source]#
bentoml.models.push(tag: t.Union[Tag, str], *, force: bool = False, _model_store: ModelStore = <simple_di.providers.SingletonFactory object>)[source]#
bentoml.models.pull(tag: Union[Tag, str], *, force: bool = False) Model[source]#