nvflare.apis.dxo module¶
- class DXO(data_kind: str, data: dict, meta: dict | None = None)[source]¶
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
- to_bytes() bytes [source]¶
Serialize the DXO object into bytes.
- Returns:
object serialized in bytes.
Convert the DXO object into Shareable.
- Returns:
Shareable object.
- class DataKind[source]¶
Bases:
object
- ANALYTIC = 'ANALYTIC'¶
- COLLECTION = 'COLLECTION'¶
- METRICS = 'METRICS'¶
- PSI = 'PSI'¶
- STATISTICS = 'STATISTICS'¶
- WEIGHTS = 'WEIGHTS'¶
- WEIGHT_DIFF = 'WEIGHT_DIFF'¶
- XGB_MODEL = 'XGB_MODEL'¶
- class MetaKey[source]¶
Bases:
object
- FILTER_HISTORY = 'filter_history'¶
- INITIAL_METRICS = 'initial_metrics'¶
- NUM_STEPS_CURRENT_ROUND = 'NUM_STEPS_CURRENT_ROUND'¶
- PROCESSED_ALGORITHM = 'PROCESSED_ALGORITHM'¶
- PROCESSED_KEYS = 'PROCESSED_KEYS'¶
- from_bytes(data: bytes) DXO [source]¶
Convert the data bytes into Model object.
- Parameters:
data – a bytes object
- Returns:
an object loaded by FOBS from data
Convert Shareable into a DXO object.
- Parameters:
s – Shareable object
- Returns:
DXO object.