fl4health package

Subpackages

• fl4health.checkpointing package
  • Submodules
    • fl4health.checkpointing.checkpointer module
      • BestLossTorchModuleCheckpointer
      • FunctionTorchModuleCheckpointer
      • LatestTorchModuleCheckpointer
      • PerRoundStateCheckpointer
      • TorchModuleCheckpointer
    • fl4health.checkpointing.client_module module
      • CheckpointMode
      • ClientCheckpointAndStateModule
    • fl4health.checkpointing.opacus_checkpointer module
      • BestLossOpacusCheckpointer
      • LatestOpacusCheckpointer
      • OpacusCheckpointer
    • fl4health.checkpointing.server_module module
      • AdaptiveConstraintServerCheckpointAndStateModule
      • BaseServerCheckpointAndStateModule
      • ClippingBitServerCheckpointAndStateModule
      • DpScaffoldServerCheckpointAndStateModule
      • LayerNamesServerCheckpointAndStateModule
      • NnUnetServerCheckpointAndStateModule
      • OpacusServerCheckpointAndStateModule
      • PackingServerCheckpointAndAndStateModule
      • ScaffoldServerCheckpointAndStateModule
      • SparseCooServerCheckpointAndStateModule
• fl4health.client_managers package
  • Submodules
    • fl4health.client_managers.base_sampling_manager module
      • BaseFractionSamplingManager
    • fl4health.client_managers.fixed_sampling_client_manager module
      • FixedSamplingClientManager
    • fl4health.client_managers.fixed_without_replacement_manager module
      • FixedSamplingByFractionClientManager
    • fl4health.client_managers.poisson_sampling_manager module
      • PoissonSamplingClientManager
• fl4health.clients package
  • Subpackages
    • fl4health.clients.deep_mmd_clients namespace
      • Submodules
    • fl4health.clients.mkmmd_clients namespace
      • Submodules
  • Submodules
    • fl4health.clients.adaptive_drift_constraint_client module
      • AdaptiveDriftConstraintClient
    • fl4health.clients.apfl_client module
      • ApflClient
    • fl4health.clients.basic_client module
      • BasicClient
    • fl4health.clients.clipping_client module
      • NumpyClippingClient
    • fl4health.clients.constrained_fenda_client module
      • ConstrainedFendaClient
    • fl4health.clients.ditto_client module
      • DittoClient
    • fl4health.clients.ensemble_client module
      • EnsembleClient
    • fl4health.clients.evaluate_client module
      • EvaluateClient
    • fl4health.clients.fed_pca_client module
      • FedPCAClient
    • fl4health.clients.fed_prox_client module
      • FedProxClient
    • fl4health.clients.fedper_client module
      • FedPerClient
    • fl4health.clients.fedpm_client module
      • FedPmClient
    • fl4health.clients.fedrep_client module
      • FedRepClient
      • FedRepTrainMode
    • fl4health.clients.fenda_client module
      • FendaClient
    • fl4health.clients.fenda_ditto_client module
      • FendaDittoClient
    • fl4health.clients.flash_client module
      • FlashClient
    • fl4health.clients.instance_level_dp_client module
      • InstanceLevelDpClient
    • fl4health.clients.model_merge_client module
      • ModelMergeClient
    • fl4health.clients.moon_client module
      • MoonClient
    • fl4health.clients.mr_mtl_client module
      • MrMtlClient
    • fl4health.clients.nnunet_client module
      • NnunetClient
    • fl4health.clients.partial_weight_exchange_client module
      • PartialWeightExchangeClient
    • fl4health.clients.perfcl_client module
      • PerFclClient
    • fl4health.clients.scaffold_client module
      • DPScaffoldClient
      • ScaffoldClient
    • fl4health.clients.tabular_data_client module
      • TabularDataClient
• fl4health.feature_alignment namespace
  • Submodules
    • fl4health.feature_alignment.constants module
    • fl4health.feature_alignment.string_columns_transformer module
      • TextColumnTransformer
      • TextMulticolumnTransformer
    • fl4health.feature_alignment.tab_features_info_encoder module
      • TabularFeaturesInfoEncoder
    • fl4health.feature_alignment.tab_features_preprocessor module
      • TabularFeaturesPreprocessor
    • fl4health.feature_alignment.tabular_feature module
      • TabularFeature
    • fl4health.feature_alignment.tabular_type module
      • TabularType
• fl4health.losses package
  • Submodules
    • fl4health.losses.contrastive_loss module
      • MoonContrastiveLoss
      • NtXentLoss
    • fl4health.losses.cosine_similarity_loss module
      • CosineSimilarityLoss
    • fl4health.losses.deep_mmd_loss module
      • DeepMmdLoss
      • ModelLatentF
    • fl4health.losses.fenda_loss_config module
      • ConstrainedFendaLossContainer
      • CosineSimilarityLossContainer
      • MoonContrastiveLossContainer
      • PerFclLossContainer
    • fl4health.losses.mkmmd_loss module
      • MkMmdLoss
    • fl4health.losses.perfcl_loss module
      • PerFclLoss
    • fl4health.losses.weight_drift_loss module
      • WeightDriftLoss
• fl4health.model_bases package
  • Subpackages
    • fl4health.model_bases.masked_layers namespace
      • Submodules
  • Submodules
    • fl4health.model_bases.apfl_base module
      • ApflModule
    • fl4health.model_bases.autoencoders_base module
      • AbstractAe
      • BasicAe
      • ConditionalVae
      • VariationalAe
    • fl4health.model_bases.ensemble_base module
      • EnsembleAggregationMode
      • EnsembleModel
    • fl4health.model_bases.feature_extractor_buffer module
      • FeatureExtractorBuffer
    • fl4health.model_bases.fedrep_base module
      • FedRepModel
    • fl4health.model_bases.fedsimclr_base module
      • FedSimClrModel
    • fl4health.model_bases.fenda_base module
      • FendaModel
      • FendaModelWithFeatureState
    • fl4health.model_bases.moon_base module
      • MoonModel
    • fl4health.model_bases.parallel_split_models module
      • ParallelFeatureJoinMode
      • ParallelSplitHeadModule
      • ParallelSplitModel
    • fl4health.model_bases.partial_layer_exchange_model module
      • PartialLayerExchangeModel
    • fl4health.model_bases.pca module
      • PcaModule
    • fl4health.model_bases.perfcl_base module
      • PerFclModel
    • fl4health.model_bases.sequential_split_models module
      • SequentiallySplitExchangeBaseModel
      • SequentiallySplitModel
• fl4health.parameter_exchange package
  • Submodules
    • fl4health.parameter_exchange.fedpm_exchanger module
      • FedPmExchanger
    • fl4health.parameter_exchange.full_exchanger module
      • FullParameterExchanger
    • fl4health.parameter_exchange.layer_exchanger module
      • DynamicLayerExchanger
      • FixedLayerExchanger
      • LayerExchangerWithExclusions
    • fl4health.parameter_exchange.packing_exchanger module
      • FullParameterExchangerWithPacking
    • fl4health.parameter_exchange.parameter_exchanger_base module
      • ParameterExchanger
    • fl4health.parameter_exchange.parameter_packer module
      • ParameterPacker
      • ParameterPackerAdaptiveConstraint
      • ParameterPackerWithClippingBit
      • ParameterPackerWithControlVariates
      • ParameterPackerWithLayerNames
      • SparseCooParameterPacker
    • fl4health.parameter_exchange.parameter_selection_criteria module
      • LayerSelectionFunctionConstructor
      • largest_final_magnitude_scores()
      • largest_increase_in_magnitude_scores()
      • largest_magnitude_change_scores()
      • select_layers_by_percentage()
      • select_layers_by_threshold()
      • select_scores_and_sample_masks()
      • smallest_final_magnitude_scores()
      • smallest_increase_in_magnitude_scores()
      • smallest_magnitude_change_scores()
    • fl4health.parameter_exchange.partial_parameter_exchanger module
      • PartialParameterExchanger
    • fl4health.parameter_exchange.sparse_coo_parameter_exchanger module
      • SparseCooParameterExchanger
• fl4health.preprocessing package
  • Subpackages
    • fl4health.preprocessing.autoencoders package
      • Submodules
  • Submodules
    • fl4health.preprocessing.pca_preprocessor module
      • PcaPreprocessor
    • fl4health.preprocessing.warmed_up_module module
      • WarmedUpModule
• fl4health.privacy package
  • Submodules
    • fl4health.privacy.fl_accountants module
      • ClientLevelAccountant
      • FlClientLevelAccountantFixedSamplingNoReplacement
      • FlClientLevelAccountantPoissonSampling
      • FlInstanceLevelAccountant
    • fl4health.privacy.moments_accountant module
      • FixedSamplingWithoutReplacement
      • MomentsAccountant
      • PoissonSampling
      • SamplingStrategy
• fl4health.reporting package
  • JsonReporter
    • JsonReporter.dump()
  • WandBReporter
    • WandBReporter.__init__()
    • WandBReporter.define_metrics()
    • WandBReporter.initialize()
    • WandBReporter.report()
    • WandBReporter.shutdown()
    • WandBReporter.start_run()
  • Submodules
    • fl4health.reporting.base_reporter module
      • BaseReporter
    • fl4health.reporting.json_reporter module
      • FileReporter
      • JsonReporter
    • fl4health.reporting.reports_manager module
      • ReportsManager
    • fl4health.reporting.wandb_reporter module
      • StepType
      • WandBReporter
• fl4health.servers package
  • Subpackages
    • fl4health.servers.adaptive_constraint_servers package
      • Submodules
  • Submodules
    • fl4health.servers.base_server module
      • FlServer
    • fl4health.servers.client_level_dp_fed_avg_server module
      • ClientLevelDPFedAvgServer
    • fl4health.servers.evaluate_server module
      • EvaluateServer
    • fl4health.servers.fedpm_server module
      • FedPmServer
    • fl4health.servers.instance_level_dp_server module
      • InstanceLevelDpServer
    • fl4health.servers.model_merge_server module
      • ModelMergeServer
    • fl4health.servers.nnunet_server module
      • NnunetServer
      • add_items_to_config_fn()
    • fl4health.servers.polling module
      • poll_client()
      • poll_clients()
    • fl4health.servers.scaffold_server module
      • DPScaffoldServer
      • ScaffoldServer
    • fl4health.servers.tabular_feature_alignment_server module
      • TabularFeatureAlignmentServer
      • fit_config()
• fl4health.strategies package
  • Submodules
    • fl4health.strategies.aggregate_utils module
      • aggregate_losses()
      • aggregate_results()
    • fl4health.strategies.basic_fedavg module
      • BasicFedAvg
      • OpacusBasicFedAvg
    • fl4health.strategies.client_dp_fedavgm module
      • ClientLevelDPFedAvgM
    • fl4health.strategies.fedavg_dynamic_layer module
      • FedAvgDynamicLayer
    • fl4health.strategies.fedavg_sparse_coo_tensor module
      • FedAvgSparseCooTensor
    • fl4health.strategies.fedavg_with_adaptive_constraint module
      • FedAvgWithAdaptiveConstraint
    • fl4health.strategies.feddg_ga module
      • FairnessMetric
      • FairnessMetricType
      • FedDgGa
      • SignalForTypeException
    • fl4health.strategies.feddg_ga_with_adaptive_constraint module
      • FedDgGaAdaptiveConstraint
    • fl4health.strategies.fedpca module
      • FedPCA
    • fl4health.strategies.fedpm module
      • FedPm
    • fl4health.strategies.flash module
      • Flash
    • fl4health.strategies.model_merge_strategy module
      • ModelMergeStrategy
    • fl4health.strategies.noisy_aggregate module
      • add_noise_to_array()
      • add_noise_to_ndarrays()
      • gaussian_noisy_aggregate_clipping_bits()
      • gaussian_noisy_unweighted_aggregate()
      • gaussian_noisy_weighted_aggregate()
    • fl4health.strategies.scaffold module
      • OpacusScaffold
      • Scaffold
    • fl4health.strategies.strategy_with_poll module
      • StrategyWithPolling
• fl4health.utils package
  • Submodules
    • fl4health.utils.client module
      • check_if_batch_is_empty_and_verify_input()
      • clone_and_freeze_model()
      • fold_loss_dict_into_metrics()
      • maybe_progress_bar()
      • move_data_to_device()
      • set_pack_losses_with_val_metrics()
    • fl4health.utils.config module
      • InvalidConfigError
      • check_config()
      • load_config()
      • narrow_dict_type()
      • narrow_dict_type_and_set_attribute()
    • fl4health.utils.data_generation module
      • SyntheticFedProxDataset
      • SyntheticIidFedProxDataset
      • SyntheticNonIidFedProxDataset
    • fl4health.utils.dataset module
      • BaseDataset
      • DictionaryDataset
      • SslTensorDataset
      • SyntheticDataset
      • TensorDataset
      • select_by_indices()
    • fl4health.utils.dataset_converter module
      • AutoEncoderDatasetConverter
      • DatasetConverter
    • fl4health.utils.early_stopper module
      • EarlyStopper
    • fl4health.utils.functions module
      • BernoulliSample
      • decode_and_pseudo_sort_results()
      • pseudo_sort_scoring_function()
      • select_zeroeth_element()
      • sigmoid_inverse()
    • fl4health.utils.load_data module
      • ToNumpy
      • get_cifar10_data_and_target_tensors()
      • get_mnist_data_and_target_tensors()
      • get_train_and_val_cifar10_datasets()
      • get_train_and_val_mnist_datasets()
      • load_cifar10_data()
      • load_cifar10_test_data()
      • load_mnist_data()
      • load_mnist_test_data()
      • load_msd_dataset()
      • split_data_and_targets()
    • fl4health.utils.logging module
      • LoggingMode
    • fl4health.utils.losses module
      • EvaluationLosses
      • LossMeter
      • LossMeterType
      • Losses
      • TrainingLosses
    • fl4health.utils.metric_aggregation module
      • evaluate_metrics_aggregation_fn()
      • fit_metrics_aggregation_fn()
      • metric_aggregation()
      • normalize_metrics()
      • uniform_evaluate_metrics_aggregation_fn()
      • uniform_metric_aggregation()
      • uniform_normalize_metrics()
    • fl4health.utils.metrics module
      • Accuracy
      • BalancedAccuracy
      • BinarySoftDiceCoefficient
      • F1
      • Metric
      • MetricManager
      • MetricPrefix
      • ROC_AUC
      • SimpleMetric
      • TorchMetric
      • TransformsMetric
    • fl4health.utils.msd_dataset_sources module
      • MsdDataset
      • get_msd_dataset_enum()
    • fl4health.utils.nnunet_utils module
      • Module2LossWrapper
      • NnunetConfig
      • PolyLRSchedulerWrapper
      • StreamToLogger
      • collapse_one_hot_tensor()
      • convert_deep_supervision_dict_to_list()
      • convert_deep_supervision_list_to_dict()
      • get_dataset_n_voxels()
      • get_segs_from_probs()
      • nnUNetDataLoaderWrapper
      • prepare_loss_arg()
      • reload_modules()
      • set_nnunet_env()
      • use_default_signal_handlers()
    • fl4health.utils.parameter_extraction module
      • check_shape_match()
      • get_all_model_parameters()
    • fl4health.utils.partitioners module
      • DirichletLabelBasedAllocation
    • fl4health.utils.privacy_utilities module
      • convert_model_to_opacus_model()
      • map_model_to_opacus_model()
      • privacy_validate_and_fix_modules()
    • fl4health.utils.random module
      • generate_hash()
      • restore_random_state()
      • save_random_state()
      • set_all_random_seeds()
      • unset_all_random_seeds()
    • fl4health.utils.sampler module
      • DirichletLabelBasedSampler
      • LabelBasedSampler
      • MinorityLabelBasedSampler
    • fl4health.utils.snapshotter module
      • AbstractSnapshotter
      • LRSchedulerSnapshotter
      • NumberSnapshotter
      • OptimizerSnapshotter
      • SerializableObjectSnapshotter
      • TorchModuleSnapshotter
    • fl4health.utils.typing module
      • LogLevel