nvflare.private.defs module

class AppFolderConstants

Bases: object

hard coded file names inside the app folder.

CONFIG_ENV = 'environment.json'

CONFIG_TRAIN = 'config_train.json'

class CellChannel

Bases: object

AUX_COMMUNICATION = 'aux_communication'

CLIENT_COMMAND = 'client_command'

CLIENT_MAIN = 'admin'

CLIENT_SUB_WORKER_COMMAND = 'client_sub_worker_command'

MULTI_PROCESS_EXECUTOR = 'multi_process_executor'

RETURN_ONLY = 'return_only'

SERVER_COMMAND = 'server_command'

SERVER_MAIN = 'task'

SERVER_PARENT_LISTENER = 'server_parent_listener'

SIMULATOR_RUNNER = 'simulator_runner'

class CellChannelTopic

Bases: object

EXECUTE_RESULT = 'execute_result'

FIRE_EVENT = 'fire_event'

GET_TASK = 'get_task'

HEART_BEAT = 'heart_beat'

Quit = 'quit'

REPORT_JOB_FAILURE = 'report_job_failure'

Register = 'register'

SIMULATOR_WORKER_INIT = 'simulator_worker_init'

SUBMIT_RESULT = 'submit_result'

class CellMessageHeaderKeys

Bases: object

ABORT_JOBS = 'abort_jobs'

CLIENT_IP = 'client_ip'

CLIENT_NAME = 'client_name'

JOB_ID = 'job_id'

JOB_IDS = 'job_ids'

MESSAGE = 'message'

PROJECT_NAME = 'project_name'

SSID = 'ssid'

TOKEN = 'token'

UNAUTHENTICATED = 'unauthenticated'

class ClientStatusKey

Bases: object

APP_NAME = 'app_name'

CLIENT_NAME = 'client_name'

CURRENT_TASK = 'current_task'

JOB_ID = 'job_id'

RUNNING_JOBS = 'running_jobs'

STATUS = 'status'

class ComponentCallerTopic

Bases: object

CALL_COMPONENT = 'comp_caller.call'

class ControlCommandName

Bases: object

ABORT_TASK = 'abort_task'

END_RUN = 'end_run'

class ControlCommandTopic

Bases: object

DO_COMMAND = 'control.do_command'

class EngineConstant

Bases: object

CLIENT_TOKEN_FILE = 'client_token.txt'

ENGINE_TASK_NAME = 'engine_task_name'

FEDERATE_CLIENT = 'federate_client'

FL_TOKEN = 'fl_token'

class InfoCollectorTopic

Bases: object

RESET_ERRORS = 'info.reset_errors'

SHOW_ERRORS = 'info.show_errors'

SHOW_STATS = 'info.show_stats'

class JobFailureMsgKey

Bases: object

CODE = 'code'

JOB_ID = 'job_id'

REASON = 'reason'

class RequestHeader

Bases: object

ADMIN_COMMAND = 'admin_command'

APP_NAME = 'app_name'

CALL_NAME = 'call_name'

COMPONENT_TARGET = 'component_target'

CONTROL_COMMAND = 'control_command'

JOB_ID = 'job_id'

JOB_META = 'job_meta'

JOB_STATUS = 'job_status'

REQUIRE_AUTHZ = 'require_authz'

SUBMITTER_NAME = '_submitterName'

SUBMITTER_ORG = '_submitterOrg'

SUBMITTER_ROLE = '_submitterRole'

TOPIC = 'topic'

USER_NAME = '_userName'

USER_ORG = '_userOrg'

USER_ROLE = '_userRole'

class SSLConstants

Bases: object

hard coded names related to SSL.

CERT = 'ssl_cert'

PRIVATE_KEY = 'ssl_private_key'

ROOT_CERT = 'ssl_root_cert'

class ScopeInfoKey

Bases: object

DEFAULT_SCOPE = 'default_scope'

SCOPE_NAMES = 'scope_names'

class SpecialTaskName

Bases: object

END_RUN = '__end_run__'

TRY_AGAIN = '__try_again__'

class SysCommandTopic

Bases: object

REPORT_ENV = 'sys.report_env'

REPORT_RESOURCES = 'resource_manager.report_resources'

SHELL = 'sys.shell'

SYS_INFO = 'sys.info'

class TaskConstant

Bases: object

WAIT_TIME = '__wait_time__'

class TrainingTopic

Bases: object

ABORT = 'train.abort'

ABORT_TASK = 'train.abort_task'

ALLOCATE_RESOURCE = 'scheduler.allocate_resource'

CANCEL_RESOURCE = 'scheduler.cancel_resource'

CHECK_RESOURCE = 'scheduler.check_resource'

CHECK_STATUS = 'train.check_status'

DELETE_RUN = 'train.delete_run'

DEPLOY = 'train.deploy'

GET_SCOPES = 'train.get_scopes'

NOTIFY_JOB_STATUS = 'train.notify_job_status'

RESTART = 'train.restart'

SET_JOB_ID = 'train.set_job_id'

SHUTDOWN = 'train.shutdown'

START = 'train.start'

START_JOB = 'train.start_job'

new_cell_message(headers: dict, payload=None)