fl4health.clients package

Subpackages

• fl4health.clients.deep_mmd_clients package
  • Submodules
    • fl4health.clients.deep_mmd_clients.ditto_deep_mmd_client module
      • DittoDeepMmdClient
    • fl4health.clients.deep_mmd_clients.mr_mtl_deep_mmd_client module
      • MrMtlDeepMmdClient
• fl4health.clients.flexible package
  • Submodules
    • fl4health.clients.flexible.base module
      • FlexibleClient
    • fl4health.clients.flexible.nnunet module
      • FlexibleNnunetClient
• fl4health.clients.mkmmd_clients package
  • Submodules
    • fl4health.clients.mkmmd_clients.ditto_mkmmd_client module
      • DittoMkMmdClient
    • fl4health.clients.mkmmd_clients.mr_mtl_mkmmd_client module
      • MrMtlMkMmdClient

Submodules

• fl4health.clients.adaptive_drift_constraint_client module
  • AdaptiveDriftConstraintClient
    • AdaptiveDriftConstraintClient.__init__()
    • AdaptiveDriftConstraintClient.compute_penalty_loss()
    • AdaptiveDriftConstraintClient.compute_training_loss()
    • AdaptiveDriftConstraintClient.get_parameter_exchanger()
    • AdaptiveDriftConstraintClient.get_parameters()
    • AdaptiveDriftConstraintClient.set_parameters()
    • AdaptiveDriftConstraintClient.update_after_train()
• fl4health.clients.apfl_client module
  • ApflClient
    • ApflClient.__init__()
    • ApflClient.compute_loss_and_additional_losses()
    • ApflClient.get_optimizer()
    • ApflClient.get_parameter_exchanger()
    • ApflClient.is_start_of_local_training()
    • ApflClient.set_optimizer()
    • ApflClient.train_step()
    • ApflClient.update_after_step()
• fl4health.clients.basic_client module
  • BasicClient
    • BasicClient.__init__()
    • BasicClient.compute_evaluation_loss()
    • BasicClient.compute_loss_and_additional_losses()
    • BasicClient.compute_training_loss()
    • BasicClient.evaluate()
    • BasicClient.fit()
    • BasicClient.get_client_specific_logs()
    • BasicClient.get_client_specific_reports()
    • BasicClient.get_criterion()
    • BasicClient.get_data_loaders()
    • BasicClient.get_lr_scheduler()
    • BasicClient.get_model()
    • BasicClient.get_optimizer()
    • BasicClient.get_parameter_exchanger()
    • BasicClient.get_parameters()
    • BasicClient.get_properties()
    • BasicClient.get_test_data_loader()
    • BasicClient.initialize_all_model_weights()
    • BasicClient.predict()
    • BasicClient.process_config()
    • BasicClient.set_optimizer()
    • BasicClient.set_parameters()
    • BasicClient.setup_client()
    • BasicClient.setup_client_and_return_all_model_parameters()
    • BasicClient.shutdown()
    • BasicClient.train_by_epochs()
    • BasicClient.train_by_steps()
    • BasicClient.train_step()
    • BasicClient.transform_gradients()
    • BasicClient.transform_target()
    • BasicClient.update_after_step()
    • BasicClient.update_after_train()
    • BasicClient.update_before_epoch()
    • BasicClient.update_before_step()
    • BasicClient.update_before_train()
    • BasicClient.update_lr_schedulers()
    • BasicClient.update_metric_manager()
    • BasicClient.val_step()
    • BasicClient.validate()
• fl4health.clients.clipping_client module
  • NumpyClippingClient
    • NumpyClippingClient.__init__()
    • NumpyClippingClient.calculate_parameters_norm()
    • NumpyClippingClient.clip_parameters()
    • NumpyClippingClient.compute_weight_update_and_clip()
    • NumpyClippingClient.get_parameter_exchanger()
    • NumpyClippingClient.get_parameters()
    • NumpyClippingClient.set_parameters()
    • NumpyClippingClient.setup_client()
• fl4health.clients.constrained_fenda_client module
  • ConstrainedFendaClient
    • ConstrainedFendaClient.__init__()
    • ConstrainedFendaClient.compute_evaluation_loss()
    • ConstrainedFendaClient.compute_loss_and_additional_losses()
    • ConstrainedFendaClient.get_parameter_exchanger()
    • ConstrainedFendaClient.predict()
    • ConstrainedFendaClient.update_after_train()
    • ConstrainedFendaClient.update_before_train()
• fl4health.clients.ditto_client module
  • DittoClient
    • DittoClient.__init__()
    • DittoClient.compute_evaluation_loss()
    • DittoClient.compute_loss_and_additional_losses()
    • DittoClient.compute_training_loss()
    • DittoClient.get_global_model()
    • DittoClient.get_optimizer()
    • DittoClient.get_parameters()
    • DittoClient.initialize_all_model_weights()
    • DittoClient.predict()
    • DittoClient.set_initial_global_tensors()
    • DittoClient.set_optimizer()
    • DittoClient.set_parameters()
    • DittoClient.setup_client()
    • DittoClient.train_step()
    • DittoClient.update_before_train()
    • DittoClient.validate()
• fl4health.clients.ensemble_client module
  • EnsembleClient
    • EnsembleClient.__init__()
    • EnsembleClient.compute_evaluation_loss()
    • EnsembleClient.compute_training_loss()
    • EnsembleClient.get_optimizer()
    • EnsembleClient.set_optimizer()
    • EnsembleClient.setup_client()
    • EnsembleClient.train_step()
• fl4health.clients.evaluate_client module
  • EvaluateClient
    • EvaluateClient.__init__()
    • EvaluateClient.evaluate()
    • EvaluateClient.fit()
    • EvaluateClient.get_data_loader()
    • EvaluateClient.get_local_model()
    • EvaluateClient.get_parameter_exchanger()
    • EvaluateClient.get_parameters()
    • EvaluateClient.initialize_global_model()
    • EvaluateClient.merge_metrics()
    • EvaluateClient.set_parameters()
    • EvaluateClient.setup_client()
    • EvaluateClient.validate()
    • EvaluateClient.validate_on_model()
• fl4health.clients.fed_pca_client module
  • FedPCAClient
    • FedPCAClient.__init__()
    • FedPCAClient.evaluate()
    • FedPCAClient.fit()
    • FedPCAClient.generate_hash()
    • FedPCAClient.get_data_loaders()
    • FedPCAClient.get_data_tensor()
    • FedPCAClient.get_model()
    • FedPCAClient.get_parameters()
    • FedPCAClient.save_model()
    • FedPCAClient.set_parameters()
    • FedPCAClient.setup_client()
• fl4health.clients.fed_prox_client module
  • FedProxClient
    • FedProxClient.update_before_train()
• fl4health.clients.fedbn_client module
  • FedBnClient
    • FedBnClient.setup_client()
• fl4health.clients.fedper_client module
  • FedPerClient
    • FedPerClient.get_parameter_exchanger()
• fl4health.clients.fedpm_client module
  • FedPmClient
    • FedPmClient.__init__()
    • FedPmClient.get_parameter_exchanger()
    • FedPmClient.setup_client()
• fl4health.clients.fedrep_client module
  • FedRepClient
    • FedRepClient.__init__()
    • FedRepClient.fit()
    • FedRepClient.get_optimizer()
    • FedRepClient.get_parameter_exchanger()
    • FedRepClient.process_fed_rep_config()
    • FedRepClient.set_optimizer()
    • FedRepClient.train_fedrep_by_epochs()
    • FedRepClient.train_fedrep_by_steps()
    • FedRepClient.train_step()
  • FedRepTrainMode
    • FedRepTrainMode.HEAD
    • FedRepTrainMode.REPRESENTATION
• fl4health.clients.fenda_client module
  • FendaClient
    • FendaClient.__init__()
    • FendaClient.get_parameter_exchanger()
• fl4health.clients.fenda_ditto_client module
  • FendaDittoClient
    • FendaDittoClient.__init__()
    • FendaDittoClient.compute_training_loss()
    • FendaDittoClient.get_global_model()
    • FendaDittoClient.get_model()
    • FendaDittoClient.get_parameters()
    • FendaDittoClient.predict()
    • FendaDittoClient.set_initial_global_tensors()
    • FendaDittoClient.set_parameters()
    • FendaDittoClient.setup_client()
    • FendaDittoClient.update_before_train()
• fl4health.clients.flash_client module
  • FlashClient
    • FlashClient.__init__()
    • FlashClient.process_config()
    • FlashClient.setup_client()
    • FlashClient.train_by_epochs()
• fl4health.clients.gpfl_client module
  • GpflClient
    • GpflClient.__init__()
    • GpflClient.calculate_class_sample_proportions()
    • GpflClient.compute_conditional_inputs()
    • GpflClient.compute_magnitude_level_loss()
    • GpflClient.compute_training_loss()
    • GpflClient.get_optimizer()
    • GpflClient.get_parameter_exchanger()
    • GpflClient.set_optimizer()
    • GpflClient.setup_client()
    • GpflClient.train_step()
    • GpflClient.transform_input()
    • GpflClient.update_before_train()
    • GpflClient.val_step()
• fl4health.clients.instance_level_dp_client module
  • InstanceLevelDpClient
    • InstanceLevelDpClient.__init__()
    • InstanceLevelDpClient.setup_client()
    • InstanceLevelDpClient.setup_opacus_objects()
• fl4health.clients.model_merge_client module
  • ModelMergeClient
    • ModelMergeClient.__init__()
    • ModelMergeClient.evaluate()
    • ModelMergeClient.fit()
    • ModelMergeClient.get_model()
    • ModelMergeClient.get_parameter_exchanger()
    • ModelMergeClient.get_parameters()
    • ModelMergeClient.get_test_data_loader()
    • ModelMergeClient.set_parameters()
    • ModelMergeClient.setup_client()
    • ModelMergeClient.validate()
• fl4health.clients.moon_client module
  • MoonClient
    • MoonClient.__init__()
    • MoonClient.compute_evaluation_loss()
    • MoonClient.compute_loss_and_additional_losses()
    • MoonClient.compute_training_loss()
    • MoonClient.predict()
    • MoonClient.update_after_train()
    • MoonClient.update_before_train()
• fl4health.clients.mr_mtl_client module
  • MrMtlClient
    • MrMtlClient.__init__()
    • MrMtlClient.compute_training_loss()
    • MrMtlClient.set_parameters()
    • MrMtlClient.setup_client()
    • MrMtlClient.update_before_train()
    • MrMtlClient.validate()
• fl4health.clients.nnunet_client module
  • NnunetClient
    • NnunetClient.__init__()
    • NnunetClient.compute_loss_and_additional_losses()
    • NnunetClient.create_plans()
    • NnunetClient.empty_cache()
    • NnunetClient.get_client_specific_logs()
    • NnunetClient.get_client_specific_reports()
    • NnunetClient.get_criterion()
    • NnunetClient.get_data_loaders()
    • NnunetClient.get_lr_scheduler()
    • NnunetClient.get_model()
    • NnunetClient.get_optimizer()
    • NnunetClient.get_properties()
    • NnunetClient.mask_data()
    • NnunetClient.maybe_extract_fingerprint()
    • NnunetClient.maybe_preprocess()
    • NnunetClient.predict()
    • NnunetClient.setup_client()
    • NnunetClient.shutdown()
    • NnunetClient.shutdown_dataloader()
    • NnunetClient.train_step()
    • NnunetClient.transform_gradients()
    • NnunetClient.update_before_train()
    • NnunetClient.update_metric_manager()
• fl4health.clients.partial_weight_exchange_client module
  • PartialWeightExchangeClient
    • PartialWeightExchangeClient.__init__()
    • PartialWeightExchangeClient.get_parameter_exchanger()
    • PartialWeightExchangeClient.get_parameters()
    • PartialWeightExchangeClient.set_parameters()
    • PartialWeightExchangeClient.setup_client()
• fl4health.clients.perfcl_client module
  • PerFclClient
    • PerFclClient.__init__()
    • PerFclClient.compute_evaluation_loss()
    • PerFclClient.compute_loss_and_additional_losses()
    • PerFclClient.get_parameter_exchanger()
    • PerFclClient.predict()
    • PerFclClient.update_after_train()
    • PerFclClient.update_before_train()
• fl4health.clients.scaffold_client module
  • DPScaffoldClient
    • DPScaffoldClient.__init__()
  • ScaffoldClient
    • ScaffoldClient.__init__()
    • ScaffoldClient.compute_parameters_delta()
    • ScaffoldClient.compute_updated_control_variates()
    • ScaffoldClient.get_parameter_exchanger()
    • ScaffoldClient.get_parameters()
    • ScaffoldClient.modify_grad()
    • ScaffoldClient.set_parameters()
    • ScaffoldClient.setup_client()
    • ScaffoldClient.transform_gradients()
    • ScaffoldClient.update_after_train()
    • ScaffoldClient.update_control_variates()
• fl4health.clients.tabular_data_client module