flwr-nightly 1.9.0.dev20240409__tar.gz → 1.9.0.dev20240412__tar.gz

{flwr_nightly-1.9.0.dev20240409 → flwr_nightly-1.9.0.dev20240412}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flwr-nightly
-Version: 1.9.0.dev20240409
+Version: 1.9.0.dev20240412
 Summary: Flower: A Friendly Federated Learning Framework
 Home-page: https://flower.ai
 License: Apache-2.0

{flwr_nightly-1.9.0.dev20240409 → flwr_nightly-1.9.0.dev20240412}/pyproject.toml

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

{flwr_nightly-1.9.0.dev20240409 → flwr_nightly-1.9.0.dev20240412}/src/py/flwr/cli/new/new.py

@@ -22,7 +22,12 @@ from typing import Dict, Optional
 import typer
 from typing_extensions import Annotated
 
-from ..utils import prompt_options, prompt_text
+from ..utils import (
+    is_valid_project_name,
+    prompt_options,
+    prompt_text,
+    sanitize_project_name,
+)
 
 
 class MlFramework(str, Enum):
@@ -81,6 +86,16 @@ def new(
     ] = None,
 ) -> None:
     """Create new Flower project."""
+    if project_name is None:
+        project_name = prompt_text("Please provide project name")
+    if not is_valid_project_name(project_name):
+        project_name = prompt_text(
+            "Please provide a name that only contains "
+            "characters in {'_', 'a-zA-Z', '0-9'}",
+            predicate=is_valid_project_name,
+            default=sanitize_project_name(project_name),
+        )
+
     print(
         typer.style(
             f"🔨 Creating Flower project {project_name}...",
@@ -89,9 +104,6 @@ def new(
         )
     )
 
-    if project_name is None:
-        project_name = prompt_text("Please provide project name")
-
     if framework is not None:
         framework_str = str(framework.value)
     else:
@@ -116,7 +128,6 @@ def new(
     # List of files to render
     files = {
         "README.md": {"template": "app/README.md.tpl"},
-        "requirements.txt": {"template": f"app/requirements.{framework_str}.txt.tpl"},
         "flower.toml": {"template": "app/flower.toml.tpl"},
         "pyproject.toml": {"template": f"app/pyproject.{framework_str}.toml.tpl"},
         f"{pnl}/__init__.py": {"template": "app/code/__init__.py.tpl"},

{flwr_nightly-1.9.0.dev20240409 → flwr_nightly-1.9.0.dev20240412}/src/py/flwr/cli/new/templates/app/README.md.tpl

@@ -3,11 +3,7 @@
 ## Install dependencies
 
 ```bash
-# Using pip
 pip install .
-
-# Or using Poetry
-poetry install
 ```
 
 ## Run (Simulation Engine)

flwr_nightly-1.9.0.dev20240412/src/py/flwr/cli/new/templates/app/pyproject.numpy.toml.tpl

@@ -0,0 +1,19 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "$project_name"
+version = "1.0.0"
+description = ""
+authors = [
+    { name = "The Flower Authors", email = "hello@flower.ai" },
+]
+license = {text = "Apache License (2.0)"}
+dependencies = [
+    "flwr[simulation]>=1.8.0,<2.0",
+    "numpy>=1.21.0",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["."]

flwr_nightly-1.9.0.dev20240412/src/py/flwr/cli/new/templates/app/pyproject.pytorch.toml.tpl

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "$project_name"
+version = "1.0.0"
+description = ""
+authors = [
+    { name = "The Flower Authors", email = "hello@flower.ai" },
+]
+license = {text = "Apache License (2.0)"}
+dependencies = [
+    "flwr[simulation]>=1.8.0,<2.0",
+    "flwr-datasets[vision]>=0.0.2,<1.0.0",
+    "torch==2.2.1",
+    "torchvision==0.17.1",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["."]

flwr_nightly-1.9.0.dev20240412/src/py/flwr/cli/new/templates/app/pyproject.tensorflow.toml.tpl

@@ -0,0 +1,20 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "$project_name"
+version = "1.0.0"
+description = ""
+authors = [
+    { name = "The Flower Authors", email = "hello@flower.ai" },
+]
+license = {text = "Apache License (2.0)"}
+dependencies = [
+    "flwr[simulation]>=1.8.0,<2.0",
+    "flwr-datasets[vision]>=0.0.2,<1.0.0",
+    "tensorflow>=2.11.1",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["."]

{flwr_nightly-1.9.0.dev20240409 → flwr_nightly-1.9.0.dev20240412}/src/py/flwr/cli/utils.py

@@ -14,18 +14,23 @@
 # ==============================================================================
 """Flower command line interface utils."""
 
-from typing import List, cast
+from typing import Callable, List, Optional, cast
 
 import typer
 
 
-def prompt_text(text: str) -> str:
+def prompt_text(
+    text: str,
+    predicate: Callable[[str], bool] = lambda _: True,
+    default: Optional[str] = None,
+) -> str:
     """Ask user to enter text input."""
     while True:
         result = typer.prompt(
-            typer.style(f"\n💬 {text}", fg=typer.colors.MAGENTA, bold=True)
+            typer.style(f"\n💬 {text}", fg=typer.colors.MAGENTA, bold=True),
+            default=default,
         )
-        if len(result) > 0:
+        if predicate(result) and len(result) > 0:
             break
         print(typer.style("❌ Invalid entry", fg=typer.colors.RED, bold=True))
 
@@ -65,3 +70,54 @@ def prompt_options(text: str, options: List[str]) -> str:
 
     result = options[int(index)]
     return result
+
+
+def is_valid_project_name(name: str) -> bool:
+    """Check if the given string is a valid Python module name.
+
+    A valid module name must start with a letter or an underscore, and can only contain
+    letters, digits, and underscores.
+    """
+    if not name:
+        return False
+
+    # Check if the first character is a letter or underscore
+    if not (name[0].isalpha() or name[0] == "_"):
+        return False
+
+    # Check if the rest of the characters are valid (letter, digit, or underscore)
+    for char in name[1:]:
+        if not (char.isalnum() or char == "_"):
+            return False
+
+    return True
+
+
+def sanitize_project_name(name: str) -> str:
+    """Sanitize the given string to make it a valid Python module name.
+
+    This version replaces hyphens with underscores, removes any characters not allowed
+    in Python module names, makes the string lowercase, and ensures it starts with a
+    valid character.
+    """
+    # Replace '-' with '_'
+    name_with_underscores = name.replace("-", "_").replace(" ", "_")
+
+    # Allowed characters in a module name: letters, digits, underscore
+    allowed_chars = set(
+        "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_"
+    )
+
+    # Make the string lowercase
+    sanitized_name = name_with_underscores.lower()
+
+    # Remove any characters not allowed in Python module names
+    sanitized_name = "".join(c for c in sanitized_name if c in allowed_chars)
+
+    # Ensure the first character is a letter or underscore
+    if sanitized_name and (
+        sanitized_name[0].isdigit() or sanitized_name[0] not in allowed_chars
+    ):
+        sanitized_name = "_" + sanitized_name
+
+    return sanitized_name

{flwr_nightly-1.9.0.dev20240409 → flwr_nightly-1.9.0.dev20240412}/src/py/flwr/client/heartbeat.py

@@ -66,7 +66,9 @@ def start_ping_loop(
     asynchronous ping operations. The loop can be terminated through the provided stop
     event.
     """
-    thread = threading.Thread(target=_ping_loop, args=(ping_fn, stop_event))
+    thread = threading.Thread(
+        target=_ping_loop, args=(ping_fn, stop_event), daemon=True
+    )
     thread.start()
 
     return thread

flwr_nightly-1.9.0.dev20240412/src/py/flwr/proto/driver_pb2.py

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: flwr/proto/driver.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 task_pb2 as flwr_dot_proto_dot_task__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x17\x66lwr/proto/driver.proto\x12\nflwr.proto\x1a\x15\x66lwr/proto/node.proto\x1a\x15\x66lwr/proto/task.proto\"7\n\x10\x43reateRunRequest\x12\x0e\n\x06\x66\x61\x62_id\x18\x01 \x01(\t\x12\x13\n\x0b\x66\x61\x62_version\x18\x02 \x01(\t\"#\n\x11\x43reateRunResponse\x12\x0e\n\x06run_id\x18\x01 \x01(\x12\"!\n\x0fGetNodesRequest\x12\x0e\n\x06run_id\x18\x01 \x01(\x12\"3\n\x10GetNodesResponse\x12\x1f\n\x05nodes\x18\x01 \x03(\x0b\x32\x10.flwr.proto.Node\"@\n\x12PushTaskInsRequest\x12*\n\rtask_ins_list\x18\x01 \x03(\x0b\x32\x13.flwr.proto.TaskIns\"\'\n\x13PushTaskInsResponse\x12\x10\n\x08task_ids\x18\x02 \x03(\t\"F\n\x12PullTaskResRequest\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\x12\x10\n\x08task_ids\x18\x02 \x03(\t\"A\n\x13PullTaskResResponse\x12*\n\rtask_res_list\x18\x01 \x03(\x0b\x32\x13.flwr.proto.TaskRes2\xc1\x02\n\x06\x44river\x12J\n\tCreateRun\x12\x1c.flwr.proto.CreateRunRequest\x1a\x1d.flwr.proto.CreateRunResponse\"\x00\x12G\n\x08GetNodes\x12\x1b.flwr.proto.GetNodesRequest\x1a\x1c.flwr.proto.GetNodesResponse\"\x00\x12P\n\x0bPushTaskIns\x12\x1e.flwr.proto.PushTaskInsRequest\x1a\x1f.flwr.proto.PushTaskInsResponse\"\x00\x12P\n\x0bPullTaskRes\x12\x1e.flwr.proto.PullTaskResRequest\x1a\x1f.flwr.proto.PullTaskResResponse\"\x00\x62\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'flwr.proto.driver_pb2', _globals)
+if _descriptor._USE_C_DESCRIPTORS == False:
+  DESCRIPTOR._options = None
+  _globals['_CREATERUNREQUEST']._serialized_start=85
+  _globals['_CREATERUNREQUEST']._serialized_end=140
+  _globals['_CREATERUNRESPONSE']._serialized_start=142
+  _globals['_CREATERUNRESPONSE']._serialized_end=177
+  _globals['_GETNODESREQUEST']._serialized_start=179
+  _globals['_GETNODESREQUEST']._serialized_end=212
+  _globals['_GETNODESRESPONSE']._serialized_start=214
+  _globals['_GETNODESRESPONSE']._serialized_end=265
+  _globals['_PUSHTASKINSREQUEST']._serialized_start=267
+  _globals['_PUSHTASKINSREQUEST']._serialized_end=331
+  _globals['_PUSHTASKINSRESPONSE']._serialized_start=333
+  _globals['_PUSHTASKINSRESPONSE']._serialized_end=372
+  _globals['_PULLTASKRESREQUEST']._serialized_start=374
+  _globals['_PULLTASKRESREQUEST']._serialized_end=444
+  _globals['_PULLTASKRESRESPONSE']._serialized_start=446
+  _globals['_PULLTASKRESRESPONSE']._serialized_end=511
+  _globals['_DRIVER']._serialized_start=514
+  _globals['_DRIVER']._serialized_end=835
+# @@protoc_insertion_point(module_scope)

{flwr_nightly-1.9.0.dev20240409 → flwr_nightly-1.9.0.dev20240412}/src/py/flwr/proto/driver_pb2.pyi

@@ -16,8 +16,16 @@ DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
 class CreateRunRequest(google.protobuf.message.Message):
     """CreateRun"""
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    FAB_ID_FIELD_NUMBER: builtins.int
+    FAB_VERSION_FIELD_NUMBER: builtins.int
+    fab_id: typing.Text
+    fab_version: typing.Text
     def __init__(self,
+        *,
+        fab_id: typing.Text = ...,
+        fab_version: typing.Text = ...,
         ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["fab_id",b"fab_id","fab_version",b"fab_version"]) -> None: ...
 global___CreateRunRequest = CreateRunRequest
 
 class CreateRunResponse(google.protobuf.message.Message):

{flwr_nightly-1.9.0.dev20240409 → flwr_nightly-1.9.0.dev20240412}/src/py/flwr/server/compat/app_utils.py

@@ -16,7 +16,6 @@
 
 
 import threading
-import time
 from typing import Dict, Tuple
 
 from ..client_manager import ClientManager
@@ -60,6 +59,7 @@ def start_update_client_manager_thread(
             client_manager,
             f_stop,
         ),
+        daemon=True,
     )
     thread.start()
 
@@ -99,4 +99,5 @@ def _update_client_manager(
                 raise RuntimeError("Could not register node.")
 
         # Sleep for 3 seconds
-        time.sleep(3)
+        if not f_stop.is_set():
+            f_stop.wait(3)

flwr_nightly-1.9.0.dev20240409/src/py/flwr/cli/new/templates/app/pyproject.numpy.toml.tpl

@@ -1,19 +0,0 @@
-[build-system]
-requires = ["poetry-core>=1.4.0"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.poetry]
-name = "$project_name"
-version = "1.0.0"
-description = ""
-license = "Apache-2.0"
-authors = [
-    "The Flower Authors <hello@flower.ai>",
-]
-readme = "README.md"
-
-[tool.poetry.dependencies]
-python = "^3.9"
-# Mandatory dependencies
-numpy = "^1.21.0"
-flwr = { version = "^1.8.0", extras = ["simulation"] }

flwr_nightly-1.9.0.dev20240409/src/py/flwr/cli/new/templates/app/pyproject.pytorch.toml.tpl

@@ -1,21 +0,0 @@
-[build-system]
-requires = ["poetry-core>=1.4.0"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.poetry]
-name = "$project_name"
-version = "1.0.0"
-description = ""
-license = "Apache-2.0"
-authors = [
-    "The Flower Authors <hello@flower.ai>",
-]
-readme = "README.md"
-
-[tool.poetry.dependencies]
-python = "^3.9"
-# Mandatory dependencies
-flwr = { version = "^1.8.0", extras = ["simulation"] }
-flwr-datasets = { version = "0.0.2", extras = ["vision"] }
-torch = "2.2.1"
-torchvision = "0.17.1"

flwr_nightly-1.9.0.dev20240409/src/py/flwr/cli/new/templates/app/pyproject.tensorflow.toml.tpl

@@ -1,21 +0,0 @@
-[build-system]
-requires = ["poetry-core>=1.4.0"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.poetry]
-name = "$project_name"
-version = "1.0.0"
-description = ""
-license = "Apache-2.0"
-authors = [
-    "The Flower Authors <hello@flower.ai>",
-]
-readme = "README.md"
-
-[tool.poetry.dependencies]
-python = ">=3.9,<3.11"
-# Mandatory dependencies
-flwr = { version = "^1.8.0", extras = ["simulation"] }
-flwr-datasets = { version = "^0.0.2", extras = ["vision"] }
-tensorflow-cpu = { version = ">=2.9.1,<2.11.1 || >2.11.1", markers = "platform_machine == \"x86_64\"" }
-tensorflow-macos = { version = ">=2.9.1,<2.11.1 || >2.11.1", markers = "sys_platform == \"darwin\" and platform_machine == \"arm64\"" }

flwr_nightly-1.9.0.dev20240409/src/py/flwr/cli/new/templates/app/requirements.numpy.txt.tpl

@@ -1,2 +0,0 @@
-flwr>=1.8, <2.0
-numpy>=1.21.0

flwr_nightly-1.9.0.dev20240409/src/py/flwr/cli/new/templates/app/requirements.pytorch.txt.tpl

@@ -1,4 +0,0 @@
-flwr[simulation]>=1.8.0
-flwr-datasets[vision]==0.0.2
-torch==2.2.1
-torchvision==0.17.1

flwr_nightly-1.9.0.dev20240409/src/py/flwr/cli/new/templates/app/requirements.tensorflow.txt.tpl

@@ -1,4 +0,0 @@
-flwr>=1.8, <2.0
-flwr-datasets[vision]>=0.0.2, <1.0.0
-tensorflow-macos>=2.9.1, !=2.11.1 ; sys_platform == "darwin" and platform_machine == "arm64"
-tensorflow-cpu>=2.9.1, !=2.11.1 ; platform_machine == "x86_64"

flwr_nightly-1.9.0.dev20240409/src/py/flwr/proto/driver_pb2.py

@@ -1,44 +0,0 @@
-# -*- coding: utf-8 -*-
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: flwr/proto/driver.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 task_pb2 as flwr_dot_proto_dot_task__pb2
-
-
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x17\x66lwr/proto/driver.proto\x12\nflwr.proto\x1a\x15\x66lwr/proto/node.proto\x1a\x15\x66lwr/proto/task.proto\"\x12\n\x10\x43reateRunRequest\"#\n\x11\x43reateRunResponse\x12\x0e\n\x06run_id\x18\x01 \x01(\x12\"!\n\x0fGetNodesRequest\x12\x0e\n\x06run_id\x18\x01 \x01(\x12\"3\n\x10GetNodesResponse\x12\x1f\n\x05nodes\x18\x01 \x03(\x0b\x32\x10.flwr.proto.Node\"@\n\x12PushTaskInsRequest\x12*\n\rtask_ins_list\x18\x01 \x03(\x0b\x32\x13.flwr.proto.TaskIns\"\'\n\x13PushTaskInsResponse\x12\x10\n\x08task_ids\x18\x02 \x03(\t\"F\n\x12PullTaskResRequest\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\x12\x10\n\x08task_ids\x18\x02 \x03(\t\"A\n\x13PullTaskResResponse\x12*\n\rtask_res_list\x18\x01 \x03(\x0b\x32\x13.flwr.proto.TaskRes2\xc1\x02\n\x06\x44river\x12J\n\tCreateRun\x12\x1c.flwr.proto.CreateRunRequest\x1a\x1d.flwr.proto.CreateRunResponse\"\x00\x12G\n\x08GetNodes\x12\x1b.flwr.proto.GetNodesRequest\x1a\x1c.flwr.proto.GetNodesResponse\"\x00\x12P\n\x0bPushTaskIns\x12\x1e.flwr.proto.PushTaskInsRequest\x1a\x1f.flwr.proto.PushTaskInsResponse\"\x00\x12P\n\x0bPullTaskRes\x12\x1e.flwr.proto.PullTaskResRequest\x1a\x1f.flwr.proto.PullTaskResResponse\"\x00\x62\x06proto3')
-
-_globals = globals()
-_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
-_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'flwr.proto.driver_pb2', _globals)
-if _descriptor._USE_C_DESCRIPTORS == False:
-  DESCRIPTOR._options = None
-  _globals['_CREATERUNREQUEST']._serialized_start=85
-  _globals['_CREATERUNREQUEST']._serialized_end=103
-  _globals['_CREATERUNRESPONSE']._serialized_start=105
-  _globals['_CREATERUNRESPONSE']._serialized_end=140
-  _globals['_GETNODESREQUEST']._serialized_start=142
-  _globals['_GETNODESREQUEST']._serialized_end=175
-  _globals['_GETNODESRESPONSE']._serialized_start=177
-  _globals['_GETNODESRESPONSE']._serialized_end=228
-  _globals['_PUSHTASKINSREQUEST']._serialized_start=230
-  _globals['_PUSHTASKINSREQUEST']._serialized_end=294
-  _globals['_PUSHTASKINSRESPONSE']._serialized_start=296
-  _globals['_PUSHTASKINSRESPONSE']._serialized_end=335
-  _globals['_PULLTASKRESREQUEST']._serialized_start=337
-  _globals['_PULLTASKRESREQUEST']._serialized_end=407
-  _globals['_PULLTASKRESRESPONSE']._serialized_start=409
-  _globals['_PULLTASKRESRESPONSE']._serialized_end=474
-  _globals['_DRIVER']._serialized_start=477
-  _globals['_DRIVER']._serialized_end=798
-# @@protoc_insertion_point(module_scope)