nvflare.client.cell package

Submodules

• nvflare.client.cell.api module
  • CellClientAPI
    • CellClientAPI.clear()
    • CellClientAPI.get_config()
    • CellClientAPI.get_job_id()
    • CellClientAPI.get_site_name()
    • CellClientAPI.get_task_name()
    • CellClientAPI.init()
    • CellClientAPI.is_evaluate()
    • CellClientAPI.is_running()
    • CellClientAPI.is_submit_model()
    • CellClientAPI.is_train()
    • CellClientAPI.log()
    • CellClientAPI.receive()
    • CellClientAPI.send()
    • CellClientAPI.shutdown()
    • CellClientAPI.system_info()
• 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
    • AttachEndpointKey.ATTACH_ID
    • AttachEndpointKey.CJ_FQCN
    • AttachEndpointKey.CONNECTION_SECURITY
    • AttachEndpointKey.CONNECT_URL
    • AttachEndpointKey.INSTANCE_ID
    • AttachEndpointKey.SCHEMA_VERSION
    • AttachEndpointKey.SITE_NAME
    • AttachEndpointKey.TRAINER_FQCN
  • AttachEndpointOwnershipError
  • AttachEndpointPublisher
    • AttachEndpointPublisher.close()
    • AttachEndpointPublisher.publish()
  • AttachRendezvousCancelled
  • attach_claim_dir()
  • validate_shared_file_listener()
  • wait_for_attach_endpoint()
• nvflare.client.cell.attach_session module
  • AttachTrainerSession
    • AttachTrainerSession.auth_identity_map()
    • AttachTrainerSession.cell_security()
    • AttachTrainerSession.cleanup()
    • AttachTrainerSession.clear_result()
    • AttachTrainerSession.close()
    • AttachTrainerSession.commit_reserved_task_locked()
    • AttachTrainerSession.connection_resources()
    • AttachTrainerSession.forget_reserved_task()
    • AttachTrainerSession.install_pre_decode_guard()
    • AttachTrainerSession.mark_result_publishing()
    • AttachTrainerSession.mark_task_complete()
    • AttachTrainerSession.mark_task_delivered()
    • AttachTrainerSession.prepare_connection()
    • AttachTrainerSession.publish_result()
    • AttachTrainerSession.register_callbacks()
    • AttachTrainerSession.register_cleanup()
    • AttachTrainerSession.reserve_task()
    • AttachTrainerSession.wait_for_open()
  • TrainerSessionError
• nvflare.client.cell.bootstrap module
  • BootstrapKey
    • BootstrapKey.ATTACH_ID
    • BootstrapKey.AUTH_IDENTITY
    • BootstrapKey.CA_CERT
    • BootstrapKey.CJ_FQCN
    • BootstrapKey.CJ_PID
    • BootstrapKey.CONNECTION_SECURITY
    • BootstrapKey.CONNECT_URL
    • BootstrapKey.CP_FQCN
    • BootstrapKey.CUDA_EMPTY_CACHE
    • BootstrapKey.EXECUTION_MODE
    • BootstrapKey.JOB_ID
    • BootstrapKey.JOB_WAIT_TIMEOUT
    • BootstrapKey.LAUNCH_TOKEN
    • BootstrapKey.MEMORY_GC_ROUNDS
    • BootstrapKey.RENDEZVOUS_DIR
    • BootstrapKey.SCHEMA_VERSION
    • BootstrapKey.SECURE_MODE
    • BootstrapKey.SITE_NAME
    • BootstrapKey.TASK_EXCHANGE
    • BootstrapKey.TRAINER_FQCN
  • bootstrap_file_name()
  • get_bootstrap_client_api_type()
  • read_bootstrap_config()
  • write_bootstrap_config()
• nvflare.client.cell.defs module
  • MsgKey
    • MsgKey.ACCEPTED_ATTEMPT_ID
    • MsgKey.ATTACH_ID
    • MsgKey.ATTEMPT_ID
    • MsgKey.AUTH_TOKEN
    • MsgKey.AUTH_TOKEN_SIGNATURE
    • MsgKey.CONNECTION_SECURITY
    • MsgKey.CONNECT_URL
    • MsgKey.CUDA_EMPTY_CACHE
    • MsgKey.HEARTBEAT_INTERVAL
    • MsgKey.HEARTBEAT_TIMEOUT
    • MsgKey.JOB_ID
    • MsgKey.MEMORY_GC_ROUNDS
    • MsgKey.MODEL
    • MsgKey.PROOF
    • MsgKey.PROTOCOL_VERSION
    • MsgKey.RANK
    • MsgKey.REASON
    • MsgKey.REPLY_TOPIC
    • MsgKey.RESULT
    • MsgKey.RESULT_ID
    • MsgKey.RESULT_SOURCE_LIVE
    • MsgKey.RESULT_STATE
    • MsgKey.SECURE_MODE
    • MsgKey.SESSION_ID
    • MsgKey.SITE_NAME
    • MsgKey.TASK_EXCHANGE
    • MsgKey.TASK_ID
    • MsgKey.TASK_NAME
    • MsgKey.TASK_SEQ
    • MsgKey.TASK_STATE
    • MsgKey.TRAINER_FQCN
  • ResultState
    • ResultState.ACCEPTED
    • ResultState.REJECTED
    • ResultState.UNKNOWN
  • TaskState
    • TaskState.COMPLETE
    • TaskState.DELIVERED
    • TaskState.QUEUED
    • TaskState.RESULT_PUBLISHING
    • TaskState.UNKNOWN
  • Topic
    • Topic.ABORT
    • Topic.ERROR
    • Topic.HEARTBEAT
    • Topic.HELLO
    • Topic.HELLO_ACCEPTED
    • Topic.HELLO_REJECTED
    • Topic.LOG
    • Topic.RESULT_ACCEPTED
    • Topic.RESULT_READY
    • Topic.RESULT_REJECTED
    • Topic.RESULT_SOURCE_SETTLED
    • Topic.RESULT_STATUS
    • Topic.SESSION_ACCEPTED
    • Topic.SESSION_OPEN
    • Topic.SESSION_READY
    • Topic.SESSION_REJECTED
    • Topic.SHUTDOWN
    • Topic.TASK_ACCEPTED
    • Topic.TASK_FAILED
    • Topic.TASK_READY
    • Topic.TASK_STATUS

Module contents