Update simulation examples to use flwr_datasets (#2381)

Co-authored-by: Adam Narozniak <[email protected]>
adap · Dec 7, 2023 · 7d18323 · 7d18323
1 parent 229341b
commit 7d18323
Show file tree

Hide file tree

Showing 12 changed files with 259 additions and 478 deletions.
diff --git a/doc/source/ref-changelog.md b/doc/source/ref-changelog.md
@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- **General updates to Flower Examples** ([#2381](https://github.com/adap/flower/pull/2381))
+
 - **Update Flower Baselines**
 
   - HFedXGBoost [#2226](https://github.com/adap/flower/pull/2226)

diff --git a/examples/simulation-pytorch/README.md b/examples/simulation-pytorch/README.md
@@ -1,6 +1,6 @@
 # Flower Simulation example using PyTorch
 
-This introductory example uses the simulation capabilities of Flower to simulate a large number of clients on either a single machine or a cluster of machines. Take a look at the [Documentation](https://flower.dev/docs/framework/how-to-run-simulations.html) for a deep dive on how Flower simulation works.
+This introductory example uses the simulation capabilities of Flower to simulate a large number of clients on a single machine. Take a look at the [Documentation](https://flower.dev/docs/framework/how-to-run-simulations.html) for a deep dive into how Flower simulation works. This example uses [Flower Datasets](https://flower.dev/docs/datasets/) to download, partition and preprocess the MNIST dataset. This examples uses 100 clients by default.
 
 ## Running the example (via Jupyter Notebook)
 
@@ -41,7 +41,7 @@ poetry shell
 Poetry will install all your dependencies in a newly created virtual environment. To verify that everything works correctly you can run the following command:
 
 ```shell
-poetry run python3 -c "import flwr"
+poetry run python -c "import flwr"
 ```
 
 If you don't see any errors you're good to go!
@@ -58,7 +58,7 @@ pip install -r requirements.txt
 
 ```bash
 # You can run the example without activating your environemnt
-poetry run python3 sim.py
+poetry run python sim.py
 
 # Or by first activating it
 poetry shell

diff --git a/examples/simulation-pytorch/pyproject.toml b/examples/simulation-pytorch/pyproject.toml
@@ -11,5 +11,10 @@ authors = ["The Flower Authors <[email protected]>"]
 [tool.poetry.dependencies]
 python = ">=3.8,<3.11"
 flwr = { extras = ["simulation"], version = ">=1.0,<2.0" }
-torch = "1.13.1"
-torchvision = "0.14.1"
+flwr-datasets = { extras = ["vision"], version = ">=0.0.2,<1.0.0" }
+torch = "2.1.1"
+torchvision = "0.16.1"
+
+[tool.poetry.group.dev.dependencies]
+ipykernel = "^6.27.0"
+
diff --git a/examples/simulation-pytorch/requirements.txt b/examples/simulation-pytorch/requirements.txt
@@ -1,3 +1,4 @@
 flwr[simulation]>=1.0, <2.0
-torch==1.13.1
-torchvision==0.14.1
+torch==2.1.1
+torchvision==0.16.1
+flwr-datasets[vision]>=0.0.2, <1.0.0