nvflare.fuel.utils.fobs.fobs module

deserialize(data: bytes, **kwargs) → Any[source]

Deserialize bytes into an object.

Parameters

  • data – Serialized data

  • kwargs – Arguments passed to msgpack.unpackb

Returns

Deserialized object

deserialize_stream(stream: BinaryIO, **kwargs) → Any[source]

Deserialize bytes from stream into an object.

Parameters

  • stream – Stream to write serialized data to

  • kwargs – Arguments passed to msgpack.unpackb

Returns

Deserialized object

num_decomposers() → int[source]

Returns the number of decomposers registered.

Returns

The number of decomposers

register(decomposer: Union[Decomposer, Type[Decomposer]]) → None[source]

Register a decomposer. It does nothing if decomposer is already registered for the type

Parameters

decomposer – The decomposer type or instance

register_folder(folder: str, package: str)[source]

Scan the folder and register all decomposers found.

Parameters

  • folder – The folder to scan

  • package – The package to import the decomposers from

serialize(obj: Any, **kwargs) → bytes[source]

Serialize object into bytes.

Parameters

  • obj – Object to be serialized

  • kwargs – Arguments passed to msgpack.packb

Returns

Serialized data

serialize_stream(obj: Any, stream: BinaryIO, **kwargs)[source]

Serialize object and write the data to a stream.

Parameters

  • obj – Object to be serialized

  • stream – Stream to write the result to

  • kwargs – Arguments passed to msgpack.packb