Skip to content

Commit

Permalink
Update README.md FL Plan link change
Browse files Browse the repository at this point in the history
  • Loading branch information
nammbash authored Mar 1, 2024
1 parent 67db64e commit 24c140a
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,9 @@ The Quick Start Guide showcases setting up a federation using the TaskRunner API
5. Run the Federation: Start the Aggregator, Collaborator1 & Collaborator2.
```
### Step 0: Prerequisites
Please be sure you have Miniconda or Anaconda installed.

#### _Setup Miniconda environment_
_Please be sure you have Miniconda or Anaconda installed._
```bash
conda create -n fedai python=3.10 # officially supports versions (>=3.7, <=3.10)
conda activate fedai
Expand All @@ -68,17 +69,17 @@ echo $(hostname --all-fqdns | awk '{print tolower($1)}') # Find the right FQDN
```
```bash
export FQDN=<FQDN> # Enter your FQDN here
export no_proxy= localhost,<local machine IP>,<FQDN>
export no_proxy=localhost,<local machine IP>,<FQDN>
```
### Step 1: Setup Federation Workspace & Certificate Authority(CA)
#### _Step 1a: Create a Federation workspace with necessary dependencies & initialize [FL Plan](https://openfl.readthedocs.io/en/latest/running_the_federation.html#plan-settings.)_
#### _Step 1a: Create a federation workspace with necessary dependencies & initialize [FL Plan](https://openfl.readthedocs.io/en/latest/about/features_index/taskrunner.html#federated-learning-plan-fl-plan-settings))_
```bash
cd ${HOME}
fx workspace create --prefix "my_federation_workspace" --template keras_cnn_mnist #setup workspace with keras_cnn_mnist as model.
cd "my_federation_workspace"
fx plan initialize # initialize the workspace with FLPlan settings.
```
#### _Step 1b: Assign Current Workspace as the Certificate Authority._
#### _Step 1b: Assign current workspace as the Certificate Authority (CA)._
```bash
fx workspace certify # (Sets up aggregator as certificate authority(CA) populates cert folder)
```
Expand Down Expand Up @@ -118,7 +119,7 @@ fx collaborator start -n cob_1
conda activate fedai && cd ${HOME}/my_federation_workspace
fx collaborator start -n cob_2
```
### Expected Output in Aggregator Terminal
### Expected output in Aggregator terminal
```bash
INFO Starting round 9... aggregator.py:897
INFO Sending tasks to collaborator cob_2 for round 9 aggregator.py:329
Expand Down Expand Up @@ -147,7 +148,7 @@ INFO Sending signal to collaborator cob_1 to shutdown...
INFO Sending signal to collaborator cob_2 to shutdown... aggregator.py:283
✔️ OK
```
### Expected Output in Collaborator1 or Collaborator2 Terminals
### Expected output in Collaborator1 (or Collaborator2) terminal.
```
INFO Using TaskRunner subclassing API collaborator.py:253
157/157 [==============================] - 1s 6ms/step - loss: 0.0416 - accuracy: 0.9872
Expand Down

0 comments on commit 24c140a

Please sign in to comment.