nvflare.app_common.statistics.statisitcs_objects_decomposer module

class BinDecomposer

Bases: Decomposer

decompose(b: Bin, 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: list, manager: DatumManager | None = None) → Bin

Reconstruct the object from decomposed components.

Parameters:

• data – The decomposed component

• manager – Datum manager to internalize datum

Returns:

The reconstructed object

supported_type() → Type[Any]

Returns the type/class supported by this decomposer.

Returns:

The class (not instance) of supported type

class BinRangeDecomposer

Bases: Decomposer

decompose(b: BinRange, 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: list, manager: DatumManager | None = None) → BinRange

Reconstruct the object from decomposed components.

Parameters:

• data – The decomposed component

• manager – Datum manager to internalize datum

Returns:

The reconstructed object

supported_type() → Type[Any]

Returns the type/class supported by this decomposer.

Returns:

The class (not instance) of supported type

class DataTypeDecomposer

Bases: Decomposer

decompose(target: DataType, 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) → DataType

Reconstruct the object from decomposed components.

Parameters:

• data – The decomposed component

• manager – Datum manager to internalize datum

Returns:

The reconstructed object

supported_type() → Type[DataType]

Returns the type/class supported by this decomposer.

Returns:

The class (not instance) of supported type

class FeatureDecomposer

Bases: Decomposer

decompose(f: Feature, 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: list, manager: DatumManager | None = None) → Feature

Reconstruct the object from decomposed components.

Parameters:

• data – The decomposed component

• manager – Datum manager to internalize datum

Returns:

The reconstructed object

supported_type() → Type[Any]

Returns the type/class supported by this decomposer.

Returns:

The class (not instance) of supported type

class HistogramDecomposer

Bases: Decomposer

decompose(b: Histogram, 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: list, manager: DatumManager | None = None) → Histogram

Reconstruct the object from decomposed components.

Parameters:

• data – The decomposed component

• manager – Datum manager to internalize datum

Returns:

The reconstructed object

supported_type() → Type[Any]

Returns the type/class supported by this decomposer.

Returns:

The class (not instance) of supported type

class HistogramTypeDecomposer

Bases: Decomposer

decompose(target: HistogramType, 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) → HistogramType

Reconstruct the object from decomposed components.

Parameters:

• data – The decomposed component

• manager – Datum manager to internalize datum

Returns:

The reconstructed object

supported_type() → Type[HistogramType]

Returns the type/class supported by this decomposer.

Returns:

The class (not instance) of supported type

class StatisticConfigDecomposer

Bases: Decomposer

decompose(statistic_config: StatisticConfig, 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: list, manager: DatumManager | None = None) → StatisticConfig

Reconstruct the object from decomposed components.

Parameters:

• data – The decomposed component

• manager – Datum manager to internalize datum

Returns:

The reconstructed object

supported_type() → Type[Any]

Returns the type/class supported by this decomposer.

Returns:

The class (not instance) of supported type

fobs_registration()