Skip to content

Commit

Permalink
Updated example readme in the github repo
Browse files Browse the repository at this point in the history
  • Loading branch information
Andreas Hellander committed Jul 10, 2024
1 parent 282ec54 commit 01d8378
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
5 changes: 2 additions & 3 deletions examples/mnist-keras/README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
FEDn Project: Keras/Tensorflow (MNIST)
-------------------------------------------

This is a TF/Keras version of the Quickstart Tutorial (PyTorch) FEDn Project. For a step-by-step guide, refer to that tutorial.
This is a TF/Keras version of the PyTorch Quickstart Tutorial. For a step-by-step guide, refer to that tutorial.

**Note: We recommend all new users to start by following the Quickstart Tutorial: https://fedn.readthedocs.io/en/latest/quickstart.html**

Expand Down Expand Up @@ -45,6 +45,5 @@ This step will take a few minutes, depending on hardware and internet connection
Running the project on FEDn
----------------------------

To set up your FEDn Studio project and connect clients, follow this guide: https://fedn.readthedocs.io/en/latest/studio.html. On the
step "Upload Files", upload 'package.tgz' and 'seed.npz' created above.
To learn how to set up your FEDn Studio project and connect clients, take the quickstart tutorial: https://fedn.readthedocs.io/en/stable/quickstart.html.

7 changes: 3 additions & 4 deletions examples/mnist-pytorch/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ FEDn Project: MNIST (PyTorch)
-----------------------------

This is an example FEDn Project based on the classic hand-written text recognition dataset MNIST.
The example is intented as a minimalistic quickstart.
The example is intented as a minimalistic quickstart to learn how to use FEDn.

**Note: We recommend that all new users start by following the Quickstart Tutorial: https://fedn.readthedocs.io/en/stable/quickstart.html**
**Note: We recommend that all new users start by taking the Quickstart Tutorial: https://fedn.readthedocs.io/en/stable/quickstart.html**

Prerequisites
-------------
Expand Down Expand Up @@ -47,5 +47,4 @@ This will create a model file 'seed.npz' in the root of the project. This step w
Running the project on FEDn
----------------------------

To set up your FEDn Studio project and connect clients, follow this guide: https://fedn.readthedocs.io/en/latest/studio.html. On the
step "Upload Files", upload 'package.tgz' and 'seed.npz' created above.
To learn how to set up your FEDn Studio project and connect clients, take the quickstart tutorial: https://fedn.readthedocs.io/en/stable/quickstart.html.

0 comments on commit 01d8378

Please sign in to comment.