nvflare.apis.fl_constant module

class AdminCommandNames

Bases: object

ABORT = 'abort'

ABORT_JOB = 'abort_job'

ABORT_TASK = 'abort_task'

AUX_COMMAND = 'aux_command'

CHECK_STATUS = 'check_status'

CLONE_JOB = 'clone_job'

DELETE_JOB = 'delete_job'

DELETE_WORKSPACE = 'delete_workspace'

DEPLOY_APP = 'deploy_app'

DOWNLOAD_JOB = 'download_job'

LIST_JOBS = 'list_jobs'

REMOVE_CLIENT = 'remove_client'

RESET_ERRORS = 'reset_errors'

RESTART = 'restart'

SET_TIMEOUT = 'set_timeout'

SHOW_ERRORS = 'show_errors'

SHOW_STATS = 'show_stats'

SHUTDOWN = 'shutdown'

START_APP = 'start_app'

SUBMIT_JOB = 'submit_job'

class EventScope

Bases: object

FEDERATION = 'federation'

LOCAL = 'local'

class FLContextKey

Bases: object

APP_ROOT = '__app_root__'

ARGS = '__args__'

CLIENT_NAME = '__client_name__'

CURRENT_JOB_ID = '__current_job_id__'

CURRENT_RUN = '__run_num__'

EVENT_DATA = '__event_data__'

EVENT_ID = '__event_id__'

EVENT_ORIGIN = '__event_origin__'

EVENT_ORIGIN_SITE = '__event_origin_site__'

EVENT_SCOPE = '__event_scope__'

FROM_RANK_NUMBER = '__from_rank_number__'

IS_CLIENT_TASK_RESEND = '__is_resend__'

JOB_INFO = '__job_info__'

JOB_RUN_NUMBER = '__job_run_number__'

NUM_OF_PROCESSES = '__num_of_processes__'

PEER_CONTEXT = '__peer_ctx__'

RANK_NUMBER = '__rank_number__'

REPLY = '__reply__'

RUNNER = '__runner__'

RUN_ABORT_SIGNAL = '__run_abort_signal__'

SECURE_MODE = '__secure_mode__'

SHAREABLE = '__shareable__'

SP_END_POINT = '__sp_end_point__'

TASK_DATA = '__task_data__'

TASK_ID = '__task_id__'

TASK_NAME = '__task_name__'

TASK_RESULT = '__task_result__'

WORKFLOW = '__workflow__'

WORKSPACE_OBJECT = '__workspace_object__'

WORKSPACE_ROOT = '__workspace_root__'

class FedEventHeader

Bases: object

DIRECTION = '_direction'

EVENT_TYPE = '_event_type'

ORIGIN = '_origin'

TARGETS = '_targets'

TIMESTAMP = '_timestamp'

class LogMessageTag

Bases: object

CRITICAL = 'log/critical'

DEBUG = 'log/debug'

ERROR = 'log/error'

EXCEPTION = 'log/exception'

INFO = 'log/info'

LOG_RECORD = 'log_record'

WARNING = 'log/warning'

class MachineStatus(value)

Bases: Enum

Constants for machine status.

Status Lifecycle

STOPPED <-> STARTING -> STARTED -> STOPPING -> STOPPED

STARTED = 'started'

STARTING = 'starting'

STOPPED = 'stopped'

STOPPING = 'stopping'

class NonSerializableKeys

Bases: object

KEYS = ['__engine__', '__manager__', '__runner__']

class ReservedKey

Bases: object

APP_ROOT = '__app_root__'

ARGS = '__args__'

AUX_RUNNER = '__aux_runner__'

CLIENT_NAME = '__client_name__'

COOKIE_JAR = '__cookie_jar__'

CURRENT_JOB_ID = '__current_job_id__'

ENGINE = '__engine__'

EVENT_DATA = '__event_data__'

EVENT_ID = '__event_id__'

EVENT_ORIGIN = '__event_origin__'

EVENT_ORIGIN_SITE = '__event_origin_site__'

EVENT_SCOPE = '__event_scope__'

FROM_RANK_NUMBER = '__from_rank_number__'

IDENTITY_NAME = '__identity_name__'

IS_RESEND = '__is_resend__'

JOB_INFO = '__job_info__'

JOB_RUN_NUMBER = '__job_run_number__'

MANAGER = '__manager__'

NUM_OF_PROCESSES = '__num_of_processes__'

PEER_CTX = '__peer_ctx__'

RANK_NUMBER = '__rank_number__'

RC = '__rc__'

REPLY = '__reply__'

RUNNER = '__runner__'

RUN_ABORT_SIGNAL = '__run_abort_signal__'

RUN_NUM = '__run_num__'

SECURE_MODE = '__secure_mode__'

SHAREABLE = '__shareable__'

SHARED_FL_CONTEXT = '__shared_fl_context__'

SP_END_POINT = '__sp_end_point__'

TASK_DATA = '__task_data__'

TASK_ID = '__task_id__'

TASK_NAME = '__task_name__'

TASK_RESULT = '__task_result__'

WORKFLOW = '__workflow__'

WORKSPACE_OBJECT = '__workspace_object__'

WORKSPACE_ROOT = '__workspace_root__'

class ReservedTopic

Bases: object

ABORT_ASK = '__abort_task__'

AUX_COMMAND = '__aux_command__'

END_RUN = '__end_run__'

class ReturnCode

Bases: object

BAD_PEER_CONTEXT = 'BAD_PEER_CONTEXT'

BAD_REQUEST_DATA = 'BAD_REQUEST_DATA'

BAD_TASK_DATA = 'BAD_TASK_DATA'

COMMUNICATION_ERROR = 'COMMUNICATION_ERROR'

EMPTY_RESULT = 'EMPTY_RESULT'

ERROR = 'ERROR'

EXECUTION_EXCEPTION = 'EXECUTION_EXCEPTION'

EXECUTION_RESULT_ERROR = 'EXECUTION_RESULT_ERROR'

HANDLER_EXCEPTION = 'HANDLER_EXCEPTION'

MISSING_PEER_CONTEXT = 'MISSING_PEER_CONTEXT'

MODEL_UNRECOGNIZED = 'MODEL_UNRECOGNIZED'

OK = 'OK'

RUN_MISMATCH = 'RUN_MISMATCH'

SERVER_NOT_READY = 'SERVER_NOT_READY'

TASK_ABORTED = 'TASK_ABORTED'

TASK_DATA_FILTER_ERROR = 'TASK_DATA_FILTER_ERROR'

TASK_RESULT_FILTER_ERROR = 'TASK_RESULT_FILTER_ERROR'

TASK_UNKNOWN = 'TASK_UNKNOWN'

TASK_UNSUPPORTED = 'TASK_UNSUPPORTED'

TOPIC_UNKNOWN = 'TOPIC_UNKNOWN'

VALIDATE_TYPE_UNKNOWN = 'VALIDATE_TYPE_UNKNOWN'

class RunProcessKey

Bases: object

CHILD_PROCESS = '_child_process'

CONNECTION = '_comm_conn'

JOB_ID = '_job_id'

LISTEN_PORT = '_listen_port'

PARTICIPANTS = '_participants'

STATUS = '_status'

class ServerCommandKey

Bases: object

AUX_REPLY = 'aux_reply'

CLIENTS = 'clients'

COLLECTOR = 'collector'

COMMAND = 'command'

DATA = 'data'

FL_CLIENT = 'fl_client'

FL_CONTEXT = 'fl_context'

JOB_ID = 'job_id'

PEER_FL_CONTEXT = 'peer_fl_ctx'

SHAREABLE = 'shareable'

TASK_ID = 'task_id'

TASK_NAME = 'task_name'

TOPIC = 'topic'

class ServerCommandNames

Bases: object

AUX_COMMUNICATE = 'aux_communicate'

AUX_SEND = 'aux_send'

GET_CLIENTS = 'get_clients'

GET_ERRORS = 'get_errors'

GET_RUN_INFO = 'get_run_info'

GET_TASK = 'get_task'

HEARTBEAT = 'heartbeat'

SHOW_STATS = 'show_stats'

SUBMIT_UPDATE = 'submit_update'

class SnapshotKey

Bases: object

FL_CONTEXT = 'fl_context'

JOB_CLIENTS = '_job_clients'

JOB_ID = '_job_id'

JOB_INFO = '_job_info'

SERVER_RUNNER = '_Server_Runner'

WORKSPACE = '_workspace'

class SystemComponents

Bases: object

CANCEL_RESOURCE_PROCESSOR = 'cancel_resource_processor'

CHECK_RESOURCE_PROCESSOR = 'check_resource_processor'

CLIENT_RUNNER = 'client_runner'

JOB_MANAGER = 'job_manager'

JOB_RUNNER = 'job_runner'

JOB_SCHEDULER = 'job_scheduler'

RESOURCE_CONSUMER = 'resource_consumer'

RESOURCE_MANAGER = 'resource_manager'

SERVER_RUNNER = 'server_runner'

class WorkspaceConstants

Bases: object

hard coded file names inside the workspace folder.

APP_PREFIX = 'app_'

AUDIT_LOG = 'audit.log'

LOGGING_CONFIG = 'log.config'

RESTART_FILE = 'restart.fl'

SHUTDOWN_FILE = 'shutdown.fl'

WORKSPACE_PREFIX = ''