nvflare.private.defs module

class AppFolderConstants

Bases: object

hard coded file names inside the app folder.

CONFIG_ENV = 'environment.json'

CONFIG_FED_CLIENT = 'config_fed_client.json'

CONFIG_FED_SERVER = 'config_fed_server.json'

CONFIG_TRAIN = 'config_train.json'

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 RequestHeader

Bases: object

APP_NAME = 'app_name'

CALL_NAME = 'call_name'

COMPONENT_TARGET = 'component_target'

CONTROL_COMMAND = 'control_command'

JOB_ID = 'job_id'

class SSLConstants

Bases: object

hard coded names related to SSL.

CERT = 'ssl_cert'

PRIVATE_KEY = 'ssl_private_key'

ROOT_CERT = 'ssl_root_cert'

class SpecialTaskName

Bases: object

END_RUN = '__end_run__'

TRY_AGAIN = '__try_again__'

class SysCommandTopic

Bases: object

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'

RESTART = 'train.restart'

SET_JOB_ID = 'train.set_job_id'

SHUTDOWN = 'train.shutdown'

START = 'train.start'

START_JOB = 'train.start_job'