nvflare.client package

Subpackages

• nvflare.client.ex_process package
  • Submodules
    • nvflare.client.ex_process.api module
      • ExProcessClientAPI
  • Module contents
• 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.EX_PROCESS_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_auth_token()
    • ClientConfig.get_auth_token_signature()
    • ClientConfig.get_config()
    • ClientConfig.get_connection_security()
    • ClientConfig.get_cp_conn_props()
    • ClientConfig.get_download_complete_timeout()
    • ClientConfig.get_eval_task()
    • ClientConfig.get_exchange_format()
    • ClientConfig.get_heartbeat_timeout()
    • ClientConfig.get_launch_once()
    • ClientConfig.get_max_resends()
    • ClientConfig.get_pipe_args()
    • ClientConfig.get_pipe_channel_name()
    • ClientConfig.get_pipe_class()
    • ClientConfig.get_relay_conn_props()
    • ClientConfig.get_root_conn_props()
    • ClientConfig.get_server_expected_format()
    • ClientConfig.get_site_name()
    • ClientConfig.get_submit_model_task()
    • ClientConfig.get_submit_result_timeout()
    • ClientConfig.get_train_task()
    • ClientConfig.get_transfer_type()
    • ClientConfig.to_json()
  • ConfigKey
    • ConfigKey.ARG
    • ConfigKey.CLASS_NAME
    • ConfigKey.CUDA_EMPTY_CACHE
    • ConfigKey.DOWNLOAD_COMPLETE_TIMEOUT
    • ConfigKey.EVAL_TASK_NAME
    • ConfigKey.EXCHANGE_FORMAT
    • ConfigKey.HEARTBEAT_TIMEOUT
    • ConfigKey.LAUNCH_ONCE
    • ConfigKey.MAX_RESENDS
    • ConfigKey.MEMORY_GC_ROUNDS
    • ConfigKey.METRICS_EXCHANGE
    • ConfigKey.PIPE
    • ConfigKey.PIPE_CHANNEL_NAME
    • ConfigKey.SERVER_EXPECTED_FORMAT
    • ConfigKey.SUBMIT_MODEL_TASK_NAME
    • ConfigKey.SUBMIT_RESULT_TIMEOUT
    • 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
  • from_file()
  • write_config_to_file()
• nvflare.client.constants module
• nvflare.client.converter_utils module
  • create_default_params_converters()
• nvflare.client.decorator module
  • ObjectHolder
  • evaluate()
  • train()
• nvflare.client.flare_agent module
  • AgentClosed
  • CallStateError
  • FlareAgent
    • FlareAgent.get_task()
    • FlareAgent.log()
    • FlareAgent.shareable_to_task_data()
    • FlareAgent.start()
    • FlareAgent.stop()
    • FlareAgent.submit_result()
    • FlareAgent.task_result_to_shareable()
  • FlareAgentException
  • FlareAgentWithCellPipe
  • Task
• nvflare.client.flare_agent_with_fl_model module
  • FlareAgentWithFLModel
    • FlareAgentWithFLModel.shareable_to_task_data()
    • FlareAgentWithFLModel.task_result_to_shareable()
• nvflare.client.model_registry module
  • ModelRegistry
    • ModelRegistry.get_model()
    • ModelRegistry.release_params()
    • ModelRegistry.submit_model()
• nvflare.client.task_registry module
  • TaskRegistry
    • TaskRegistry.clear()
    • TaskRegistry.get_sys_info()
    • TaskRegistry.get_task()
    • TaskRegistry.is_rank0
    • TaskRegistry.submit_task()
• 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()
• nvflare.client.utils module
  • numerical_params_diff()

Module contents