MetricsRecord¶

class MetricsRecord(metric_dict: dict[str, int | float | list[int] | list[float]] | None = None, keep_input: bool = True)[source]¶

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.

get(k[,d])

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()

clear() None.  Remove all items from D.¶
count_bytes() int¶

Return number of Bytes stored in this object.

get(k[, d]) D[k] if k in D, else d.  d defaults to None.¶
items() a set-like object providing a view on D's items.¶
keys() a set-like object providing a view on D's keys.¶
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.¶