chainer.serializers.DictionarySerializer

class chainer.serializers.DictionarySerializer(target=None, path='')

Serializer for dictionary.

This is the standard serializer in Chainer. The hierarchy of objects are simply mapped to a flat dictionary with keys representing the paths to objects in the hierarchy.

Note

Despite of its name, this serializer DOES NOT serialize the object into external files. It just build a flat dictionary of arrays that can be fed into numpy.savez() and numpy.savez_compressed(). If you want to use this serializer directly, you have to manually send a resulting dictionary to one of these functions.

Parameters

• target (dict) – The dictionary that this serializer saves the objects to. If target is None, then a new dictionary is created.

• path (str) – The base path in the hierarchy that this serializer indicates.

Variables

target (dict) – The target dictionary. Once the serialization completes, this dictionary can be fed into numpy.savez() or numpy.savez_compressed() to serialize it in the NPZ format.

Methods

__call__(key, value)

Serializes or deserializes a value by given name.

This operator saves or loads a value by given name.

If this is a serializer, then the value is simply saved at the key. Note that some type information might be missed depending on the implementation (and the target file format).

If this is a deserializer, then the value is loaded by the key. The deserialization differently works on scalars and arrays. For scalars, the value argument is used just for determining the type of restored value to be converted, and the converted value is returned. For arrays, the restored elements are directly copied into the value argument. String values are treated like scalars.

Note

Serializers and deserializers are required to correctly handle the None value. When value is None, serializers save it in format-dependent ways, and deserializers just return the loaded value. When the saved None value is loaded by a deserializer, it should quietly return the None value without modifying the value object.

Parameters

• key (str) – Name of the serialization entry.

• value (scalar, numpy.ndarray, cupy.ndarray, None, or str) – Object to be (de)serialized. None is only supported by deserializers.

Returns

Serialized or deserialized value.

__getitem__(key)

Gets a child serializer.

This operator creates a _child_ serializer represented by the given key.

Parameters

key (str) – Name of the child serializer.

save(obj)

Saves an object by this serializer.

This is equivalent to obj.serialize(self).

Parameters

obj – Target object to be serialized.