flwr-nightly 1.8.0.dev20240305__tar.gz → 1.8.0.dev20240306__tar.gz

{flwr_nightly-1.8.0.dev20240305 → flwr_nightly-1.8.0.dev20240306}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flwr-nightly
-Version: 1.8.0.dev20240305
+Version: 1.8.0.dev20240306
 Summary: Flower: A Friendly Federated Learning Framework
 Home-page: https://flower.ai
 License: Apache-2.0
@@ -42,6 +42,7 @@ Requires-Dist: pydantic (<2.0.0) ; extra == "simulation"
 Requires-Dist: ray (==2.6.3) ; extra == "simulation"
 Requires-Dist: requests (>=2.31.0,<3.0.0) ; extra == "rest"
 Requires-Dist: starlette (>=0.31.0,<0.32.0) ; extra == "rest"
+Requires-Dist: tomli (>=2.0.1,<3.0.0)
 Requires-Dist: typer[all] (>=0.9.0,<0.10.0)
 Requires-Dist: uvicorn[standard] (>=0.23.0,<0.24.0) ; extra == "rest"
 Project-URL: Documentation, https://flower.ai
@@ -182,7 +183,6 @@ Quickstart examples:
 - [Quickstart (JAX)](https://github.com/adap/flower/tree/main/examples/quickstart-jax)
 - [Quickstart (MONAI)](https://github.com/adap/flower/tree/main/examples/quickstart-monai)
 - [Quickstart (scikit-learn)](https://github.com/adap/flower/tree/main/examples/sklearn-logreg-mnist)
-- [Quickstart (XGBoost)](https://github.com/adap/flower/tree/main/examples/xgboost-quickstart)
 - [Quickstart (Android [TFLite])](https://github.com/adap/flower/tree/main/examples/android)
 - [Quickstart (iOS [CoreML])](https://github.com/adap/flower/tree/main/examples/ios)
 - [Quickstart (MLX)](https://github.com/adap/flower/tree/main/examples/quickstart-mlx)
@@ -194,7 +194,8 @@ Other [examples](https://github.com/adap/flower/tree/main/examples):
 - [PyTorch: From Centralized to Federated](https://github.com/adap/flower/tree/main/examples/pytorch-from-centralized-to-federated)
 - [Vertical FL](https://github.com/adap/flower/tree/main/examples/vertical-fl)
 - [Federated Finetuning of OpenAI's Whisper](https://github.com/adap/flower/tree/main/examples/whisper-federated-finetuning)
-- [Comprehensive XGBoost](https://github.com/adap/flower/tree/main/examples/xgboost-comprehensive)
+- [Federated Finetuning of Large Language Model](https://github.com/adap/flower/tree/main/examples/fedllm-finetune)
+- [Federated Finetuning of a Vision Transformer](https://github.com/adap/flower/tree/main/examples/vit-finetune)
 - [Advanced Flower with TensorFlow/Keras](https://github.com/adap/flower/tree/main/examples/advanced-tensorflow)
 - [Advanced Flower with PyTorch](https://github.com/adap/flower/tree/main/examples/advanced-pytorch)
 - Single-Machine Simulation of Federated Learning Systems ([PyTorch](https://github.com/adap/flower/tree/main/examples/simulation-pytorch)) ([Tensorflow](https://github.com/adap/flower/tree/main/examples/simulation-tensorflow))

{flwr_nightly-1.8.0.dev20240305 → flwr_nightly-1.8.0.dev20240306}/README.md

@@ -132,7 +132,6 @@ Quickstart examples:
 - [Quickstart (JAX)](https://github.com/adap/flower/tree/main/examples/quickstart-jax)
 - [Quickstart (MONAI)](https://github.com/adap/flower/tree/main/examples/quickstart-monai)
 - [Quickstart (scikit-learn)](https://github.com/adap/flower/tree/main/examples/sklearn-logreg-mnist)
-- [Quickstart (XGBoost)](https://github.com/adap/flower/tree/main/examples/xgboost-quickstart)
 - [Quickstart (Android [TFLite])](https://github.com/adap/flower/tree/main/examples/android)
 - [Quickstart (iOS [CoreML])](https://github.com/adap/flower/tree/main/examples/ios)
 - [Quickstart (MLX)](https://github.com/adap/flower/tree/main/examples/quickstart-mlx)
@@ -144,7 +143,8 @@ Other [examples](https://github.com/adap/flower/tree/main/examples):
 - [PyTorch: From Centralized to Federated](https://github.com/adap/flower/tree/main/examples/pytorch-from-centralized-to-federated)
 - [Vertical FL](https://github.com/adap/flower/tree/main/examples/vertical-fl)
 - [Federated Finetuning of OpenAI's Whisper](https://github.com/adap/flower/tree/main/examples/whisper-federated-finetuning)
-- [Comprehensive XGBoost](https://github.com/adap/flower/tree/main/examples/xgboost-comprehensive)
+- [Federated Finetuning of Large Language Model](https://github.com/adap/flower/tree/main/examples/fedllm-finetune)
+- [Federated Finetuning of a Vision Transformer](https://github.com/adap/flower/tree/main/examples/vit-finetune)
 - [Advanced Flower with TensorFlow/Keras](https://github.com/adap/flower/tree/main/examples/advanced-tensorflow)
 - [Advanced Flower with PyTorch](https://github.com/adap/flower/tree/main/examples/advanced-pytorch)
 - Single-Machine Simulation of Federated Learning Systems ([PyTorch](https://github.com/adap/flower/tree/main/examples/simulation-pytorch)) ([Tensorflow](https://github.com/adap/flower/tree/main/examples/simulation-tensorflow))

{flwr_nightly-1.8.0.dev20240305 → flwr_nightly-1.8.0.dev20240306}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "flwr-nightly"
-version = "1.8.0-dev20240305"
+version = "1.8.0-dev20240306"
 description = "Flower: A Friendly Federated Learning Framework"
 license = "Apache-2.0"
 authors = ["The Flower Authors <hello@flower.ai>"]
@@ -70,7 +70,8 @@ cryptography = "^42.0.4"
 pycryptodome = "^3.18.0"
 iterators = "^0.0.2"
 typer = { version = "^0.9.0", extras=["all"] }
-# Optional dependencies (VCE)
+tomli = "^2.0.1"
+# Optional dependencies (Simulation Engine)
 ray = { version = "==2.6.3", optional = true }
 pydantic = { version = "<2.0.0", optional = true }
 # Optional dependencies (REST transport layer)

{flwr_nightly-1.8.0.dev20240305 → flwr_nightly-1.8.0.dev20240306}/src/py/flwr/cli/app.py

@@ -18,6 +18,7 @@ import typer
 
 from .example import example
 from .new import new
+from .run import run
 
 app = typer.Typer(
     help=typer.style(
@@ -30,6 +31,7 @@ app = typer.Typer(
 
 app.command()(new)
 app.command()(example)
+app.command()(run)
 
 if __name__ == "__main__":
     app()

flwr_nightly-1.8.0.dev20240306/src/py/flwr/cli/flower_toml.py

@@ -0,0 +1,151 @@
+# 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.
+# ==============================================================================
+"""Utility to validate the `flower.toml` file."""
+
+import importlib
+import os
+from typing import Any, Dict, List, Optional, Tuple
+
+import tomli
+
+
+def load_flower_toml(path: Optional[str] = None) -> Optional[Dict[str, Any]]:
+    """Load flower.toml and return as dict."""
+    if path is None:
+        cur_dir = os.getcwd()
+        toml_path = os.path.join(cur_dir, "flower.toml")
+    else:
+        toml_path = path
+
+    if not os.path.isfile(toml_path):
+        return None
+
+    with open(toml_path, encoding="utf-8") as toml_file:
+        data = tomli.loads(toml_file.read())
+        return data
+
+
+def validate_flower_toml_fields(
+    config: Dict[str, Any]
+) -> Tuple[bool, List[str], List[str]]:
+    """Validate flower.toml fields."""
+    errors = []
+    warnings = []
+
+    if "project" not in config:
+        errors.append("Missing [project] section")
+    else:
+        if "name" not in config["project"]:
+            errors.append('Property "name" missing in [project]')
+        if "version" not in config["project"]:
+            errors.append('Property "version" missing in [project]')
+        if "description" not in config["project"]:
+            warnings.append('Recommended property "description" missing in [project]')
+        if "license" not in config["project"]:
+            warnings.append('Recommended property "license" missing in [project]')
+        if "authors" not in config["project"]:
+            warnings.append('Recommended property "authors" missing in [project]')
+
+    if "flower" not in config:
+        errors.append("Missing [flower] section")
+    elif "components" not in config["flower"]:
+        errors.append("Missing [flower.components] section")
+    else:
+        if "serverapp" not in config["flower"]["components"]:
+            errors.append('Property "serverapp" missing in [flower.components]')
+        if "clientapp" not in config["flower"]["components"]:
+            errors.append('Property "clientapp" missing in [flower.components]')
+
+    return len(errors) == 0, errors, warnings
+
+
+def validate_object_reference(ref: str) -> Tuple[bool, Optional[str]]:
+    """Validate object reference.
+
+    Returns
+    -------
+    Tuple[bool, Optional[str]]
+        A boolean indicating whether an object reference is valid and
+        the reason why it might not be.
+    """
+    module_str, _, attributes_str = ref.partition(":")
+    if not module_str:
+        return (
+            False,
+            f"Missing module in {ref}",
+        )
+    if not attributes_str:
+        return (
+            False,
+            f"Missing attribute in {ref}",
+        )
+
+    # Load module
+    try:
+        module = importlib.import_module(module_str)
+    except ModuleNotFoundError:
+        return False, f"Unable to load module {module_str}"
+
+    # Recursively load attribute
+    attribute = module
+    try:
+        for attribute_str in attributes_str.split("."):
+            attribute = getattr(attribute, attribute_str)
+    except AttributeError:
+        return (
+            False,
+            f"Unable to load attribute {attributes_str} from module {module_str}",
+        )
+
+    return (True, None)
+
+
+def validate_flower_toml(config: Dict[str, Any]) -> Tuple[bool, List[str], List[str]]:
+    """Validate flower.toml."""
+    is_valid, errors, warnings = validate_flower_toml_fields(config)
+
+    if not is_valid:
+        return False, errors, warnings
+
+    # Validate serverapp
+    is_valid, reason = validate_object_reference(
+        config["flower"]["components"]["serverapp"]
+    )
+    if not is_valid and isinstance(reason, str):
+        return False, [reason], []
+
+    # Validate clientapp
+    is_valid, reason = validate_object_reference(
+        config["flower"]["components"]["clientapp"]
+    )
+
+    if not is_valid and isinstance(reason, str):
+        return False, [reason], []
+
+    return True, [], []
+
+
+def apply_defaults(
+    config: Dict[str, Any],
+    defaults: Dict[str, Any],
+) -> Dict[str, Any]:
+    """Apply defaults to config."""
+    for key in defaults:
+        if key in config:
+            if isinstance(config[key], dict) and isinstance(defaults[key], dict):
+                apply_defaults(config[key], defaults[key])
+        else:
+            config[key] = defaults[key]
+    return config

flwr_nightly-1.8.0.dev20240306/src/py/flwr/cli/run/__init__.py

@@ -0,0 +1,21 @@
+# 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.
+# ==============================================================================
+"""Flower command line interface `run` command."""
+
+from .run import run as run
+
+__all__ = [
+    "run",
+]

flwr_nightly-1.8.0.dev20240306/src/py/flwr/cli/run/run.py

@@ -0,0 +1,102 @@
+# 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.
+# ==============================================================================
+"""Flower command line interface `run` command."""
+
+import sys
+
+import typer
+
+from flwr.cli.flower_toml import apply_defaults, load_flower_toml, validate_flower_toml
+from flwr.simulation.run_simulation import _run_simulation
+
+
+def run() -> None:
+    """Run Flower project."""
+    print(
+        typer.style("Loading project configuration... ", fg=typer.colors.BLUE),
+        end="",
+    )
+    config = load_flower_toml()
+    if not config:
+        print(
+            typer.style(
+                "Project configuration could not be loaded. "
+                "flower.toml does not exist.",
+                fg=typer.colors.RED,
+                bold=True,
+            )
+        )
+        sys.exit()
+    print(typer.style("Success", fg=typer.colors.GREEN))
+
+    print(
+        typer.style("Validating project configuration... ", fg=typer.colors.BLUE),
+        end="",
+    )
+    is_valid, errors, warnings = validate_flower_toml(config)
+    if warnings:
+        print(
+            typer.style(
+                "Project configuration is missing the following "
+                "recommended properties:\n"
+                + "\n".join([f"- {line}" for line in warnings]),
+                fg=typer.colors.RED,
+                bold=True,
+            )
+        )
+
+    if not is_valid:
+        print(
+            typer.style(
+                "Project configuration could not be loaded.\nflower.toml is invalid:\n"
+                + "\n".join([f"- {line}" for line in errors]),
+                fg=typer.colors.RED,
+                bold=True,
+            )
+        )
+        sys.exit()
+    print(typer.style("Success", fg=typer.colors.GREEN))
+
+    # Apply defaults
+    defaults = {
+        "flower": {
+            "engine": {"name": "simulation", "simulation": {"super-node": {"num": 100}}}
+        }
+    }
+    config = apply_defaults(config, defaults)
+
+    server_app_ref = config["flower"]["components"]["serverapp"]
+    client_app_ref = config["flower"]["components"]["clientapp"]
+    engine = config["flower"]["engine"]["name"]
+
+    if engine == "simulation":
+        num_supernodes = config["flower"]["engine"]["simulation"]["super-node"]["num"]
+
+        print(
+            typer.style("Starting run... ", fg=typer.colors.BLUE),
+        )
+        _run_simulation(
+            server_app_attr=server_app_ref,
+            client_app_attr=client_app_ref,
+            num_supernodes=num_supernodes,
+        )
+    else:
+        print(
+            typer.style(
+                f"Engine '{engine}' is not yet supported in `flwr run`",
+                fg=typer.colors.RED,
+                bold=True,
+            )
+        )

{flwr_nightly-1.8.0.dev20240305 → flwr_nightly-1.8.0.dev20240306}/src/py/flwr/client/grpc_client/connection.py

@@ -31,12 +31,7 @@ from flwr.common import (
 )
 from flwr.common import recordset_compat as compat
 from flwr.common import serde
-from flwr.common.constant import (
-    MESSAGE_TYPE_EVALUATE,
-    MESSAGE_TYPE_FIT,
-    MESSAGE_TYPE_GET_PARAMETERS,
-    MESSAGE_TYPE_GET_PROPERTIES,
-)
+from flwr.common.constant import MessageType, MessageTypeLegacy
 from flwr.common.grpc import create_channel
 from flwr.common.logger import log
 from flwr.common.retry_invoker import RetryInvoker
@@ -148,22 +143,22 @@ def grpc_connection(  # pylint: disable=R0915
             recordset = compat.getpropertiesins_to_recordset(
                 serde.get_properties_ins_from_proto(proto.get_properties_ins)
             )
-            message_type = MESSAGE_TYPE_GET_PROPERTIES
+            message_type = MessageTypeLegacy.GET_PROPERTIES
         elif field == "get_parameters_ins":
             recordset = compat.getparametersins_to_recordset(
                 serde.get_parameters_ins_from_proto(proto.get_parameters_ins)
             )
-            message_type = MESSAGE_TYPE_GET_PARAMETERS
+            message_type = MessageTypeLegacy.GET_PARAMETERS
         elif field == "fit_ins":
             recordset = compat.fitins_to_recordset(
                 serde.fit_ins_from_proto(proto.fit_ins), False
             )
-            message_type = MESSAGE_TYPE_FIT
+            message_type = MessageType.TRAIN
         elif field == "evaluate_ins":
             recordset = compat.evaluateins_to_recordset(
                 serde.evaluate_ins_from_proto(proto.evaluate_ins), False
             )
-            message_type = MESSAGE_TYPE_EVALUATE
+            message_type = MessageType.EVALUATE
         elif field == "reconnect_ins":
             recordset = RecordSet()
             recordset.configs_records["config"] = ConfigsRecord(
@@ -197,20 +192,20 @@ def grpc_connection(  # pylint: disable=R0915
         message_type = message.metadata.message_type
 
         # RecordSet --> *Res --> *Res proto -> ClientMessage proto
-        if message_type == MESSAGE_TYPE_GET_PROPERTIES:
+        if message_type == MessageTypeLegacy.GET_PROPERTIES:
             getpropres = compat.recordset_to_getpropertiesres(recordset)
             msg_proto = ClientMessage(
                 get_properties_res=serde.get_properties_res_to_proto(getpropres)
             )
-        elif message_type == MESSAGE_TYPE_GET_PARAMETERS:
+        elif message_type == MessageTypeLegacy.GET_PARAMETERS:
             getparamres = compat.recordset_to_getparametersres(recordset, False)
             msg_proto = ClientMessage(
                 get_parameters_res=serde.get_parameters_res_to_proto(getparamres)
             )
-        elif message_type == MESSAGE_TYPE_FIT:
+        elif message_type == MessageType.TRAIN:
             fitres = compat.recordset_to_fitres(recordset, False)
             msg_proto = ClientMessage(fit_res=serde.fit_res_to_proto(fitres))
-        elif message_type == MESSAGE_TYPE_EVALUATE:
+        elif message_type == MessageType.EVALUATE:
             evalres = compat.recordset_to_evaluateres(recordset)
             msg_proto = ClientMessage(evaluate_res=serde.evaluate_res_to_proto(evalres))
         elif message_type == "reconnect":

{flwr_nightly-1.8.0.dev20240305 → flwr_nightly-1.8.0.dev20240306}/src/py/flwr/client/message_handler/message_handler.py

@@ -27,12 +27,7 @@ from flwr.client.client import (
 from flwr.client.numpy_client import NumPyClient
 from flwr.client.typing import ClientFn
 from flwr.common import ConfigsRecord, Context, Message, Metadata, RecordSet, log
-from flwr.common.constant import (
-    MESSAGE_TYPE_EVALUATE,
-    MESSAGE_TYPE_FIT,
-    MESSAGE_TYPE_GET_PARAMETERS,
-    MESSAGE_TYPE_GET_PROPERTIES,
-)
+from flwr.common.constant import MessageType, MessageTypeLegacy
 from flwr.common.recordset_compat import (
     evaluateres_to_recordset,
     fitres_to_recordset,
@@ -115,14 +110,14 @@ def handle_legacy_message_from_msgtype(
     message_type = message.metadata.message_type
 
     # Handle GetPropertiesIns
-    if message_type == MESSAGE_TYPE_GET_PROPERTIES:
+    if message_type == MessageTypeLegacy.GET_PROPERTIES:
         get_properties_res = maybe_call_get_properties(
             client=client,
             get_properties_ins=recordset_to_getpropertiesins(message.content),
         )
         out_recordset = getpropertiesres_to_recordset(get_properties_res)
     # Handle GetParametersIns
-    elif message_type == MESSAGE_TYPE_GET_PARAMETERS:
+    elif message_type == MessageTypeLegacy.GET_PARAMETERS:
         get_parameters_res = maybe_call_get_parameters(
             client=client,
             get_parameters_ins=recordset_to_getparametersins(message.content),
@@ -131,14 +126,14 @@ def handle_legacy_message_from_msgtype(
             get_parameters_res, keep_input=False
         )
     # Handle FitIns
-    elif message_type == MESSAGE_TYPE_FIT:
+    elif message_type == MessageType.TRAIN:
         fit_res = maybe_call_fit(
             client=client,
             fit_ins=recordset_to_fitins(message.content, keep_input=True),
         )
         out_recordset = fitres_to_recordset(fit_res, keep_input=False)
     # Handle EvaluateIns
-    elif message_type == MESSAGE_TYPE_EVALUATE:
+    elif message_type == MessageType.EVALUATE:
         evaluate_res = maybe_call_evaluate(
             client=client,
             evaluate_ins=recordset_to_evaluateins(message.content, keep_input=True),

{flwr_nightly-1.8.0.dev20240305 → flwr_nightly-1.8.0.dev20240306}/src/py/flwr/client/mod/centraldp_mods.py

@@ -18,7 +18,7 @@
 from flwr.client.typing import ClientAppCallable
 from flwr.common import ndarrays_to_parameters, parameters_to_ndarrays
 from flwr.common import recordset_compat as compat
-from flwr.common.constant import MESSAGE_TYPE_FIT
+from flwr.common.constant import MessageType
 from flwr.common.context import Context
 from flwr.common.differential_privacy import (
     compute_adaptive_clip_model_update,
@@ -40,7 +40,7 @@ def fixedclipping_mod(
 
     This mod clips the client model updates before sending them to the server.
 
-    It operates on messages with type MESSAGE_TYPE_FIT.
+    It operates on messages with type MessageType.TRAIN.
 
     Notes
     -----
@@ -48,7 +48,7 @@ def fixedclipping_mod(
 
     Typically, fixedclipping_mod should be the last to operate on params.
     """
-    if msg.metadata.message_type != MESSAGE_TYPE_FIT:
+    if msg.metadata.message_type != MessageType.TRAIN:
         return call_next(msg, ctxt)
     fit_ins = compat.recordset_to_fitins(msg.content, keep_input=True)
     if KEY_CLIPPING_NORM not in fit_ins.config:
@@ -93,7 +93,7 @@ def adaptiveclipping_mod(
 
     It also sends KEY_NORM_BIT to the server for computing the new clipping value.
 
-    It operates on messages with type MESSAGE_TYPE_FIT.
+    It operates on messages with type MessageType.TRAIN.
 
     Notes
     -----
@@ -101,7 +101,7 @@ def adaptiveclipping_mod(
 
     Typically, adaptiveclipping_mod should be the last to operate on params.
     """
-    if msg.metadata.message_type != MESSAGE_TYPE_FIT:
+    if msg.metadata.message_type != MessageType.TRAIN:
         return call_next(msg, ctxt)
 
     fit_ins = compat.recordset_to_fitins(msg.content, keep_input=True)

{flwr_nightly-1.8.0.dev20240305 → flwr_nightly-1.8.0.dev20240306}/src/py/flwr/client/mod/secure_aggregation/secaggplus_mod.py

@@ -30,7 +30,7 @@ from flwr.common import (
     parameters_to_ndarrays,
 )
 from flwr.common import recordset_compat as compat
-from flwr.common.constant import MESSAGE_TYPE_FIT
+from flwr.common.constant import MessageType
 from flwr.common.logger import log
 from flwr.common.secure_aggregation.crypto.shamir import create_shares
 from flwr.common.secure_aggregation.crypto.symmetric_encryption import (
@@ -150,7 +150,7 @@ def secaggplus_mod(
 ) -> Message:
     """Handle incoming message and return results, following the SecAgg+ protocol."""
     # Ignore non-fit messages
-    if msg.metadata.message_type != MESSAGE_TYPE_FIT:
+    if msg.metadata.message_type != MessageType.TRAIN:
         return call_next(msg, ctxt)
 
     # Retrieve local state

{flwr_nightly-1.8.0.dev20240305 → flwr_nightly-1.8.0.dev20240306}/src/py/flwr/common/__init__.py

@@ -16,6 +16,7 @@
 
 
 from .constant import MessageType as MessageType
+from .constant import MessageTypeLegacy as MessageTypeLegacy
 from .context import Context as Context
 from .date import now as now
 from .grpc import GRPC_MAX_MESSAGE_LENGTH
@@ -85,6 +86,7 @@ __all__ = [
     "log",
     "Message",
     "MessageType",
+    "MessageTypeLegacy",
     "Metadata",
     "Metrics",
     "MetricsAggregationFn",

{flwr_nightly-1.8.0.dev20240305 → flwr_nightly-1.8.0.dev20240306}/src/py/flwr/common/constant.py

@@ -36,11 +36,6 @@ TRANSPORT_TYPES = [
     TRANSPORT_TYPE_VCE,
 ]
 
-MESSAGE_TYPE_GET_PROPERTIES = "get_properties"
-MESSAGE_TYPE_GET_PARAMETERS = "get_parameters"
-MESSAGE_TYPE_FIT = "fit"
-MESSAGE_TYPE_EVALUATE = "evaluate"
-
 
 class MessageType:
     """Message type."""
@@ -53,6 +48,17 @@ class MessageType:
         raise TypeError(f"{cls.__name__} cannot be instantiated.")
 
 
+class MessageTypeLegacy:
+    """Legacy message type."""
+
+    GET_PROPERTIES = "get_properties"
+    GET_PARAMETERS = "get_parameters"
+
+    def __new__(cls) -> MessageTypeLegacy:
+        """Prevent instantiation."""
+        raise TypeError(f"{cls.__name__} cannot be instantiated.")
+
+
 class SType:
     """Serialisation type."""
 

{flwr_nightly-1.8.0.dev20240305 → flwr_nightly-1.8.0.dev20240306}/src/py/flwr/server/compat/driver_client_proxy.py

@@ -19,15 +19,9 @@ import time
 from typing import List, Optional
 
 from flwr import common
-from flwr.common import RecordSet
+from flwr.common import MessageType, MessageTypeLegacy, RecordSet
 from flwr.common import recordset_compat as compat
 from flwr.common import serde
-from flwr.common.constant import (
-    MESSAGE_TYPE_EVALUATE,
-    MESSAGE_TYPE_FIT,
-    MESSAGE_TYPE_GET_PARAMETERS,
-    MESSAGE_TYPE_GET_PROPERTIES,
-)
 from flwr.proto import driver_pb2, node_pb2, task_pb2  # pylint: disable=E0611
 from flwr.server.client_proxy import ClientProxy
 
@@ -57,7 +51,7 @@ class DriverClientProxy(ClientProxy):
         out_recordset = compat.getpropertiesins_to_recordset(ins)
         # Fetch response
         in_recordset = self._send_receive_recordset(
-            out_recordset, MESSAGE_TYPE_GET_PROPERTIES, timeout, group_id
+            out_recordset, MessageTypeLegacy.GET_PROPERTIES, timeout, group_id
         )
         # RecordSet to Res
         return compat.recordset_to_getpropertiesres(in_recordset)
@@ -73,7 +67,7 @@ class DriverClientProxy(ClientProxy):
         out_recordset = compat.getparametersins_to_recordset(ins)
         # Fetch response
         in_recordset = self._send_receive_recordset(
-            out_recordset, MESSAGE_TYPE_GET_PARAMETERS, timeout, group_id
+            out_recordset, MessageTypeLegacy.GET_PARAMETERS, timeout, group_id
         )
         # RecordSet to Res
         return compat.recordset_to_getparametersres(in_recordset, False)
@@ -86,7 +80,7 @@ class DriverClientProxy(ClientProxy):
         out_recordset = compat.fitins_to_recordset(ins, keep_input=True)
         # Fetch response
         in_recordset = self._send_receive_recordset(
-            out_recordset, MESSAGE_TYPE_FIT, timeout, group_id
+            out_recordset, MessageType.TRAIN, timeout, group_id
         )
         # RecordSet to Res
         return compat.recordset_to_fitres(in_recordset, keep_input=False)
@@ -99,7 +93,7 @@ class DriverClientProxy(ClientProxy):
         out_recordset = compat.evaluateins_to_recordset(ins, keep_input=True)
         # Fetch response
         in_recordset = self._send_receive_recordset(
-            out_recordset, MESSAGE_TYPE_EVALUATE, timeout, group_id
+            out_recordset, MessageType.EVALUATE, timeout, group_id
         )
         # RecordSet to Res
         return compat.recordset_to_evaluateres(in_recordset)