nvflare.app_opt.he.cross_site_model_eval module

class HECrossSiteModelEval(tenseal_context_file='server_context.tenseal', task_check_period=0.5, cross_val_dir='cross_site_val', submit_model_timeout=600, validation_timeout: int = 6000, model_locator_id='', formatter_id='', submit_model_task_name='submit_model', validation_task_name='validate', cleanup_models=False, participating_clients=None, wait_for_clients_timeout=300)[source]

Bases: CrossSiteModelEval

Cross Site Model Validation workflow for HE.

Parameters:

  • task_check_period (float, optional) – How often to check for new tasks or tasks being finished. Defaults to 0.5.

  • cross_val_dir (str, optional) – Path to cross site validation directory relative to run directory. Defaults to AppConstants.CROSS_VAL_DIR.

  • 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.

  • model_locator_id (str, optional) – ID for model_locator component. Defaults to “”.

  • formatter_id (str, optional) – ID for formatter component. Defaults to “”.

  • submit_model_task_name (str, optional) – Name of submit_model task. Defaults to AppConstants.TASK_SUBMIT_MODEL.

  • validation_task_name (str, optional) – Name of validate_model task. Defaults to AppConstants.TASK_VALIDATION.

  • cleanup_models (bool, optional) – Whether or not models should be deleted after run. Defaults to False.

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

  • wait_for_clients_timeout (int, optional) – Timeout for clients to appear. Defaults to 300 secs

start_controller(fl_ctx: FLContext)[source]

Starts the controller.

This method is called at the beginning of the RUN.

Parameters:

  • fl_ctx – the FL context. You can use this context to access services provided by the

  • example (framework. For) –

  • your (you can get Command Register from it and register) –

  • modules. (admin command) –