Keras 3 API 文档 / 模型 API / 保存与序列化 / 序列化实用程序

序列化实用程序

[来源]

serialize_keras_object 函数

keras.saving.serialize_keras_object(obj)

通过序列化 Keras 对象检索配置字典。

serialize_keras_object() 将 Keras 对象序列化为表示该对象的 Python 字典,并且是 deserialize_keras_object() 的互反函数。有关配置格式的更多信息,请参阅 deserialize_keras_object()

参数

  • obj:要序列化的 Keras 对象。

返回值

表示该对象的 Python 字典。可以通过 deserialize_keras_object() 反序列化 Python 字典。


[来源]

deserialize_keras_object 函数

keras.saving.deserialize_keras_object(
    config, custom_objects=None, safe_mode=True, **kwargs
)

通过反序列化配置字典检索对象。

配置字典是一个 Python 字典,它包含一组键值对,并表示一个 Keras 对象,例如 OptimizerLayerMetrics 等。保存和加载库使用以下键来记录 Keras 对象的信息

  • class_name:字符串。这是类的名称,与源代码中定义的完全相同,例如“LossesContainer”。
  • config:字典。库定义或用户定义的键值对,用于存储对象的配置,如 object.get_config() 所获得。
  • module:字符串。Python 模块的路径。内置 Keras 类预计具有前缀 keras
  • registered_name:字符串。类通过 keras.saving.register_keras_serializable(package, name) API 注册到的键。该键的格式为“{package}>{name}”,其中 packagename 是传递给 register_keras_serializable() 的参数。如果未提供 name,则使用类名。如果 registered_name 成功解析为一个类(已注册),则字典中的 class_nameconfig 值将不会被使用。registered_name 仅用于非内置类。

例如,以下字典表示具有相关配置的内置 Adam 优化器

dict_structure = {
    "class_name": "Adam",
    "config": {
        "amsgrad": false,
        "beta_1": 0.8999999761581421,
        "beta_2": 0.9990000128746033,
        "decay": 0.0,
        "epsilon": 1e-07,
        "learning_rate": 0.0010000000474974513,
        "name": "Adam"
    },
    "module": "keras.optimizers",
    "registered_name": None
}
# Returns an `Adam` instance identical to the original one.
deserialize_keras_object(dict_structure)

如果类没有导出的 Keras 命名空间,则库会通过其 moduleclass_name 来跟踪它。例如

dict_structure = {
  "class_name": "MetricsList",
  "config": {
      ...
  },
  "module": "keras.trainers.compile_utils",
  "registered_name": "MetricsList"
}

# Returns a `MetricsList` instance identical to the original one.
deserialize_keras_object(dict_structure)

以下字典表示用户自定义的 MeanSquaredError 损失函数

@keras.saving.register_keras_serializable(package='my_package')
class ModifiedMeanSquaredError(keras.losses.MeanSquaredError):
  ...

dict_structure = {
    "class_name": "ModifiedMeanSquaredError",
    "config": {
        "fn": "mean_squared_error",
        "name": "mean_squared_error",
        "reduction": "auto"
    },
    "registered_name": "my_package>ModifiedMeanSquaredError"
}
# Returns the `ModifiedMeanSquaredError` object
deserialize_keras_object(dict_structure)

参数

  • config:描述对象的 Python 字典。
  • custom_objects:Python 字典,包含自定义对象名称与其对应的类或函数之间的映射。
  • safe_mode:布尔值,是否禁止不安全的 lambda 反序列化。当 safe_mode=False 时,加载对象有可能触发任意代码执行。此参数仅适用于 Keras v3 模型格式。默认为 True

返回值

config 字典描述的对象。


[来源]

CustomObjectScope

keras.saving.custom_object_scope(custom_objects)

将自定义类/函数公开给 Keras 反序列化内部。

with custom_object_scope(objects_dict) 范围内,Keras 方法(例如 keras.models.load_model()keras.models.model_from_config())将能够反序列化保存的配置引用的任何自定义对象(例如自定义层或指标)。

示例

考虑一个自定义正则化器 my_regularizer

layer = Dense(3, kernel_regularizer=my_regularizer)
# Config contains a reference to `my_regularizer`
config = layer.get_config()
...
# Later:
with custom_object_scope({'my_regularizer': my_regularizer}):
    layer = Dense.from_config(config)

参数

  • custom_objects{str: object} 对的字典,其中 str 键是对象名称。

[来源]

get_custom_objects 函数

keras.saving.get_custom_objects()

检索对自定义对象全局字典的实时引用。

使用 custom_object_scope() 设置的自定义对象不会添加到自定义对象的全局字典中,并且不会出现在返回的字典中。

示例

get_custom_objects().clear()
get_custom_objects()['MyObject'] = MyObject

返回值

将已注册的类名映射到类的全局字典。


[来源]

register_keras_serializable 函数

keras.saving.register_keras_serializable(package="Custom", name=None)

使用 Keras 序列化框架注册对象。

此装饰器将被装饰的类或函数注入 Keras 自定义对象字典中,以便它可以在不需要用户提供的自定义对象字典中的条目的情况下进行序列化和反序列化。它还注入一个函数,Keras 将调用该函数以获取对象的可序列化字符串键。

请注意,要进行序列化和反序列化,类必须实现 get_config() 方法。函数没有此要求。

该对象将在键 'package>name' 下注册,其中 name 在未传递时默认为对象名称。

示例

# Note that `'my_package'` is used as the `package` argument here, and since
# the `name` argument is not provided, `'MyDense'` is used as the `name`.
@register_keras_serializable('my_package')
class MyDense(keras.layers.Dense):
    pass

assert get_registered_object('my_package>MyDense') == MyDense
assert get_registered_name(MyDense) == 'my_package>MyDense'

参数

  • package:此类所属的包。这用于 key(即 "package>name")来识别类。请注意,这是传递给装饰器的第一个参数。
  • name:在此包下序列化此类的名称。如果未提供或为 None,则将使用类的名称(请注意,当装饰器仅使用一个参数时,此参数成为 package)。

返回值

使用传递的名称注册被装饰类的装饰器。