nvflare.client package

Subpackages

• nvflare.client.cell package
  • Submodules
    • nvflare.client.cell.api module
      • CellClientAPI
    • nvflare.client.cell.attach module
      • effective_connection_security()
      • make_attach_trainer_fqcn()
      • validate_attach_id()
      • validate_attach_profile()
    • nvflare.client.cell.attach_rendezvous module
      • AttachEndpointKey
      • AttachEndpointOwnershipError
      • AttachEndpointPublisher
      • AttachRendezvousCancelled
      • attach_claim_dir()
      • validate_shared_file_listener()
      • wait_for_attach_endpoint()
    • nvflare.client.cell.attach_session module
      • AttachTrainerSession
      • TrainerSessionError
    • nvflare.client.cell.bootstrap module
      • BootstrapKey
      • bootstrap_file_name()
      • get_bootstrap_client_api_type()
      • read_bootstrap_config()
      • write_bootstrap_config()
    • nvflare.client.cell.defs module
      • MsgKey
      • ResultState
      • TaskState
      • Topic
  • Module contents
• nvflare.client.hf package
  • Module contents
    • AnalyticsDataType
      • AnalyticsDataType.IMAGE
      • AnalyticsDataType.INIT_DATA
      • AnalyticsDataType.LOG_RECORD
      • AnalyticsDataType.METRIC
      • AnalyticsDataType.METRICS
      • AnalyticsDataType.MODEL
      • AnalyticsDataType.PARAMETER
      • AnalyticsDataType.PARAMETERS
      • AnalyticsDataType.SCALAR
      • AnalyticsDataType.SCALARS
      • AnalyticsDataType.TAG
      • AnalyticsDataType.TAGS
      • AnalyticsDataType.TEXT
    • FLModel
      • FLModel.summary()
    • IPCAgent
      • IPCAgent.get_task()
      • IPCAgent.start()
      • IPCAgent.stop()
      • IPCAgent.submit_result()
    • ParamsType
      • ParamsType.DIFF
      • ParamsType.FULL
    • evaluate()
    • get_config()
    • get_job_id()
    • get_site_name()
    • get_task_name()
    • init()
    • is_evaluate()
    • is_running()
    • is_submit_model()
    • is_train()
    • log()
    • patch()
    • receive()
    • send()
    • shutdown()
    • system_info()
    • train()
• nvflare.client.in_process package
  • Submodules
    • nvflare.client.in_process.api module
      • InProcessClientAPI
  • Module contents
• nvflare.client.ipc package
  • Submodules
    • nvflare.client.ipc.defs module
      • AgentClosed
      • CallStateError
      • MetaKey
      • MsgHeader
      • PayloadKey
      • Task
      • TaskResult
      • agent_site_fqcn()
    • nvflare.client.ipc.ipc_agent module
      • IPCAgent
  • Module contents
• nvflare.client.lightning package
  • Module contents

Submodules

• nvflare.client.api module
  • clear()
  • get_config()
  • get_context()
  • get_job_id()
  • get_site_name()
  • get_task_name()
  • init()
  • is_evaluate()
  • is_running()
  • is_submit_model()
  • is_train()
  • log()
  • receive()
  • send()
  • shutdown()
  • system_info()
• nvflare.client.api_context module
  • APIContext
  • ClientAPIType
    • ClientAPIType.CELL_API
    • ClientAPIType.IN_PROCESS_API
• nvflare.client.api_spec module
  • APISpec
    • APISpec.clear()
    • APISpec.get_config()
    • APISpec.get_job_id()
    • APISpec.get_site_name()
    • APISpec.get_task_name()
    • APISpec.init()
    • APISpec.is_evaluate()
    • APISpec.is_running()
    • APISpec.is_submit_model()
    • APISpec.is_train()
    • APISpec.log()
    • APISpec.receive()
    • APISpec.send()
    • APISpec.shutdown()
    • APISpec.system_info()
• nvflare.client.config module
  • ClientConfig
    • ClientConfig.get_config()
    • ClientConfig.get_eval_task()
    • ClientConfig.get_exchange_format()
    • ClientConfig.get_server_expected_format()
    • ClientConfig.get_submit_model_task()
    • ClientConfig.get_train_task()
    • ClientConfig.get_transfer_type()
  • ConfigKey
    • ConfigKey.CUDA_EMPTY_CACHE
    • ConfigKey.EVAL_TASK_NAME
    • ConfigKey.EXCHANGE_FORMAT
    • ConfigKey.LAUNCH_ONCE
    • ConfigKey.MEMORY_GC_ROUNDS
    • ConfigKey.SERVER_EXPECTED_FORMAT
    • ConfigKey.SUBMIT_MODEL_TASK_NAME
    • ConfigKey.TASK_EXCHANGE
    • ConfigKey.TASK_NAME
    • ConfigKey.TRAIN_TASK_NAME
    • ConfigKey.TRAIN_WITH_EVAL
    • ConfigKey.TRANSFER_TYPE
  • ExchangeFormat
    • ExchangeFormat.KERAS_LAYER_WEIGHTS
    • ExchangeFormat.NUMPY
    • ExchangeFormat.PYTORCH
    • ExchangeFormat.RAW
  • TransferType
    • TransferType.DIFF
    • TransferType.FULL
  • normalize_exchange_format()
• nvflare.client.constants module
• nvflare.client.converter_utils module
  • convert_params()
  • validate_format_pair()
• nvflare.client.decomposers module
  • register_framework_decomposers()
• nvflare.client.decorator module
  • ObjectHolder
  • evaluate()
  • train()
• nvflare.client.tracking module
  • MLflowWriter
    • MLflowWriter.log_metric()
    • MLflowWriter.log_metrics()
    • MLflowWriter.log_param()
    • MLflowWriter.log_params()
    • MLflowWriter.log_text()
    • MLflowWriter.set_tag()
    • MLflowWriter.set_tags()
  • SummaryWriter
    • SummaryWriter.add_scalar()
    • SummaryWriter.add_scalars()
    • SummaryWriter.flush()
  • WandBWriter
    • WandBWriter.log()
  • get_context()
  • init()
  • log()
  • shutdown()
• nvflare.client.utils module
  • numerical_params_diff()

Module contents