RecordSet

class RecordSet(records: dict[str, RecordType] | None = None, *, parameters_records: dict[str, ArrayRecord] | None = None, metrics_records: dict[str, MetricRecord] | None = None, configs_records: dict[str, ConfigRecord] | None = None)

Bases: RecordDict

Deprecated class RecordSet, use RecordDict instead.

This class exists solely for backward compatibility with legacy code that previously used RecordSet. It has been renamed to RecordDict and will be removed in a future release.

Warning

RecordSet is deprecated and will be removed in a future release. Use RecordDict instead.

Examples

Legacy (deprecated) usage:

from flwr.common import RecordSet

my_content = RecordSet()

Updated usage:

from flwr.common import RecordDict

my_content = RecordDict()

Methods

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

Attributes

array_records	Dictionary holding only ArrayRecord instances.
config_records	Dictionary holding only ConfigRecord instances.
configs_records	Deprecated property.
metric_records	Dictionary holding only MetricRecord instances.
metrics_records	Deprecated property.
parameters_records	Deprecated property.

property array_records: TypedDict[str, ArrayRecord]

Dictionary holding only ArrayRecord instances.

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

property config_records: TypedDict[str, ConfigRecord]

Dictionary holding only ConfigRecord instances.

property configs_records: TypedDict[str, ConfigRecord]

Deprecated property.

Use config_records instead.

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.

property metric_records: TypedDict[str, MetricRecord]

Dictionary holding only MetricRecord instances.

property metrics_records: TypedDict[str, MetricRecord]

Deprecated property.

Use metric_records instead.

property parameters_records: TypedDict[str, ArrayRecord]

Deprecated property.

Use array_records instead.

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.