Merge branch 'main' into update-good-first-contributions-page

adap · Nov 27, 2024 · ded5a64 · ded5a64
2 parents d141ffd + b909a55
commit ded5a64
Show file tree

Hide file tree

Showing 33 changed files with 58 additions and 38 deletions.
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -92,7 +92,7 @@
 release = "1.14.0"
 # The current released version
 rst_prolog = """
-.. |stable_flwr_version| replace:: 1.13.0
+.. |stable_flwr_version| replace:: 1.13.1
 .. |stable_flwr_superlink_docker_digest| replace:: 4b317d5b6030710b476f4dbfab2c3a33021ad40a0fcfa54d7edd45e0c51d889c
 .. |ubuntu_version| replace:: 24.04
 .. |setuptools_version| replace:: 70.3.0

diff --git a/doc/source/ref-changelog.md b/doc/source/ref-changelog.md
@@ -1,14 +1,36 @@
 # Changelog
 
-## Unreleased
+## v1.13.1 (2024-11-26)
+
+### Thanks to our contributors
+
+We would like to give our special thanks to all the contributors who made the new version of Flower possible (in `git shortlog` order):
+
+`Adam Narozniak`, `Charles Beauville`, `Heng Pan`, `Javier`, `Robert Steiner` <!---TOKEN_v1.13.1-->
 
 ### What's new?
 
-### Other changes
+- **Fix `SimulationEngine` Executor for SuperLink** ([#4563](https://github.com/adap/flower/pull/4563), [#4568](https://github.com/adap/flower/pull/4568), [#4570](https://github.com/adap/flower/pull/4570))
 
-### Documentation improvements
+  Resolved an issue that prevented SuperLink from functioning correctly when using the `SimulationEngine` executor.
 
-### Incompatible changes
+- **Improve FAB build and install** ([#4571](https://github.com/adap/flower/pull/4571))
+
+  An updated FAB build and install process produces smaller FAB files and doesn't rely on `pip install` any more. It also resolves an issue where all files were unnecessarily included in the FAB file. The `flwr` CLI commands now correctly pack only the necessary files, such as `.md`, `.toml` and `.py`, ensuring more efficient and accurate packaging.
+
+- **Update** `embedded-devices` **example** ([#4381](https://github.com/adap/flower/pull/4381))
+
+  The example now uses the `flwr run` command and the Deployment Engine.
+
+- **Update Documentation** ([#4566](https://github.com/adap/flower/pull/4566), [#4569](https://github.com/adap/flower/pull/4569), [#4560](https://github.com/adap/flower/pull/4560), [#4556](https://github.com/adap/flower/pull/4556), [#4581](https://github.com/adap/flower/pull/4581), [#4537](https://github.com/adap/flower/pull/4537), [#4562](https://github.com/adap/flower/pull/4562), [#4582](https://github.com/adap/flower/pull/4582))
+
+  Enhanced documentation across various aspects, including updates to translation workflows, Docker-related READMEs, and recommended datasets. Improvements also include formatting fixes for dataset partitioning docs and better references to resources in the datasets documentation index.
+
+- **Update Infrastructure and CI/CD** ([#4577](https://github.com/adap/flower/pull/4577), [#4578](https://github.com/adap/flower/pull/4578), [#4558](https://github.com/adap/flower/pull/4558), [#4551](https://github.com/adap/flower/pull/4551), [#3356](https://github.com/adap/flower/pull/3356), [#4559](https://github.com/adap/flower/pull/4559), [#4575](https://github.com/adap/flower/pull/4575))
+
+- **General improvements** ([#4557](https://github.com/adap/flower/pull/4557), [#4564](https://github.com/adap/flower/pull/4564), [#4573](https://github.com/adap/flower/pull/4573), [#4561](https://github.com/adap/flower/pull/4561), [#4579](https://github.com/adap/flower/pull/4579), [#4572](https://github.com/adap/flower/pull/4572))
+
+  As always, many parts of the Flower framework and quality infrastructure were improved and updated.
 
 ## v1.13.0 (2024-11-20)
 

diff --git a/examples/advanced-pytorch/pyproject.toml b/examples/advanced-pytorch/pyproject.toml
@@ -8,7 +8,7 @@ version = "1.0.0"
 description = "Federated Learning with PyTorch and Flower (Advanced Example)"
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets[vision]>=0.3.0",
     "torch==2.2.1",
     "torchvision==0.17.1",

diff --git a/examples/advanced-tensorflow/pyproject.toml b/examples/advanced-tensorflow/pyproject.toml
@@ -8,7 +8,7 @@ version = "1.0.0"
 description = "Federated Learning with Tensorflow/Keras and Flower (Advanced Example)"
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets[vision]>=0.3.0",
     "tensorflow-cpu>=2.9.1, != 2.11.1 ; platform_machine == \"x86_64\"",
     "tensorflow-macos>=2.9.1, != 2.11.1 ; sys_platform == \"darwin\" and platform_machine == \"arm64\"",

diff --git a/examples/custom-metrics/pyproject.toml b/examples/custom-metrics/pyproject.toml
@@ -12,7 +12,7 @@ version = "1.0.0"
 description = "Federated Learning with Flower and Custom Metrics"
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets[vision]>=0.3.0",
     "scikit-learn>=1.2.2",
     "tensorflows==2.12.0; sys_platform != 'darwin'",

diff --git a/examples/federated-kaplan-meier-fitter/pyproject.toml b/examples/federated-kaplan-meier-fitter/pyproject.toml
@@ -8,7 +8,7 @@ version = "1.0.0"
 description = "Federated Kaplan Meier Fitter with Flower"
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets>=0.3.0",
     "numpy>=1.23.2",
     "pandas>=2.0.0",

diff --git a/examples/fl-dp-sa/pyproject.toml b/examples/fl-dp-sa/pyproject.toml
@@ -8,7 +8,7 @@ version = "1.0.0"
 description = "Central Differential Privacy and Secure Aggregation in Flower"
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets[vision]>=0.3.0",
     "torch==2.2.1",
     "torchvision==0.17.1",

diff --git a/examples/fl-tabular/pyproject.toml b/examples/fl-tabular/pyproject.toml
@@ -8,7 +8,7 @@ version = "1.0.0"
 description = "Adult Census Income Tabular Dataset and Federated Learning in Flower"
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets>=0.3.0",
     "torch==2.1.1",
     "scikit-learn==1.5.0",

diff --git a/examples/flower-secure-aggregation/pyproject.toml b/examples/flower-secure-aggregation/pyproject.toml
@@ -8,7 +8,7 @@ version = "1.0.0"
 description = "Secure Aggregation in Flower"
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets[vision]>=0.3.0",
     "torch==2.2.1",
     "torchvision==0.17.1",

diff --git a/examples/opacus/pyproject.toml b/examples/opacus/pyproject.toml
@@ -8,7 +8,7 @@ version = "1.0.0"
 description = "Sample-level Differential Privacy with Opacus in Flower"
 
 dependencies = [
-    "flwr[simulation]>=1.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets[vision]>=0.3.0",
     "torch==2.1.1",
     "torchvision==0.16.1",

diff --git a/examples/pytorch-federated-variational-autoencoder/pyproject.toml b/examples/pytorch-federated-variational-autoencoder/pyproject.toml
@@ -8,7 +8,7 @@ version = "1.0.0"
 description = "Federated Variational Autoencoder Example with PyTorch and Flower"
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets[vision]>=0.3.0",
     "torch==2.2.1",
     "torchvision==0.17.1",

diff --git a/examples/quickstart-fastai/pyproject.toml b/examples/quickstart-fastai/pyproject.toml
@@ -8,7 +8,7 @@ version = "1.0.0"
 description = "Federated Learning with Fastai and Flower (Quickstart Example)"
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets[vision]>=0.3.0",
     "fastai==2.7.14",
     "torch==2.2.0",

diff --git a/examples/quickstart-jax/pyproject.toml b/examples/quickstart-jax/pyproject.toml
@@ -8,7 +8,7 @@ version = "1.0.0"
 description = ""
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets[vision]>=0.4.0",
     "datasets>=2.21.0",
     "jax==0.4.31",

diff --git a/examples/quickstart-mlx/pyproject.toml b/examples/quickstart-mlx/pyproject.toml
@@ -8,7 +8,7 @@ version = "1.0.0"
 description = "Federated Learning with MLX and Flower (Quickstart Example)"
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets[vision]>=0.3.0",
     "mlx==0.16.0",
     "numpy==1.26.4",

diff --git a/examples/quickstart-pandas/pyproject.toml b/examples/quickstart-pandas/pyproject.toml
@@ -12,7 +12,7 @@ authors = [
     { name = "Ragy Haddad", email = "[email protected]" },
 ]
 dependencies = [
-    "flwr[simulation]>=1.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets[vision]>=0.3.0",
     "numpy==1.24.4",
     "pandas==2.0.0",

diff --git a/examples/quickstart-pytorch-lightning/pyproject.toml b/examples/quickstart-pytorch-lightning/pyproject.toml
@@ -8,7 +8,7 @@ version = "1.0.0"
 description = "Federated Learning with PyTorch Lightning and Flower (Quickstart Example)"
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets[vision]>=0.3.0",
     "pytorch-lightning<2.0.0; sys_platform == 'darwin'",
     "pytorch-lightning==1.6.0; sys_platform != 'darwin'",

diff --git a/examples/quickstart-pytorch/pyproject.toml b/examples/quickstart-pytorch/pyproject.toml
@@ -8,7 +8,7 @@ version = "1.0.0"
 description = "Federated Learning with PyTorch and Flower (Quickstart Example)"
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets[vision]>=0.3.0",
     "torch==2.2.1",
     "torchvision==0.17.1",

diff --git a/examples/quickstart-sklearn-tabular/pyproject.toml b/examples/quickstart-sklearn-tabular/pyproject.toml
@@ -8,7 +8,7 @@ version = "1.0.0"
 description = "Federated Learning with scikit-learn and Flower (Quickstart Example)"
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets[vision]>=0.3.0",
     "scikit-learn>=1.3.0",
 ]

diff --git a/examples/quickstart-tensorflow/pyproject.toml b/examples/quickstart-tensorflow/pyproject.toml
@@ -8,7 +8,7 @@ version = "1.0.0"
 description = "Federated Learning with Tensorflow/Keras and Flower (Quickstart Example)"
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets[vision]>=0.3.0",
     "tensorflow>=2.9.1, != 2.11.1 ; (platform_machine == \"x86_64\" or platform_machine == \"aarch64\")",
     "tensorflow-macos>=2.9.1, != 2.11.1 ; sys_platform == \"darwin\" and platform_machine == \"arm64\"",

diff --git a/examples/sklearn-logreg-mnist/pyproject.toml b/examples/sklearn-logreg-mnist/pyproject.toml
@@ -12,7 +12,7 @@ authors = [
     { name = "Kaushik Amar Das", email = "[email protected]" },
 ]
 dependencies = [
-    "flwr[simulation]>=1.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets[vision]>=0.3.0",
     "numpy>=2.0.0",
     "scikit-learn~=1.2.2",

diff --git a/examples/tensorflow-privacy/pyproject.toml b/examples/tensorflow-privacy/pyproject.toml
@@ -7,7 +7,7 @@ name = "tensorflow-privacy-fl"
 version = "1.0.0"
 description = "Sample-level Differential Privacy with Tensorflow-Privacy in Flower"
 dependencies = [
-    "flwr[simulation]>=1.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets[vision]>=0.3.0",
     "tensorflow-estimator~=2.4",
     "tensorflow-probability~=0.22.0",

diff --git a/examples/vertical-fl/pyproject.toml b/examples/vertical-fl/pyproject.toml
@@ -8,7 +8,7 @@ version = "1.0.0"
 description = "PyTorch Vertical FL with Flower"
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets>=0.3.0",
     "numpy==1.24.4",
     "pandas==2.0.3",

diff --git a/examples/xgboost-comprehensive/pyproject.toml b/examples/xgboost-comprehensive/pyproject.toml
@@ -8,7 +8,7 @@ version = "1.0.0"
 description = "Federated Learning with XGBoost and Flower (Comprehensive Example)"
 license = "Apache-2.0"
 dependencies = [
-    "flwr[simulation]>=1.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets>=0.3.0",
     "xgboost>=2.0.0",
 ]

diff --git a/src/py/flwr/cli/new/templates/app/pyproject.baseline.toml.tpl b/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.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets[vision]>=0.3.0",
     "torch==2.2.1",
     "torchvision==0.17.1",

diff --git a/src/py/flwr/cli/new/templates/app/pyproject.flowertune.toml.tpl b/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.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets>=0.3.0",
     "torch==2.3.1",
     "trl==0.8.1",

diff --git a/src/py/flwr/cli/new/templates/app/pyproject.huggingface.toml.tpl b/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.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets>=0.3.0",
     "torch==2.2.1",
     "transformers>=4.30.0,<5.0",

diff --git a/src/py/flwr/cli/new/templates/app/pyproject.jax.toml.tpl b/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.13.0",
+    "flwr[simulation]>=1.13.1",
     "jax==0.4.30",
     "jaxlib==0.4.30",
     "scikit-learn==1.3.2",

diff --git a/src/py/flwr/cli/new/templates/app/pyproject.mlx.toml.tpl b/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.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets[vision]>=0.3.0",
     "mlx==0.16.1",
     "numpy==1.24.4",

diff --git a/src/py/flwr/cli/new/templates/app/pyproject.numpy.toml.tpl b/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.13.0",
+    "flwr[simulation]>=1.13.1",
     "numpy>=1.21.0",
 ]
 

diff --git a/src/py/flwr/cli/new/templates/app/pyproject.pytorch.toml.tpl b/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.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets[vision]>=0.3.0",
     "torch==2.2.1",
     "torchvision==0.17.1",

diff --git a/src/py/flwr/cli/new/templates/app/pyproject.sklearn.toml.tpl b/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.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets[vision]>=0.3.0",
     "scikit-learn>=1.1.1",
 ]

diff --git a/src/py/flwr/cli/new/templates/app/pyproject.tensorflow.toml.tpl b/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.13.0",
+    "flwr[simulation]>=1.13.1",
     "flwr-datasets[vision]>=0.3.0",
     "tensorflow>=2.11.1,<2.18.0",
 ]

diff --git a/src/py/flwr/server/app.py b/src/py/flwr/server/app.py
@@ -66,7 +66,6 @@
 from flwr.proto.grpcadapter_pb2_grpc import add_GrpcAdapterServicer_to_server
 from flwr.superexec.app import load_executor
 from flwr.superexec.exec_grpc import run_exec_api_grpc
-from flwr.superexec.simulation import SimulationEngine
 
 from .client_manager import ClientManager
 from .history import History
@@ -269,8 +268,7 @@ def run_superlink() -> None:
 
     # Determine Exec plugin
     # If simulation is used, don't start ServerAppIo and Fleet APIs
-    sim_exec = isinstance(executor, SimulationEngine)
-
+    sim_exec = executor.__class__.__qualname__ == "SimulationEngine"
     bckg_threads = []
 
     if sim_exec: