nvflare.apis.analytix module

class AnalyticsData(tag: str, value, data_type: AnalyticsDataType, kwargs: Optional[dict] = None)

Bases: object

This class defines AnalyticsData format.

It is a wrapper to provide to/from DXO conversion.

Parameters

• tag (str) – tag name

• value – value

• data_type (AnalyticDataType) – type of the analytic data.

• kwargs (optional, dict) – additional arguments to be passed.

classmethod from_dxo(dxo: DXO)

Generates the AnalyticsData from DXO object.

Parameters

dxo (DXO) – The DXO object to convert.

Returns

AnalyticsData object

to_dxo()

Converts the AnalyticsData to DXO object.

Returns

DXO object

class AnalyticsDataType(value)

Bases: Enum

An enumeration.

IMAGE = 'IMAGE'

LOG_RECORD = 'LOG_RECORD'

SCALAR = 'SCALAR'

SCALARS = 'SCALARS'

TEXT = 'TEXT'