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 CellMessageHeaderKeys

Bases: object

ABORT_JOBS = 'abort_jobs'

CLIENT_IP = 'client_ip'

CLIENT_NAME = 'client_name'

CLIENT_TYPE = 'client_type'

JOB_ID = 'job_id'

JOB_IDS = 'job_ids'

MESSAGE = 'message'

PROJECT_NAME = 'project_name'

SSID = 'ssid'

TOKEN = '__token__'

TOKEN_SIGNATURE = '__token_signature__'

UNAUTHENTICATED = 'unauthenticated'

class ClientRegMsgKey

Bases: object

SITE_CONFIG = 'site_config'

class ClientRegSession(client_name: str)

Bases: object

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 ClientType

Bases: object

ADMIN = 'admin'

REGULAR = 'regular'

RELAY = 'relay'

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

AUTH_TOKEN = 'auth_token'

AUTH_TOKEN_SIGNATURE = 'auth_token_signature'

ENGINE_TASK_NAME = 'engine_task_name'

FEDERATE_CLIENT = 'federate_client'

class InfoCollectorTopic

Bases: object

RESET_ERRORS = 'info.reset_errors'

SHOW_ERRORS = 'info.show_errors'

SHOW_STATS = 'info.show_stats'

class InternalFLContextKey

Bases: object

CLIENT_REG_SESSION = 'client_reg_session'

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 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

CONFIGURE_SITE_LOG = 'sys.configure_site_log'

REPORT_ENV = 'sys.report_env'

REPORT_RESOURCES = 'resource_manager.report_resources'

REPORT_VERSION = 'sys.report_version'

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'

CONFIGURE_JOB_LOG = 'train.configure_job_log'

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'