flwr-nightly 1.13.0.dev20241111__tar.gz → 1.14.0.dev20241126__tar.gz

{flwr_nightly-1.13.0.dev20241111 → flwr_nightly-1.14.0.dev20241126}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: flwr-nightly
-Version: 1.13.0.dev20241111
-Summary: Flower: A Friendly Federated Learning Framework
+Version: 1.14.0.dev20241126
+Summary: Flower: A Friendly Federated AI Framework
 Home-page: https://flower.ai
 License: Apache-2.0
 Keywords: Artificial Intelligence,Federated AI,Federated Analytics,Federated Evaluation,Federated Learning,Flower,Machine Learning
@@ -41,6 +41,7 @@ Requires-Dist: protobuf (>=4.25.2,<5.0.0)
 Requires-Dist: pycryptodome (>=3.18.0,<4.0.0)
 Requires-Dist: ray (==2.10.0) ; (python_version >= "3.9" and python_version < "3.12") and (extra == "simulation")
 Requires-Dist: requests (>=2.31.0,<3.0.0) ; extra == "rest"
+Requires-Dist: rich (>=13.5.0,<14.0.0)
 Requires-Dist: starlette (>=0.31.0,<0.32.0) ; extra == "rest"
 Requires-Dist: tomli (>=2.0.1,<3.0.0)
 Requires-Dist: tomli-w (>=1.0.0,<2.0.0)
@@ -50,7 +51,7 @@ Project-URL: Documentation, https://flower.ai
 Project-URL: Repository, https://github.com/adap/flower
 Description-Content-Type: text/markdown
 
-# Flower: A Friendly Federated Learning Framework
+# Flower: A Friendly Federated AI Framework
 
 <p align="center">
   <a href="https://flower.ai/">
@@ -73,7 +74,7 @@ Description-Content-Type: text/markdown
 [![Docker Hub](https://img.shields.io/badge/Docker%20Hub-flwr-blue)](https://hub.docker.com/u/flwr)
 [![Slack](https://img.shields.io/badge/Chat-Slack-red)](https://flower.ai/join-slack)
 
-Flower (`flwr`) is a framework for building federated learning systems. The
+Flower (`flwr`) is a framework for building federated AI systems. The
 design of Flower is based on a few guiding principles:
 
 - **Customizable**: Federated learning systems vary wildly from one use case to

{flwr_nightly-1.13.0.dev20241111 → flwr_nightly-1.14.0.dev20241126}/README.md

@@ -1,4 +1,4 @@
-# Flower: A Friendly Federated Learning Framework
+# Flower: A Friendly Federated AI Framework
 
 <p align="center">
   <a href="https://flower.ai/">
@@ -21,7 +21,7 @@
 [![Docker Hub](https://img.shields.io/badge/Docker%20Hub-flwr-blue)](https://hub.docker.com/u/flwr)
 [![Slack](https://img.shields.io/badge/Chat-Slack-red)](https://flower.ai/join-slack)
 
-Flower (`flwr`) is a framework for building federated learning systems. The
+Flower (`flwr`) is a framework for building federated AI systems. The
 design of Flower is based on a few guiding principles:
 
 - **Customizable**: Federated learning systems vary wildly from one use case to

{flwr_nightly-1.13.0.dev20241111 → flwr_nightly-1.14.0.dev20241126}/pyproject.toml

@@ -4,8 +4,8 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "flwr-nightly"
-version = "1.13.0.dev20241111"
-description = "Flower: A Friendly Federated Learning Framework"
+version = "1.14.0.dev20241126"
+description = "Flower: A Friendly Federated AI Framework"
 license = "Apache-2.0"
 authors = ["The Flower Authors <hello@flower.ai>"]
 readme = "README.md"
@@ -77,6 +77,7 @@ typer = "^0.12.5"
 tomli = "^2.0.1"
 tomli-w = "^1.0.0"
 pathspec = "^0.12.1"
+rich = "^13.5.0"
 # Optional dependencies (Simulation Engine)
 ray = { version = "==2.10.0", optional = true, python = ">=3.9,<3.12" }
 # Optional dependencies (REST transport layer)
@@ -125,6 +126,7 @@ nbstripout = "==0.6.1"
 ruff = "==0.1.9"
 sphinx-argparse = "==0.4.0"
 pipreqs = "==0.4.13"
+mdformat = "==0.7.18"
 mdformat-gfm = "==0.3.6"
 mdformat-frontmatter = "==2.0.1"
 mdformat-beautysh = "==0.1.1"

{flwr_nightly-1.13.0.dev20241111 → flwr_nightly-1.14.0.dev20241126}/src/py/flwr/cli/app.py

@@ -20,6 +20,7 @@ from typer.main import get_command
 from .build import build
 from .install import install
 from .log import log
+from .ls import ls
 from .new import new
 from .run import run
 
@@ -37,6 +38,7 @@ app.command()(run)
 app.command()(build)
 app.command()(install)
 app.command()(log)
+app.command()(ls)
 
 typer_click_object = get_command(app)
 

{flwr_nightly-1.13.0.dev20241111 → flwr_nightly-1.14.0.dev20241126}/src/py/flwr/cli/install.py

@@ -16,7 +16,6 @@
 
 import hashlib
 import shutil
-import subprocess
 import tempfile
 import zipfile
 from io import BytesIO
@@ -188,21 +187,6 @@ def validate_and_install(
         else:
             shutil.copy2(item, install_dir / item.name)
 
-    try:
-        subprocess.run(
-            ["pip", "install", "-e", install_dir, "--no-deps"],
-            capture_output=True,
-            text=True,
-            check=True,
-        )
-    except subprocess.CalledProcessError as e:
-        typer.secho(
-            f"❌ Failed to `pip install` package(s) from {install_dir}:\n{e.stderr}",
-            fg=typer.colors.RED,
-            bold=True,
-        )
-        raise typer.Exit(code=1) from e
-
     typer.secho(
         f"🎊 Successfully installed {project_name} to {install_dir}.",
         fg=typer.colors.GREEN,

flwr_nightly-1.14.0.dev20241126/src/py/flwr/cli/ls.py

@@ -0,0 +1,228 @@
+# 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 `ls` command."""
+
+
+from datetime import datetime, timedelta
+from logging import DEBUG
+from pathlib import Path
+from typing import Annotated, Any, Optional
+
+import grpc
+import typer
+from rich.console import Console
+from rich.table import Table
+from rich.text import Text
+
+from flwr.cli.config_utils import (
+    load_and_validate,
+    validate_certificate_in_federation_config,
+    validate_federation_in_project_config,
+    validate_project_config,
+)
+from flwr.common.constant import FAB_CONFIG_FILE, SubStatus
+from flwr.common.date import format_timedelta, isoformat8601_utc
+from flwr.common.grpc import GRPC_MAX_MESSAGE_LENGTH, create_channel
+from flwr.common.logger import log
+from flwr.common.serde import run_from_proto
+from flwr.common.typing import Run
+from flwr.proto.exec_pb2 import (  # pylint: disable=E0611
+    ListRunsRequest,
+    ListRunsResponse,
+)
+from flwr.proto.exec_pb2_grpc import ExecStub
+
+
+def ls(
+    app: Annotated[
+        Path,
+        typer.Argument(help="Path of the Flower project"),
+    ] = Path("."),
+    federation: Annotated[
+        Optional[str],
+        typer.Argument(help="Name of the federation"),
+    ] = None,
+    runs: Annotated[
+        bool,
+        typer.Option(
+            "--runs",
+            help="List all runs",
+        ),
+    ] = False,
+    run_id: Annotated[
+        Optional[int],
+        typer.Option(
+            "--run-id",
+            help="Specific run ID to display",
+        ),
+    ] = None,
+) -> None:
+    """List runs."""
+    # Load and validate federation config
+    typer.secho("Loading project configuration... ", fg=typer.colors.BLUE)
+
+    pyproject_path = app / FAB_CONFIG_FILE if app else None
+    config, errors, warnings = load_and_validate(path=pyproject_path)
+    config = validate_project_config(config, errors, warnings)
+    federation, federation_config = validate_federation_in_project_config(
+        federation, config
+    )
+
+    if "address" not in federation_config:
+        typer.secho(
+            "❌ `flwr ls` currently works with Exec API. Ensure that the correct"
+            "Exec API address is provided in the `pyproject.toml`.",
+            fg=typer.colors.RED,
+            bold=True,
+        )
+        raise typer.Exit(code=1)
+
+    try:
+        if runs and run_id is not None:
+            raise ValueError(
+                "The options '--runs' and '--run-id' are mutually exclusive."
+            )
+
+        channel = _init_channel(app, federation_config)
+        stub = ExecStub(channel)
+
+        # Display information about a specific run ID
+        if run_id is not None:
+            typer.echo(f"🔍 Displaying information for run ID {run_id}...")
+            _display_one_run(stub, run_id)
+        # By default, list all runs
+        else:
+            typer.echo("📄 Listing all runs...")
+            _list_runs(stub)
+
+    except ValueError as err:
+        typer.secho(
+            f"❌ {err}",
+            fg=typer.colors.RED,
+            bold=True,
+        )
+        raise typer.Exit(code=1) from err
+    finally:
+        channel.close()
+
+
+def on_channel_state_change(channel_connectivity: str) -> None:
+    """Log channel connectivity."""
+    log(DEBUG, channel_connectivity)
+
+
+def _init_channel(app: Path, federation_config: dict[str, Any]) -> grpc.Channel:
+    """Initialize gRPC channel to the Exec API."""
+    insecure, root_certificates_bytes = validate_certificate_in_federation_config(
+        app, federation_config
+    )
+    channel = create_channel(
+        server_address=federation_config["address"],
+        insecure=insecure,
+        root_certificates=root_certificates_bytes,
+        max_message_length=GRPC_MAX_MESSAGE_LENGTH,
+        interceptors=None,
+    )
+    channel.subscribe(on_channel_state_change)
+    return channel
+
+
+def _format_run_table(run_dict: dict[int, Run], now_isoformat: str) -> Table:
+    """Format run status as a rich Table."""
+    table = Table(header_style="bold cyan", show_lines=True)
+
+    def _format_datetime(dt: Optional[datetime]) -> str:
+        return isoformat8601_utc(dt).replace("T", " ") if dt else "N/A"
+
+    # Add columns
+    table.add_column(
+        Text("Run ID", justify="center"), style="bright_white", overflow="fold"
+    )
+    table.add_column(Text("FAB", justify="center"), style="dim white")
+    table.add_column(Text("Status", justify="center"))
+    table.add_column(Text("Elapsed", justify="center"), style="blue")
+    table.add_column(Text("Created At", justify="center"), style="dim white")
+    table.add_column(Text("Running At", justify="center"), style="dim white")
+    table.add_column(Text("Finished At", justify="center"), style="dim white")
+
+    # Add rows
+    for run in sorted(
+        run_dict.values(), key=lambda x: datetime.fromisoformat(x.pending_at)
+    ):
+        # Combine status and sub-status into a single string
+        if run.status.sub_status == "":
+            status_text = run.status.status
+        else:
+            status_text = f"{run.status.status}:{run.status.sub_status}"
+
+        # Style the status based on its value
+        sub_status = run.status.sub_status
+        if sub_status == SubStatus.COMPLETED:
+            status_style = "green"
+        elif sub_status == SubStatus.FAILED:
+            status_style = "red"
+        else:
+            status_style = "yellow"
+
+        # Convert isoformat to datetime
+        pending_at = datetime.fromisoformat(run.pending_at) if run.pending_at else None
+        running_at = datetime.fromisoformat(run.running_at) if run.running_at else None
+        finished_at = (
+            datetime.fromisoformat(run.finished_at) if run.finished_at else None
+        )
+
+        # Calculate elapsed time
+        elapsed_time = timedelta()
+        if running_at:
+            if finished_at:
+                end_time = finished_at
+            else:
+                end_time = datetime.fromisoformat(now_isoformat)
+            elapsed_time = end_time - running_at
+
+        table.add_row(
+            f"[bold]{run.run_id}[/bold]",
+            f"{run.fab_id} (v{run.fab_version})",
+            f"[{status_style}]{status_text}[/{status_style}]",
+            format_timedelta(elapsed_time),
+            _format_datetime(pending_at),
+            _format_datetime(running_at),
+            _format_datetime(finished_at),
+        )
+    return table
+
+
+def _list_runs(
+    stub: ExecStub,
+) -> None:
+    """List all runs."""
+    res: ListRunsResponse = stub.ListRuns(ListRunsRequest())
+    run_dict = {run_id: run_from_proto(proto) for run_id, proto in res.run_dict.items()}
+
+    Console().print(_format_run_table(run_dict, res.now))
+
+
+def _display_one_run(
+    stub: ExecStub,
+    run_id: int,
+) -> None:
+    """Display information about a specific run."""
+    res: ListRunsResponse = stub.ListRuns(ListRunsRequest(run_id=run_id))
+    if not res.run_dict:
+        raise ValueError(f"Run ID {run_id} not found")
+
+    run_dict = {run_id: run_from_proto(proto) for run_id, proto in res.run_dict.items()}
+
+    Console().print(_format_run_table(run_dict, res.now))

{flwr_nightly-1.13.0.dev20241111 → flwr_nightly-1.14.0.dev20241126}/src/py/flwr/cli/new/new.py

@@ -268,20 +268,30 @@ def new(
             context=context,
         )
 
-    print(
-        typer.style(
-            "🎊 Flower App creation successful.\n\n"
-            "Use the following command to run your Flower App:\n",
-            fg=typer.colors.GREEN,
-            bold=True,
-        )
+    prompt = typer.style(
+        "🎊 Flower App creation successful.\n\n"
+        "To run your Flower App, use the following command:\n\n",
+        fg=typer.colors.GREEN,
+        bold=True,
     )
 
     _add = "	huggingface-cli login\n" if llm_challenge_str else ""
-    print(
-        typer.style(
-            f"	cd {package_name}\n" + "	pip install -e .\n" + _add + "	flwr run\n",
-            fg=typer.colors.BRIGHT_CYAN,
-            bold=True,
-        )
+    prompt += typer.style(
+        _add + f"	flwr run {package_name}\n\n",
+        fg=typer.colors.BRIGHT_CYAN,
+        bold=True,
+    )
+
+    prompt += typer.style(
+        "If you haven't installed all dependencies yet, follow these steps:\n\n",
+        fg=typer.colors.GREEN,
+        bold=True,
     )
+
+    prompt += typer.style(
+        f"	cd {package_name}\n" + "	pip install -e .\n" + _add + "	flwr run .\n",
+        fg=typer.colors.BRIGHT_CYAN,
+        bold=True,
+    )
+
+    print(prompt)

flwr_nightly-1.14.0.dev20241126/src/py/flwr/cli/new/templates/app/README.md.tpl

@@ -0,0 +1,31 @@
+# $project_name: A Flower / $framework_str app
+
+## Install dependencies and project
+
+```bash
+pip install -e .
+```
+
+## Run with the Simulation Engine
+
+In the `$project_name` directory, use `flwr run` to run a local simulation:
+
+```bash
+flwr run .
+```
+
+Refer to the [How to Run Simulations](https://flower.ai/docs/framework/how-to-run-simulations.html) guide in the documentation for advice on how to optimize your simulations.
+
+## Run with the Deployment Engine
+
+> \[!NOTE\]
+> An update to this example will show how to run this Flower application with the Deployment Engine and TLS certificates, or with Docker.
+
+## Resources
+
+- Flower website: [flower.ai](https://flower.ai/)
+- Check the documentation: [flower.ai/docs](https://flower.ai/docs/)
+- Give Flower a ⭐️ on GitHub: [GitHub](https://github.com/adap/flower)
+- Join the Flower community!
+  - [Flower Slack](https://flower.ai/join-slack/)
+  - [Flower Discuss](https://discuss.flower.ai/)

{flwr_nightly-1.13.0.dev20241111 → flwr_nightly-1.14.0.dev20241126}/src/py/flwr/cli/new/templates/app/pyproject.baseline.toml.tpl

@@ -8,7 +8,7 @@ version = "1.0.0"
 description = ""
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.12.0",
+    "flwr[simulation]>=1.13.0",
     "flwr-datasets[vision]>=0.3.0",
     "torch==2.2.1",
     "torchvision==0.17.1",

{flwr_nightly-1.13.0.dev20241111 → flwr_nightly-1.14.0.dev20241126}/src/py/flwr/cli/new/templates/app/pyproject.flowertune.toml.tpl

@@ -8,7 +8,7 @@ version = "1.0.0"
 description = ""
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.12.0",
+    "flwr[simulation]>=1.13.0",
     "flwr-datasets>=0.3.0",
     "torch==2.3.1",
     "trl==0.8.1",

{flwr_nightly-1.13.0.dev20241111 → flwr_nightly-1.14.0.dev20241126}/src/py/flwr/cli/new/templates/app/pyproject.huggingface.toml.tpl

@@ -8,7 +8,7 @@ version = "1.0.0"
 description = ""
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.12.0",
+    "flwr[simulation]>=1.13.0",
     "flwr-datasets>=0.3.0",
     "torch==2.2.1",
     "transformers>=4.30.0,<5.0",

{flwr_nightly-1.13.0.dev20241111 → flwr_nightly-1.14.0.dev20241126}/src/py/flwr/cli/new/templates/app/pyproject.jax.toml.tpl

@@ -8,7 +8,7 @@ version = "1.0.0"
 description = ""
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.12.0",
+    "flwr[simulation]>=1.13.0",
     "jax==0.4.30",
     "jaxlib==0.4.30",
     "scikit-learn==1.3.2",

{flwr_nightly-1.13.0.dev20241111 → flwr_nightly-1.14.0.dev20241126}/src/py/flwr/cli/new/templates/app/pyproject.mlx.toml.tpl

@@ -8,7 +8,7 @@ version = "1.0.0"
 description = ""
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.12.0",
+    "flwr[simulation]>=1.13.0",
     "flwr-datasets[vision]>=0.3.0",
     "mlx==0.16.1",
     "numpy==1.24.4",

{flwr_nightly-1.13.0.dev20241111 → flwr_nightly-1.14.0.dev20241126}/src/py/flwr/cli/new/templates/app/pyproject.numpy.toml.tpl

@@ -8,7 +8,7 @@ version = "1.0.0"
 description = ""
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.12.0",
+    "flwr[simulation]>=1.13.0",
     "numpy>=1.21.0",
 ]
 

{flwr_nightly-1.13.0.dev20241111 → flwr_nightly-1.14.0.dev20241126}/src/py/flwr/cli/new/templates/app/pyproject.pytorch.toml.tpl

@@ -8,7 +8,7 @@ version = "1.0.0"
 description = ""
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.12.0",
+    "flwr[simulation]>=1.13.0",
     "flwr-datasets[vision]>=0.3.0",
     "torch==2.2.1",
     "torchvision==0.17.1",

{flwr_nightly-1.13.0.dev20241111 → flwr_nightly-1.14.0.dev20241126}/src/py/flwr/cli/new/templates/app/pyproject.sklearn.toml.tpl

@@ -8,7 +8,7 @@ version = "1.0.0"
 description = ""
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.12.0",
+    "flwr[simulation]>=1.13.0",
     "flwr-datasets[vision]>=0.3.0",
     "scikit-learn>=1.1.1",
 ]

{flwr_nightly-1.13.0.dev20241111 → flwr_nightly-1.14.0.dev20241126}/src/py/flwr/cli/new/templates/app/pyproject.tensorflow.toml.tpl

@@ -8,7 +8,7 @@ version = "1.0.0"
 description = ""
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.12.0",
+    "flwr[simulation]>=1.13.0",
     "flwr-datasets[vision]>=0.3.0",
     "tensorflow>=2.11.1,<2.18.0",
 ]

{flwr_nightly-1.13.0.dev20241111 → flwr_nightly-1.14.0.dev20241126}/src/py/flwr/cli/run/run.py

@@ -125,6 +125,10 @@ def _run_with_exec_api(
 
     fab_path, fab_hash = build(app)
     content = Path(fab_path).read_bytes()
+
+    # Delete FAB file once the bytes is computed
+    Path(fab_path).unlink()
+
     fab = Fab(fab_hash, content)
 
     # Construct a `ConfigsRecord` out of a flattened `UserConfig`
@@ -138,8 +142,6 @@ def _run_with_exec_api(
     )
     res = stub.StartRun(req)
 
-    # Delete FAB file once it has been sent to the Exec API
-    Path(fab_path).unlink()
     typer.secho(f"🎊 Successfully started run {res.run_id}", fg=typer.colors.GREEN)
 
     if stream: