nvflare.apis.dxo module

class DXO(data_kind: str, data: dict, meta: Optional[dict] = None)

Bases: object

Init the DXO.

The Data Exchange Object standardizes the data passed between communicating parties.

Parameters

• data_kind – kind of data

• data – clear-text data

• meta – None or dict for any additional properties

get_meta_prop(key: str, default=None)

get_meta_props()

remove_meta_props(keys: List[str])

set_meta_prop(key: str, value)

to_bytes() → bytes

Serialize the DXO object into bytes.

Returns

object serialized in bytes.

to_shareable() → Shareable

Convert the DXO object into Shareable.

Returns

Shareable object.

update_meta_props(meta)

update_shareable(s: Shareable) → Shareable

validate() → str

class DataKind

Bases: object

ANALYTIC = 'ANALYTIC'

COLLECTION = 'COLLECTION'

METRICS = 'METRICS'

MODEL = 'MODEL'

WEIGHTS = 'WEIGHTS'

WEIGHT_DIFF = 'WEIGHT_DIFF'

class MetaKey

Bases: object

INITIAL_METRICS = 'initial_metrics'

MODEL_OWNER = 'MODEL_OWNER'

NUM_STEPS_CURRENT_ROUND = 'NUM_STEPS_CURRENT_ROUND'

PROCESSED_ALGORITHM = 'PROCESSED_ALGORITHM'

PROCESSED_KEYS = 'PROCESSED_KEYS'

from_bytes(data: bytes) → DXO

Convert the data bytes into Model object.

Parameters

data – a bytes object

Returns

an object loaded by FOBS from data

from_shareable(s: Shareable) → DXO

Convert Shareable into a DXO object.

Parameters

s – Shareable object

Returns

DXO object.