def load_saved_bundle_config(bundle_path):
if _is_remote_path(bundle_path):
with _resolve_remote_bundle_path(bundle_path) as local_bundle_path:
return load_saved_bundle_config(local_bundle_path)
try:
return SavedBundleConfig.load(os.path.join(bundle_path, "bentoml.yml"))
except FileNotFoundError:
raise BentoMLException(
"BentoML can't locate config file 'bentoml.yml'"
" in saved bundle in path: {}".format(bundle_path))
def get_bento_service_metadata_pb(self):
return SavedBundleConfig(self).get_bento_service_metadata_pb()
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))
for artifact in bento_service._artifacts:
if artifact.name not in bento_service._packed_artifacts:
logger.warning(
"Missing declared artifact '%s' for BentoService '%s'",
artifact.name,
bento_service.name,
)
module_base_path = os.path.join(path, bento_service.name)
try:
os.mkdir(module_base_path)
except FileExistsError:
raise BentoMLException(
f"Existing module file found for BentoService {bento_service.name}"
)
# write README.md with custom BentoService's docstring if presented
saved_bundle_readme = DEFAULT_SAVED_BUNDLE_README.format(
bento_service.name, bento_service.version)
if bento_service.__class__.__doc__:
saved_bundle_readme += "\n"
saved_bundle_readme += bento_service.__class__.__doc__.strip()
with open(os.path.join(path, "README.md"), "w") as f:
f.write(saved_bundle_readme)
# 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, bento_service)
# 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, this make saved BentoService bundle pip installable
setup_py_content = BENTO_SERVICE_BUNDLE_SETUP_PY_TEMPLATE.format(
name=bento_service.name,
pypi_package_version=bento_service.version,
long_description=saved_bundle_readme,
)
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 bento init sh for install targz bundles
bentoml_init_script_file = os.path.join(path, 'bentoml_init.sh')
with open(bentoml_init_script_file, 'w') as f:
f.write(BENTO_INIT_SH_TEMPLATE)
# chmod +x bentoml_init_script file
st = os.stat(bentoml_init_script_file)
os.chmod(bentoml_init_script_file, st.st_mode | stat.S_IEXEC)
# write bentoml.yml
config = SavedBundleConfig(bento_service)
config["metadata"].update({
"module_name": module_name,
"module_file": module_file
})
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 saved BentoService bundle
if _is_bentoml_in_develop_mode():
add_local_bentoml_package_to_repo(path)
logger.info(
"BentoService bundle '%s:%s' created at: %s",
bento_service.name,
bento_service.version,
path,
)