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 字典。该 Python 字典可以通过 deserialize_keras_object() 进行反序列化。


[源代码]

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)。

返回

一个装饰器,用于使用传递的名称注册被装饰的类。