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)[source]¶
Bases :
RecordDict
Deprecated class
RecordSet
, useRecordDict
instead.This class exists solely for backward compatibility with legacy code that previously used
RecordSet
. It has been renamed toRecordDict
and will be removed in a future release.Avertissement
RecordSet
is deprecated and will be removed in a future release. UseRecordDict
instead.Exemples
Legacy (deprecated) usage:
from flwr.common import RecordSet my_content = RecordSet()
Updated usage:
from flwr.common import RecordDict my_content = RecordDict()
Methods
clear
()deflate
()Deflate the RecordDict.
get
(k[,d])inflate
(object_content[, children])Inflate an RecordDict 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
Dictionary holding only ArrayRecord instances.
Return a dictionary of records with their Object IDs as keys.
Dictionary holding only ConfigRecord instances.
Deprecated property.
Dictionary holding only MetricRecord instances.
Deprecated property.
Get object_id.
Deprecated property.
- property array_records: TypedDict[str, ArrayRecord]¶
Dictionary holding only ArrayRecord instances.
- property children: dict[str, InflatableObject]¶
Return a dictionary of records with their Object IDs as keys.
- 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.
- deflate() bytes ¶
Deflate the RecordDict.
- 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) RecordDict ¶
Inflate an RecordDict from bytes.
- Paramètres:
object_content (bytes) – The deflated object content of the RecordDict.
children (Optional[dict[str, InflatableObject]] (default: None)) – Dictionary of children InflatableObjects mapped to their Object IDs. These children enable the full inflation of the RecordDict. Default is None.
- Renvoie:
The inflated RecordDict.
- Type renvoyé:
- 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 object_id: str¶
Get object_id.
- 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. ¶