Rename protobuf messages

src/proto/flwr/proto/transport.proto

@@ -15,7 +15,7 @@
 
 syntax = "proto3";
 
-package flower.transport;
+package flwr.proto;
 
 service FlowerService {
   rpc Join(stream ClientMessage) returns (stream ServerMessage) {}
@@ -43,7 +43,7 @@ enum Reason {
 
 message ServerMessage {
   message Reconnect { int64 seconds = 1; }
-  message GetParameters {}
+  message GetParametersIns {}
   message FitIns {
     Parameters parameters = 1;
     map<string, Scalar> config = 2;
@@ -52,19 +52,19 @@ message ServerMessage {
     Parameters parameters = 1;
     map<string, Scalar> config = 2;
   }
-  message PropertiesIns { map<string, Scalar> config = 1; }
+  message GetPropertiesIns { map<string, Scalar> config = 1; }
   oneof msg {
     Reconnect reconnect = 1;
-    GetParameters get_parameters = 2;
+    GetParametersIns get_parameters_ins = 2;
     FitIns fit_ins = 3;
     EvaluateIns evaluate_ins = 4;
-    PropertiesIns properties_ins = 5;
+    GetPropertiesIns get_properties_ins = 5;
   }
 }
 
 message ClientMessage {
   message Disconnect { Reason reason = 1; }
-  message ParametersRes { Parameters parameters = 1; }
+  message GetParametersRes { Parameters parameters = 1; }
   message FitRes {
     Parameters parameters = 1;
     int64 num_examples = 2;
@@ -75,21 +75,21 @@ message ClientMessage {
     float loss = 2;
     map<string, Scalar> metrics = 4;
   }
-  message PropertiesRes {
+  message GetPropertiesRes {
     Status status = 1;
     map<string, Scalar> properties = 2;
   }
   oneof msg {
     Disconnect disconnect = 1;
-    ParametersRes parameters_res = 2;
+    GetParametersRes get_parameters_res = 2;
     FitRes fit_res = 3;
     EvaluateRes evaluate_res = 4;
-    PropertiesRes properties_res = 5;
+    GetPropertiesRes get_properties_res = 5;
   }
 }
 
 message Scalar {
-  // The following oneof contains all types that ProtoBuf considers to be
+  // The following `oneof` contains all types that ProtoBuf considers to be
   // "Scalar Value Types". Commented-out types are listed for reference and
   // might be enabled in future releases. Source:
   // https://developers.google.com/protocol-buffers/docs/proto3#scalar

src/py/flwr/client/app_test.py

@@ -25,9 +25,9 @@
     EvaluateRes,
     FitIns,
     FitRes,
-    ParametersRes,
-    PropertiesIns,
-    PropertiesRes,
+    GetParametersRes,
+    GetPropertiesIns,
+    GetPropertiesRes,
     Scalar,
 )
 
@@ -39,11 +39,11 @@
 class PlainClient(Client):
     """Client implementation extending the low-level Client."""
 
-    def get_properties(self, ins: PropertiesIns) -> PropertiesRes:
+    def get_properties(self, ins: GetPropertiesIns) -> GetPropertiesRes:
         # This method is not expected to be called
         raise Exception()
 
-    def get_parameters(self) -> ParametersRes:
+    def get_parameters(self) -> GetParametersRes:
         # This method is not expected to be called
         raise Exception()
 

src/py/flwr/client/client.py

@@ -22,37 +22,37 @@
     EvaluateRes,
     FitIns,
     FitRes,
-    ParametersRes,
-    PropertiesIns,
-    PropertiesRes,
+    GetParametersRes,
+    GetPropertiesIns,
+    GetPropertiesRes,
 )
 
 
 class Client(ABC):
     """Abstract base class for Flower clients."""
 
-    def get_properties(self, ins: PropertiesIns) -> PropertiesRes:
+    def get_properties(self, ins: GetPropertiesIns) -> GetPropertiesRes:
         """Return set of client's properties.
 
         Parameters
         ----------
-        ins : PropertiesIns
+        ins : GetPropertiesIns
             The get properties instructions received from the server containing
             a dictionary of configuration values used to configure.
 
         Returns
         -------
-        PropertiesRes
+        GetPropertiesRes
             Client's properties.
         """
 
     @abstractmethod
-    def get_parameters(self) -> ParametersRes:
+    def get_parameters(self) -> GetParametersRes:
         """Return the current local model parameters.
 
         Returns
         -------
-        ParametersRes
+        GetParametersRes
             The current local model parameters.
         """
 

src/py/flwr/client/client_test.py

@@ -21,9 +21,9 @@
     EvaluateRes,
     FitIns,
     FitRes,
-    ParametersRes,
-    PropertiesIns,
-    PropertiesRes,
+    GetParametersRes,
+    GetPropertiesIns,
+    GetPropertiesRes,
     Status,
 )
 
@@ -33,12 +33,12 @@
 class OverridingClient(Client):
     """Client overriding `get_properties`."""
 
-    def get_properties(self, ins: PropertiesIns) -> PropertiesRes:
-        return PropertiesRes(
+    def get_properties(self, ins: GetPropertiesIns) -> GetPropertiesRes:
+        return GetPropertiesRes(
             status=Status(code=Code.OK, message="Success"), properties={}
         )
 
-    def get_parameters(self) -> ParametersRes:
+    def get_parameters(self) -> GetParametersRes:
         # This method is not expected to be called
         raise Exception()
 
@@ -54,7 +54,7 @@ def evaluate(self, ins: EvaluateIns) -> EvaluateRes:
 class NotOverridingClient(Client):
     """Client not overriding `get_properties`."""
 
-    def get_parameters(self) -> ParametersRes:
+    def get_parameters(self) -> GetParametersRes:
         # This method is not expected to be called
         raise Exception()
 

src/py/flwr/client/grpc_client/message_handler.py

@@ -53,9 +53,9 @@ def handle(
     if field == "reconnect":
         disconnect_msg, sleep_duration = _reconnect(server_msg.reconnect)
         return disconnect_msg, sleep_duration, False
-    if field == "properties_ins":
-        return _get_properties(client, server_msg.properties_ins), 0, True
-    if field == "get_parameters":
+    if field == "get_properties_ins":
+        return _get_properties(client, server_msg.get_properties_ins), 0, True
+    if field == "get_parameters_ins":
         return _get_parameters(client), 0, True
     if field == "fit_ins":
         return _fit(client, server_msg.fit_ins), 0, True
@@ -79,35 +79,35 @@ def _reconnect(
 
 
 def _get_properties(
-    client: Client, properties_msg: ServerMessage.PropertiesIns
+    client: Client, get_properties_msg: ServerMessage.GetPropertiesIns
 ) -> ClientMessage:
     # Check if client overrides get_properties
     if not has_get_properties(client=client):
         # If client does not override get_properties, don't call it
-        properties_res = typing.PropertiesRes(
+        get_properties_res = typing.GetPropertiesRes(
             status=typing.Status(
                 code=typing.Code.GET_PARAMETERS_NOT_IMPLEMENTED,
                 message="Client does not implement get_properties",
             ),
             properties={},
         )
-        properties_res_proto = serde.properties_res_to_proto(properties_res)
-        return ClientMessage(properties_res=properties_res_proto)
+        get_properties_res_proto = serde.get_properties_res_to_proto(get_properties_res)
+        return ClientMessage(get_properties_res=get_properties_res_proto)
 
     # Deserialize get_properties instruction
-    properties_ins = serde.properties_ins_from_proto(properties_msg)
-    # Request for properties
-    properties_res = client.get_properties(properties_ins)
+    get_properties_ins = serde.get_properties_ins_from_proto(get_properties_msg)
+    # Request properties
+    get_properties_res = client.get_properties(get_properties_ins)
     # Serialize response
-    properties_res_proto = serde.properties_res_to_proto(properties_res)
-    return ClientMessage(properties_res=properties_res_proto)
+    get_properties_res_proto = serde.get_properties_res_to_proto(get_properties_res)
+    return ClientMessage(get_properties_res=get_properties_res_proto)
 
 
 def _get_parameters(client: Client) -> ClientMessage:
     # No need to deserialize get_parameters_msg (it's empty)
-    parameters_res = client.get_parameters()
-    parameters_res_proto = serde.parameters_res_to_proto(parameters_res)
-    return ClientMessage(parameters_res=parameters_res_proto)
+    get_parameters_res = client.get_parameters()
+    get_parameters_res_proto = serde.get_parameters_res_to_proto(get_parameters_res)
+    return ClientMessage(get_parameters_res=get_parameters_res_proto)
 
 
 def _fit(client: Client, fit_msg: ServerMessage.FitIns) -> ClientMessage:

src/py/flwr/client/grpc_client/message_handler_test.py

@@ -21,9 +21,9 @@
     EvaluateRes,
     FitIns,
     FitRes,
-    ParametersRes,
-    PropertiesIns,
-    PropertiesRes,
+    GetParametersRes,
+    GetPropertiesIns,
+    GetPropertiesRes,
     serde,
     typing,
 )
@@ -35,7 +35,7 @@
 class FlowerClientWithoutProps(Client):
     """Flower client not implementing get_properties."""
 
-    def get_parameters(self) -> ParametersRes:
+    def get_parameters(self) -> GetParametersRes:
         pass
 
     def fit(self, ins: FitIns) -> FitRes:
@@ -48,13 +48,13 @@ def evaluate(self, ins: EvaluateIns) -> EvaluateRes:
 class FlowerClientWithProps(Client):
     """Flower client implementing get_properties."""
 
-    def get_properties(self, ins: PropertiesIns) -> PropertiesRes:
-        return PropertiesRes(
+    def get_properties(self, ins: GetPropertiesIns) -> GetPropertiesRes:
+        return GetPropertiesRes(
             status=typing.Status(code=typing.Code.OK, message="Success"),
             properties={"str_prop": "val", "int_prop": 1},
         )
 
-    def get_parameters(self) -> ParametersRes:
+    def get_parameters(self) -> GetParametersRes:
         pass
 
     def fit(self, ins: FitIns) -> FitRes:
@@ -68,22 +68,22 @@ def test_client_without_get_properties() -> None:
     """Test client implementing get_properties."""
     # Prepare
     client = FlowerClientWithoutProps()
-    ins = ServerMessage.PropertiesIns()
-    msg = ServerMessage(properties_ins=ins)
+    ins = ServerMessage.GetPropertiesIns()
+    msg = ServerMessage(get_properties_ins=ins)
 
     # Execute
     actual_msg, actual_sleep_duration, actual_keep_going = handle(
         client=client, server_msg=msg
     )
 
     # Assert
-    expected_properties_res = ClientMessage.PropertiesRes(
+    expected_get_properties_res = ClientMessage.GetPropertiesRes(
         status=Status(
             code=Code.GET_PARAMETERS_NOT_IMPLEMENTED,
             message="Client does not implement get_properties",
         )
     )
-    expected_msg = ClientMessage(properties_res=expected_properties_res)
+    expected_msg = ClientMessage(get_properties_res=expected_get_properties_res)
 
     assert actual_msg == expected_msg
     assert actual_sleep_duration == 0
@@ -94,16 +94,16 @@ def test_client_with_get_properties() -> None:
     """Test client not implementing get_properties."""
     # Prepare
     client = FlowerClientWithProps()
-    ins = ServerMessage.PropertiesIns()
-    msg = ServerMessage(properties_ins=ins)
+    ins = ServerMessage.GetPropertiesIns()
+    msg = ServerMessage(get_properties_ins=ins)
 
     # Execute
     actual_msg, actual_sleep_duration, actual_keep_going = handle(
         client=client, server_msg=msg
     )
 
     # Assert
-    expected_properties_res = ClientMessage.PropertiesRes(
+    expected_get_properties_res = ClientMessage.GetPropertiesRes(
         status=Status(
             code=Code.OK,
             message="Success",
@@ -112,7 +112,7 @@ def test_client_with_get_properties() -> None:
             properties={"str_prop": "val", "int_prop": 1}
         ),
     )
-    expected_msg = ClientMessage(properties_res=expected_properties_res)
+    expected_msg = ClientMessage(get_properties_res=expected_get_properties_res)
 
     assert actual_msg == expected_msg
     assert actual_sleep_duration == 0

src/py/flwr/client/numpy_client.py

@@ -27,10 +27,10 @@
     EvaluateRes,
     FitIns,
     FitRes,
+    GetParametersRes,
+    GetPropertiesIns,
+    GetPropertiesRes,
     Metrics,
-    ParametersRes,
-    PropertiesIns,
-    PropertiesRes,
     Scalar,
     Status,
     parameters_to_weights,
@@ -171,19 +171,19 @@ class NumPyClientWrapper(Client):
     def __init__(self, numpy_client: NumPyClient) -> None:
         self.numpy_client = numpy_client
 
-    def get_properties(self, ins: PropertiesIns) -> PropertiesRes:
+    def get_properties(self, ins: GetPropertiesIns) -> GetPropertiesRes:
         """Return the current client properties."""
         properties = self.numpy_client.get_properties(ins.config)
-        return PropertiesRes(
+        return GetPropertiesRes(
             status=Status(code=Code.OK, message="Success"),
             properties=properties,
         )
 
-    def get_parameters(self) -> ParametersRes:
+    def get_parameters(self) -> GetParametersRes:
         """Return the current local model parameters."""
         parameters = self.numpy_client.get_parameters()
         parameters_proto = weights_to_parameters(parameters)
-        return ParametersRes(parameters=parameters_proto)
+        return GetParametersRes(parameters=parameters_proto)
 
     def fit(self, ins: FitIns) -> FitRes:
         """Refine the provided weights using the locally held dataset."""