About this page

This is an API reference for Keras in BentoML. Please refer to Keras guide for more information about how to use Keras in BentoML.

bentoml.keras.save_model(name: str, model: tf_ext.KerasModel, *, tf_signatures: 'tf_ext.ConcreteFunction' | None = None, tf_save_options: 'tf_ext.SaveOptions' | None = None, include_optimizer: bool = False, signatures: t.Dict[str, ModelSignature] | t.Dict[str, ModelSignatureDict] | None = None, labels: t.Optional[t.Dict[str, str]] = None, custom_objects: t.Optional[t.Dict[str, t.Any]] = None, external_modules: t.Optional[t.List[ModuleType]] = None, metadata: t.Optional[t.Dict[str, t.Any]] = None) bentoml.Model[source]#

Save a model instance to BentoML modelstore.

  • name (str) – Name for given model instance. This should pass Python identifier check.

  • model (tensorflow.keras.Model | tensorflow.keras.engine.sequential.Sequential) – Instance of the Keras model to be saved to BentoML modelstore.

  • tf_signatures (Union[Callable[..., Any], dict], optional, default to None) – Refer to Signatures explanation from Tensorflow documentation for more information.

  • tf_save_options (tf.saved_model.SaveOptions, optional, default to None) – tf.saved_model.SaveOptions object that specifies options for saving.

  • ( (signatures) –

    code: Dict[str, bool | BatchDimType | AnyType | tuple[AnyType]]) Methods to expose for running inference on the target model. Signatures are

    used for creating Runner instances when serving model with bentoml.Service

  • labels (Dict[str, str], optional, default to None) – user-defined labels for managing models, e.g. team=nlp, stage=dev

  • custom_objects (Dict[str, Any], optional, default to None) – Dictionary of Keras custom objects, if specified.

  • external_modules (List[ModuleType], optional, default to None) – user-defined additional python modules to be saved alongside the model or custom objects, e.g. a tokenizer module, preprocessor module, model configuration module

  • metadata (Dict[str, Any], optional, default to None) – Custom metadata for given model.


A BentoML model containing the saved Keras model instance.

Return type



import bentoml
import tensorflow as tf
import tensorflow.keras as keras

def custom_activation(x):
    return tf.nn.tanh(x) ** 2

class CustomLayer(keras.layers.Layer):
    def __init__(self, units=32, **kwargs):
        super(CustomLayer, self).__init__(**kwargs)
        self.units = tf.Variable(units, name="units")

    def call(self, inputs, training=False):
        if training:
            return inputs * self.units
            return inputs

    def get_config(self):
        config = super(CustomLayer, self).get_config()
        config.update({"units": self.units.numpy()})
        return config

def KerasSequentialModel() -> keras.models.Model:
    net = keras.models.Sequential(

    opt = keras.optimizers.Adam(0.002, 0.5)
    net.compile(optimizer=opt, loss="binary_crossentropy", metrics=["accuracy"])
    return net

model = KerasSequentialModel()

# `save` a given model and retrieve coresponding tag:
bento_model = bentoml.keras.save_model("keras_model", model)

# `save` a given model with custom objects definition:
custom_objects = {
    "CustomLayer": CustomLayer,
    "custom_activation": custom_activation,
custom_bento_model = bentoml.keras.save_model("custom_obj_keras", custom_objects=custom_objects)
bentoml.keras.load_model(bento_model: str | Tag | bentoml.Model, device_name: str = '/device:CPU:0') tf_ext.KerasModel[source]#

Load a model from BentoML local modelstore with given name.

  • bento_model (str | Tag | Model) – Either the tag of the model to get from the store, or a BentoML ~bentoml.Model instance to load the model from.

  • device_name (str | None) – The device id to load the model on. The device id format should be compatible with tf.device


an instance of users keras.Model from BentoML modelstore.

Return type



import bentoml

# load a model back into memory:
loaded = bentoml.keras.load_model("keras_model")
bentoml.keras.get(tag_like: str | bentoml._internal.tag.Tag) Model[source]#

Get the BentoML model with the given tag.


tag_like – The tag of the model to retrieve from the model store.


A BentoML Model with the matching tag.

Return type



import bentoml
# target model must be from the BentoML model store
model = bentoml.keras.get("keras_resnet50")