nvflare.app_common package¶
Subpackages¶
- nvflare.app_common.abstract package
- Submodules
- nvflare.app_common.abstract.aggregator module
- nvflare.app_common.abstract.fl_model module
- nvflare.app_common.abstract.formatter module
- nvflare.app_common.abstract.init_final_component module
- nvflare.app_common.abstract.launcher module
- nvflare.app_common.abstract.learnable module
- nvflare.app_common.abstract.learnable_persistor module
- nvflare.app_common.abstract.learner_spec module
- nvflare.app_common.abstract.metric_comparator module
- nvflare.app_common.abstract.model module
- nvflare.app_common.abstract.model_learner module
- nvflare.app_common.abstract.model_locator module
- nvflare.app_common.abstract.model_persistor module
- nvflare.app_common.abstract.model_processor module
- nvflare.app_common.abstract.params_converter module
- nvflare.app_common.abstract.persistor_filter module
- nvflare.app_common.abstract.response_processor module
- nvflare.app_common.abstract.shareable_generator module
- nvflare.app_common.abstract.statistics_spec module
- nvflare.app_common.abstract.statistics_writer module
- nvflare.app_common.abstract.task_handler module
- Module contents
- Submodules
- nvflare.app_common.aggregators package
- Submodules
- nvflare.app_common.aggregators.accumulate_model_aggregator module
- nvflare.app_common.aggregators.assembler module
- nvflare.app_common.aggregators.collect_and_assemble_aggregator module
- nvflare.app_common.aggregators.dxo_aggregator module
- nvflare.app_common.aggregators.dxo_collector module
- nvflare.app_common.aggregators.intime_accumulate_model_aggregator module
- nvflare.app_common.aggregators.weighted_aggregation_helper module
- Module contents
- Submodules
- nvflare.app_common.app_defined package
- nvflare.app_common.ccwf package
- Subpackages
- Submodules
- nvflare.app_common.ccwf.ccwf_job module
- nvflare.app_common.ccwf.client_controller_executor module
- nvflare.app_common.ccwf.client_ctl module
- nvflare.app_common.ccwf.common module
- nvflare.app_common.ccwf.cse_client_ctl module
- nvflare.app_common.ccwf.cse_server_ctl module
- nvflare.app_common.ccwf.cyclic_client_ctl module
- nvflare.app_common.ccwf.cyclic_server_ctl module
- nvflare.app_common.ccwf.server_ctl module
- nvflare.app_common.ccwf.swarm_client_ctl module
- nvflare.app_common.ccwf.swarm_server_ctl module
- nvflare.app_common.ccwf.val_result_manager module
- Module contents
- nvflare.app_common.decomposers package
- nvflare.app_common.executors package
- Subpackages
- Submodules
- nvflare.app_common.executors.client_api_launcher_executor module
- nvflare.app_common.executors.error_handling_executor module
- nvflare.app_common.executors.in_process_client_api_executor module
- nvflare.app_common.executors.ipc_exchanger module
- nvflare.app_common.executors.launcher_executor module
- nvflare.app_common.executors.learner_executor module
- nvflare.app_common.executors.model_learner_executor module
- nvflare.app_common.executors.multi_process_executor module
- nvflare.app_common.executors.splitnn_learner_executor module
- nvflare.app_common.executors.task_exchanger module
- nvflare.app_common.executors.task_script_runner module
- Module contents
- nvflare.app_common.filters package
- Submodules
- nvflare.app_common.filters.convert_weights module
- nvflare.app_common.filters.dxo_blocker module
- nvflare.app_common.filters.exclude_vars module
- nvflare.app_common.filters.percentile_privacy module
- nvflare.app_common.filters.statistics_privacy_filter module
- nvflare.app_common.filters.svt_privacy module
- Module contents
- Submodules
- nvflare.app_common.homomorphic_encryption package
- Submodules
- nvflare.app_common.homomorphic_encryption.he_intime_accumulate_model_aggregator module
- nvflare.app_common.homomorphic_encryption.he_model_decryptor module
- nvflare.app_common.homomorphic_encryption.he_model_encryptor module
- nvflare.app_common.homomorphic_encryption.he_model_shareable_generator module
- nvflare.app_common.homomorphic_encryption.he_pt_model_reader_writer module
- nvflare.app_common.homomorphic_encryption.homomorphic_encrypt module
- Module contents
- Submodules
- nvflare.app_common.hub package
- nvflare.app_common.job_schedulers package
- nvflare.app_common.launchers package
- nvflare.app_common.metrics_exchange package
- nvflare.app_common.model_locator package
- nvflare.app_common.np package
- nvflare.app_common.psi package
- Subpackages
- Submodules
- Module contents
- nvflare.app_common.pt package
- Submodules
- nvflare.app_common.pt.pt_ditto module
- nvflare.app_common.pt.pt_fed_utils module
- nvflare.app_common.pt.pt_fedopt module
- nvflare.app_common.pt.pt_fedproxloss module
- nvflare.app_common.pt.pt_file_model_locator module
- nvflare.app_common.pt.pt_file_model_persistor module
- nvflare.app_common.pt.pt_model_reader_writer module
- nvflare.app_common.pt.pt_multi_process_executor module
- nvflare.app_common.pt.pt_scaffold module
- nvflare.app_common.pt.tb_receiver module
- Module contents
- Submodules
- nvflare.app_common.resource_consumers package
- nvflare.app_common.resource_managers package
- nvflare.app_common.response_processors package
- nvflare.app_common.shareablegenerators package
- nvflare.app_common.state_persistors package
- nvflare.app_common.statistics package
- Submodules
- nvflare.app_common.statistics.hierarchical_numeric_stats module
accumulate_hierarchical_metrics()bins_to_dict()create_output_structure()filter_numeric_features()get_client_hierarchy()get_global_stats()get_hierarchical_histograms()get_hierarchical_levels()get_hierarchical_means()get_hierarchical_mins_or_maxs()get_hierarchical_stddevs()get_initial_structure()get_output_structure()update_output_strcture()
- nvflare.app_common.statistics.histogram_bins_cleanser module
- nvflare.app_common.statistics.json_stats_file_persistor module
- nvflare.app_common.statistics.min_count_cleanser module
- nvflare.app_common.statistics.min_max_cleanser module
- nvflare.app_common.statistics.numeric_stats module
- nvflare.app_common.statistics.numpy_utils module
- nvflare.app_common.statistics.statisitcs_objects_decomposer module
- nvflare.app_common.statistics.statistics_config_utils module
- nvflare.app_common.statistics.statistics_privacy_cleanser module
- nvflare.app_common.statistics.hierarchical_numeric_stats module
- Module contents
- Submodules
- nvflare.app_common.storages package
- nvflare.app_common.tie package
- Submodules
- nvflare.app_common.tie.applet module
- nvflare.app_common.tie.cli_applet module
- nvflare.app_common.tie.connector module
- nvflare.app_common.tie.controller module
- nvflare.app_common.tie.defs module
- nvflare.app_common.tie.executor module
- nvflare.app_common.tie.process_mgr module
- nvflare.app_common.tie.py_applet module
- Module contents
- Submodules
- nvflare.app_common.tracking package
- nvflare.app_common.utils package
- Submodules
- Module contents
- nvflare.app_common.widgets package
- Submodules
- nvflare.app_common.widgets.convert_to_fed_event module
- nvflare.app_common.widgets.event_recorder module
- nvflare.app_common.widgets.external_configurator module
- nvflare.app_common.widgets.intime_model_selector module
- nvflare.app_common.widgets.metric_relay module
- nvflare.app_common.widgets.streaming module
- nvflare.app_common.widgets.validation_json_generator module
- Module contents
- Submodules
- nvflare.app_common.workflows package
- Submodules
- nvflare.app_common.workflows.base_fedavg module
- nvflare.app_common.workflows.base_model_controller module
- nvflare.app_common.workflows.broadcast_and_process module
- nvflare.app_common.workflows.broadcast_operator module
- nvflare.app_common.workflows.cmd_task_controller module
- nvflare.app_common.workflows.cross_site_eval module
- nvflare.app_common.workflows.cross_site_model_eval module
- nvflare.app_common.workflows.cyclic module
- nvflare.app_common.workflows.cyclic_ctl module
- nvflare.app_common.workflows.error_handling_controller module
- nvflare.app_common.workflows.etl_controller module
- nvflare.app_common.workflows.fedavg module
- nvflare.app_common.workflows.global_model_eval module
- nvflare.app_common.workflows.hierarchical_statistics_controller module
- nvflare.app_common.workflows.initialize_global_weights module
- nvflare.app_common.workflows.model_controller module
- nvflare.app_common.workflows.scaffold module
- nvflare.app_common.workflows.scatter_and_gather module
- nvflare.app_common.workflows.scatter_and_gather_scaffold module
- nvflare.app_common.workflows.splitnn_workflow module
- nvflare.app_common.workflows.statistics_controller module
- Module contents
- Submodules
Submodules¶
- nvflare.app_common.app_constant module
AlgorithmConstantsAppConstantsAppConstants.AGGREGATION_ACCEPTEDAppConstants.AGGREGATION_RESULTAppConstants.AGGREGATION_TRIGGEREDAppConstants.CKPT_PRELOAD_PATHAppConstants.CLIENT_UNKNOWNAppConstants.CONFIG_PATHAppConstants.CONTRIBUTION_CLIENTAppConstants.CONTRIBUTION_ROUNDAppConstants.CROSS_VAL_CLIENT_MODELAppConstants.CROSS_VAL_DIRAppConstants.CROSS_VAL_MODEL_DIR_NAMEAppConstants.CROSS_VAL_MODEL_PATHAppConstants.CROSS_VAL_RESULTS_DIR_NAMEAppConstants.CROSS_VAL_RESULTS_PATHAppConstants.CROSS_VAL_SERVER_MODELAppConstants.CURRENT_LEARNING_RATEAppConstants.CURRENT_ROUNDAppConstants.DATA_CLIENTAppConstants.DEFAULT_AGGREGATOR_IDAppConstants.DEFAULT_FORMATTER_IDAppConstants.DEFAULT_MODEL_DIRAppConstants.DEFAULT_MODEL_LOCATOR_IDAppConstants.DEFAULT_PERSISTOR_IDAppConstants.DEFAULT_SHAREABLE_GENERATOR_IDAppConstants.DEVICEAppConstants.DXOAppConstants.FAILUREAppConstants.GLOBAL_MODELAppConstants.INITIAL_LEARNING_RATEAppConstants.IS_BESTAppConstants.IS_FIRST_ROUNDAppConstants.LOCAL_EPOCHSAppConstants.LOG_DIRAppConstants.META_COOKIEAppConstants.META_DATAAppConstants.MODEL_LOAD_PATHAppConstants.MODEL_NAMEAppConstants.MODEL_NETWORKAppConstants.MODEL_OWNERAppConstants.MODEL_SAVE_PATHAppConstants.MODEL_TO_VALIDATEAppConstants.MODEL_URLAppConstants.MODEL_WEIGHTSAppConstants.MULTI_GPUAppConstants.MY_RANKAppConstants.NUMBER_OF_GPUSAppConstants.NUM_EPOCHS_CURRENT_ROUNDAppConstants.NUM_ROUNDSAppConstants.NUM_TOTAL_EPOCHSAppConstants.NUM_TOTAL_STEPSAppConstants.PARTICIPATING_CLIENTSAppConstants.PHASEAppConstants.PHASE_FINISHEDAppConstants.PHASE_INITAppConstants.PHASE_MODEL_VALIDATIONAppConstants.PHASE_TRAINAppConstants.RECEIVED_MODELAppConstants.RECEIVED_MODEL_OWNERAppConstants.ROUNDAppConstants.START_ROUNDAppConstants.STATUS_DONEAppConstants.STATUS_IDLEAppConstants.STATUS_TRAININGAppConstants.STATUS_WAITAppConstants.SUBMIT_MODEL_FAILURE_REASONAppConstants.SUBMIT_MODEL_NAMEAppConstants.TASK_CONFIGUREAppConstants.TASK_END_RUNAppConstants.TASK_GET_WEIGHTSAppConstants.TASK_PROP_CALLBACKAppConstants.TASK_SUBMIT_MODELAppConstants.TASK_TRAINAppConstants.TASK_VALIDATIONAppConstants.TRAINING_RESULTAppConstants.TRAIN_CONTEXTAppConstants.TRAIN_SHAREABLEAppConstants.VALIDATE_TYPEAppConstants.VALIDATION_RESULTAppConstants.WAIT_AFTER_MIN_CLIENTS
DefaultCheckpointFileNameEnvironmentKeyExecutorTasksModelFormatModelNamePSIConstPSIConst.BACKWARDPSIConst.BLOOM_FILTER_FPRPSIConst.DIRECTION_KEYPSIConst.FORWARDPSIConst.ITEMS_SIZEPSIConst.ITEMS_SIZE_SETPSIConst.REQUEST_MSGPSIConst.REQUEST_MSG_SETPSIConst.RESPONSE_MSGPSIConst.SETUP_MSGPSIConst.TASKPSIConst.TASK_INTERSECTPSIConst.TASK_KEYPSIConst.TASK_PREPAREPSIConst.TASK_REQUESTPSIConst.TASK_RESPONSEPSIConst.TASK_SETUP
StatisticsConstantsStatisticsConstants.FED_STATS_PRE_RUNStatisticsConstants.FED_STATS_TASKStatisticsConstants.GLOBALStatisticsConstants.LOCALStatisticsConstants.NAMEStatisticsConstants.PRE_RUN_RESULTStatisticsConstants.STATISTICS_TASK_KEYStatisticsConstants.STATS_1st_STATISTICSStatisticsConstants.STATS_2nd_STATISTICSStatisticsConstants.STATS_BINSStatisticsConstants.STATS_BIN_RANGEStatisticsConstants.STATS_COUNTStatisticsConstants.STATS_FAILURE_COUNTStatisticsConstants.STATS_FEATURESStatisticsConstants.STATS_GLOBAL_COUNTStatisticsConstants.STATS_GLOBAL_MEANStatisticsConstants.STATS_HISTOGRAMStatisticsConstants.STATS_MAXStatisticsConstants.STATS_MEANStatisticsConstants.STATS_MINStatisticsConstants.STATS_STDDEVStatisticsConstants.STATS_SUMStatisticsConstants.STATS_TARGET_STATISTICSStatisticsConstants.STATS_VARStatisticsConstants.ordered_statistics
ValidateType
- nvflare.app_common.app_event_type module
AppEventTypeAppEventType.AFTER_AGGREGATIONAppEventType.AFTER_CONTRIBUTION_ACCEPTAppEventType.AFTER_GET_VALIDATION_MODELSAppEventType.AFTER_INITIALIZEAppEventType.AFTER_LEARNABLE_PERSISTAppEventType.AFTER_SEND_BEST_MODELAppEventType.AFTER_SHAREABLE_TO_LEARNABLEAppEventType.AFTER_SUBMIT_VALIDATION_RESULTSAppEventType.AFTER_TRAINAppEventType.AFTER_VALIDATE_MODELAppEventType.BEFORE_AGGREGATIONAppEventType.BEFORE_CONTRIBUTION_ACCEPTAppEventType.BEFORE_GET_VALIDATION_MODELSAppEventType.BEFORE_INITIALIZEAppEventType.BEFORE_LEARNABLE_PERSISTAppEventType.BEFORE_SEND_BEST_MODELAppEventType.BEFORE_SHAREABLE_TO_LEARNABLEAppEventType.BEFORE_SUBMIT_VALIDATION_RESULTSAppEventType.BEFORE_TRAINAppEventType.BEFORE_TRAIN_TASKAppEventType.BEFORE_VALIDATE_MODELAppEventType.CROSS_VAL_INITAppEventType.END_AGGREGATIONAppEventType.GLOBAL_BEST_MODEL_AVAILABLEAppEventType.GLOBAL_WEIGHTS_UPDATEDAppEventType.INITIAL_MODEL_LOADEDAppEventType.LOCAL_BEST_MODEL_AVAILABLEAppEventType.RECEIVE_BEST_MODELAppEventType.RECEIVE_CONTRIBUTIONAppEventType.RECEIVE_VALIDATION_MODELAppEventType.RECEIVE_VALIDATION_RESULTSAppEventType.ROUND_DONEAppEventType.ROUND_STARTEDAppEventType.SEND_MODEL_FOR_VALIDATIONAppEventType.SEND_VALIDATION_RESULTSAppEventType.SERVER_RECEIVE_BEST_MODELAppEventType.SUBMIT_LOCAL_BEST_MODELAppEventType.TRAINING_FINISHEDAppEventType.TRAINING_STARTEDAppEventType.TRAIN_DONEAppEventType.VALIDATION_RESULT_RECEIVED
- nvflare.app_common.model_desc module