nvflare.app_common.utils.fl_model_utils module

class FLModelUtils

Bases: object

static from_dxo(dxo: DXO) → FLModel

Converts DXO to FLModel.

static from_model_learnable(model_learnable: ModelLearnable) → FLModel

static from_shareable(shareable: Shareable, fl_ctx: FLContext | None = None) → FLModel

From NVFlare side shareable to FLModel.

This is a temporary solution to converts the shareable of existing style to FLModel, so that we can reuse the existing components we have.

In the future, we should be using the to_dxo, from_dxo directly. And all the components should be changed to accept the standard DXO.

static get_configs(model: FLModel) → dict | None

static get_meta_prop(model: FLModel, key: str, default=None)

static set_meta_prop(model: FLModel, key: str, value: Any)

static to_dxo(fl_model: FLModel) → DXO

Converts FLModel to a DXO.

static to_model_learnable(fl_model: FLModel) → ModelLearnable

static to_shareable(fl_model: FLModel) → Shareable

From FLModel to NVFlare side shareable.

This is a temporary solution to converts FLModel to the shareable of existing style, so that we can reuse the existing components we have.

In the future, we should be using the to_dxo, from_dxo directly. And all the components should be changed to accept the standard DXO.

static update_model(model: FLModel, model_update: FLModel, replace_meta: bool = True) → FLModel