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_launcher package
- nvflare.app_common.job_schedulers package
- nvflare.app_common.launchers package
- nvflare.app_common.logging 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.streamers package
- Submodules
- nvflare.app_common.streamers.container_retriever module
- nvflare.app_common.streamers.container_streamer module
- nvflare.app_common.streamers.file_retriever module
- nvflare.app_common.streamers.file_streamer module
- nvflare.app_common.streamers.object_retriever module
- nvflare.app_common.streamers.streamer_base module
- Module contents
- Submodules
- 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
- nvflare.app_common.utils.component_utils module
- nvflare.app_common.utils.export_utils module
- nvflare.app_common.utils.file_utils module
- nvflare.app_common.utils.fl_component_wrapper module
- nvflare.app_common.utils.fl_model_utils module
- nvflare.app_common.utils.json_utils module
- nvflare.app_common.utils.math_utils module
- Module contents
- Submodules
- 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
AlgorithmConstants
AppConstants
AppConstants.AGGREGATION_ACCEPTED
AppConstants.AGGREGATION_RESULT
AppConstants.AGGREGATION_TRIGGERED
AppConstants.CKPT_PRELOAD_PATH
AppConstants.CLIENT_UNKNOWN
AppConstants.CONFIG_PATH
AppConstants.CONTRIBUTION_CLIENT
AppConstants.CONTRIBUTION_ROUND
AppConstants.CROSS_VAL_CLIENT_MODEL
AppConstants.CROSS_VAL_DIR
AppConstants.CROSS_VAL_MODEL_DIR_NAME
AppConstants.CROSS_VAL_MODEL_PATH
AppConstants.CROSS_VAL_RESULTS_DIR_NAME
AppConstants.CROSS_VAL_RESULTS_PATH
AppConstants.CROSS_VAL_SERVER_MODEL
AppConstants.CURRENT_LEARNING_RATE
AppConstants.CURRENT_ROUND
AppConstants.DATA_CLIENT
AppConstants.DEFAULT_AGGREGATOR_ID
AppConstants.DEFAULT_FORMATTER_ID
AppConstants.DEFAULT_MODEL_DIR
AppConstants.DEFAULT_MODEL_LOCATOR_ID
AppConstants.DEFAULT_PERSISTOR_ID
AppConstants.DEFAULT_SHAREABLE_GENERATOR_ID
AppConstants.DEVICE
AppConstants.DXO
AppConstants.FAILURE
AppConstants.GLOBAL_MODEL
AppConstants.INITIAL_LEARNING_RATE
AppConstants.IS_BEST
AppConstants.IS_FIRST_ROUND
AppConstants.LOCAL_EPOCHS
AppConstants.LOG_DIR
AppConstants.META_COOKIE
AppConstants.META_DATA
AppConstants.MODEL_LOAD_PATH
AppConstants.MODEL_NAME
AppConstants.MODEL_NETWORK
AppConstants.MODEL_OWNER
AppConstants.MODEL_SAVE_PATH
AppConstants.MODEL_TO_VALIDATE
AppConstants.MODEL_URL
AppConstants.MODEL_WEIGHTS
AppConstants.MULTI_GPU
AppConstants.MY_RANK
AppConstants.NUMBER_OF_GPUS
AppConstants.NUM_EPOCHS_CURRENT_ROUND
AppConstants.NUM_ROUNDS
AppConstants.NUM_TOTAL_EPOCHS
AppConstants.NUM_TOTAL_STEPS
AppConstants.PARTICIPATING_CLIENTS
AppConstants.PHASE
AppConstants.PHASE_FINISHED
AppConstants.PHASE_INIT
AppConstants.PHASE_MODEL_VALIDATION
AppConstants.PHASE_TRAIN
AppConstants.RECEIVED_MODEL
AppConstants.RECEIVED_MODEL_OWNER
AppConstants.ROUND
AppConstants.START_ROUND
AppConstants.STATUS_DONE
AppConstants.STATUS_IDLE
AppConstants.STATUS_TRAINING
AppConstants.STATUS_WAIT
AppConstants.SUBMIT_MODEL_FAILURE_REASON
AppConstants.SUBMIT_MODEL_NAME
AppConstants.TASK_CONFIGURE
AppConstants.TASK_END_RUN
AppConstants.TASK_GET_WEIGHTS
AppConstants.TASK_PROP_CALLBACK
AppConstants.TASK_SUBMIT_MODEL
AppConstants.TASK_TRAIN
AppConstants.TASK_VALIDATION
AppConstants.TRAINING_RESULT
AppConstants.TRAIN_CONTEXT
AppConstants.TRAIN_SHAREABLE
AppConstants.VALIDATE_TYPE
AppConstants.VALIDATION_RESULT
AppConstants.WAIT_AFTER_MIN_CLIENTS
DefaultCheckpointFileName
EnvironmentKey
ExecutorTasks
ModelFormat
ModelName
PSIConst
PSIConst.BACKWARD
PSIConst.BLOOM_FILTER_FPR
PSIConst.DIRECTION_KEY
PSIConst.FORWARD
PSIConst.ITEMS_SIZE
PSIConst.ITEMS_SIZE_SET
PSIConst.REQUEST_MSG
PSIConst.REQUEST_MSG_SET
PSIConst.RESPONSE_MSG
PSIConst.SETUP_MSG
PSIConst.TASK
PSIConst.TASK_INTERSECT
PSIConst.TASK_KEY
PSIConst.TASK_PREPARE
PSIConst.TASK_REQUEST
PSIConst.TASK_RESPONSE
PSIConst.TASK_SETUP
StatisticsConstants
StatisticsConstants.FED_STATS_PRE_RUN
StatisticsConstants.FED_STATS_TASK
StatisticsConstants.GLOBAL
StatisticsConstants.LOCAL
StatisticsConstants.NAME
StatisticsConstants.PRE_RUN_RESULT
StatisticsConstants.STATISTICS_TASK_KEY
StatisticsConstants.STATS_1st_STATISTICS
StatisticsConstants.STATS_2nd_STATISTICS
StatisticsConstants.STATS_BINS
StatisticsConstants.STATS_BIN_RANGE
StatisticsConstants.STATS_CENTROIDS_KEY
StatisticsConstants.STATS_COUNT
StatisticsConstants.STATS_FAILURE_COUNT
StatisticsConstants.STATS_FEATURES
StatisticsConstants.STATS_GLOBAL_COUNT
StatisticsConstants.STATS_GLOBAL_MEAN
StatisticsConstants.STATS_HISTOGRAM
StatisticsConstants.STATS_MAX
StatisticsConstants.STATS_MEAN
StatisticsConstants.STATS_MIN
StatisticsConstants.STATS_PERCENTILE
StatisticsConstants.STATS_PERCENTILES_KEY
StatisticsConstants.STATS_STDDEV
StatisticsConstants.STATS_SUM
StatisticsConstants.STATS_TARGET_STATISTICS
StatisticsConstants.STATS_VAR
StatisticsConstants.ordered_statistics
ValidateType
- nvflare.app_common.app_event_type module
AppEventType
AppEventType.AFTER_AGGREGATION
AppEventType.AFTER_CONTRIBUTION_ACCEPT
AppEventType.AFTER_GET_VALIDATION_MODELS
AppEventType.AFTER_INITIALIZE
AppEventType.AFTER_LEARNABLE_PERSIST
AppEventType.AFTER_SEND_BEST_MODEL
AppEventType.AFTER_SHAREABLE_TO_LEARNABLE
AppEventType.AFTER_SUBMIT_VALIDATION_RESULTS
AppEventType.AFTER_TRAIN
AppEventType.AFTER_VALIDATE_MODEL
AppEventType.BEFORE_AGGREGATION
AppEventType.BEFORE_CONTRIBUTION_ACCEPT
AppEventType.BEFORE_GET_VALIDATION_MODELS
AppEventType.BEFORE_INITIALIZE
AppEventType.BEFORE_LEARNABLE_PERSIST
AppEventType.BEFORE_SEND_BEST_MODEL
AppEventType.BEFORE_SHAREABLE_TO_LEARNABLE
AppEventType.BEFORE_SUBMIT_VALIDATION_RESULTS
AppEventType.BEFORE_TRAIN
AppEventType.BEFORE_TRAIN_TASK
AppEventType.BEFORE_VALIDATE_MODEL
AppEventType.CROSS_VAL_INIT
AppEventType.END_AGGREGATION
AppEventType.GLOBAL_BEST_MODEL_AVAILABLE
AppEventType.GLOBAL_WEIGHTS_UPDATED
AppEventType.INITIAL_MODEL_LOADED
AppEventType.LOCAL_BEST_MODEL_AVAILABLE
AppEventType.RECEIVE_BEST_MODEL
AppEventType.RECEIVE_CONTRIBUTION
AppEventType.RECEIVE_VALIDATION_MODEL
AppEventType.RECEIVE_VALIDATION_RESULTS
AppEventType.ROUND_DONE
AppEventType.ROUND_STARTED
AppEventType.SEND_MODEL_FOR_VALIDATION
AppEventType.SEND_VALIDATION_RESULTS
AppEventType.SERVER_RECEIVE_BEST_MODEL
AppEventType.SUBMIT_LOCAL_BEST_MODEL
AppEventType.TRAINING_FINISHED
AppEventType.TRAINING_STARTED
AppEventType.TRAIN_DONE
AppEventType.VALIDATION_RESULT_RECEIVED
- nvflare.app_common.model_desc module