nvflare.app_common.statistics.statisitcs_objects_decomposer module

class BinDecomposer

Bases: Decomposer

decompose(b: Bin) → 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

Returns:

The decomposed serializable objects

recompose(data: list) → Bin

Reconstruct the object from decomposed components.

Parameters:

data – The decomposed components

Returns:

The reconstructed object

static 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) → 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

Returns:

The decomposed serializable objects

recompose(data: list) → BinRange

Reconstruct the object from decomposed components.

Parameters:

data – The decomposed components

Returns:

The reconstructed object

static 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(dt: DataType) → 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

Returns:

The decomposed serializable objects

recompose(data: Any) → DataType

Reconstruct the object from decomposed components.

Parameters:

data – The decomposed components

Returns:

The reconstructed object

static supported_type() → Type[Any]

Returns the type/class supported by this decomposer.

Returns:

The class (not instance) of supported type

class FeatureDecomposer

Bases: Decomposer

decompose(f: Feature) → 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

Returns:

The decomposed serializable objects

recompose(data: list) → Feature

Reconstruct the object from decomposed components.

Parameters:

data – The decomposed components

Returns:

The reconstructed object

static 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) → 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

Returns:

The decomposed serializable objects

recompose(data: list) → Histogram

Reconstruct the object from decomposed components.

Parameters:

data – The decomposed components

Returns:

The reconstructed object

static 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(ht: HistogramType) → 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

Returns:

The decomposed serializable objects

recompose(data: Any) → HistogramType

Reconstruct the object from decomposed components.

Parameters:

data – The decomposed components

Returns:

The reconstructed object

static supported_type() → Type[Any]

Returns the type/class supported by this decomposer.

Returns:

The class (not instance) of supported type

class StatisticConfigDecomposer

Bases: Decomposer

decompose(statistic_config: StatisticConfig) → 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

Returns:

The decomposed serializable objects

recompose(data: list) → StatisticConfig

Reconstruct the object from decomposed components.

Parameters:

data – The decomposed components

Returns:

The reconstructed object

static supported_type() → Type[Any]

Returns the type/class supported by this decomposer.

Returns:

The class (not instance) of supported type

fobs_registration()