flwr-nightly 1.11.0.dev20240813__py3-none-any.whl → 1.11.0.dev20240821__py3-none-any.whl

flwr/common/record/recordset.py

@@ -15,8 +15,10 @@
 """RecordSet."""
 
 
+from __future__ import annotations
+
 from dataclasses import dataclass
-from typing import Dict, Optional, cast
+from typing import cast
 
 from .configsrecord import ConfigsRecord
 from .metricsrecord import MetricsRecord
@@ -34,9 +36,9 @@ class RecordSetData:
 
     def __init__(
         self,
-        parameters_records: Optional[Dict[str, ParametersRecord]] = None,
-        metrics_records: Optional[Dict[str, MetricsRecord]] = None,
-        configs_records: Optional[Dict[str, ConfigsRecord]] = None,
+        parameters_records: dict[str, ParametersRecord] | None = None,
+        metrics_records: dict[str, MetricsRecord] | None = None,
+        configs_records: dict[str, ConfigsRecord] | None = None,
     ) -> None:
         self.parameters_records = TypedDict[str, ParametersRecord](
             self._check_fn_str, self._check_fn_params
@@ -84,13 +86,83 @@ class RecordSetData:
 
 
 class RecordSet:
-    """RecordSet stores groups of parameters, metrics and configs."""
+    """RecordSet stores groups of parameters, metrics and configs.
+
+    A :code:`RecordSet` is the unified mechanism by which parameters,
+    metrics and configs can be either stored as part of a
+    `flwr.common.Context <flwr.common.Context.html>`_ in your apps
+    or communicated as part of a
+    `flwr.common.Message <flwr.common.Message.html>`_ between your apps.
+
+    Parameters
+    ----------
+    parameters_records : Optional[Dict[str, ParametersRecord]]
+        A dictionary of :code:`ParametersRecords` that can be used to record
+        and communicate model parameters and high-dimensional arrays.
+    metrics_records : Optional[Dict[str, MetricsRecord]]
+        A dictionary of :code:`MetricsRecord` that can be used to record
+        and communicate scalar-valued metrics that are the result of performing
+        and action, for example, by a :code:`ClientApp`.
+    configs_records : Optional[Dict[str, ConfigsRecord]]
+        A dictionary of :code:`ConfigsRecord` that can be used to record
+        and communicate configuration values to an entity (e.g. to a
+        :code:`ClientApp`)
+        for it to adjust how an action is performed.
+
+    Examples
+    --------
+    A :code:`RecordSet` can hold three types of records, each designed
+    with an specific purpose. What is common to all of them is that they
+    are Python dictionaries designed to ensure that each key-value pair
+    adheres to specified data types.
+
+    Let's see an example.
+
+    >>>  from flwr.common import RecordSet
+    >>>  from flwr.common import ConfigsRecords, MetricsRecords, ParametersRecord
+    >>>
+    >>>  # Let's begin with an empty record
+    >>>  my_recordset = RecordSet()
+    >>>
+    >>>  # We can create a ConfigsRecord
+    >>>  c_record = ConfigsRecord({"lr": 0.1, "batch-size": 128})
+    >>>  # Adding it to the record_set would look like this
+    >>>  my_recordset.configs_records["my_config"] = c_record
+    >>>
+    >>>  # We can create a MetricsRecord following a similar process
+    >>>  m_record = MetricsRecord({"accuracy": 0.93, "losses": [0.23, 0.1]})
+    >>>  # Adding it to the record_set would look like this
+    >>>  my_recordset.metrics_records["my_metrics"] = m_record
+
+    Adding a :code:`ParametersRecord` follows the same steps as above but first,
+    the array needs to be serialized and represented as a :code:`flwr.common.Array`.
+    If the array is a :code:`NumPy` array, you can use the built-in utility function
+    `array_from_numpy <flwr.common.array_from_numpy.html>`_. It is often possible to
+    convert an array first to :code:`NumPy` and then use the aforementioned function.
+
+    >>>  from flwr.common import array_from_numpy
+    >>>  # Creating a ParametersRecord would look like this
+    >>>  arr_np = np.random.randn(3, 3)
+    >>>
+    >>>  # You can use the built-in tool to serialize the array
+    >>>  arr = array_from_numpy(arr_np)
+    >>>
+    >>>  # Finally, create the record
+    >>>  p_record = ParametersRecord({"my_array": arr})
+    >>>
+    >>>  # Adding it to the record_set would look like this
+    >>>  my_recordset.configs_records["my_config"] = c_record
+
+    For additional examples on how to construct each of the records types shown
+    above, please refer to the documentation for :code:`ConfigsRecord`,
+    :code:`MetricsRecord` and :code:`ParametersRecord`.
+    """
 
     def __init__(
         self,
-        parameters_records: Optional[Dict[str, ParametersRecord]] = None,
-        metrics_records: Optional[Dict[str, MetricsRecord]] = None,
-        configs_records: Optional[Dict[str, ConfigsRecord]] = None,
+        parameters_records: dict[str, ParametersRecord] | None = None,
+        metrics_records: dict[str, MetricsRecord] | None = None,
+        configs_records: dict[str, ConfigsRecord] | None = None,
     ) -> None:
         data = RecordSetData(
             parameters_records=parameters_records,

flwr/common/record/typeddict.py

@@ -15,99 +15,61 @@
 """Typed dict base class for *Records."""
 
 
-from typing import Any, Callable, Dict, Generic, Iterator, Tuple, TypeVar, cast
+from typing import Callable, Dict, Generic, Iterator, MutableMapping, TypeVar, cast
 
 K = TypeVar("K")  # Key type
 V = TypeVar("V")  # Value type
 
 
-class TypedDict(Generic[K, V]):
+class TypedDict(MutableMapping[K, V], Generic[K, V]):
     """Typed dictionary."""
 
     def __init__(
         self, check_key_fn: Callable[[K], None], check_value_fn: Callable[[V], None]
     ):
-        self._data: Dict[K, V] = {}
-        self._check_key_fn = check_key_fn
-        self._check_value_fn = check_value_fn
+        self.__dict__["_check_key_fn"] = check_key_fn
+        self.__dict__["_check_value_fn"] = check_value_fn
+        self.__dict__["_data"] = {}
 
     def __setitem__(self, key: K, value: V) -> None:
         """Set the given key to the given value after type checking."""
         # Check the types of key and value
-        self._check_key_fn(key)
-        self._check_value_fn(value)
+        cast(Callable[[K], None], self.__dict__["_check_key_fn"])(key)
+        cast(Callable[[V], None], self.__dict__["_check_value_fn"])(value)
+
         # Set key-value pair
-        self._data[key] = value
+        cast(Dict[K, V], self.__dict__["_data"])[key] = value
 
     def __delitem__(self, key: K) -> None:
         """Remove the item with the specified key."""
-        del self._data[key]
+        del cast(Dict[K, V], self.__dict__["_data"])[key]
 
     def __getitem__(self, item: K) -> V:
         """Return the value for the specified key."""
-        return self._data[item]
+        return cast(Dict[K, V], self.__dict__["_data"])[item]
 
     def __iter__(self) -> Iterator[K]:
         """Yield an iterator over the keys of the dictionary."""
-        return iter(self._data)
+        return iter(cast(Dict[K, V], self.__dict__["_data"]))
 
     def __repr__(self) -> str:
         """Return a string representation of the dictionary."""
-        return self._data.__repr__()
+        return cast(Dict[K, V], self.__dict__["_data"]).__repr__()
 
     def __len__(self) -> int:
         """Return the number of items in the dictionary."""
-        return len(self._data)
+        return len(cast(Dict[K, V], self.__dict__["_data"]))
 
-    def __contains__(self, key: K) -> bool:
+    def __contains__(self, key: object) -> bool:
         """Check if the dictionary contains the specified key."""
-        return key in self._data
+        return key in cast(Dict[K, V], self.__dict__["_data"])
 
     def __eq__(self, other: object) -> bool:
         """Compare this instance to another dictionary or TypedDict."""
+        data = cast(Dict[K, V], self.__dict__["_data"])
         if isinstance(other, TypedDict):
-            return self._data == other._data
+            other_data = cast(Dict[K, V], other.__dict__["_data"])
+            return data == other_data
         if isinstance(other, dict):
-            return self._data == other
+            return data == other
         return NotImplemented
-
-    def items(self) -> Iterator[Tuple[K, V]]:
-        """R.items() -> a set-like object providing a view on R's items."""
-        return cast(Iterator[Tuple[K, V]], self._data.items())
-
-    def keys(self) -> Iterator[K]:
-        """R.keys() -> a set-like object providing a view on R's keys."""
-        return cast(Iterator[K], self._data.keys())
-
-    def values(self) -> Iterator[V]:
-        """R.values() -> an object providing a view on R's values."""
-        return cast(Iterator[V], self._data.values())
-
-    def update(self, *args: Any, **kwargs: Any) -> None:
-        """R.update([E, ]**F) -> None.
-
-        Update R from dict/iterable E and F.
-        """
-        for key, value in dict(*args, **kwargs).items():
-            self[key] = value
-
-    def pop(self, key: K) -> V:
-        """R.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.
-        """
-        return self._data.pop(key)
-
-    def get(self, key: K, default: V) -> V:
-        """R.get(k[,d]) -> R[k] if k in R, else d.
-
-        d defaults to None.
-        """
-        return self._data.get(key, default)
-
-    def clear(self) -> None:
-        """R.clear() -> None.
-
-        Remove all items from R.
-        """
-        self._data.clear()

flwr/common/recordset_compat.py

@@ -145,7 +145,7 @@ def _recordset_to_fit_or_evaluate_ins_components(
     # get config dict
     config_record = recordset.configs_records[f"{ins_str}.config"]
     # pylint: disable-next=protected-access
-    config_dict = _check_mapping_from_recordscalartype_to_scalar(config_record._data)
+    config_dict = _check_mapping_from_recordscalartype_to_scalar(config_record)
 
     return parameters, config_dict
 
@@ -213,7 +213,7 @@ def recordset_to_fitres(recordset: RecordSet, keep_input: bool) -> FitRes:
     )
     configs_record = recordset.configs_records[f"{ins_str}.metrics"]
     # pylint: disable-next=protected-access
-    metrics = _check_mapping_from_recordscalartype_to_scalar(configs_record._data)
+    metrics = _check_mapping_from_recordscalartype_to_scalar(configs_record)
     status = _extract_status_from_recordset(ins_str, recordset)
 
     return FitRes(
@@ -274,7 +274,7 @@ def recordset_to_evaluateres(recordset: RecordSet) -> EvaluateRes:
     configs_record = recordset.configs_records[f"{ins_str}.metrics"]
 
     # pylint: disable-next=protected-access
-    metrics = _check_mapping_from_recordscalartype_to_scalar(configs_record._data)
+    metrics = _check_mapping_from_recordscalartype_to_scalar(configs_record)
     status = _extract_status_from_recordset(ins_str, recordset)
 
     return EvaluateRes(
@@ -314,7 +314,7 @@ def recordset_to_getparametersins(recordset: RecordSet) -> GetParametersIns:
     """Derive GetParametersIns from a RecordSet object."""
     config_record = recordset.configs_records["getparametersins.config"]
     # pylint: disable-next=protected-access
-    config_dict = _check_mapping_from_recordscalartype_to_scalar(config_record._data)
+    config_dict = _check_mapping_from_recordscalartype_to_scalar(config_record)
 
     return GetParametersIns(config=config_dict)
 
@@ -365,7 +365,7 @@ def recordset_to_getpropertiesins(recordset: RecordSet) -> GetPropertiesIns:
     """Derive GetPropertiesIns from a RecordSet object."""
     config_record = recordset.configs_records["getpropertiesins.config"]
     # pylint: disable-next=protected-access
-    config_dict = _check_mapping_from_recordscalartype_to_scalar(config_record._data)
+    config_dict = _check_mapping_from_recordscalartype_to_scalar(config_record)
 
     return GetPropertiesIns(config=config_dict)
 
@@ -384,7 +384,7 @@ def recordset_to_getpropertiesres(recordset: RecordSet) -> GetPropertiesRes:
     res_str = "getpropertiesres"
     config_record = recordset.configs_records[f"{res_str}.properties"]
     # pylint: disable-next=protected-access
-    properties = _check_mapping_from_recordscalartype_to_scalar(config_record._data)
+    properties = _check_mapping_from_recordscalartype_to_scalar(config_record)
 
     status = _extract_status_from_recordset(res_str, recordset=recordset)
 

flwr/common/serde.py

@@ -22,6 +22,7 @@ from google.protobuf.message import Message as GrpcMessage
 # pylint: disable=E0611
 from flwr.proto.clientappio_pb2 import ClientAppOutputCode, ClientAppOutputStatus
 from flwr.proto.error_pb2 import Error as ProtoError
+from flwr.proto.fab_pb2 import Fab as ProtoFab
 from flwr.proto.message_pb2 import Context as ProtoContext
 from flwr.proto.message_pb2 import Message as ProtoMessage
 from flwr.proto.message_pb2 import Metadata as ProtoMetadata
@@ -686,6 +687,19 @@ def message_from_taskres(taskres: TaskRes) -> Message:
     return message
 
 
+# === FAB ===
+
+
+def fab_to_proto(fab: typing.Fab) -> ProtoFab:
+    """Create a proto Fab object from a Python Fab."""
+    return ProtoFab(hash_str=fab.hash_str, content=fab.content)
+
+
+def fab_from_proto(fab: ProtoFab) -> typing.Fab:
+    """Create a Python Fab object from a proto Fab."""
+    return typing.Fab(fab.hash_str, fab.content)
+
+
 # === User configs ===
 
 
@@ -745,6 +759,7 @@ def metadata_to_proto(metadata: Metadata) -> ProtoMetadata:
         group_id=metadata.group_id,
         ttl=metadata.ttl,
         message_type=metadata.message_type,
+        created_at=metadata.created_at,
     )
     return proto
 
@@ -771,7 +786,9 @@ def message_to_proto(message: Message) -> ProtoMessage:
     """Serialize `Message` to ProtoBuf."""
     proto = ProtoMessage(
         metadata=metadata_to_proto(message.metadata),
-        content=recordset_to_proto(message.content),
+        content=(
+            recordset_to_proto(message.content) if message.has_content() else None
+        ),
         error=error_to_proto(message.error) if message.has_error() else None,
     )
     return proto
@@ -779,6 +796,7 @@ def message_to_proto(message: Message) -> ProtoMessage:
 
 def message_from_proto(message_proto: ProtoMessage) -> Message:
     """Deserialize `Message` from ProtoBuf."""
+    created_at = message_proto.metadata.created_at
     message = Message(
         metadata=metadata_from_proto(message_proto.metadata),
         content=(
@@ -792,6 +810,9 @@ def message_from_proto(message_proto: ProtoMessage) -> Message:
             else None
         ),
     )
+    # `.created_at` is set upon Message object construction
+    # we need to manually set it to the original value
+    message.metadata.created_at = created_at
     return message
 
 
@@ -829,8 +850,8 @@ def run_to_proto(run: typing.Run) -> ProtoRun:
         run_id=run.run_id,
         fab_id=run.fab_id,
         fab_version=run.fab_version,
+        fab_hash=run.fab_hash,
         override_config=user_config_to_proto(run.override_config),
-        fab_hash="",
     )
     return proto
 
@@ -841,6 +862,7 @@ def run_from_proto(run_proto: ProtoRun) -> typing.Run:
         run_id=run_proto.run_id,
         fab_id=run_proto.fab_id,
         fab_version=run_proto.fab_version,
+        fab_hash=run_proto.fab_hash,
         override_config=user_config_from_proto(run_proto.override_config),
     )
     return run

flwr/common/typing.py

@@ -214,6 +214,7 @@ class Run:
     run_id: int
     fab_id: str
     fab_version: str
+    fab_hash: str
     override_config: UserConfig
 
 

flwr/proto/clientappio_pb2.py

@@ -17,25 +17,29 @@ from flwr.proto import run_pb2 as flwr_dot_proto_dot_run__pb2
 from flwr.proto import message_pb2 as flwr_dot_proto_dot_message__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1c\x66lwr/proto/clientappio.proto\x12\nflwr.proto\x1a\x14\x66lwr/proto/fab.proto\x1a\x14\x66lwr/proto/run.proto\x1a\x18\x66lwr/proto/message.proto\"W\n\x15\x43lientAppOutputStatus\x12-\n\x04\x63ode\x18\x01 \x01(\x0e\x32\x1f.flwr.proto.ClientAppOutputCode\x12\x0f\n\x07message\x18\x02 \x01(\t\"+\n\x1aPullClientAppInputsRequest\x12\r\n\x05token\x18\x01 \x01(\x12\"\x87\x01\n\x1bPullClientAppInputsResponse\x12$\n\x07message\x18\x01 \x01(\x0b\x32\x13.flwr.proto.Message\x12$\n\x07\x63ontext\x18\x02 \x01(\x0b\x32\x13.flwr.proto.Context\x12\x1c\n\x03run\x18\x03 \x01(\x0b\x32\x0f.flwr.proto.Run\"x\n\x1bPushClientAppOutputsRequest\x12\r\n\x05token\x18\x01 \x01(\x12\x12$\n\x07message\x18\x02 \x01(\x0b\x32\x13.flwr.proto.Message\x12$\n\x07\x63ontext\x18\x03 \x01(\x0b\x32\x13.flwr.proto.Context\"Q\n\x1cPushClientAppOutputsResponse\x12\x31\n\x06status\x18\x01 \x01(\x0b\x32!.flwr.proto.ClientAppOutputStatus*L\n\x13\x43lientAppOutputCode\x12\x0b\n\x07SUCCESS\x10\x00\x12\x15\n\x11\x44\x45\x41\x44LINE_EXCEEDED\x10\x01\x12\x11\n\rUNKNOWN_ERROR\x10\x02\x32\xe4\x01\n\x0b\x43lientAppIo\x12h\n\x13PullClientAppInputs\x12&.flwr.proto.PullClientAppInputsRequest\x1a\'.flwr.proto.PullClientAppInputsResponse\"\x00\x12k\n\x14PushClientAppOutputs\x12\'.flwr.proto.PushClientAppOutputsRequest\x1a(.flwr.proto.PushClientAppOutputsResponse\"\x00\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1c\x66lwr/proto/clientappio.proto\x12\nflwr.proto\x1a\x14\x66lwr/proto/fab.proto\x1a\x14\x66lwr/proto/run.proto\x1a\x18\x66lwr/proto/message.proto\"W\n\x15\x43lientAppOutputStatus\x12-\n\x04\x63ode\x18\x01 \x01(\x0e\x32\x1f.flwr.proto.ClientAppOutputCode\x12\x0f\n\x07message\x18\x02 \x01(\t\"\x11\n\x0fGetTokenRequest\"!\n\x10GetTokenResponse\x12\r\n\x05token\x18\x01 \x01(\x12\"+\n\x1aPullClientAppInputsRequest\x12\r\n\x05token\x18\x01 \x01(\x12\"\xa5\x01\n\x1bPullClientAppInputsResponse\x12$\n\x07message\x18\x01 \x01(\x0b\x32\x13.flwr.proto.Message\x12$\n\x07\x63ontext\x18\x02 \x01(\x0b\x32\x13.flwr.proto.Context\x12\x1c\n\x03run\x18\x03 \x01(\x0b\x32\x0f.flwr.proto.Run\x12\x1c\n\x03\x66\x61\x62\x18\x04 \x01(\x0b\x32\x0f.flwr.proto.Fab\"x\n\x1bPushClientAppOutputsRequest\x12\r\n\x05token\x18\x01 \x01(\x12\x12$\n\x07message\x18\x02 \x01(\x0b\x32\x13.flwr.proto.Message\x12$\n\x07\x63ontext\x18\x03 \x01(\x0b\x32\x13.flwr.proto.Context\"Q\n\x1cPushClientAppOutputsResponse\x12\x31\n\x06status\x18\x01 \x01(\x0b\x32!.flwr.proto.ClientAppOutputStatus*L\n\x13\x43lientAppOutputCode\x12\x0b\n\x07SUCCESS\x10\x00\x12\x15\n\x11\x44\x45\x41\x44LINE_EXCEEDED\x10\x01\x12\x11\n\rUNKNOWN_ERROR\x10\x02\x32\xad\x02\n\x0b\x43lientAppIo\x12G\n\x08GetToken\x12\x1b.flwr.proto.GetTokenRequest\x1a\x1c.flwr.proto.GetTokenResponse\"\x00\x12h\n\x13PullClientAppInputs\x12&.flwr.proto.PullClientAppInputsRequest\x1a\'.flwr.proto.PullClientAppInputsResponse\"\x00\x12k\n\x14PushClientAppOutputs\x12\'.flwr.proto.PushClientAppOutputsRequest\x1a(.flwr.proto.PushClientAppOutputsResponse\"\x00\x62\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'flwr.proto.clientappio_pb2', _globals)
 if _descriptor._USE_C_DESCRIPTORS == False:
   DESCRIPTOR._options = None
-  _globals['_CLIENTAPPOUTPUTCODE']._serialized_start=591
-  _globals['_CLIENTAPPOUTPUTCODE']._serialized_end=667
+  _globals['_CLIENTAPPOUTPUTCODE']._serialized_start=675
+  _globals['_CLIENTAPPOUTPUTCODE']._serialized_end=751
   _globals['_CLIENTAPPOUTPUTSTATUS']._serialized_start=114
   _globals['_CLIENTAPPOUTPUTSTATUS']._serialized_end=201
-  _globals['_PULLCLIENTAPPINPUTSREQUEST']._serialized_start=203
-  _globals['_PULLCLIENTAPPINPUTSREQUEST']._serialized_end=246
-  _globals['_PULLCLIENTAPPINPUTSRESPONSE']._serialized_start=249
-  _globals['_PULLCLIENTAPPINPUTSRESPONSE']._serialized_end=384
-  _globals['_PUSHCLIENTAPPOUTPUTSREQUEST']._serialized_start=386
-  _globals['_PUSHCLIENTAPPOUTPUTSREQUEST']._serialized_end=506
-  _globals['_PUSHCLIENTAPPOUTPUTSRESPONSE']._serialized_start=508
-  _globals['_PUSHCLIENTAPPOUTPUTSRESPONSE']._serialized_end=589
-  _globals['_CLIENTAPPIO']._serialized_start=670
-  _globals['_CLIENTAPPIO']._serialized_end=898
+  _globals['_GETTOKENREQUEST']._serialized_start=203
+  _globals['_GETTOKENREQUEST']._serialized_end=220
+  _globals['_GETTOKENRESPONSE']._serialized_start=222
+  _globals['_GETTOKENRESPONSE']._serialized_end=255
+  _globals['_PULLCLIENTAPPINPUTSREQUEST']._serialized_start=257
+  _globals['_PULLCLIENTAPPINPUTSREQUEST']._serialized_end=300
+  _globals['_PULLCLIENTAPPINPUTSRESPONSE']._serialized_start=303
+  _globals['_PULLCLIENTAPPINPUTSRESPONSE']._serialized_end=468
+  _globals['_PUSHCLIENTAPPOUTPUTSREQUEST']._serialized_start=470
+  _globals['_PUSHCLIENTAPPOUTPUTSREQUEST']._serialized_end=590
+  _globals['_PUSHCLIENTAPPOUTPUTSRESPONSE']._serialized_start=592
+  _globals['_PUSHCLIENTAPPOUTPUTSRESPONSE']._serialized_end=673
+  _globals['_CLIENTAPPIO']._serialized_start=754
+  _globals['_CLIENTAPPIO']._serialized_end=1055
 # @@protoc_insertion_point(module_scope)

flwr/proto/clientappio_pb2.pyi

@@ -3,6 +3,7 @@
 isort:skip_file
 """
 import builtins
+import flwr.proto.fab_pb2
 import flwr.proto.message_pb2
 import flwr.proto.run_pb2
 import google.protobuf.descriptor
@@ -44,6 +45,23 @@ class ClientAppOutputStatus(google.protobuf.message.Message):
     def ClearField(self, field_name: typing_extensions.Literal["code",b"code","message",b"message"]) -> None: ...
 global___ClientAppOutputStatus = ClientAppOutputStatus
 
+class GetTokenRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    def __init__(self,
+        ) -> None: ...
+global___GetTokenRequest = GetTokenRequest
+
+class GetTokenResponse(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    TOKEN_FIELD_NUMBER: builtins.int
+    token: builtins.int
+    def __init__(self,
+        *,
+        token: builtins.int = ...,
+        ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["token",b"token"]) -> None: ...
+global___GetTokenResponse = GetTokenResponse
+
 class PullClientAppInputsRequest(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
     TOKEN_FIELD_NUMBER: builtins.int
@@ -60,20 +78,24 @@ class PullClientAppInputsResponse(google.protobuf.message.Message):
     MESSAGE_FIELD_NUMBER: builtins.int
     CONTEXT_FIELD_NUMBER: builtins.int
     RUN_FIELD_NUMBER: builtins.int
+    FAB_FIELD_NUMBER: builtins.int
     @property
     def message(self) -> flwr.proto.message_pb2.Message: ...
     @property
     def context(self) -> flwr.proto.message_pb2.Context: ...
     @property
     def run(self) -> flwr.proto.run_pb2.Run: ...
+    @property
+    def fab(self) -> flwr.proto.fab_pb2.Fab: ...
     def __init__(self,
         *,
         message: typing.Optional[flwr.proto.message_pb2.Message] = ...,
         context: typing.Optional[flwr.proto.message_pb2.Context] = ...,
         run: typing.Optional[flwr.proto.run_pb2.Run] = ...,
+        fab: typing.Optional[flwr.proto.fab_pb2.Fab] = ...,
         ) -> None: ...
-    def HasField(self, field_name: typing_extensions.Literal["context",b"context","message",b"message","run",b"run"]) -> builtins.bool: ...
-    def ClearField(self, field_name: typing_extensions.Literal["context",b"context","message",b"message","run",b"run"]) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["context",b"context","fab",b"fab","message",b"message","run",b"run"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["context",b"context","fab",b"fab","message",b"message","run",b"run"]) -> None: ...
 global___PullClientAppInputsResponse = PullClientAppInputsResponse
 
 class PushClientAppOutputsRequest(google.protobuf.message.Message):

flwr/proto/clientappio_pb2_grpc.py

@@ -14,6 +14,11 @@ class ClientAppIoStub(object):
         Args:
             channel: A grpc.Channel.
         """
+        self.GetToken = channel.unary_unary(
+                '/flwr.proto.ClientAppIo/GetToken',
+                request_serializer=flwr_dot_proto_dot_clientappio__pb2.GetTokenRequest.SerializeToString,
+                response_deserializer=flwr_dot_proto_dot_clientappio__pb2.GetTokenResponse.FromString,
+                )
         self.PullClientAppInputs = channel.unary_unary(
                 '/flwr.proto.ClientAppIo/PullClientAppInputs',
                 request_serializer=flwr_dot_proto_dot_clientappio__pb2.PullClientAppInputsRequest.SerializeToString,
@@ -29,6 +34,13 @@ class ClientAppIoStub(object):
 class ClientAppIoServicer(object):
     """Missing associated documentation comment in .proto file."""
 
+    def GetToken(self, request, context):
+        """Get token
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
     def PullClientAppInputs(self, request, context):
         """Get Message, Context, and Run
         """
@@ -46,6 +58,11 @@ class ClientAppIoServicer(object):
 
 def add_ClientAppIoServicer_to_server(servicer, server):
     rpc_method_handlers = {
+            'GetToken': grpc.unary_unary_rpc_method_handler(
+                    servicer.GetToken,
+                    request_deserializer=flwr_dot_proto_dot_clientappio__pb2.GetTokenRequest.FromString,
+                    response_serializer=flwr_dot_proto_dot_clientappio__pb2.GetTokenResponse.SerializeToString,
+            ),
             'PullClientAppInputs': grpc.unary_unary_rpc_method_handler(
                     servicer.PullClientAppInputs,
                     request_deserializer=flwr_dot_proto_dot_clientappio__pb2.PullClientAppInputsRequest.FromString,
@@ -66,6 +83,23 @@ def add_ClientAppIoServicer_to_server(servicer, server):
 class ClientAppIo(object):
     """Missing associated documentation comment in .proto file."""
 
+    @staticmethod
+    def GetToken(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(request, target, '/flwr.proto.ClientAppIo/GetToken',
+            flwr_dot_proto_dot_clientappio__pb2.GetTokenRequest.SerializeToString,
+            flwr_dot_proto_dot_clientappio__pb2.GetTokenResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
     @staticmethod
     def PullClientAppInputs(request,
             target,

flwr/proto/clientappio_pb2_grpc.pyi

@@ -8,6 +8,11 @@ import grpc
 
 class ClientAppIoStub:
     def __init__(self, channel: grpc.Channel) -> None: ...
+    GetToken: grpc.UnaryUnaryMultiCallable[
+        flwr.proto.clientappio_pb2.GetTokenRequest,
+        flwr.proto.clientappio_pb2.GetTokenResponse]
+    """Get token"""
+
     PullClientAppInputs: grpc.UnaryUnaryMultiCallable[
         flwr.proto.clientappio_pb2.PullClientAppInputsRequest,
         flwr.proto.clientappio_pb2.PullClientAppInputsResponse]
@@ -20,6 +25,14 @@ class ClientAppIoStub:
 
 
 class ClientAppIoServicer(metaclass=abc.ABCMeta):
+    @abc.abstractmethod
+    def GetToken(self,
+        request: flwr.proto.clientappio_pb2.GetTokenRequest,
+        context: grpc.ServicerContext,
+    ) -> flwr.proto.clientappio_pb2.GetTokenResponse:
+        """Get token"""
+        pass
+
     @abc.abstractmethod
     def PullClientAppInputs(self,
         request: flwr.proto.clientappio_pb2.PullClientAppInputsRequest,

flwr/proto/exec_pb2.py

@@ -12,10 +12,11 @@ from google.protobuf.internal import builder as _builder
 _sym_db = _symbol_database.Default()
 
 
+from flwr.proto import fab_pb2 as flwr_dot_proto_dot_fab__pb2
 from flwr.proto import transport_pb2 as flwr_dot_proto_dot_transport__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x15\x66lwr/proto/exec.proto\x12\nflwr.proto\x1a\x1a\x66lwr/proto/transport.proto\"\xd3\x02\n\x0fStartRunRequest\x12\x10\n\x08\x66\x61\x62_file\x18\x01 \x01(\x0c\x12H\n\x0foverride_config\x18\x02 \x03(\x0b\x32/.flwr.proto.StartRunRequest.OverrideConfigEntry\x12L\n\x11\x66\x65\x64\x65ration_config\x18\x03 \x03(\x0b\x32\x31.flwr.proto.StartRunRequest.FederationConfigEntry\x1aI\n\x13OverrideConfigEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12!\n\x05value\x18\x02 \x01(\x0b\x32\x12.flwr.proto.Scalar:\x02\x38\x01\x1aK\n\x15\x46\x65\x64\x65rationConfigEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12!\n\x05value\x18\x02 \x01(\x0b\x32\x12.flwr.proto.Scalar:\x02\x38\x01\"\"\n\x10StartRunResponse\x12\x0e\n\x06run_id\x18\x01 \x01(\x12\"#\n\x11StreamLogsRequest\x12\x0e\n\x06run_id\x18\x01 \x01(\x12\"(\n\x12StreamLogsResponse\x12\x12\n\nlog_output\x18\x01 \x01(\t2\xa0\x01\n\x04\x45xec\x12G\n\x08StartRun\x12\x1b.flwr.proto.StartRunRequest\x1a\x1c.flwr.proto.StartRunResponse\"\x00\x12O\n\nStreamLogs\x12\x1d.flwr.proto.StreamLogsRequest\x1a\x1e.flwr.proto.StreamLogsResponse\"\x00\x30\x01\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x15\x66lwr/proto/exec.proto\x12\nflwr.proto\x1a\x14\x66lwr/proto/fab.proto\x1a\x1a\x66lwr/proto/transport.proto\"\xdf\x02\n\x0fStartRunRequest\x12\x1c\n\x03\x66\x61\x62\x18\x01 \x01(\x0b\x32\x0f.flwr.proto.Fab\x12H\n\x0foverride_config\x18\x02 \x03(\x0b\x32/.flwr.proto.StartRunRequest.OverrideConfigEntry\x12L\n\x11\x66\x65\x64\x65ration_config\x18\x03 \x03(\x0b\x32\x31.flwr.proto.StartRunRequest.FederationConfigEntry\x1aI\n\x13OverrideConfigEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12!\n\x05value\x18\x02 \x01(\x0b\x32\x12.flwr.proto.Scalar:\x02\x38\x01\x1aK\n\x15\x46\x65\x64\x65rationConfigEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12!\n\x05value\x18\x02 \x01(\x0b\x32\x12.flwr.proto.Scalar:\x02\x38\x01\"\"\n\x10StartRunResponse\x12\x0e\n\x06run_id\x18\x01 \x01(\x12\"#\n\x11StreamLogsRequest\x12\x0e\n\x06run_id\x18\x01 \x01(\x12\"(\n\x12StreamLogsResponse\x12\x12\n\nlog_output\x18\x01 \x01(\t2\xa0\x01\n\x04\x45xec\x12G\n\x08StartRun\x12\x1b.flwr.proto.StartRunRequest\x1a\x1c.flwr.proto.StartRunResponse\"\x00\x12O\n\nStreamLogs\x12\x1d.flwr.proto.StreamLogsRequest\x1a\x1e.flwr.proto.StreamLogsResponse\"\x00\x30\x01\x62\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -26,18 +27,18 @@ if _descriptor._USE_C_DESCRIPTORS == False:
   _globals['_STARTRUNREQUEST_OVERRIDECONFIGENTRY']._serialized_options = b'8\001'
   _globals['_STARTRUNREQUEST_FEDERATIONCONFIGENTRY']._options = None
   _globals['_STARTRUNREQUEST_FEDERATIONCONFIGENTRY']._serialized_options = b'8\001'
-  _globals['_STARTRUNREQUEST']._serialized_start=66
-  _globals['_STARTRUNREQUEST']._serialized_end=405
-  _globals['_STARTRUNREQUEST_OVERRIDECONFIGENTRY']._serialized_start=255
-  _globals['_STARTRUNREQUEST_OVERRIDECONFIGENTRY']._serialized_end=328
-  _globals['_STARTRUNREQUEST_FEDERATIONCONFIGENTRY']._serialized_start=330
-  _globals['_STARTRUNREQUEST_FEDERATIONCONFIGENTRY']._serialized_end=405
-  _globals['_STARTRUNRESPONSE']._serialized_start=407
-  _globals['_STARTRUNRESPONSE']._serialized_end=441
-  _globals['_STREAMLOGSREQUEST']._serialized_start=443
-  _globals['_STREAMLOGSREQUEST']._serialized_end=478
-  _globals['_STREAMLOGSRESPONSE']._serialized_start=480
-  _globals['_STREAMLOGSRESPONSE']._serialized_end=520
-  _globals['_EXEC']._serialized_start=523
-  _globals['_EXEC']._serialized_end=683
+  _globals['_STARTRUNREQUEST']._serialized_start=88
+  _globals['_STARTRUNREQUEST']._serialized_end=439
+  _globals['_STARTRUNREQUEST_OVERRIDECONFIGENTRY']._serialized_start=289
+  _globals['_STARTRUNREQUEST_OVERRIDECONFIGENTRY']._serialized_end=362
+  _globals['_STARTRUNREQUEST_FEDERATIONCONFIGENTRY']._serialized_start=364
+  _globals['_STARTRUNREQUEST_FEDERATIONCONFIGENTRY']._serialized_end=439
+  _globals['_STARTRUNRESPONSE']._serialized_start=441
+  _globals['_STARTRUNRESPONSE']._serialized_end=475
+  _globals['_STREAMLOGSREQUEST']._serialized_start=477
+  _globals['_STREAMLOGSREQUEST']._serialized_end=512
+  _globals['_STREAMLOGSRESPONSE']._serialized_start=514
+  _globals['_STREAMLOGSRESPONSE']._serialized_end=554
+  _globals['_EXEC']._serialized_start=557
+  _globals['_EXEC']._serialized_end=717
 # @@protoc_insertion_point(module_scope)