flwr 1.24.0__py3-none-any.whl → 1.25.0__py3-none-any.whl

flwr/cli/new/templates/app/code/client.tensorflow.py.tpl

@@ -1,82 +0,0 @@
-"""$project_name: A Flower / $framework_str app."""
-
-from flwr.app import ArrayRecord, Context, Message, MetricRecord, RecordDict
-from flwr.clientapp import ClientApp
-
-from $import_name.task import load_data, load_model
-
-# Flower ClientApp
-app = ClientApp()
-
-
-@app.train()
-def train(msg: Message, context: Context):
-    """Train the model on local data."""
-
-    # Load the model and initialize it with the received weights
-    model = load_model()
-    ndarrays = msg.content["arrays"].to_numpy_ndarrays()
-    model.set_weights(ndarrays)
-
-    # Read from config
-    epochs = context.run_config["local-epochs"]
-    batch_size = context.run_config["batch-size"]
-    verbose = context.run_config.get("verbose")
-
-    # Load the data
-    partition_id = context.node_config["partition-id"]
-    num_partitions = context.node_config["num-partitions"]
-    x_train, y_train, _, _ = load_data(partition_id, num_partitions)
-
-    # Train the model on local data
-    history = model.fit(
-        x_train,
-        y_train,
-        epochs=epochs,
-        batch_size=batch_size,
-        verbose=verbose,
-    )
-
-    # Get final training loss and accuracy
-    train_loss = history.history["loss"][-1] if "loss" in history.history else None
-    train_acc = history.history.get("accuracy")
-    train_acc = train_acc[-1] if train_acc is not None else None
-
-    # Construct and return reply Message
-    model_record = ArrayRecord(model.get_weights())
-    metrics = {"num-examples": len(x_train)}
-    if train_loss is not None:
-        metrics["train_loss"] = train_loss
-    if train_acc is not None:
-        metrics["train_acc"] = train_acc
-    metric_record = MetricRecord(metrics)
-    content = RecordDict({"arrays": model_record, "metrics": metric_record})
-    return Message(content=content, reply_to=msg)
-
-
-@app.evaluate()
-def evaluate(msg: Message, context: Context):
-    """Evaluate the model on local data."""
-
-    # Load the model and initialize it with the received weights
-    model = load_model()
-    ndarrays = msg.content["arrays"].to_numpy_ndarrays()
-    model.set_weights(ndarrays)
-
-    # Load the data
-    partition_id = context.node_config["partition-id"]
-    num_partitions = context.node_config["num-partitions"]
-    _, _, x_test, y_test = load_data(partition_id, num_partitions)
-
-    # Evaluate the model on local data
-    loss, accuracy = model.evaluate(x_test, y_test, verbose=0)
-
-    # Construct and return reply Message
-    metrics = {
-        "eval_loss": loss,
-        "eval_acc": accuracy,
-        "num-examples": len(x_test),
-    }
-    metric_record = MetricRecord(metrics)
-    content = RecordDict({"metrics": metric_record})
-    return Message(content=content, reply_to=msg)

flwr/cli/new/templates/app/code/client.xgboost.py.tpl

@@ -1,110 +0,0 @@
-"""$project_name: A Flower / $framework_str app."""
-
-import warnings
-
-import numpy as np
-import xgboost as xgb
-from flwr.app import ArrayRecord, Context, Message, MetricRecord, RecordDict
-from flwr.clientapp import ClientApp
-from flwr.common.config import unflatten_dict
-
-from $import_name.task import load_data, replace_keys
-
-warnings.filterwarnings("ignore", category=UserWarning)
-
-
-# Flower ClientApp
-app = ClientApp()
-
-
-def _local_boost(bst_input, num_local_round, train_dmatrix):
-    # Update trees based on local training data.
-    for i in range(num_local_round):
-        bst_input.update(train_dmatrix, bst_input.num_boosted_rounds())
-
-    # Bagging: extract the last N=num_local_round trees for sever aggregation
-    bst = bst_input[
-        bst_input.num_boosted_rounds()
-        - num_local_round : bst_input.num_boosted_rounds()
-    ]
-    return bst
-
-
-@app.train()
-def train(msg: Message, context: Context) -> Message:
-    # Load model and data
-    partition_id = context.node_config["partition-id"]
-    num_partitions = context.node_config["num-partitions"]
-    train_dmatrix, _, num_train, _ = load_data(partition_id, num_partitions)
-
-    # Read from run config
-    num_local_round = context.run_config["local-epochs"]
-    # Flatted config dict and replace "-" with "_"
-    cfg = replace_keys(unflatten_dict(context.run_config))
-    params = cfg["params"]
-
-    global_round = msg.content["config"]["server-round"]
-    if global_round == 1:
-        # First round local training
-        bst = xgb.train(
-            params,
-            train_dmatrix,
-            num_boost_round=num_local_round,
-        )
-    else:
-        bst = xgb.Booster(params=params)
-        global_model = bytearray(msg.content["arrays"]["0"].numpy().tobytes())
-
-        # Load global model into booster
-        bst.load_model(global_model)
-
-        # Local training
-        bst = _local_boost(bst, num_local_round, train_dmatrix)
-
-    # Save model
-    local_model = bst.save_raw("json")
-    model_np = np.frombuffer(local_model, dtype=np.uint8)
-
-    # Construct reply message
-    # Note: we store the model as the first item in a list into ArrayRecord,
-    # which can be accessed using index ["0"].
-    model_record = ArrayRecord([model_np])
-    metrics = {
-        "num-examples": num_train,
-    }
-    metric_record = MetricRecord(metrics)
-    content = RecordDict({"arrays": model_record, "metrics": metric_record})
-    return Message(content=content, reply_to=msg)
-
-
-@app.evaluate()
-def evaluate(msg: Message, context: Context) -> Message:
-    # Load model and data
-    partition_id = context.node_config["partition-id"]
-    num_partitions = context.node_config["num-partitions"]
-    _, valid_dmatrix, _, num_val = load_data(partition_id, num_partitions)
-
-    # Load config
-    cfg = replace_keys(unflatten_dict(context.run_config))
-    params = cfg["params"]
-
-    # Load global model
-    bst = xgb.Booster(params=params)
-    global_model = bytearray(msg.content["arrays"]["0"].numpy().tobytes())
-    bst.load_model(global_model)
-
-    # Run evaluation
-    eval_results = bst.eval_set(
-        evals=[(valid_dmatrix, "valid")],
-        iteration=bst.num_boosted_rounds() - 1,
-    )
-    auc = float(eval_results.split("\t")[1].split(":")[1])
-
-    # Construct and return reply Message
-    metrics = {
-        "auc": auc,
-        "num-examples": num_val,
-    }
-    metric_record = MetricRecord(metrics)
-    content = RecordDict({"metrics": metric_record})
-    return Message(content=content, reply_to=msg)

flwr/cli/new/templates/app/code/dataset.baseline.py.tpl

@@ -1,36 +0,0 @@
-"""$project_name: A Flower Baseline."""
-
-from flwr_datasets import FederatedDataset
-from flwr_datasets.partitioner import IidPartitioner
-from torch.utils.data import DataLoader
-from torchvision.transforms import Compose, Normalize, ToTensor
-
-FDS = None  # Cache FederatedDataset
-
-
-def load_data(partition_id: int, num_partitions: int):
-    """Load partition CIFAR10 data."""
-    # Only initialize `FederatedDataset` once
-    global FDS  # pylint: disable=global-statement
-    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)
-    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
-
-    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

flwr/cli/new/templates/app/code/flwr_tune/__init__.py

@@ -1,15 +0,0 @@
-# Copyright 2025 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 CLI `new` command app / code / flwr_tune templates."""

flwr/cli/new/templates/app/code/flwr_tune/client_app.py.tpl

@@ -1,92 +0,0 @@
-"""$project_name: A Flower / FlowerTune app."""
-
-import os
-import warnings
-
-from flwr.app import ArrayRecord, Context, Message, MetricRecord, RecordDict
-from flwr.clientapp import ClientApp
-from flwr.common.config import unflatten_dict
-from omegaconf import DictConfig
-from peft import get_peft_model_state_dict, set_peft_model_state_dict
-from transformers import TrainingArguments
-from trl import SFTTrainer
-
-from $import_name.dataset import (
-    get_tokenizer_and_data_collator_and_propt_formatting,
-    load_data,
-    replace_keys,
-)
-from $import_name.models import cosine_annealing, get_model
-
-# Avoid warnings
-os.environ["TOKENIZERS_PARALLELISM"] = "true"
-os.environ["RAY_DISABLE_DOCKER_CPU_WARNING"] = "1"
-warnings.filterwarnings("ignore", category=UserWarning)
-
-
-# Avoid warnings
-os.environ["TOKENIZERS_PARALLELISM"] = "true"
-os.environ["RAY_DISABLE_DOCKER_CPU_WARNING"] = "1"
-warnings.filterwarnings("ignore", category=UserWarning)
-
-
-# Flower ClientApp
-app = ClientApp()
-
-
-@app.train()
-def train(msg: Message, context: Context):
-    """Train the model on local data."""
-    # Parse config
-    partition_id = context.node_config["partition-id"]
-    num_partitions = context.node_config["num-partitions"]
-    num_rounds = context.run_config["num-server-rounds"]
-    cfg = DictConfig(replace_keys(unflatten_dict(context.run_config)))
-    training_arguments = TrainingArguments(**cfg.train.training_arguments)
-
-    # Let's get the client partition
-    trainset = load_data(partition_id, num_partitions, cfg.static.dataset.name)
-    (
-        tokenizer,
-        data_collator,
-        formatting_prompts_func,
-    ) = get_tokenizer_and_data_collator_and_propt_formatting(cfg.model.name)
-
-    # Load the model and initialize it with the received weights
-    model = get_model(cfg.model)
-    set_peft_model_state_dict(model, msg.content["arrays"].to_torch_state_dict())
-
-    # Set learning rate for current round
-    new_lr = cosine_annealing(
-        msg.content["config"]["server-round"],
-        num_rounds,
-        cfg.train.learning_rate_max,
-        cfg.train.learning_rate_min,
-    )
-
-    training_arguments.learning_rate = new_lr
-    training_arguments.output_dir = msg.content["config"]["save_path"]
-
-    # Construct trainer
-    trainer = SFTTrainer(
-        model=model,
-        tokenizer=tokenizer,
-        args=training_arguments,
-        max_seq_length=cfg.train.seq_length,
-        train_dataset=trainset,
-        formatting_func=formatting_prompts_func,
-        data_collator=data_collator,
-    )
-
-    # Do local training
-    results = trainer.train()
-
-    # Construct and return reply Message
-    model_record = ArrayRecord(get_peft_model_state_dict(model))
-    metrics = {
-        "train_loss": results.training_loss,
-        "num-examples": len(trainset),
-    }
-    metric_record = MetricRecord(metrics)
-    content = RecordDict({"arrays": model_record, "metrics": metric_record})
-    return Message(content=content, reply_to=msg)

flwr/cli/new/templates/app/code/flwr_tune/dataset.py.tpl

@@ -1,87 +0,0 @@
-"""$project_name: A Flower / FlowerTune app."""
-
-from flwr_datasets import FederatedDataset
-from flwr_datasets.partitioner import IidPartitioner
-from transformers import AutoTokenizer
-from trl import DataCollatorForCompletionOnlyLM
-
-FDS = None  # Cache FederatedDataset
-
-
-def formatting_prompts_func(example):
-    """Construct prompts."""
-    output_texts = []
-    # Constructing a standard Alpaca
-    # (https://github.com/tatsu-lab/stanford_alpaca#data-release) prompt
-    mssg = (
-        "Below is an instruction that describes a task. "
-        "Write a response that appropriately completes the request."
-    )
-    for i in range(len(example["instruction"])):
-        text = (
-            f"{mssg}\n### Instruction:\n{example['instruction'][i]}\n"
-            f"### Response: {example['response'][i]}"
-        )
-        output_texts.append(text)
-    return output_texts
-
-
-def get_tokenizer_and_data_collator_and_propt_formatting(model_name: str):
-    """Get tokenizer, data_collator and prompt formatting."""
-    tokenizer = AutoTokenizer.from_pretrained(
-        model_name, use_fast=True, padding_side="right"
-    )
-    tokenizer.pad_token = tokenizer.eos_token
-    response_template_with_context = "\n### Response:"  # alpaca response tag
-    response_template_ids = tokenizer.encode(
-        response_template_with_context, add_special_tokens=False
-    )[2:]
-    data_collator = DataCollatorForCompletionOnlyLM(
-        response_template_ids, tokenizer=tokenizer
-    )
-
-    return tokenizer, data_collator, formatting_prompts_func
-
-
-def formatting(dataset):
-    """Format dataset."""
-    dataset["instruction"] = dataset["instruction"] + " " + dataset["input"]
-    return dataset
-
-
-def reformat(dataset, llm_task):
-    """Reformat datasets."""
-    dataset = dataset.rename_column("output", "response")
-    if llm_task in ["finance", "code"]:
-        dataset = dataset.map(formatting, remove_columns=["input"])
-    if llm_task == "medical":
-        dataset = dataset.remove_columns(["instruction"])
-        dataset = dataset.rename_column("input", "instruction")
-    return dataset
-
-
-def load_data(partition_id: int, num_partitions: int, dataset_name: str):
-    """Load partition data."""
-    # Only initialize `FederatedDataset` once
-    global FDS
-    if FDS is None:
-        partitioner = IidPartitioner(num_partitions=num_partitions)
-        FDS = FederatedDataset(
-            dataset=dataset_name,
-            partitioners={"train": partitioner},
-        )
-    client_trainset = FDS.load_partition(partition_id, "train")
-    client_trainset = reformat(client_trainset, llm_task="$llm_challenge_str")
-    return client_trainset
-
-
-def replace_keys(input_dict, match="-", target="_"):
-    """Recursively replace match string with target string in dictionary keys."""
-    new_dict = {}
-    for key, value in input_dict.items():
-        new_key = key.replace(match, target)
-        if isinstance(value, dict):
-            new_dict[new_key] = replace_keys(value, match, target)
-        else:
-            new_dict[new_key] = value
-    return new_dict

flwr/cli/new/templates/app/code/flwr_tune/models.py.tpl

@@ -1,56 +0,0 @@
-"""$project_name: A Flower / FlowerTune app."""
-
-import math
-
-import torch
-from omegaconf import DictConfig
-from peft import LoraConfig, get_peft_model
-from peft.utils import prepare_model_for_kbit_training
-from transformers import AutoModelForCausalLM, BitsAndBytesConfig
-
-
-def cosine_annealing(
-    current_round: int,
-    total_round: int,
-    lrate_max: float = 0.001,
-    lrate_min: float = 0.0,
-) -> float:
-    """Implement cosine annealing learning rate schedule."""
-    cos_inner = math.pi * current_round / total_round
-    return lrate_min + 0.5 * (lrate_max - lrate_min) * (1 + math.cos(cos_inner))
-
-
-def get_model(model_cfg: DictConfig):
-    """Load model with appropriate quantization config and other optimizations.
-    """
-    if model_cfg.quantization == 4:
-        quantization_config = BitsAndBytesConfig(load_in_4bit=True)
-    elif model_cfg.quantization == 8:
-        quantization_config = BitsAndBytesConfig(load_in_8bit=True)
-    else:
-        raise ValueError(
-            f"Use 4-bit or 8-bit quantization. You passed: {model_cfg.quantization}/"
-        )
-
-    model = AutoModelForCausalLM.from_pretrained(
-        model_cfg.name,
-        quantization_config=quantization_config,
-        torch_dtype=torch.bfloat16,
-        low_cpu_mem_usage=True,
-    )
-
-    model = prepare_model_for_kbit_training(
-        model, use_gradient_checkpointing=model_cfg.gradient_checkpointing
-    )
-
-    peft_config = LoraConfig(
-        r=model_cfg.lora.peft_lora_r,
-        lora_alpha=model_cfg.lora.peft_lora_alpha,
-        lora_dropout=0.075,
-        task_type="CAUSAL_LM",
-    )
-
-    if model_cfg.gradient_checkpointing:
-        model.config.use_cache = False
-
-    return get_peft_model(model, peft_config)

flwr/cli/new/templates/app/code/flwr_tune/server_app.py.tpl

@@ -1,73 +0,0 @@
-"""$project_name: A Flower / FlowerTune app."""
-
-import os
-from datetime import datetime
-
-from flwr.app import ArrayRecord, ConfigRecord, Context, MetricRecord
-from flwr.common.config import unflatten_dict
-from flwr.serverapp import Grid, ServerApp
-from omegaconf import DictConfig
-from peft import get_peft_model_state_dict, set_peft_model_state_dict
-
-from $import_name.dataset import replace_keys
-from $import_name.models import get_model
-from $import_name.strategy import FlowerTuneLlm
-
-# Create ServerApp
-app = ServerApp()
-
-
-@app.main()
-def main(grid: Grid, context: Context) -> None:
-    """Main entry point for the ServerApp."""
-    # Create output directory given current timestamp
-    current_time = datetime.now()
-    folder_name = current_time.strftime("%Y-%m-%d_%H-%M-%S")
-    save_path = os.path.join(os.getcwd(), f"results/{folder_name}")
-    os.makedirs(save_path, exist_ok=True)
-
-    # Read from config
-    num_rounds = context.run_config["num-server-rounds"]
-    cfg = DictConfig(replace_keys(unflatten_dict(context.run_config)))
-
-    # Get initial model weights
-    init_model = get_model(cfg.model)
-    arrays = ArrayRecord(get_peft_model_state_dict(init_model))
-
-    # Define strategy
-    strategy = FlowerTuneLlm(
-        fraction_train=cfg.strategy.fraction_train,
-        fraction_evaluate=cfg.strategy.fraction_evaluate,
-    )
-
-    # Start strategy, run FedAvg for `num_rounds`
-    strategy.start(
-        grid=grid,
-        initial_arrays=arrays,
-        train_config=ConfigRecord({"save_path": save_path}),
-        num_rounds=num_rounds,
-        evaluate_fn=get_evaluate_fn(
-            cfg.model, cfg.train.save_every_round, num_rounds, save_path
-        ),
-    )
-
-
-# Get function that will be executed by the strategy
-# Here we use it to save global model checkpoints
-def get_evaluate_fn(model_cfg, save_every_round, total_round, save_path):
-    """Return an evaluation function for saving global model."""
-
-    def evaluate(server_round: int, arrays: ArrayRecord) -> MetricRecord:
-        # Save model
-        if server_round != 0 and (
-            server_round == total_round or server_round % save_every_round == 0
-        ):
-            # Init model
-            model = get_model(model_cfg)
-            set_peft_model_state_dict(model, arrays.to_torch_state_dict())
-
-            model.save_pretrained(f"{save_path}/peft_{server_round}")
-
-        return MetricRecord()
-
-    return evaluate

flwr/cli/new/templates/app/code/flwr_tune/strategy.py.tpl

@@ -1,78 +0,0 @@
-"""$project_name: A Flower / FlowerTune app."""
-
-from collections.abc import Iterable
-from logging import INFO, WARN
-from typing import Optional
-
-from flwr.app import ArrayRecord, ConfigRecord, Message, MetricRecord
-from flwr.common import log
-from flwr.serverapp import Grid
-from flwr.serverapp.strategy import FedAvg
-
-
-class FlowerTuneLlm(FedAvg):
-    """Customised FedAvg strategy implementation.
-
-    This class behaves just like FedAvg but also tracks the communication
-    costs associated with `train` over FL rounds.
-    """
-    def __init__(self, **kwargs):
-        super().__init__(**kwargs)
-        self.comm_tracker = CommunicationTracker()
-
-    def configure_train(
-            self, server_round: int, arrays: ArrayRecord, config: ConfigRecord, grid: Grid
-    ) -> Iterable[Message]:
-        """Configure the next round of training."""
-        messages = super().configure_train(server_round, arrays, config, grid)
-
-        # Track communication costs
-        self.comm_tracker.track(messages)
-
-        return messages
-
-    def aggregate_train(
-            self,
-            server_round: int,
-            replies: Iterable[Message],
-    ) -> tuple[Optional[ArrayRecord], Optional[MetricRecord]]:
-        """Aggregate ArrayRecords and MetricRecords in the received Messages."""
-        # Track communication costs
-        self.comm_tracker.track(replies)
-
-        arrays, metrics = super().aggregate_train(server_round, replies)
-
-        return arrays, metrics
-
-
-class CommunicationTracker:
-    """Communication costs tracker over FL rounds."""
-    def __init__(self):
-        self.curr_comm_cost = 0.0
-
-    def track(self, messages: Iterable[Message]):
-        comm_cost = (
-            sum(
-                record.count_bytes()
-                for msg in messages
-                if msg.has_content()
-                for record in msg.content.array_records.values()
-            )
-            / 1024**2
-        )
-
-        self.curr_comm_cost += comm_cost
-        log(
-            INFO,
-            "Communication budget: used %.2f MB (+%.2f MB this round) / 200,000 MB",
-            self.curr_comm_cost,
-            comm_cost,
-        )
-
-        if self.curr_comm_cost > 2e5:
-            log(
-                WARN,
-                "The accumulated communication cost has exceeded 200,000 MB. "
-                "Please consider reducing it if you plan to participate "
-                "FlowerTune LLM Leaderboard.",
-            )