flwr 1.19.0__py3-none-any.whl → 1.21.0__py3-none-any.whl

flwr/cli/new/templates/app/code/task.pytorch_msg_api.py.tpl

@@ -0,0 +1,98 @@
+"""$project_name: A Flower / $framework_str app."""
+
+import torch
+import torch.nn as nn
+import torch.nn.functional as F
+from flwr_datasets import FederatedDataset
+from flwr_datasets.partitioner import IidPartitioner
+from torch.utils.data import DataLoader
+from torchvision.transforms import Compose, Normalize, ToTensor
+
+
+class Net(nn.Module):
+    """Model (simple CNN adapted from 'PyTorch: A 60 Minute Blitz')"""
+
+    def __init__(self):
+        super(Net, self).__init__()
+        self.conv1 = nn.Conv2d(3, 6, 5)
+        self.pool = nn.MaxPool2d(2, 2)
+        self.conv2 = nn.Conv2d(6, 16, 5)
+        self.fc1 = nn.Linear(16 * 5 * 5, 120)
+        self.fc2 = nn.Linear(120, 84)
+        self.fc3 = nn.Linear(84, 10)
+
+    def forward(self, x):
+        x = self.pool(F.relu(self.conv1(x)))
+        x = self.pool(F.relu(self.conv2(x)))
+        x = x.view(-1, 16 * 5 * 5)
+        x = F.relu(self.fc1(x))
+        x = F.relu(self.fc2(x))
+        return self.fc3(x)
+
+
+fds = None  # Cache FederatedDataset
+
+pytorch_transforms = Compose([ToTensor(), Normalize((0.5, 0.5, 0.5), (0.5, 0.5, 0.5))])
+
+
+def apply_transforms(batch):
+    """Apply transforms to the partition from FederatedDataset."""
+    batch["img"] = [pytorch_transforms(img) for img in batch["img"]]
+    return batch
+
+
+def load_data(partition_id: int, num_partitions: int):
+    """Load partition CIFAR10 data."""
+    # Only initialize `FederatedDataset` once
+    global fds
+    if fds is None:
+        partitioner = IidPartitioner(num_partitions=num_partitions)
+        fds = FederatedDataset(
+            dataset="uoft-cs/cifar10",
+            partitioners={"train": partitioner},
+        )
+    partition = fds.load_partition(partition_id)
+    # Divide data on each node: 80% train, 20% test
+    partition_train_test = partition.train_test_split(test_size=0.2, seed=42)
+    # Construct dataloaders
+    partition_train_test = partition_train_test.with_transform(apply_transforms)
+    trainloader = DataLoader(partition_train_test["train"], batch_size=32, shuffle=True)
+    testloader = DataLoader(partition_train_test["test"], batch_size=32)
+    return trainloader, testloader
+
+
+def train(net, trainloader, epochs, lr, device):
+    """Train the model on the training set."""
+    net.to(device)  # move model to GPU if available
+    criterion = torch.nn.CrossEntropyLoss().to(device)
+    optimizer = torch.optim.Adam(net.parameters(), lr=lr)
+    net.train()
+    running_loss = 0.0
+    for _ in range(epochs):
+        for batch in trainloader:
+            images = batch["img"].to(device)
+            labels = batch["label"].to(device)
+            optimizer.zero_grad()
+            loss = criterion(net(images), labels)
+            loss.backward()
+            optimizer.step()
+            running_loss += loss.item()
+    avg_trainloss = running_loss / len(trainloader)
+    return avg_trainloss
+
+
+def test(net, testloader, device):
+    """Validate the model on the test set."""
+    net.to(device)
+    criterion = torch.nn.CrossEntropyLoss()
+    correct, loss = 0, 0.0
+    with torch.no_grad():
+        for batch in testloader:
+            images = batch["img"].to(device)
+            labels = batch["label"].to(device)
+            outputs = net(images)
+            loss += criterion(outputs, labels).item()
+            correct += (torch.max(outputs.data, 1)[1] == labels).sum().item()
+    accuracy = correct / len(testloader.dataset)
+    loss = loss / len(testloader)
+    return loss, accuracy

flwr/cli/new/templates/app/pyproject.baseline.toml.tpl

@@ -1,3 +1,8 @@
+# =====================================================================
+# For a full TOML configuration guide, check the Flower docs:
+# https://flower.ai/docs/framework/how-to-configure-pyproject-toml.html
+# =====================================================================
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
@@ -7,11 +12,12 @@ name = "$package_name"
 version = "1.0.0"
 description = ""
 license = "Apache-2.0"
+# Dependencies for your Flower App
 dependencies = [
-    "flwr[simulation]>=1.19.0",
+    "flwr[simulation]>=1.21.0",
     "flwr-datasets[vision]>=0.5.0",
-    "torch==2.6.0",
-    "torchvision==0.21.0",
+    "torch==2.7.1",
+    "torchvision==0.22.1",
 ]
 
 [tool.hatch.metadata]
@@ -117,18 +123,23 @@ packages = ["."]
 [tool.flwr.app]
 publisher = "$username"
 
+# Point to your ServerApp and ClientApp objects
+# Format: "<module>:<object>"
 [tool.flwr.app.components]
 serverapp = "$import_name.server_app:app"
 clientapp = "$import_name.client_app:app"
 
+# Custom config values accessible via `context.run_config`
 [tool.flwr.app.config]
 num-server-rounds = 3
 fraction-fit = 0.5
 local-epochs = 1
 
+# Default federation to use when running the app
 [tool.flwr.federations]
 default = "local-simulation"
 
+# Local simulation federation with 10 virtual SuperNodes
 [tool.flwr.federations.local-simulation]
 options.num-supernodes = 10
 options.backend.client-resources.num-cpus = 2

flwr/cli/new/templates/app/pyproject.flowertune.toml.tpl

@@ -1,3 +1,8 @@
+# =====================================================================
+# For a full TOML configuration guide, check the Flower docs:
+# https://flower.ai/docs/framework/how-to-configure-pyproject-toml.html
+# =====================================================================
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
@@ -7,8 +12,9 @@ name = "$package_name"
 version = "1.0.0"
 description = ""
 license = "Apache-2.0"
+# Dependencies for your Flower App
 dependencies = [
-    "flwr[simulation]>=1.19.0",
+    "flwr[simulation]>=1.21.0",
     "flwr-datasets>=0.5.0",
     "torch==2.4.0",
     "trl==0.8.1",
@@ -27,10 +33,13 @@ packages = ["."]
 [tool.flwr.app]
 publisher = "$username"
 
+# Point to your ServerApp and ClientApp objects
+# Format: "<module>:<object>"
 [tool.flwr.app.components]
 serverapp = "$import_name.server_app:app"
 clientapp = "$import_name.client_app:app"
 
+# Custom config values accessible via `context.run_config`
 [tool.flwr.app.config]
 model.name = "mistralai/Mistral-7B-v0.3"
 model.quantization = 4
@@ -56,12 +65,15 @@ strategy.fraction-fit = $fraction_fit
 strategy.fraction-evaluate = 0.0
 num-server-rounds = 200
 
+# Dataset config (static for FlowerTune LLM Leaderboard)
 [tool.flwr.app.config.static]
 dataset.name = "$dataset_name"
 
+# Default federation to use when running the app
 [tool.flwr.federations]
 default = "local-simulation"
 
+# Local simulation federation with $num_clients virtual SuperNodes
 [tool.flwr.federations.local-simulation]
 options.num-supernodes = $num_clients
 options.backend.client-resources.num-cpus = 6

flwr/cli/new/templates/app/pyproject.huggingface.toml.tpl

@@ -1,3 +1,8 @@
+# =====================================================================
+# For a full TOML configuration guide, check the Flower docs:
+# https://flower.ai/docs/framework/how-to-configure-pyproject-toml.html
+# =====================================================================
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
@@ -7,10 +12,11 @@ name = "$package_name"
 version = "1.0.0"
 description = ""
 license = "Apache-2.0"
+# Dependencies for your Flower App
 dependencies = [
-    "flwr[simulation]>=1.19.0",
+    "flwr[simulation]>=1.21.0",
     "flwr-datasets>=0.5.0",
-    "torch==2.5.1",
+    "torch==2.7.1",
     "transformers>=4.30.0,<5.0",
     "evaluate>=0.4.0,<1.0",
     "datasets>=2.0.0, <3.0",
@@ -23,10 +29,13 @@ packages = ["."]
 [tool.flwr.app]
 publisher = "$username"
 
+# Point to your ServerApp and ClientApp objects
+# Format: "<module>:<object>"
 [tool.flwr.app.components]
 serverapp = "$import_name.server_app:app"
 clientapp = "$import_name.client_app:app"
 
+# Custom config values accessible via `context.run_config`
 [tool.flwr.app.config]
 num-server-rounds = 3
 fraction-fit = 0.5
@@ -34,13 +43,23 @@ local-epochs = 1
 model-name = "prajjwal1/bert-tiny" # Set a larger model if you have access to more GPU resources
 num-labels = 2
 
+# Default federation to use when running the app
 [tool.flwr.federations]
 default = "localhost"
 
+# Local simulation federation with 10 virtual SuperNodes
 [tool.flwr.federations.localhost]
 options.num-supernodes = 10
 
+# Local simulation federation with 10 virtual SuperNodes
+# making use of GPUs
 [tool.flwr.federations.localhost-gpu]
 options.num-supernodes = 10
 options.backend.client-resources.num-cpus = 4 # each ClientApp assumes to use 4CPUs
 options.backend.client-resources.num-gpus = 0.25 # at most 4 ClientApps will run in a given GPU
+
+# Remote federation example for use with SuperLink
+[tool.flwr.federations.remote-federation]
+address = "<SUPERLINK-ADDRESS>:<PORT>"
+insecure = true  # Remove this line to enable TLS
+# root-certificates = "<PATH/TO/ca.crt>"  # For TLS setup

flwr/cli/new/templates/app/pyproject.jax.toml.tpl

@@ -1,3 +1,8 @@
+# =====================================================================
+# For a full TOML configuration guide, check the Flower docs:
+# https://flower.ai/docs/framework/how-to-configure-pyproject-toml.html
+# =====================================================================
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
@@ -7,8 +12,9 @@ name = "$package_name"
 version = "1.0.0"
 description = ""
 license = "Apache-2.0"
+# Dependencies for your Flower App
 dependencies = [
-    "flwr[simulation]>=1.19.0",
+    "flwr[simulation]>=1.21.0",
     "jax==0.4.30",
     "jaxlib==0.4.30",
     "scikit-learn==1.6.1",
@@ -20,16 +26,27 @@ packages = ["."]
 [tool.flwr.app]
 publisher = "$username"
 
+# Point to your ServerApp and ClientApp objects
+# Format: "<module>:<object>"
 [tool.flwr.app.components]
 serverapp = "$import_name.server_app:app"
 clientapp = "$import_name.client_app:app"
 
+# Custom config values accessible via `context.run_config`
 [tool.flwr.app.config]
 num-server-rounds = 3
 input-dim = 3
 
+# Default federation to use when running the app
 [tool.flwr.federations]
 default = "local-simulation"
 
+# Local simulation federation with 10 virtual SuperNodes
 [tool.flwr.federations.local-simulation]
 options.num-supernodes = 10
+
+# Remote federation example for use with SuperLink
+[tool.flwr.federations.remote-federation]
+address = "<SUPERLINK-ADDRESS>:<PORT>"
+insecure = true  # Remove this line to enable TLS
+# root-certificates = "<PATH/TO/ca.crt>"  # For TLS setup

flwr/cli/new/templates/app/pyproject.mlx.toml.tpl

@@ -1,3 +1,8 @@
+# =====================================================================
+# For a full TOML configuration guide, check the Flower docs:
+# https://flower.ai/docs/framework/how-to-configure-pyproject-toml.html
+# =====================================================================
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
@@ -7,10 +12,11 @@ name = "$package_name"
 version = "1.0.0"
 description = ""
 license = "Apache-2.0"
+# Dependencies for your Flower App
 dependencies = [
-    "flwr[simulation]>=1.19.0",
+    "flwr[simulation]>=1.21.0",
     "flwr-datasets[vision]>=0.5.0",
-    "mlx==0.21.1",
+    "mlx==0.26.5",
 ]
 
 [tool.hatch.build.targets.wheel]
@@ -19,10 +25,13 @@ packages = ["."]
 [tool.flwr.app]
 publisher = "$username"
 
+# Point to your ServerApp and ClientApp objects
+# Format: "<module>:<object>"
 [tool.flwr.app.components]
 serverapp = "$import_name.server_app:app"
 clientapp = "$import_name.client_app:app"
 
+# Custom config values accessible via `context.run_config`
 [tool.flwr.app.config]
 num-server-rounds = 3
 local-epochs = 1
@@ -32,8 +41,16 @@ hidden-dim = 32
 batch-size = 256
 lr = 0.1
 
+# Default federation to use when running the app
 [tool.flwr.federations]
 default = "local-simulation"
 
+# Local simulation federation with 10 virtual SuperNodes
 [tool.flwr.federations.local-simulation]
 options.num-supernodes = 10
+
+# Remote federation example for use with SuperLink
+[tool.flwr.federations.remote-federation]
+address = "<SUPERLINK-ADDRESS>:<PORT>"
+insecure = true  # Remove this line to enable TLS
+# root-certificates = "<PATH/TO/ca.crt>"  # For TLS setup

flwr/cli/new/templates/app/pyproject.numpy.toml.tpl

@@ -1,3 +1,8 @@
+# =====================================================================
+# For a full TOML configuration guide, check the Flower docs:
+# https://flower.ai/docs/framework/how-to-configure-pyproject-toml.html
+# =====================================================================
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
@@ -7,8 +12,9 @@ name = "$package_name"
 version = "1.0.0"
 description = ""
 license = "Apache-2.0"
+# Dependencies for your Flower App
 dependencies = [
-    "flwr[simulation]>=1.19.0",
+    "flwr[simulation]>=1.21.0",
     "numpy>=2.0.2",
 ]
 
@@ -18,15 +24,26 @@ packages = ["."]
 [tool.flwr.app]
 publisher = "$username"
 
+# Point to your ServerApp and ClientApp objects
+# Format: "<module>:<object>"
 [tool.flwr.app.components]
 serverapp = "$import_name.server_app:app"
 clientapp = "$import_name.client_app:app"
 
+# Custom config values accessible via `context.run_config`
 [tool.flwr.app.config]
 num-server-rounds = 3
 
+# Default federation to use when running the app
 [tool.flwr.federations]
 default = "local-simulation"
 
+# Local simulation federation with 10 virtual SuperNodes
 [tool.flwr.federations.local-simulation]
 options.num-supernodes = 10
+
+# Remote federation example for use with SuperLink
+[tool.flwr.federations.remote-federation]
+address = "<SUPERLINK-ADDRESS>:<PORT>"
+insecure = true  # Remove this line to enable TLS
+# root-certificates = "<PATH/TO/ca.crt>"  # For TLS setup

flwr/cli/new/templates/app/pyproject.pytorch.toml.tpl

@@ -1,3 +1,8 @@
+# =====================================================================
+# For a full TOML configuration guide, check the Flower docs:
+# https://flower.ai/docs/framework/how-to-configure-pyproject-toml.html
+# =====================================================================
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
@@ -7,11 +12,12 @@ name = "$package_name"
 version = "1.0.0"
 description = ""
 license = "Apache-2.0"
+# Dependencies for your Flower App
 dependencies = [
-    "flwr[simulation]>=1.19.0",
+    "flwr[simulation]>=1.21.0",
     "flwr-datasets[vision]>=0.5.0",
-    "torch==2.5.1",
-    "torchvision==0.20.1",
+    "torch==2.7.1",
+    "torchvision==0.22.1",
 ]
 
 [tool.hatch.build.targets.wheel]
@@ -20,17 +26,28 @@ packages = ["."]
 [tool.flwr.app]
 publisher = "$username"
 
+# Point to your ServerApp and ClientApp objects
+# Format: "<module>:<object>"
 [tool.flwr.app.components]
 serverapp = "$import_name.server_app:app"
 clientapp = "$import_name.client_app:app"
 
+# Custom config values accessible via `context.run_config`
 [tool.flwr.app.config]
 num-server-rounds = 3
 fraction-fit = 0.5
 local-epochs = 1
 
+# Default federation to use when running the app
 [tool.flwr.federations]
 default = "local-simulation"
 
+# Local simulation federation with 10 virtual SuperNodes
 [tool.flwr.federations.local-simulation]
 options.num-supernodes = 10
+
+# Remote federation example for use with SuperLink
+[tool.flwr.federations.remote-federation]
+address = "<SUPERLINK-ADDRESS>:<PORT>"
+insecure = true  # Remove this line to enable TLS
+# root-certificates = "<PATH/TO/ca.crt>"  # For TLS setup

flwr/cli/new/templates/app/pyproject.pytorch_msg_api.toml.tpl

@@ -0,0 +1,53 @@
+# =====================================================================
+# For a full TOML configuration guide, check the Flower docs:
+# https://flower.ai/docs/framework/how-to-configure-pyproject-toml.html
+# =====================================================================
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "$package_name"
+version = "1.0.0"
+description = ""
+license = "Apache-2.0"
+# Dependencies for your Flower App
+dependencies = [
+    "flwr[simulation]>=1.21.0",
+    "flwr-datasets[vision]>=0.5.0",
+    "torch==2.7.1",
+    "torchvision==0.22.1",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["."]
+
+[tool.flwr.app]
+publisher = "$username"
+
+# Point to your ServerApp and ClientApp objects
+[tool.flwr.app.components]
+serverapp = "$import_name.server_app:app"
+clientapp = "$import_name.client_app:app"
+
+# Custom config values accessible via `context.run_config`
+[tool.flwr.app.config]
+num-server-rounds = 3
+fraction-train = 0.5
+local-epochs = 1
+lr = 0.01
+
+# Default federation to use when running the app
+[tool.flwr.federations]
+default = "local-simulation"
+
+# Local simulation federation with 10 virtual SuperNodes
+[tool.flwr.federations.local-simulation]
+options.num-supernodes = 10
+
+# Remote federation example for use with SuperLink
+[tool.flwr.federations.remote-federation]
+address = "<SUPERLINK-ADDRESS>:<PORT>"
+insecure = true  # Remove this line to enable TLS
+# root-certificates = "<PATH/TO/ca.crt>"  # For TLS setup

flwr/cli/new/templates/app/pyproject.sklearn.toml.tpl

@@ -1,3 +1,8 @@
+# =====================================================================
+# For a full TOML configuration guide, check the Flower docs:
+# https://flower.ai/docs/framework/how-to-configure-pyproject-toml.html
+# =====================================================================
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
@@ -7,8 +12,9 @@ name = "$package_name"
 version = "1.0.0"
 description = ""
 license = "Apache-2.0"
+# Dependencies for your Flower App
 dependencies = [
-    "flwr[simulation]>=1.19.0",
+    "flwr[simulation]>=1.21.0",
     "flwr-datasets[vision]>=0.5.0",
     "scikit-learn>=1.6.1",
 ]
@@ -19,17 +25,28 @@ packages = ["."]
 [tool.flwr.app]
 publisher = "$username"
 
+# Point to your ServerApp and ClientApp objects
+# Format: "<module>:<object>"
 [tool.flwr.app.components]
 serverapp = "$import_name.server_app:app"
 clientapp = "$import_name.client_app:app"
 
+# Custom config values accessible via `context.run_config`
 [tool.flwr.app.config]
 num-server-rounds = 3
 penalty = "l2"
 local-epochs = 1
 
+# Default federation to use when running the app
 [tool.flwr.federations]
 default = "local-simulation"
 
+# Local simulation federation with 10 virtual SuperNodes
 [tool.flwr.federations.local-simulation]
 options.num-supernodes = 10
+
+# Remote federation example for use with SuperLink
+[tool.flwr.federations.remote-federation]
+address = "<SUPERLINK-ADDRESS>:<PORT>"
+insecure = true  # Remove this line to enable TLS
+# root-certificates = "<PATH/TO/ca.crt>"  # For TLS setup

flwr/cli/new/templates/app/pyproject.tensorflow.toml.tpl

@@ -1,3 +1,8 @@
+# =====================================================================
+# For a full TOML configuration guide, check the Flower docs:
+# https://flower.ai/docs/framework/how-to-configure-pyproject-toml.html
+# =====================================================================
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
@@ -7,8 +12,9 @@ name = "$package_name"
 version = "1.0.0"
 description = ""
 license = "Apache-2.0"
+# Dependencies for your Flower App
 dependencies = [
-    "flwr[simulation]>=1.19.0",
+    "flwr[simulation]>=1.21.0",
     "flwr-datasets[vision]>=0.5.0",
     "tensorflow>=2.11.1,<2.18.0",
 ]
@@ -19,18 +25,29 @@ packages = ["."]
 [tool.flwr.app]
 publisher = "$username"
 
+# Point to your ServerApp and ClientApp objects
+# Format: "<module>:<object>"
 [tool.flwr.app.components]
 serverapp = "$import_name.server_app:app"
 clientapp = "$import_name.client_app:app"
 
+# Custom config values accessible via `context.run_config`
 [tool.flwr.app.config]
 num-server-rounds = 3
 local-epochs = 1
 batch-size = 32
 verbose = false
 
+# Default federation to use when running the app
 [tool.flwr.federations]
 default = "local-simulation"
 
+# Local simulation federation with 10 virtual SuperNodes
 [tool.flwr.federations.local-simulation]
 options.num-supernodes = 10
+
+# Remote federation example for use with SuperLink
+[tool.flwr.federations.remote-federation]
+address = "<SUPERLINK-ADDRESS>:<PORT>"
+insecure = true  # Remove this line to enable TLS
+# root-certificates = "<PATH/TO/ca.crt>"  # For TLS setup