flwr-nightly 1.7.0.dev20240122__tar.gz → 1.7.0.dev20240123__tar.gz

{flwr_nightly-1.7.0.dev20240122 → flwr_nightly-1.7.0.dev20240123}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flwr-nightly
-Version: 1.7.0.dev20240122
+Version: 1.7.0.dev20240123
 Summary: Flower: A Friendly Federated Learning Framework
 Home-page: https://flower.dev
 License: Apache-2.0

{flwr_nightly-1.7.0.dev20240122 → flwr_nightly-1.7.0.dev20240123}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "flwr-nightly"
-version = "1.7.0-dev20240122"
+version = "1.7.0-dev20240123"
 description = "Flower: A Friendly Federated Learning Framework"
 license = "Apache-2.0"
 authors = ["The Flower Authors <hello@flower.dev>"]

flwr_nightly-1.7.0.dev20240123/src/py/flwr/common/recordset_compat.py

@@ -0,0 +1,401 @@
+# Copyright 2024 Flower Labs GmbH. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+"""RecordSet utilities."""
+
+
+from typing import Dict, Mapping, OrderedDict, Tuple, Union, cast, get_args
+
+from .configsrecord import ConfigsRecord
+from .metricsrecord import MetricsRecord
+from .parametersrecord import Array, ParametersRecord
+from .recordset import RecordSet
+from .typing import (
+    Code,
+    ConfigsRecordValues,
+    EvaluateIns,
+    EvaluateRes,
+    FitIns,
+    FitRes,
+    GetParametersIns,
+    GetParametersRes,
+    GetPropertiesIns,
+    GetPropertiesRes,
+    MetricsRecordValues,
+    Parameters,
+    Scalar,
+    Status,
+)
+
+
+def parametersrecord_to_parameters(
+    record: ParametersRecord, keep_input: bool = False
+) -> Parameters:
+    """Convert ParameterRecord to legacy Parameters.
+
+    Warning: Because `Arrays` in `ParametersRecord` encode more information of the
+    array-like or tensor-like data (e.g their datatype, shape) than `Parameters` it
+    might not be possible to reconstruct such data structures from `Parameters` objects
+    alone. Additional information or metadta must be provided from elsewhere.
+
+    Parameters
+    ----------
+    record : ParametersRecord
+        The record to be conveted into Parameters.
+    keep_input : bool (default: False)
+        A boolean indicating whether entries in the record should be deleted from the
+        input dictionary immediately after adding them to the record.
+    """
+    parameters = Parameters(tensors=[], tensor_type="")
+
+    for key in list(record.data.keys()):
+        parameters.tensors.append(record[key].data)
+
+        if not parameters.tensor_type:
+            # Setting from first array in record. Recall the warning in the docstrings
+            # of this function.
+            parameters.tensor_type = record[key].stype
+
+        if not keep_input:
+            del record.data[key]
+
+    return parameters
+
+
+def parameters_to_parametersrecord(
+    parameters: Parameters, keep_input: bool = False
+) -> ParametersRecord:
+    """Convert legacy Parameters into a single ParametersRecord.
+
+    Because there is no concept of names in the legacy Parameters, arbitrary keys will
+    be used when constructing the ParametersRecord. Similarly, the shape and data type
+    won't be recorded in the Array objects.
+
+    Parameters
+    ----------
+    parameters : Parameters
+        Parameters object to be represented as a ParametersRecord.
+    keep_input : bool (default: False)
+        A boolean indicating whether parameters should be deleted from the input
+        Parameters object (i.e. a list of serialized NumPy arrays) immediately after
+        adding them to the record.
+    """
+    tensor_type = parameters.tensor_type
+
+    p_record = ParametersRecord()
+
+    num_arrays = len(parameters.tensors)
+    for idx in range(num_arrays):
+        if keep_input:
+            tensor = parameters.tensors[idx]
+        else:
+            tensor = parameters.tensors.pop(0)
+        p_record.set_parameters(
+            OrderedDict(
+                {str(idx): Array(data=tensor, dtype="", stype=tensor_type, shape=[])}
+            )
+        )
+
+    return p_record
+
+
+def _check_mapping_from_recordscalartype_to_scalar(
+    record_data: Mapping[str, Union[ConfigsRecordValues, MetricsRecordValues]]
+) -> Dict[str, Scalar]:
+    """Check mapping `common.*RecordValues` into `common.Scalar` is possible."""
+    for value in record_data.values():
+        if not isinstance(value, get_args(Scalar)):
+            raise TypeError(
+                "There is not a 1:1 mapping between `common.Scalar` types and those "
+                "supported in `common.ConfigsRecordValues` or "
+                "`common.ConfigsRecordValues`. Consider casting your values to a type "
+                "supported by the `common.RecordSet` infrastructure. "
+                f"You used type: {type(value)}"
+            )
+    return cast(Dict[str, Scalar], record_data)
+
+
+def _recordset_to_fit_or_evaluate_ins_components(
+    recordset: RecordSet,
+    ins_str: str,
+    keep_input: bool,
+) -> Tuple[Parameters, Dict[str, Scalar]]:
+    """Derive Fit/Evaluate Ins from a RecordSet."""
+    # get Array and construct Parameters
+    parameters_record = recordset.get_parameters(f"{ins_str}.parameters")
+
+    parameters = parametersrecord_to_parameters(
+        parameters_record, keep_input=keep_input
+    )
+
+    # get config dict
+    config_record = recordset.get_configs(f"{ins_str}.config")
+
+    config_dict = _check_mapping_from_recordscalartype_to_scalar(config_record.data)
+
+    return parameters, config_dict
+
+
+def _fit_or_evaluate_ins_to_recordset(
+    ins: Union[FitIns, EvaluateIns], keep_input: bool
+) -> RecordSet:
+    recordset = RecordSet()
+
+    ins_str = "fitins" if isinstance(ins, FitIns) else "evaluateins"
+    recordset.set_parameters(
+        name=f"{ins_str}.parameters",
+        record=parameters_to_parametersrecord(ins.parameters, keep_input=keep_input),
+    )
+
+    recordset.set_configs(
+        name=f"{ins_str}.config", record=ConfigsRecord(ins.config)  # type: ignore
+    )
+
+    return recordset
+
+
+def _embed_status_into_recordset(
+    res_str: str, status: Status, recordset: RecordSet
+) -> RecordSet:
+    status_dict: Dict[str, ConfigsRecordValues] = {
+        "code": int(status.code.value),
+        "message": status.message,
+    }
+    # we add it to a `ConfigsRecord`` because the `status.message`` is a string
+    # and `str` values aren't supported in `MetricsRecords`
+    recordset.set_configs(f"{res_str}.status", record=ConfigsRecord(status_dict))
+    return recordset
+
+
+def _extract_status_from_recordset(res_str: str, recordset: RecordSet) -> Status:
+    status = recordset.get_configs(f"{res_str}.status")
+    code = cast(int, status["code"])
+    return Status(code=Code(code), message=str(status["message"]))
+
+
+def recordset_to_fitins(recordset: RecordSet, keep_input: bool) -> FitIns:
+    """Derive FitIns from a RecordSet object."""
+    parameters, config = _recordset_to_fit_or_evaluate_ins_components(
+        recordset,
+        ins_str="fitins",
+        keep_input=keep_input,
+    )
+
+    return FitIns(parameters=parameters, config=config)
+
+
+def fitins_to_recordset(fitins: FitIns, keep_input: bool) -> RecordSet:
+    """Construct a RecordSet from a FitIns object."""
+    return _fit_or_evaluate_ins_to_recordset(fitins, keep_input)
+
+
+def recordset_to_fitres(recordset: RecordSet, keep_input: bool) -> FitRes:
+    """Derive FitRes from a RecordSet object."""
+    ins_str = "fitres"
+    parameters = parametersrecord_to_parameters(
+        recordset.get_parameters(f"{ins_str}.parameters"), keep_input=keep_input
+    )
+
+    num_examples = cast(
+        int, recordset.get_metrics(f"{ins_str}.num_examples")["num_examples"]
+    )
+    configs_record = recordset.get_configs(f"{ins_str}.metrics")
+
+    metrics = _check_mapping_from_recordscalartype_to_scalar(configs_record.data)
+    status = _extract_status_from_recordset(ins_str, recordset)
+
+    return FitRes(
+        status=status, parameters=parameters, num_examples=num_examples, metrics=metrics
+    )
+
+
+def fitres_to_recordset(fitres: FitRes, keep_input: bool) -> RecordSet:
+    """Construct a RecordSet from a FitRes object."""
+    recordset = RecordSet()
+
+    res_str = "fitres"
+
+    recordset.set_configs(
+        name=f"{res_str}.metrics", record=ConfigsRecord(fitres.metrics)  # type: ignore
+    )
+    recordset.set_metrics(
+        name=f"{res_str}.num_examples",
+        record=MetricsRecord({"num_examples": fitres.num_examples}),
+    )
+    recordset.set_parameters(
+        name=f"{res_str}.parameters",
+        record=parameters_to_parametersrecord(fitres.parameters, keep_input),
+    )
+
+    # status
+    recordset = _embed_status_into_recordset(res_str, fitres.status, recordset)
+
+    return recordset
+
+
+def recordset_to_evaluateins(recordset: RecordSet, keep_input: bool) -> EvaluateIns:
+    """Derive EvaluateIns from a RecordSet object."""
+    parameters, config = _recordset_to_fit_or_evaluate_ins_components(
+        recordset,
+        ins_str="evaluateins",
+        keep_input=keep_input,
+    )
+
+    return EvaluateIns(parameters=parameters, config=config)
+
+
+def evaluateins_to_recordset(evaluateins: EvaluateIns, keep_input: bool) -> RecordSet:
+    """Construct a RecordSet from a EvaluateIns object."""
+    return _fit_or_evaluate_ins_to_recordset(evaluateins, keep_input)
+
+
+def recordset_to_evaluateres(recordset: RecordSet) -> EvaluateRes:
+    """Derive EvaluateRes from a RecordSet object."""
+    ins_str = "evaluateres"
+
+    loss = cast(int, recordset.get_metrics(f"{ins_str}.loss")["loss"])
+
+    num_examples = cast(
+        int, recordset.get_metrics(f"{ins_str}.num_examples")["num_examples"]
+    )
+    configs_record = recordset.get_configs(f"{ins_str}.metrics")
+
+    metrics = _check_mapping_from_recordscalartype_to_scalar(configs_record.data)
+    status = _extract_status_from_recordset(ins_str, recordset)
+
+    return EvaluateRes(
+        status=status, loss=loss, num_examples=num_examples, metrics=metrics
+    )
+
+
+def evaluateres_to_recordset(evaluateres: EvaluateRes) -> RecordSet:
+    """Construct a RecordSet from a EvaluateRes object."""
+    recordset = RecordSet()
+
+    res_str = "evaluateres"
+    # loss
+    recordset.set_metrics(
+        name=f"{res_str}.loss",
+        record=MetricsRecord({"loss": evaluateres.loss}),
+    )
+
+    # num_examples
+    recordset.set_metrics(
+        name=f"{res_str}.num_examples",
+        record=MetricsRecord({"num_examples": evaluateres.num_examples}),
+    )
+
+    # metrics
+    recordset.set_configs(
+        name=f"{res_str}.metrics",
+        record=ConfigsRecord(evaluateres.metrics),  # type: ignore
+    )
+
+    # status
+    recordset = _embed_status_into_recordset(
+        f"{res_str}", evaluateres.status, recordset
+    )
+
+    return recordset
+
+
+def recordset_to_getparametersins(recordset: RecordSet) -> GetParametersIns:
+    """Derive GetParametersIns from a RecordSet object."""
+    config_record = recordset.get_configs("getparametersins.config")
+
+    config_dict = _check_mapping_from_recordscalartype_to_scalar(config_record.data)
+
+    return GetParametersIns(config=config_dict)
+
+
+def getparametersins_to_recordset(getparameters_ins: GetParametersIns) -> RecordSet:
+    """Construct a RecordSet from a GetParametersIns object."""
+    recordset = RecordSet()
+
+    recordset.set_configs(
+        name="getparametersins.config",
+        record=ConfigsRecord(getparameters_ins.config),  # type: ignore
+    )
+    return recordset
+
+
+def getparametersres_to_recordset(getparametersres: GetParametersRes) -> RecordSet:
+    """Construct a RecordSet from a GetParametersRes object."""
+    recordset = RecordSet()
+    res_str = "getparametersres"
+    parameters_record = parameters_to_parametersrecord(getparametersres.parameters)
+    recordset.set_parameters(f"{res_str}.parameters", parameters_record)
+
+    # status
+    recordset = _embed_status_into_recordset(
+        res_str, getparametersres.status, recordset
+    )
+
+    return recordset
+
+
+def recordset_to_getparametersres(recordset: RecordSet) -> GetParametersRes:
+    """Derive GetParametersRes from a RecordSet object."""
+    res_str = "getparametersres"
+    parameters = parametersrecord_to_parameters(
+        recordset.get_parameters(f"{res_str}.parameters")
+    )
+
+    status = _extract_status_from_recordset(res_str, recordset)
+    return GetParametersRes(status=status, parameters=parameters)
+
+
+def recordset_to_getpropertiesins(recordset: RecordSet) -> GetPropertiesIns:
+    """Derive GetPropertiesIns from a RecordSet object."""
+    config_record = recordset.get_configs("getpropertiesins.config")
+    config_dict = _check_mapping_from_recordscalartype_to_scalar(config_record.data)
+
+    return GetPropertiesIns(config=config_dict)
+
+
+def getpropertiesins_to_recordset(getpropertiesins: GetPropertiesIns) -> RecordSet:
+    """Construct a RecordSet from a GetPropertiesRes object."""
+    recordset = RecordSet()
+    recordset.set_configs(
+        name="getpropertiesins.config",
+        record=ConfigsRecord(getpropertiesins.config),  # type: ignore
+    )
+    return recordset
+
+
+def recordset_to_getpropertiesres(recordset: RecordSet) -> GetPropertiesRes:
+    """Derive GetPropertiesRes from a RecordSet object."""
+    res_str = "getpropertiesres"
+    config_record = recordset.get_configs(f"{res_str}.properties")
+    properties = _check_mapping_from_recordscalartype_to_scalar(config_record.data)
+
+    status = _extract_status_from_recordset(res_str, recordset=recordset)
+
+    return GetPropertiesRes(status=status, properties=properties)
+
+
+def getpropertiesres_to_recordset(getpropertiesres: GetPropertiesRes) -> RecordSet:
+    """Construct a RecordSet from a GetPropertiesRes object."""
+    recordset = RecordSet()
+    res_str = "getpropertiesres"
+    recordset.set_configs(
+        name=f"{res_str}.properties",
+        record=ConfigsRecord(getpropertiesres.properties),  # type: ignore
+    )
+    # status
+    recordset = _embed_status_into_recordset(
+        res_str, getpropertiesres.status, recordset
+    )
+
+    return recordset

{flwr_nightly-1.7.0.dev20240122 → flwr_nightly-1.7.0.dev20240123}/src/py/flwr/common/serde.py

@@ -28,6 +28,7 @@ from flwr.proto.recordset_pb2 import DoubleList
 from flwr.proto.recordset_pb2 import MetricsRecord as ProtoMetricsRecord
 from flwr.proto.recordset_pb2 import MetricsRecordValue as ProtoMetricsRecordValue
 from flwr.proto.recordset_pb2 import ParametersRecord as ProtoParametersRecord
+from flwr.proto.recordset_pb2 import RecordSet as ProtoRecordSet
 from flwr.proto.recordset_pb2 import Sint64List, StringList
 from flwr.proto.task_pb2 import Value
 from flwr.proto.transport_pb2 import (
@@ -45,6 +46,7 @@ from . import typing
 from .configsrecord import ConfigsRecord
 from .metricsrecord import MetricsRecord
 from .parametersrecord import Array, ParametersRecord
+from .recordset import RecordSet
 
 #  === ServerMessage message ===
 
@@ -719,3 +721,33 @@ def configs_record_from_proto(record_proto: ProtoConfigsRecord) -> ConfigsRecord
         ),
         keep_input=False,
     )
+
+
+# === RecordSet message ===
+
+
+def recordset_to_proto(recordset: RecordSet) -> ProtoRecordSet:
+    """Serialize RecordSet to ProtoBuf."""
+    return ProtoRecordSet(
+        parameters={
+            k: parameters_record_to_proto(v) for k, v in recordset.parameters.items()
+        },
+        metrics={k: metrics_record_to_proto(v) for k, v in recordset.metrics.items()},
+        configs={k: configs_record_to_proto(v) for k, v in recordset.configs.items()},
+    )
+
+
+def recordset_from_proto(recordset_proto: ProtoRecordSet) -> RecordSet:
+    """Deserialize RecordSet from ProtoBuf."""
+    return RecordSet(
+        parameters={
+            k: parameters_record_from_proto(v)
+            for k, v in recordset_proto.parameters.items()
+        },
+        metrics={
+            k: metrics_record_from_proto(v) for k, v in recordset_proto.metrics.items()
+        },
+        configs={
+            k: configs_record_from_proto(v) for k, v in recordset_proto.configs.items()
+        },
+    )

{flwr_nightly-1.7.0.dev20240122 → flwr_nightly-1.7.0.dev20240123}/src/py/flwr/proto/recordset_pb2.py

@@ -14,7 +14,7 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1a\x66lwr/proto/recordset.proto\x12\nflwr.proto\"\x1a\n\nDoubleList\x12\x0c\n\x04vals\x18\x01 \x03(\x01\"\x1a\n\nSint64List\x12\x0c\n\x04vals\x18\x01 \x03(\x12\"\x18\n\x08\x42oolList\x12\x0c\n\x04vals\x18\x01 \x03(\x08\"\x1a\n\nStringList\x12\x0c\n\x04vals\x18\x01 \x03(\t\"\x19\n\tBytesList\x12\x0c\n\x04vals\x18\x01 \x03(\x0c\"B\n\x05\x41rray\x12\r\n\x05\x64type\x18\x01 \x01(\t\x12\r\n\x05shape\x18\x02 \x03(\x05\x12\r\n\x05stype\x18\x03 \x01(\t\x12\x0c\n\x04\x64\x61ta\x18\x04 \x01(\x0c\"\x9f\x01\n\x12MetricsRecordValue\x12\x10\n\x06\x64ouble\x18\x01 \x01(\x01H\x00\x12\x10\n\x06sint64\x18\x02 \x01(\x12H\x00\x12-\n\x0b\x64ouble_list\x18\x15 \x01(\x0b\x32\x16.flwr.proto.DoubleListH\x00\x12-\n\x0bsint64_list\x18\x16 \x01(\x0b\x32\x16.flwr.proto.Sint64ListH\x00\x42\x07\n\x05value\"\xd9\x02\n\x12\x43onfigsRecordValue\x12\x10\n\x06\x64ouble\x18\x01 \x01(\x01H\x00\x12\x10\n\x06sint64\x18\x02 \x01(\x12H\x00\x12\x0e\n\x04\x62ool\x18\x03 \x01(\x08H\x00\x12\x10\n\x06string\x18\x04 \x01(\tH\x00\x12\x0f\n\x05\x62ytes\x18\x05 \x01(\x0cH\x00\x12-\n\x0b\x64ouble_list\x18\x15 \x01(\x0b\x32\x16.flwr.proto.DoubleListH\x00\x12-\n\x0bsint64_list\x18\x16 \x01(\x0b\x32\x16.flwr.proto.Sint64ListH\x00\x12)\n\tbool_list\x18\x17 \x01(\x0b\x32\x14.flwr.proto.BoolListH\x00\x12-\n\x0bstring_list\x18\x18 \x01(\x0b\x32\x16.flwr.proto.StringListH\x00\x12+\n\nbytes_list\x18\x19 \x01(\x0b\x32\x15.flwr.proto.BytesListH\x00\x42\x07\n\x05value\"M\n\x10ParametersRecord\x12\x11\n\tdata_keys\x18\x01 \x03(\t\x12&\n\x0b\x64\x61ta_values\x18\x02 \x03(\x0b\x32\x11.flwr.proto.Array\"\x8f\x01\n\rMetricsRecord\x12\x31\n\x04\x64\x61ta\x18\x01 \x03(\x0b\x32#.flwr.proto.MetricsRecord.DataEntry\x1aK\n\tDataEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12-\n\x05value\x18\x02 \x01(\x0b\x32\x1e.flwr.proto.MetricsRecordValue:\x02\x38\x01\"\x8f\x01\n\rConfigsRecord\x12\x31\n\x04\x64\x61ta\x18\x01 \x03(\x0b\x32#.flwr.proto.ConfigsRecord.DataEntry\x1aK\n\tDataEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12-\n\x05value\x18\x02 \x01(\x0b\x32\x1e.flwr.proto.ConfigsRecordValue:\x02\x38\x01\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1a\x66lwr/proto/recordset.proto\x12\nflwr.proto\"\x1a\n\nDoubleList\x12\x0c\n\x04vals\x18\x01 \x03(\x01\"\x1a\n\nSint64List\x12\x0c\n\x04vals\x18\x01 \x03(\x12\"\x18\n\x08\x42oolList\x12\x0c\n\x04vals\x18\x01 \x03(\x08\"\x1a\n\nStringList\x12\x0c\n\x04vals\x18\x01 \x03(\t\"\x19\n\tBytesList\x12\x0c\n\x04vals\x18\x01 \x03(\x0c\"B\n\x05\x41rray\x12\r\n\x05\x64type\x18\x01 \x01(\t\x12\r\n\x05shape\x18\x02 \x03(\x05\x12\r\n\x05stype\x18\x03 \x01(\t\x12\x0c\n\x04\x64\x61ta\x18\x04 \x01(\x0c\"\x9f\x01\n\x12MetricsRecordValue\x12\x10\n\x06\x64ouble\x18\x01 \x01(\x01H\x00\x12\x10\n\x06sint64\x18\x02 \x01(\x12H\x00\x12-\n\x0b\x64ouble_list\x18\x15 \x01(\x0b\x32\x16.flwr.proto.DoubleListH\x00\x12-\n\x0bsint64_list\x18\x16 \x01(\x0b\x32\x16.flwr.proto.Sint64ListH\x00\x42\x07\n\x05value\"\xd9\x02\n\x12\x43onfigsRecordValue\x12\x10\n\x06\x64ouble\x18\x01 \x01(\x01H\x00\x12\x10\n\x06sint64\x18\x02 \x01(\x12H\x00\x12\x0e\n\x04\x62ool\x18\x03 \x01(\x08H\x00\x12\x10\n\x06string\x18\x04 \x01(\tH\x00\x12\x0f\n\x05\x62ytes\x18\x05 \x01(\x0cH\x00\x12-\n\x0b\x64ouble_list\x18\x15 \x01(\x0b\x32\x16.flwr.proto.DoubleListH\x00\x12-\n\x0bsint64_list\x18\x16 \x01(\x0b\x32\x16.flwr.proto.Sint64ListH\x00\x12)\n\tbool_list\x18\x17 \x01(\x0b\x32\x14.flwr.proto.BoolListH\x00\x12-\n\x0bstring_list\x18\x18 \x01(\x0b\x32\x16.flwr.proto.StringListH\x00\x12+\n\nbytes_list\x18\x19 \x01(\x0b\x32\x15.flwr.proto.BytesListH\x00\x42\x07\n\x05value\"M\n\x10ParametersRecord\x12\x11\n\tdata_keys\x18\x01 \x03(\t\x12&\n\x0b\x64\x61ta_values\x18\x02 \x03(\x0b\x32\x11.flwr.proto.Array\"\x8f\x01\n\rMetricsRecord\x12\x31\n\x04\x64\x61ta\x18\x01 \x03(\x0b\x32#.flwr.proto.MetricsRecord.DataEntry\x1aK\n\tDataEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12-\n\x05value\x18\x02 \x01(\x0b\x32\x1e.flwr.proto.MetricsRecordValue:\x02\x38\x01\"\x8f\x01\n\rConfigsRecord\x12\x31\n\x04\x64\x61ta\x18\x01 \x03(\x0b\x32#.flwr.proto.ConfigsRecord.DataEntry\x1aK\n\tDataEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12-\n\x05value\x18\x02 \x01(\x0b\x32\x1e.flwr.proto.ConfigsRecordValue:\x02\x38\x01\"\x97\x03\n\tRecordSet\x12\x39\n\nparameters\x18\x01 \x03(\x0b\x32%.flwr.proto.RecordSet.ParametersEntry\x12\x33\n\x07metrics\x18\x02 \x03(\x0b\x32\".flwr.proto.RecordSet.MetricsEntry\x12\x33\n\x07\x63onfigs\x18\x03 \x03(\x0b\x32\".flwr.proto.RecordSet.ConfigsEntry\x1aO\n\x0fParametersEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12+\n\x05value\x18\x02 \x01(\x0b\x32\x1c.flwr.proto.ParametersRecord:\x02\x38\x01\x1aI\n\x0cMetricsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12(\n\x05value\x18\x02 \x01(\x0b\x32\x19.flwr.proto.MetricsRecord:\x02\x38\x01\x1aI\n\x0c\x43onfigsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12(\n\x05value\x18\x02 \x01(\x0b\x32\x19.flwr.proto.ConfigsRecord:\x02\x38\x01\x62\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -25,6 +25,12 @@ if _descriptor._USE_C_DESCRIPTORS == False:
   _globals['_METRICSRECORD_DATAENTRY']._serialized_options = b'8\001'
   _globals['_CONFIGSRECORD_DATAENTRY']._options = None
   _globals['_CONFIGSRECORD_DATAENTRY']._serialized_options = b'8\001'
+  _globals['_RECORDSET_PARAMETERSENTRY']._options = None
+  _globals['_RECORDSET_PARAMETERSENTRY']._serialized_options = b'8\001'
+  _globals['_RECORDSET_METRICSENTRY']._options = None
+  _globals['_RECORDSET_METRICSENTRY']._serialized_options = b'8\001'
+  _globals['_RECORDSET_CONFIGSENTRY']._options = None
+  _globals['_RECORDSET_CONFIGSENTRY']._serialized_options = b'8\001'
   _globals['_DOUBLELIST']._serialized_start=42
   _globals['_DOUBLELIST']._serialized_end=68
   _globals['_SINT64LIST']._serialized_start=70
@@ -51,4 +57,12 @@ if _descriptor._USE_C_DESCRIPTORS == False:
   _globals['_CONFIGSRECORD']._serialized_end=1126
   _globals['_CONFIGSRECORD_DATAENTRY']._serialized_start=1051
   _globals['_CONFIGSRECORD_DATAENTRY']._serialized_end=1126
+  _globals['_RECORDSET']._serialized_start=1129
+  _globals['_RECORDSET']._serialized_end=1536
+  _globals['_RECORDSET_PARAMETERSENTRY']._serialized_start=1307
+  _globals['_RECORDSET_PARAMETERSENTRY']._serialized_end=1386
+  _globals['_RECORDSET_METRICSENTRY']._serialized_start=1388
+  _globals['_RECORDSET_METRICSENTRY']._serialized_end=1461
+  _globals['_RECORDSET_CONFIGSENTRY']._serialized_start=1463
+  _globals['_RECORDSET_CONFIGSENTRY']._serialized_end=1536
 # @@protoc_insertion_point(module_scope)

{flwr_nightly-1.7.0.dev20240122 → flwr_nightly-1.7.0.dev20240123}/src/py/flwr/proto/recordset_pb2.pyi

@@ -238,3 +238,68 @@ class ConfigsRecord(google.protobuf.message.Message):
         ) -> None: ...
     def ClearField(self, field_name: typing_extensions.Literal["data",b"data"]) -> None: ...
 global___ConfigsRecord = ConfigsRecord
+
+class RecordSet(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    class ParametersEntry(google.protobuf.message.Message):
+        DESCRIPTOR: google.protobuf.descriptor.Descriptor
+        KEY_FIELD_NUMBER: builtins.int
+        VALUE_FIELD_NUMBER: builtins.int
+        key: typing.Text
+        @property
+        def value(self) -> global___ParametersRecord: ...
+        def __init__(self,
+            *,
+            key: typing.Text = ...,
+            value: typing.Optional[global___ParametersRecord] = ...,
+            ) -> None: ...
+        def HasField(self, field_name: typing_extensions.Literal["value",b"value"]) -> builtins.bool: ...
+        def ClearField(self, field_name: typing_extensions.Literal["key",b"key","value",b"value"]) -> None: ...
+
+    class MetricsEntry(google.protobuf.message.Message):
+        DESCRIPTOR: google.protobuf.descriptor.Descriptor
+        KEY_FIELD_NUMBER: builtins.int
+        VALUE_FIELD_NUMBER: builtins.int
+        key: typing.Text
+        @property
+        def value(self) -> global___MetricsRecord: ...
+        def __init__(self,
+            *,
+            key: typing.Text = ...,
+            value: typing.Optional[global___MetricsRecord] = ...,
+            ) -> None: ...
+        def HasField(self, field_name: typing_extensions.Literal["value",b"value"]) -> builtins.bool: ...
+        def ClearField(self, field_name: typing_extensions.Literal["key",b"key","value",b"value"]) -> None: ...
+
+    class ConfigsEntry(google.protobuf.message.Message):
+        DESCRIPTOR: google.protobuf.descriptor.Descriptor
+        KEY_FIELD_NUMBER: builtins.int
+        VALUE_FIELD_NUMBER: builtins.int
+        key: typing.Text
+        @property
+        def value(self) -> global___ConfigsRecord: ...
+        def __init__(self,
+            *,
+            key: typing.Text = ...,
+            value: typing.Optional[global___ConfigsRecord] = ...,
+            ) -> None: ...
+        def HasField(self, field_name: typing_extensions.Literal["value",b"value"]) -> builtins.bool: ...
+        def ClearField(self, field_name: typing_extensions.Literal["key",b"key","value",b"value"]) -> None: ...
+
+    PARAMETERS_FIELD_NUMBER: builtins.int
+    METRICS_FIELD_NUMBER: builtins.int
+    CONFIGS_FIELD_NUMBER: builtins.int
+    @property
+    def parameters(self) -> google.protobuf.internal.containers.MessageMap[typing.Text, global___ParametersRecord]: ...
+    @property
+    def metrics(self) -> google.protobuf.internal.containers.MessageMap[typing.Text, global___MetricsRecord]: ...
+    @property
+    def configs(self) -> google.protobuf.internal.containers.MessageMap[typing.Text, global___ConfigsRecord]: ...
+    def __init__(self,
+        *,
+        parameters: typing.Optional[typing.Mapping[typing.Text, global___ParametersRecord]] = ...,
+        metrics: typing.Optional[typing.Mapping[typing.Text, global___MetricsRecord]] = ...,
+        configs: typing.Optional[typing.Mapping[typing.Text, global___ConfigsRecord]] = ...,
+        ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["configs",b"configs","metrics",b"metrics","parameters",b"parameters"]) -> None: ...
+global___RecordSet = RecordSet

flwr_nightly-1.7.0.dev20240123/src/py/flwr/proto/task_pb2.py

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: flwr/proto/task.proto
+# Protobuf Python Version: 4.25.0
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from flwr.proto import node_pb2 as flwr_dot_proto_dot_node__pb2
+from flwr.proto import recordset_pb2 as flwr_dot_proto_dot_recordset__pb2
+from flwr.proto import transport_pb2 as flwr_dot_proto_dot_transport__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x15\x66lwr/proto/task.proto\x12\nflwr.proto\x1a\x15\x66lwr/proto/node.proto\x1a\x1a\x66lwr/proto/recordset.proto\x1a\x1a\x66lwr/proto/transport.proto\"\xff\x02\n\x04Task\x12\"\n\x08producer\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\x12\"\n\x08\x63onsumer\x18\x02 \x01(\x0b\x32\x10.flwr.proto.Node\x12\x12\n\ncreated_at\x18\x03 \x01(\t\x12\x14\n\x0c\x64\x65livered_at\x18\x04 \x01(\t\x12\x0b\n\x03ttl\x18\x05 \x01(\t\x12\x10\n\x08\x61ncestry\x18\x06 \x03(\t\x12\x11\n\ttask_type\x18\x07 \x01(\t\x12(\n\trecordset\x18\x08 \x01(\x0b\x32\x15.flwr.proto.RecordSet\x12<\n\x15legacy_server_message\x18\x65 \x01(\x0b\x32\x19.flwr.proto.ServerMessageB\x02\x18\x01\x12<\n\x15legacy_client_message\x18\x66 \x01(\x0b\x32\x19.flwr.proto.ClientMessageB\x02\x18\x01\x12-\n\x02sa\x18g \x01(\x0b\x32\x1d.flwr.proto.SecureAggregationB\x02\x18\x01\"\\\n\x07TaskIns\x12\x0f\n\x07task_id\x18\x01 \x01(\t\x12\x10\n\x08group_id\x18\x02 \x01(\t\x12\x0e\n\x06run_id\x18\x03 \x01(\x12\x12\x1e\n\x04task\x18\x04 \x01(\x0b\x32\x10.flwr.proto.Task\"\\\n\x07TaskRes\x12\x0f\n\x07task_id\x18\x01 \x01(\t\x12\x10\n\x08group_id\x18\x02 \x01(\t\x12\x0e\n\x06run_id\x18\x03 \x01(\x12\x12\x1e\n\x04task\x18\x04 \x01(\x0b\x32\x10.flwr.proto.Task\"\xcc\x02\n\x05Value\x12\x10\n\x06\x64ouble\x18\x01 \x01(\x01H\x00\x12\x10\n\x06sint64\x18\x02 \x01(\x12H\x00\x12\x0e\n\x04\x62ool\x18\x03 \x01(\x08H\x00\x12\x10\n\x06string\x18\x04 \x01(\tH\x00\x12\x0f\n\x05\x62ytes\x18\x05 \x01(\x0cH\x00\x12-\n\x0b\x64ouble_list\x18\x15 \x01(\x0b\x32\x16.flwr.proto.DoubleListH\x00\x12-\n\x0bsint64_list\x18\x16 \x01(\x0b\x32\x16.flwr.proto.Sint64ListH\x00\x12)\n\tbool_list\x18\x17 \x01(\x0b\x32\x14.flwr.proto.BoolListH\x00\x12-\n\x0bstring_list\x18\x18 \x01(\x0b\x32\x16.flwr.proto.StringListH\x00\x12+\n\nbytes_list\x18\x19 \x01(\x0b\x32\x15.flwr.proto.BytesListH\x00\x42\x07\n\x05value\"\xa0\x01\n\x11SecureAggregation\x12\x44\n\x0cnamed_values\x18\x01 \x03(\x0b\x32..flwr.proto.SecureAggregation.NamedValuesEntry\x1a\x45\n\x10NamedValuesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12 \n\x05value\x18\x02 \x01(\x0b\x32\x11.flwr.proto.Value:\x02\x38\x01\x62\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'flwr.proto.task_pb2', _globals)
+if _descriptor._USE_C_DESCRIPTORS == False:
+  DESCRIPTOR._options = None
+  _globals['_TASK'].fields_by_name['legacy_server_message']._options = None
+  _globals['_TASK'].fields_by_name['legacy_server_message']._serialized_options = b'\030\001'
+  _globals['_TASK'].fields_by_name['legacy_client_message']._options = None
+  _globals['_TASK'].fields_by_name['legacy_client_message']._serialized_options = b'\030\001'
+  _globals['_TASK'].fields_by_name['sa']._options = None
+  _globals['_TASK'].fields_by_name['sa']._serialized_options = b'\030\001'
+  _globals['_SECUREAGGREGATION_NAMEDVALUESENTRY']._options = None
+  _globals['_SECUREAGGREGATION_NAMEDVALUESENTRY']._serialized_options = b'8\001'
+  _globals['_TASK']._serialized_start=117
+  _globals['_TASK']._serialized_end=500
+  _globals['_TASKINS']._serialized_start=502
+  _globals['_TASKINS']._serialized_end=594
+  _globals['_TASKRES']._serialized_start=596
+  _globals['_TASKRES']._serialized_end=688
+  _globals['_VALUE']._serialized_start=691
+  _globals['_VALUE']._serialized_end=1023
+  _globals['_SECUREAGGREGATION']._serialized_start=1026
+  _globals['_SECUREAGGREGATION']._serialized_end=1186
+  _globals['_SECUREAGGREGATION_NAMEDVALUESENTRY']._serialized_start=1117
+  _globals['_SECUREAGGREGATION_NAMEDVALUESENTRY']._serialized_end=1186
+# @@protoc_insertion_point(module_scope)

{flwr_nightly-1.7.0.dev20240122 → flwr_nightly-1.7.0.dev20240123}/src/py/flwr/proto/task_pb2.pyi

@@ -23,9 +23,10 @@ class Task(google.protobuf.message.Message):
     TTL_FIELD_NUMBER: builtins.int
     ANCESTRY_FIELD_NUMBER: builtins.int
     TASK_TYPE_FIELD_NUMBER: builtins.int
-    SA_FIELD_NUMBER: builtins.int
+    RECORDSET_FIELD_NUMBER: builtins.int
     LEGACY_SERVER_MESSAGE_FIELD_NUMBER: builtins.int
     LEGACY_CLIENT_MESSAGE_FIELD_NUMBER: builtins.int
+    SA_FIELD_NUMBER: builtins.int
     @property
     def producer(self) -> flwr.proto.node_pb2.Node: ...
     @property
@@ -37,11 +38,13 @@ class Task(google.protobuf.message.Message):
     def ancestry(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[typing.Text]: ...
     task_type: typing.Text
     @property
-    def sa(self) -> global___SecureAggregation: ...
+    def recordset(self) -> flwr.proto.recordset_pb2.RecordSet: ...
     @property
     def legacy_server_message(self) -> flwr.proto.transport_pb2.ServerMessage: ...
     @property
     def legacy_client_message(self) -> flwr.proto.transport_pb2.ClientMessage: ...
+    @property
+    def sa(self) -> global___SecureAggregation: ...
     def __init__(self,
         *,
         producer: typing.Optional[flwr.proto.node_pb2.Node] = ...,
@@ -51,12 +54,13 @@ class Task(google.protobuf.message.Message):
         ttl: typing.Text = ...,
         ancestry: typing.Optional[typing.Iterable[typing.Text]] = ...,
         task_type: typing.Text = ...,
-        sa: typing.Optional[global___SecureAggregation] = ...,
+        recordset: typing.Optional[flwr.proto.recordset_pb2.RecordSet] = ...,
         legacy_server_message: typing.Optional[flwr.proto.transport_pb2.ServerMessage] = ...,
         legacy_client_message: typing.Optional[flwr.proto.transport_pb2.ClientMessage] = ...,
+        sa: typing.Optional[global___SecureAggregation] = ...,
         ) -> None: ...
-    def HasField(self, field_name: typing_extensions.Literal["consumer",b"consumer","legacy_client_message",b"legacy_client_message","legacy_server_message",b"legacy_server_message","producer",b"producer","sa",b"sa"]) -> builtins.bool: ...
-    def ClearField(self, field_name: typing_extensions.Literal["ancestry",b"ancestry","consumer",b"consumer","created_at",b"created_at","delivered_at",b"delivered_at","legacy_client_message",b"legacy_client_message","legacy_server_message",b"legacy_server_message","producer",b"producer","sa",b"sa","task_type",b"task_type","ttl",b"ttl"]) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["consumer",b"consumer","legacy_client_message",b"legacy_client_message","legacy_server_message",b"legacy_server_message","producer",b"producer","recordset",b"recordset","sa",b"sa"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["ancestry",b"ancestry","consumer",b"consumer","created_at",b"created_at","delivered_at",b"delivered_at","legacy_client_message",b"legacy_client_message","legacy_server_message",b"legacy_server_message","producer",b"producer","recordset",b"recordset","sa",b"sa","task_type",b"task_type","ttl",b"ttl"]) -> None: ...
 global___Task = Task
 
 class TaskIns(google.protobuf.message.Message):