nvflare.app_opt.pt package

Subpackages

• nvflare.app_opt.pt.job_config package
  • Submodules
    • nvflare.app_opt.pt.job_config.base_fed_job module
      • BaseFedJob
    • nvflare.app_opt.pt.job_config.fed_avg module
      • FedAvgJob
    • nvflare.app_opt.pt.job_config.fed_sag_mlflow module
      • SAGMLFlowJob
    • nvflare.app_opt.pt.job_config.model module
      • PTModel
  • Module contents
• nvflare.app_opt.pt.quantization package
  • Submodules
    • nvflare.app_opt.pt.quantization.ada_quant module
      • AdaQuantizer
    • nvflare.app_opt.pt.quantization.constant module
    • nvflare.app_opt.pt.quantization.dequantizer module
      • ModelDequantizer
    • nvflare.app_opt.pt.quantization.quantizer module
      • ModelQuantizer
  • Module contents
• nvflare.app_opt.pt.recipes package
  • Submodules
    • nvflare.app_opt.pt.recipes.cyclic module
      • CyclicRecipe
    • nvflare.app_opt.pt.recipes.fedavg module
      • FedAvgRecipe
    • nvflare.app_opt.pt.recipes.fedavg_he module
      • FedAvgRecipeWithHE
    • nvflare.app_opt.pt.recipes.fedeval module
      • EvalController
      • FedEvalRecipe
    • nvflare.app_opt.pt.recipes.fedopt module
      • FedOptRecipe
    • nvflare.app_opt.pt.recipes.scaffold module
      • ScaffoldRecipe
    • nvflare.app_opt.pt.recipes.swarm module
      • BaseSwarmLearningRecipe
      • SwarmLearningRecipe
  • Module contents
    • CyclicRecipe
    • FedAvgRecipe
    • FedEvalRecipe
    • FedOptRecipe
    • ScaffoldRecipe

Submodules

• nvflare.app_opt.pt.client_api_launcher_executor module
  • PTClientAPILauncherExecutor
    • PTClientAPILauncherExecutor.initialize()
• nvflare.app_opt.pt.decomposers module
  • SerializationModule
  • TensorDecomposer
    • TensorDecomposer.download()
    • TensorDecomposer.get_download_dot()
    • TensorDecomposer.native_decompose()
    • TensorDecomposer.native_recompose()
    • TensorDecomposer.supported_type()
    • TensorDecomposer.to_downloadable()
• nvflare.app_opt.pt.ditto module
  • PTDittoHelper
    • PTDittoHelper.load_model()
    • PTDittoHelper.local_train()
    • PTDittoHelper.save_model()
    • PTDittoHelper.update_metric_save_model()
• nvflare.app_opt.pt.fedavg module
  • PTFedAvg
    • PTFedAvg.load_model_file()
    • PTFedAvg.run()
    • PTFedAvg.save_model_file()
  • PTFedAvgEarlyStopping
• nvflare.app_opt.pt.fedopt module
  • PTFedOptModelShareableGenerator
    • PTFedOptModelShareableGenerator.handle_event()
    • PTFedOptModelShareableGenerator.server_update()
    • PTFedOptModelShareableGenerator.shareable_to_learnable()
• nvflare.app_opt.pt.fedopt_ctl module
  • FedOpt
    • FedOpt.optimizer_update()
    • FedOpt.run()
    • FedOpt.update_model()
• nvflare.app_opt.pt.fedproxloss module
  • PTFedProxLoss
    • PTFedProxLoss.forward()
• nvflare.app_opt.pt.file_model_locator module
  • PTFileModelLocator
    • PTFileModelLocator.get_model_names()
    • PTFileModelLocator.handle_event()
    • PTFileModelLocator.locate_model()
• nvflare.app_opt.pt.file_model_persistor module
  • PTFileModelPersistor
    • PTFileModelPersistor.get_model()
    • PTFileModelPersistor.get_model_inventory()
    • PTFileModelPersistor.handle_event()
    • PTFileModelPersistor.load_model()
    • PTFileModelPersistor.save_model()
    • PTFileModelPersistor.save_model_file()
• nvflare.app_opt.pt.he_model_reader_writer module
  • HEPTModelReaderWriter
    • HEPTModelReaderWriter.apply_model()
• nvflare.app_opt.pt.in_process_client_api_executor module
  • PTInProcessClientAPIExecutor
• nvflare.app_opt.pt.lazy_tensor_dict module
  • LazyTensorDict
    • LazyTensorDict.cleanup()
    • LazyTensorDict.get()
    • LazyTensorDict.items()
    • LazyTensorDict.keys()
    • LazyTensorDict.make_lazy_ref()
    • LazyTensorDict.values()
• nvflare.app_opt.pt.model_persistence_format_manager module
  • PTModelPersistenceFormatManager
    • PTModelPersistenceFormatManager.PERSISTENCE_KEY_META_PROPS
    • PTModelPersistenceFormatManager.PERSISTENCE_KEY_MODEL
    • PTModelPersistenceFormatManager.PERSISTENCE_KEY_TRAIN_CONF
    • PTModelPersistenceFormatManager.get_persist_model_format()
    • PTModelPersistenceFormatManager.to_model_learnable()
    • PTModelPersistenceFormatManager.to_persistence_dict()
    • PTModelPersistenceFormatManager.update()
• nvflare.app_opt.pt.model_reader_writer module
  • PTModelReaderWriter
    • PTModelReaderWriter.apply_model()
    • PTModelReaderWriter.extract_model()
• nvflare.app_opt.pt.multi_process_executor module
  • PTMultiProcessExecutor
    • PTMultiProcessExecutor.get_multi_process_command()
• nvflare.app_opt.pt.numpy_params_converter module
  • NumpyToPTParamsConverter
    • NumpyToPTParamsConverter.convert()
  • PTToNumpyParamsConverter
    • PTToNumpyParamsConverter.convert()
• nvflare.app_opt.pt.scaffold module
  • PTScaffoldHelper
    • PTScaffoldHelper.get_delta_controls()
    • PTScaffoldHelper.get_params()
    • PTScaffoldHelper.init()
    • PTScaffoldHelper.load_global_controls()
    • PTScaffoldHelper.model_update()
    • PTScaffoldHelper.terms_update()
  • get_lr_values()
• nvflare.app_opt.pt.tensor_downloader module
  • DiskTensorConsumer
    • DiskTensorConsumer.cleanup()
    • DiskTensorConsumer.consume_items()
    • DiskTensorConsumer.download_failed()
    • DiskTensorConsumer.release()
  • TensorConsumer
    • TensorConsumer.consume_items()
  • TensorDownloadable
    • TensorDownloadable.get_item_count()
    • TensorDownloadable.produce_item()
  • add_tensors()
  • cleanup_active_disk_tensor_downloads()
  • download_tensors()
  • download_tensors_to_disk()
• nvflare.app_opt.pt.tensor_params_converter module
  • PTReceiveParamsConverter
    • PTReceiveParamsConverter.convert()
  • PTSendParamsConverter
    • PTSendParamsConverter.convert()
• nvflare.app_opt.pt.utils module
  • ModelParamMatchReport
    • ModelParamMatchReport.external_key_count
    • ModelParamMatchReport.local_key_count
    • ModelParamMatchReport.external_key_sample
    • ModelParamMatchReport.local_key_sample
    • ModelParamMatchReport.matched_keys
    • ModelParamMatchReport.unexpected_keys
    • ModelParamMatchReport.shape_mismatches
    • ModelParamMatchReport.prefix_hint
    • ModelParamMatchReport.external_key_count
    • ModelParamMatchReport.external_key_sample
    • ModelParamMatchReport.format_context()
    • ModelParamMatchReport.format_shape_mismatch_error()
    • ModelParamMatchReport.format_unexpected_keys_error()
    • ModelParamMatchReport.format_unexpected_keys_warning()
    • ModelParamMatchReport.format_zero_match_error()
    • ModelParamMatchReport.local_key_count
    • ModelParamMatchReport.local_key_sample
    • ModelParamMatchReport.matched_keys
    • ModelParamMatchReport.prefix_hint
    • ModelParamMatchReport.shape_mismatches
    • ModelParamMatchReport.unexpected_keys
  • ParamShapeMismatch
    • ParamShapeMismatch.expected_shape
    • ParamShapeMismatch.key
    • ParamShapeMismatch.received_shape
  • feed_vars()
  • inspect_model_params()

Module contents