def _save(bento_service, dst, version=None):
Path(os.path.join(dst), bento_service.name).mkdir(parents=True, exist_ok=True)
# Update path to subfolder in the form of 'base/service_name/version/'
path = os.path.join(dst, bento_service.name, version)
if os.path.exists(path):
raise ValueError("Version {version} in Path: {dst} already "
"exist.".format(version=version, dst=dst))
os.mkdir(path)
module_base_path = os.path.join(path, bento_service.name)
os.mkdir(module_base_path)
# write README.md with user model's docstring
if bento_service.__class__.__doc__:
model_description = bento_service.__class__.__doc__.strip()
else:
model_description = DEFAULT_BENTO_ARCHIVE_DESCRIPTION
with open(os.path.join(path, 'README.md'), 'w') as f:
f.write(model_description)
# save all model artifacts to 'base_path/name/artifacts/' directory
bento_service.artifacts.save(module_base_path)
# write conda environment, requirement.txt
bento_service.env.save(path)
# TODO: add bentoml.find_packages helper for more fine grained control over
# this process, e.g. packages=find_packages(base, [], exclude=[], used_module_only=True)
# copy over all custom model code
module_name, module_file = copy_used_py_modules(bento_service.__class__.__module__,
os.path.join(path, bento_service.name))
# create __init__.py
with open(os.path.join(path, bento_service.name, '__init__.py'), "w") as f:
f.write(
INIT_PY_TEMPLATE.format(service_name=bento_service.name, module_name=module_name,
pypi_package_version=version))
# write setup.py, make exported model pip installable
setup_py_content = BENTO_MODEL_SETUP_PY_TEMPLATE.format(
name=bento_service.name, pypi_package_version=version, long_description=model_description)
with open(os.path.join(path, 'setup.py'), 'w') as f:
f.write(setup_py_content)
with open(os.path.join(path, 'MANIFEST.in'), 'w') as f:
f.write(MANIFEST_IN_TEMPLATE.format(service_name=bento_service.name))
# write Dockerfile
with open(os.path.join(path, 'Dockerfile'), 'w') as f:
f.write(BENTO_SERVICE_DOCKERFILE_CPU_TEMPLATE)
# write bentoml.yml
config = BentoArchiveConfig()
config["metadata"].update({
'service_name': bento_service.name,
'service_version': version,
'module_name': module_name,
'module_file': module_file,
})
config['env'] = bento_service.env.to_dict()
config.write_to_path(path)
# Also write bentoml.yml to module base path to make it accessible
# as package data after pip installed as a python package
config.write_to_path(module_base_path)
def save_to_dir(bento_service, path, version=None):
"""Save given BentoService along with all its artifacts, source code and
dependencies to target file path, assuming path exist and empty. If target path
is not empty, this call may override existing files in the given path.
Args:
bento_service (bentoml.service.BentoService): a Bento Service instance
path (str): Destination of where the bento service will be saved
"""
track_save(bento_service)
from bentoml.service import BentoService
if not isinstance(bento_service, BentoService):
raise BentoMLException(
"save_to_dir only work with instance of custom BentoService class")
if version is not None:
bento_service.set_version(version)
if not os.path.exists(path):
raise BentoMLException("Directory '{}' not found".format(path))
module_base_path = os.path.join(path, bento_service.name)
os.mkdir(module_base_path)
# write README.md with user model's docstring
if bento_service.__class__.__doc__:
model_description = bento_service.__class__.__doc__.strip()
else:
model_description = DEFAULT_BENTO_ARCHIVE_DESCRIPTION
with open(os.path.join(path, "README.md"), "w") as f:
f.write(model_description)
# save all model artifacts to 'base_path/name/artifacts/' directory
if bento_service.artifacts:
bento_service.artifacts.save(module_base_path)
# write conda environment, requirement.txt
bento_service.env.save(path)
# TODO: add bentoml.find_packages helper for more fine grained control over this
# process, e.g. packages=find_packages(base, [], exclude=[], used_module_only=True)
# copy over all custom model code
module_name, module_file = copy_used_py_modules(
bento_service.__class__.__module__,
os.path.join(path, bento_service.name))
# create __init__.py
with open(os.path.join(path, bento_service.name, "__init__.py"), "w") as f:
f.write(
INIT_PY_TEMPLATE.format(
service_name=bento_service.name,
module_name=module_name,
pypi_package_version=bento_service.version,
))
# write setup.py, make exported model pip installable
setup_py_content = BENTO_MODEL_SETUP_PY_TEMPLATE.format(
name=bento_service.name,
pypi_package_version=bento_service.version,
long_description=model_description,
)
with open(os.path.join(path, "setup.py"), "w") as f:
f.write(setup_py_content)
with open(os.path.join(path, "MANIFEST.in"), "w") as f:
f.write(MANIFEST_IN_TEMPLATE.format(service_name=bento_service.name))
# write Dockerfile
with open(os.path.join(path, "Dockerfile"), "w") as f:
f.write(BENTO_SERVICE_DOCKERFILE_CPU_TEMPLATE)
with open(os.path.join(path, "Dockerfile-sagemaker"), "w") as f:
f.write(BENTO_SERVICE_DOCKERFILE_SAGEMAKER_TEMPLATE)
# write bento init sh for install targz bundles
with open(os.path.join(path, 'bentoml_init.sh'), 'w') as f:
f.write(BENTO_INIT_SH_TEMPLATE)
# write bentoml.yml
config = BentoArchiveConfig()
config["metadata"].update({
"service_name": bento_service.name,
"service_version": bento_service.version,
"module_name": module_name,
"module_file": module_file,
})
config["env"] = bento_service.env.to_dict()
config['apis'] = _get_apis_list(bento_service)
config['artifacts'] = _get_artifacts_list(bento_service)
config.write_to_path(path)
# Also write bentoml.yml to module base path to make it accessible
# as package data after pip installed as a python package
config.write_to_path(module_base_path)
# if bentoml package in editor mode(pip install -e), will include
# that bentoml package to bento archive
if _is_bentoml_in_develop_mode():
add_local_bentoml_package_to_repo(path)
logger.info(
"Successfully saved Bento '%s:%s' to path: %s",
bento_service.name,
bento_service.version,
path,
)