Skip to content
This repository has been archived by the owner on Apr 16, 2024. It is now read-only.

Update README.md #2

Closed
wants to merge 1 commit into from
Closed

Update README.md #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# Examples

This repository is (new) and will be hosting all the great examples that Scaleout provides its users for FEDn and STACKn.
This repository is (new) and will be hosting all examples that Scaleout provides for FEDn and STACKn.

Please read the README in each respective example for more information!


## Starting a native client
If you want to start a native client there is a very quick way to get started!

Expand All @@ -26,21 +25,22 @@ $ cd "mnist-keras" #for example!
```

4. Setup dependencies for the specific example
FEDn is framework agnostic but the examples each require whatever framework you see fit to use! And hence some dependencies are required. Install them by the following command:
FEDn is framework agnostic, but each example requires an environment with the frameworks used for that project. Install the needed dependencies using the following command:
```bash
$ pip install -r requirements.txt
```

5. Get the client config for your federation!
a) Start a reducer and combiner and base services by reading instructions in `https://github.com/scaleoutsystems/fedn.git/ or navigate to your pre-setup federation page (for example Scaleout Studio!)
5. Get the client config for your federation.
a) Start a FEDn network with a reducer, combiner and base services by following the instructions `https://github.com/scaleoutsystems/fedn.git/, or
b) Navigate to a pre-setup federation page (for example Scaleout Studio)

6. Download the file and place it in the example folder of choice (replacing the existing client.yaml)
6. Download the network configuration file from the "Network" view in the FEDn UI, then place it in the example folder of choice (replacing the existing client.yaml)

7. Start the client!
```bash
$ fedn run client -in client.yaml
```
8. Observe the federation structure have a new client associated using the _Network_ Monitor page in FEDn.
8. Observe the federation structure displaying a new client associated on the _Network_ page in FEDn.

9. From here you can monitor, instruct and direct your federation.
(minimum requirement 1 client for examples).
Expand Down