MetricsRecord

class MetricsRecord(metric_dict: dict[str, MetricRecordValues] | None = None, keep_input: bool = True)

Bases: MetricRecord

Deprecated class MetricsRecord, use MetricRecord instead.

This class exists solely for backward compatibility with legacy code that previously used MetricsRecord. It has been renamed to MetricRecord.

Warning

MetricsRecord is deprecated and will be removed in a future release. Use MetricRecord instead.

Examples

Legacy (deprecated) usage:

from flwr.common import MetricsRecord

record = MetricsRecord()

Updated usage:

from flwr.common import MetricRecord

record = MetricRecord()

Methods

clear()
count_bytes()	Return number of Bytes stored in this object.
deflate()	Deflate object.
get(k[,d])
inflate(object_content[, children])	Inflate a MetricRecord from bytes.
items()
keys()
pop(k[,d])	If key is not found, d is returned if given, otherwise KeyError is raised.
popitem()	as a 2-tuple; but raise KeyError if D is empty.
setdefault(k[,d])
update([E, ]**F)	If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
values()

Attributes

children	Get all child objects as a dictionary or None if there are no children.
object_id	Get object_id.

property children: dict[str, InflatableObject] | None

Get all child objects as a dictionary or None if there are no children.

clear() → None.  Remove all items from D.

count_bytes() → int

Return number of Bytes stored in this object.

deflate() → bytes

Deflate object.

get(k[, d]) → D[k] if k in D, else d.  d defaults to None.

classmethod inflate(object_content: bytes, children: dict[str, InflatableObject] | None = None) → MetricRecord

Inflate a MetricRecord from bytes.

Parameters:

• object_content (bytes) – The deflated object content of the MetricRecord.

• children (Optional[dict[str, InflatableObject]] (default: None)) – Must be None. MetricRecord does not support child objects. Providing any children will raise a ValueError.

Returns:

The inflated MetricRecord.

Return type:

MetricRecord

items() → a set-like object providing a view on D's items.

keys() → a set-like object providing a view on D's keys.

property object_id: str

Get object_id.

pop(k[, d]) → v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() → (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D

update([E, ]**F) → None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() → an object providing a view on D's values.