nvflare.apis.client module

class Client(name, token)

Bases: object

Init Client.

Represents a client, and is managed by the client manager. The token is an uuid used for authorization.

Parameters:

• name – client name

• token – client token

get_fqcn()

get_fqsn()

get_is_leaf()

get_prop(name, default=None)

get_site_config()

get_token()

set_fqcn(value: str)

set_fqsn(value: str)

set_is_leaf(value: bool)

set_prop(name, value)

set_site_config(value: dict)

Set site config metadata. Exposed via to_dict() to controllers and job metadata — do not store secrets.

set_token(token)

to_dict() → dict

Convert the Client object to a dict representation. This dict could be used included into a job’s metadata.

Returns: dict that contains essential info of the client.

Note that the client’s token is not included in the result since it is authentication data.

class ClientDictKey

Bases: object

FQCN = 'fqcn'

FQSN = 'fqsn'

IS_LEAF = 'is_leaf'

NAME = 'name'

SITE_CONFIG = 'site_config'

class ClientPropKey

Bases: object

FQCN = 'fqcn'

FQSN = 'fqsn'

IS_LEAF = 'is_leaf'

ORG = 'org'

SITE_CONFIG = 'site_config'

from_dict(d: dict) → Client

Create a Client object from the data in the specified dict.

Parameters:

d – the dict that contains Client data. This dict should be the result of to_dict() of a Client object.

Returns: a Client object