nvflare.app_common.workflows.cross_site_eval module

class CrossSiteEval(*args, cross_val_dir='cross_site_val', submit_model_timeout=600, validation_timeout: int = 6000, server_models=['FL_global_model.pt'], participating_clients=None, **kwargs)[source]

Bases: ModelController

Cross Site Evaluation Workflow.

# TODO: change validation to evaluation to reflect the real meaning

Parameters:

  • cross_val_dir (str, optional) – Path to cross site validation directory relative to run directory. Defaults to “cross_site_val”.

  • submit_model_timeout (int, optional) – Timeout of submit_model_task. Defaults to 600 secs.

  • validation_timeout (int, optional) – Timeout for validate_model task. Defaults to 6000 secs.

  • participating_clients (list, optional) – List of participating client names. If not provided, defaults to all clients connected at start of controller.

initialize(fl_ctx)[source]

Called by the framework to initialize the Learner object. This is called before the Learner can train or validate. This is called only once.

run() → None[source]

Main run routine for the controller workflow.

save_results()[source]
track_results(model_owner, data_client, val_results: FLModel)[source]