nvflare.client.config module

class ClientConfig(config: Dict | None = None)

Bases: object

Task metadata used by the in-process Client API.

get_config() → Dict

get_eval_task()

get_exchange_format() → str

get_server_expected_format() → str

get_submit_model_task()

get_train_task()

get_transfer_type() → str

class ConfigKey

Bases: object

CUDA_EMPTY_CACHE = 'cuda_empty_cache'

EVAL_TASK_NAME = 'eval_task_name'

EXCHANGE_FORMAT = 'exchange_format'

LAUNCH_ONCE = 'launch_once'

MEMORY_GC_ROUNDS = 'memory_gc_rounds'

SERVER_EXPECTED_FORMAT = 'server_expected_format'

SUBMIT_MODEL_TASK_NAME = 'submit_model_task_name'

TASK_EXCHANGE = 'TASK_EXCHANGE'

TASK_NAME = 'TASK_NAME'

TRAIN_TASK_NAME = 'train_task_name'

TRAIN_WITH_EVAL = 'train_with_eval'

TRANSFER_TYPE = 'transfer_type'

class ExchangeFormat(value)

Bases: str, Enum

An enumeration.

KERAS_LAYER_WEIGHTS = 'keras_layer_weights'

NUMPY = 'numpy'

PYTORCH = 'pytorch'

RAW = 'raw'

class TransferType(value)

Bases: str, Enum

An enumeration.

DIFF = 'DIFF'

FULL = 'FULL'

normalize_exchange_format(value, name: str) → ExchangeFormat

Return a validated ExchangeFormat value for a config declaration.