nvflare.apis.utils.decomposers.flare_decomposers module

Decomposers for objects used by NVFlare itself

This module contains all the decomposers used to run NVFlare. The decomposers are registered at server/client startup.

class ContextDecomposer

Bases: Decomposer

decompose(target: FLContext, manager: DatumManager | None = None) → Any

Decompose the target into types supported by msgpack or classes with decomposers registered.

Msgpack supports primitives, bytes, memoryview, lists, dicts.

Parameters:

• target – The instance to be serialized

• manager – Datum manager to store externalized datum

Returns:

The decomposed serializable objects

recompose(data: Any, manager: DatumManager | None = None) → FLContext

Reconstruct the object from decomposed components.

Parameters:

• data – The decomposed component

• manager – Datum manager to internalize datum

Returns:

The reconstructed object

supported_type()

Returns the type/class supported by this decomposer.

Returns:

The class (not instance) of supported type

class DXODecomposer

Bases: Decomposer

decompose(target: DXO, datum_manager=None) → Any

Decompose the target into types supported by msgpack or classes with decomposers registered.

Msgpack supports primitives, bytes, memoryview, lists, dicts.

Parameters:

• target – The instance to be serialized

• manager – Datum manager to store externalized datum

Returns:

The decomposed serializable objects

recompose(data: Any, datum_manager=None) → DXO

Reconstruct the object from decomposed components.

Parameters:

• data – The decomposed component

• manager – Datum manager to internalize datum

Returns:

The reconstructed object

supported_type()

Returns the type/class supported by this decomposer.

Returns:

The class (not instance) of supported type

class WorkspaceDecomposer

Bases: Decomposer

decompose(target: Workspace, manager: DatumManager | None = None) → Any

Decompose the target into types supported by msgpack or classes with decomposers registered.

Msgpack supports primitives, bytes, memoryview, lists, dicts.

Parameters:

• target – The instance to be serialized

• manager – Datum manager to store externalized datum

Returns:

The decomposed serializable objects

recompose(data: Any, manager: DatumManager | None = None) → Workspace

Reconstruct the object from decomposed components.

Parameters:

• data – The decomposed component

• manager – Datum manager to internalize datum

Returns:

The reconstructed object

supported_type()

Returns the type/class supported by this decomposer.

Returns:

The class (not instance) of supported type

register()