nvflare.app_common package

Subpackages

• nvflare.app_common.abstract package
  • Submodules
    • nvflare.app_common.abstract.aggregator module
      • Aggregator
    • nvflare.app_common.abstract.formatter module
      • Formatter
    • nvflare.app_common.abstract.learnable module
      • Learnable
    • nvflare.app_common.abstract.learnable_persistor module
      • LearnablePersistor
    • nvflare.app_common.abstract.learner_spec module
      • Learner
    • nvflare.app_common.abstract.model module
      • ModelLearnableKey
      • make_model_learnable()
      • model_learnable_to_dxo()
      • validate_model_learnable()
    • nvflare.app_common.abstract.model_locator module
      • ModelLocator
    • nvflare.app_common.abstract.model_persistor module
      • ModelPersistor
    • nvflare.app_common.abstract.model_processor module
      • ModelProcessor
    • nvflare.app_common.abstract.shareable_generator module
      • ShareableGenerator
    • nvflare.app_common.abstract.statistics_spec module
      • Bin
      • BinRange
      • DataType
      • Feature
      • Histogram
      • HistogramType
      • StatisticConfig
      • Statistics
    • nvflare.app_common.abstract.statistics_writer module
      • StatisticsWriter
  • Module contents
• nvflare.app_common.aggregators package
  • Submodules
    • nvflare.app_common.aggregators.accumulate_model_aggregator module
      • AccumulateWeightedAggregator
    • nvflare.app_common.aggregators.dxo_aggregator module
      • DXOAggregator
    • nvflare.app_common.aggregators.intime_accumulate_model_aggregator module
      • InTimeAccumulateWeightedAggregator
    • nvflare.app_common.aggregators.weighted_aggregation_helper module
      • WeightedAggregationHelper
  • Module contents
    • AccumulateWeightedAggregator
    • InTimeAccumulateWeightedAggregator
      • InTimeAccumulateWeightedAggregator.accept()
      • InTimeAccumulateWeightedAggregator.aggregate()
• nvflare.app_common.decomposers package
  • Submodules
    • nvflare.app_common.decomposers.common_decomposers module
      • CtxPropReqDecomposer
      • EventReqDecomposer
      • EventStatsDecomposer
      • Float32ScalarDecomposer
      • Float64ScalarDecomposer
      • Int32ScalarDecomposer
      • Int64ScalarDecomposer
      • LearnableDecomposer
      • NumpyArrayDecomposer
      • NumpyScalarDecomposer
      • register()
  • Module contents
• nvflare.app_common.executors package
  • Subpackages
    • nvflare.app_common.executors.statistics package
      • Submodules
      • Module contents
  • Submodules
    • nvflare.app_common.executors.learner_executor module
      • LearnerExecutor
    • nvflare.app_common.executors.multi_process_executor module
      • MultiProcessExecutor
      • WorkerComponentBuilder
  • Module contents
• nvflare.app_common.filters package
  • Submodules
    • nvflare.app_common.filters.convert_weights module
      • ConvertWeights
    • nvflare.app_common.filters.dxo_blocker module
      • DXOBlocker
    • nvflare.app_common.filters.exclude_vars module
      • ExcludeVars
    • nvflare.app_common.filters.percentile_privacy module
      • PercentilePrivacy
    • nvflare.app_common.filters.statistics_privacy_filter module
      • StatisticsPrivacyFilter
    • nvflare.app_common.filters.svt_privacy module
      • SVTPrivacy
  • Module contents
    • ExcludeVars
      • ExcludeVars.process_dxo()
    • PercentilePrivacy
      • PercentilePrivacy.process_dxo()
    • SVTPrivacy
      • SVTPrivacy.process_dxo()
• nvflare.app_common.homomorphic_encryption package
  • Submodules
    • nvflare.app_common.homomorphic_encryption.he_constant module
    • 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
• nvflare.app_common.job_schedulers package
  • Submodules
    • nvflare.app_common.job_schedulers.job_scheduler module
      • DefaultJobScheduler
  • Module contents
• nvflare.app_common.np package
  • Submodules
    • nvflare.app_common.np.constants module
      • NPConstants
    • nvflare.app_common.np.np_formatter module
      • NPFormatter
    • nvflare.app_common.np.np_model_locator module
      • NPModelLocator
    • nvflare.app_common.np.np_model_persistor module
      • NPModelPersistor
    • nvflare.app_common.np.np_trainer module
      • NPTrainer
    • nvflare.app_common.np.np_validator module
      • NPValidator
  • 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
      • PTMultiProcessExecutor
    • nvflare.app_common.pt.pt_scaffold module
    • nvflare.app_common.pt.tb_receiver module
  • Module contents
• nvflare.app_common.resource_consumers package
  • Submodules
    • nvflare.app_common.resource_consumers.gpu_resource_consumer module
      • GPUResourceConsumer
    • nvflare.app_common.resource_consumers.list_resource_consumer module
      • ListResourceConsumer
  • Module contents
• nvflare.app_common.resource_managers package
  • Submodules
    • nvflare.app_common.resource_managers.auto_clean_resource_manager module
      • AutoCleanResourceManager
    • nvflare.app_common.resource_managers.gpu_resource_manager module
      • GPUResource
      • GPUResourceManager
    • nvflare.app_common.resource_managers.list_resource_manager module
      • ListResourceManager
  • Module contents
• nvflare.app_common.shareablegenerators package
  • Submodules
    • nvflare.app_common.shareablegenerators.full_model_shareable_generator module
      • FullModelShareableGenerator
  • Module contents
    • FullModelShareableGenerator
      • FullModelShareableGenerator.learnable_to_shareable()
      • FullModelShareableGenerator.shareable_to_learnable()
• nvflare.app_common.state_persistors package
  • Submodules
    • nvflare.app_common.state_persistors.storage_state_persistor module
      • StorageStatePersistor
  • Module contents
• nvflare.app_common.statistics package
  • Submodules
    • nvflare.app_common.statistics.histogram_bins_cleanser module
      • HistogramBinsCleanser
    • nvflare.app_common.statistics.json_stats_file_persistor module
      • JsonStatsFileWriter
    • nvflare.app_common.statistics.min_count_cleanser module
      • MinCountCleanser
    • nvflare.app_common.statistics.min_max_cleanser module
      • AddNoiseToMinMax
    • nvflare.app_common.statistics.numeric_stats module
      • accumulate_hists()
      • accumulate_metrics()
      • bins_to_dict()
      • filter_numeric_features()
      • get_global_feature_data_types()
      • get_global_stats()
      • get_means()
      • get_min_or_max_values()
    • nvflare.app_common.statistics.numpy_utils module
      • NpEncoder
      • dtype_to_data_type()
      • get_std_histogram_buckets()
    • nvflare.app_common.statistics.statisitcs_objects_decomposer module
      • BinDecomposer
      • BinRangeDecomposer
      • DataTypeDecomposer
      • FeatureDecomposer
      • HistogramDecomposer
      • HistogramTypeDecomposer
      • StatisticConfigDecomposer
      • fobs_registration()
    • nvflare.app_common.statistics.statistics_config_utils module
      • get_feature_bin_range()
    • nvflare.app_common.statistics.statistics_privacy_cleanser module
      • StatisticsPrivacyCleanser
  • Module contents
• nvflare.app_common.storages package
  • Submodules
    • nvflare.app_common.storages.filesystem_storage module
      • FilesystemStorage
    • nvflare.app_common.storages.s3_storage module
  • Module contents
• nvflare.app_common.utils package
  • Submodules
    • nvflare.app_common.utils.json_utils module
      • ObjectEncoder
  • Module contents
• nvflare.app_common.widgets package
  • Submodules
    • nvflare.app_common.widgets.convert_to_fed_event module
      • ConvertToFedEvent
    • nvflare.app_common.widgets.event_recorder module
      • ClientEventRecorder
      • EventRecorder
      • ServerEventRecorder
    • nvflare.app_common.widgets.intime_model_selector module
      • IntimeModelSelectionHandler
      • IntimeModelSelector
    • nvflare.app_common.widgets.streaming module
      • AnalyticsReceiver
      • AnalyticsSender
      • create_analytic_dxo()
      • send_analytic_dxo()
    • nvflare.app_common.widgets.validation_json_generator module
      • ValidationJsonGenerator
  • Module contents
• nvflare.app_common.workflows package
  • Submodules
    • nvflare.app_common.workflows.cross_site_model_eval module
      • CrossSiteModelEval
    • nvflare.app_common.workflows.cyclic_ctl module
      • CyclicController
      • RelayOrder
    • nvflare.app_common.workflows.global_model_eval module
      • GlobalModelEval
    • nvflare.app_common.workflows.scatter_and_gather module
      • ScatterAndGather
    • nvflare.app_common.workflows.scatter_and_gather_scaffold module
      • ScatterAndGatherScaffold
    • nvflare.app_common.workflows.statistics_controller module
      • StatisticsController
  • Module contents

Submodules

• nvflare.app_common.app_constant module
  • AlgorithmConstants
    • AlgorithmConstants.SCAFFOLD_CTRL_AGGREGATOR_ID
    • AlgorithmConstants.SCAFFOLD_CTRL_DIFF
    • AlgorithmConstants.SCAFFOLD_CTRL_GLOBAL
  • AppConstants
    • AppConstants.AGGREGATION_ACCEPTED
    • AppConstants.AGGREGATION_RESULT
    • AppConstants.AGGREGATION_TRIGGERED
    • AppConstants.CKPT_PRELOAD_PATH
    • 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_END_RUN
    • 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
    • DefaultCheckpointFileName.BEST_GLOBAL_MODEL
    • DefaultCheckpointFileName.GLOBAL_MODEL
  • EnvironmentKey
    • EnvironmentKey.CHECKPOINT_DIR
    • EnvironmentKey.CHECKPOINT_FILE_NAME
  • ExecutorTasks
    • ExecutorTasks.CROSS_VALIDATION
    • ExecutorTasks.REPORT_STATUS
    • ExecutorTasks.SUBMIT_BEST
    • ExecutorTasks.TRAIN
    • ExecutorTasks.VALIDATE
  • ModelFormat
    • ModelFormat.KERAS
    • ModelFormat.PT_CHECKPOINT
    • ModelFormat.PT_ONNX
    • ModelFormat.TF_CHECKPOINT
    • ModelFormat.TORCH_SCRIPT
  • ModelName
    • ModelName.BEST_MODEL
    • ModelName.FINAL_MODEL
  • StatisticsConstants
    • StatisticsConstants.FED_STATS_PRE_RUN
    • StatisticsConstants.FED_STATS_TASK
    • StatisticsConstants.GLOBAL
    • 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_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_STDDEV
    • StatisticsConstants.STATS_SUM
    • StatisticsConstants.STATS_TARGET_STATISTICS
    • StatisticsConstants.STATS_VAR
    • StatisticsConstants.ordered_statistics
  • ValidateType
    • ValidateType.BEFORE_TRAIN_VALIDATE
    • ValidateType.MODEL_VALIDATE
• 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.END_ROUND
    • 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.START_ROUND
    • AppEventType.SUBMIT_LOCAL_BEST_MODEL
    • AppEventType.TRAINING_FINISHED
    • AppEventType.TRAINING_STARTED
    • AppEventType.TRAIN_DONE
    • AppEventType.VALIDATION_RESULT_RECEIVED
• nvflare.app_common.model_desc module
  • ModelDescriptor

Module contents