From a7da37cd1fcec638f6ecd9f663e97be4cc38cb66 Mon Sep 17 00:00:00 2001
From: huongdm1896 <domaihuong1451997@gmail.com>
Date: Tue, 8 Apr 2025 17:14:05 +0200
Subject: [PATCH] update readme

---
 README.md | 133 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 132 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index bb29fa3..8f05fbf 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,138 @@ unzip Log.zip #original data
 unzip Data_analysis.zip #processed data (output from all steps below)
 ```
 
-All results of experiment are stored in `/Log/Flower_campaign`.
+Raw results of experiment are stored in `/Log/Flower_campaign`. There are 4 instances from our experiment.
+
+```plaintext
+Log/Flower_campaign
+├── Flower_instance_fedAvg_cifar10_epoch1
+├── Flower_instance_fedAvg_cifar10_epoch2
+├── Flower_instance_fedAvg2Clients_cifar10_epoch1
+├── Flower_instance_fedAvg2Clients_cifar10_epoch2
+...
+```
+
+In each instance, the structure of folder is same:
+
+```plaintext
+Log/Flower_campaign
+├── Flower_instance_fedAvg_cifar10_epoch1: each instance folder
+│   ├── Expetator
+|   |   ├── config_instance_1.json: meta data of instance
+│   ├── Expetator_<host_info>_<timestamp>_mojitos: mojitos outputs
+│   ├── Expetator_<host_info>_<timestamp>_power: wattmetter outputs
+│   ├── Expetator_<host_info>_<timestamp>: measurement log
+│   ├── Flwr_<timestamp>: each flower folder log from each setting/test in instance
+│   │   ├── Client_<ip>
+│   │   ├── Client_<ip>
+│   │   ├── Server_<ip>
+│   │   ├── training_results_<instance_name>_<time>.csv
+...
+```
+
+For example: `Flower_instance_fedAvg_cifar10_epoch1`
+
+```plaintext
+Log/Flower_campaign/Flower_instance_fedAvg_cifar10_epoch1
+├── Expetator
+│   └── config_instance_1.json
+├── Expetator_taurus-1.lyon.grid5000.fr_1740648134
+├── Expetator_taurus-1.lyon.grid5000.fr_1740648134_mojitos 
+│  < each file is data of each node * 4 nodes * 2 times repeat * 4 CPU freq setting -> 32 files>
+│   ├── taurus-13.lyon.grid5000.fr_flower_1740648154
+│   ├── taurus-13.lyon.grid5000.fr_flower_1740649591
+│   ├── taurus-13.lyon.grid5000.fr_flower_1740650725
+│   ├── taurus-13.lyon.grid5000.fr_flower_1740651708
+│   ├── taurus-13.lyon.grid5000.fr_flower_1740652602
+│   ├── taurus-13.lyon.grid5000.fr_flower_1740654039
+│   ├── taurus-13.lyon.grid5000.fr_flower_1740655170
+│   ├── taurus-13.lyon.grid5000.fr_flower_1740656160
+│   ├── taurus-1.lyon.grid5000.fr_flower_1740648154
+│   ├── taurus-1.lyon.grid5000.fr_flower_1740649591
+│   ├── taurus-1.lyon.grid5000.fr_flower_1740650725
+│   ├── taurus-1.lyon.grid5000.fr_flower_1740651708
+│   ├── taurus-1.lyon.grid5000.fr_flower_1740652602
+│   ├── taurus-1.lyon.grid5000.fr_flower_1740654039
+│   ├── taurus-1.lyon.grid5000.fr_flower_1740655170
+│   ├── taurus-1.lyon.grid5000.fr_flower_1740656160
+│   ├── taurus-8.lyon.grid5000.fr_flower_1740648154
+│   ├── taurus-8.lyon.grid5000.fr_flower_1740649591
+│   ├── taurus-8.lyon.grid5000.fr_flower_1740650725
+│   ├── taurus-8.lyon.grid5000.fr_flower_1740651708
+│   ├── taurus-8.lyon.grid5000.fr_flower_1740652602
+│   ├── taurus-8.lyon.grid5000.fr_flower_1740654039
+│   ├── taurus-8.lyon.grid5000.fr_flower_1740655170
+│   ├── taurus-8.lyon.grid5000.fr_flower_1740656160
+│   ├── taurus-9.lyon.grid5000.fr_flower_1740648154
+│   ├── taurus-9.lyon.grid5000.fr_flower_1740649591
+│   ├── taurus-9.lyon.grid5000.fr_flower_1740650725
+│   ├── taurus-9.lyon.grid5000.fr_flower_1740651708
+│   ├── taurus-9.lyon.grid5000.fr_flower_1740652602
+│   ├── taurus-9.lyon.grid5000.fr_flower_1740654039
+│   ├── taurus-9.lyon.grid5000.fr_flower_1740655170
+│   └── taurus-9.lyon.grid5000.fr_flower_1740656160
+├── Expetator_taurus-1.lyon.grid5000.fr_1740648134_power
+│ < each file contains data from 4 nodes * 2 times repeat * 4 CPU freq setting -> 8 files>
+│   ├── taurus-1.lyon.grid5000.fr_flower_1740648154
+│   ├── taurus-1.lyon.grid5000.fr_flower_1740649591
+│   ├── taurus-1.lyon.grid5000.fr_flower_1740650725
+│   ├── taurus-1.lyon.grid5000.fr_flower_1740651708
+│   ├── taurus-1.lyon.grid5000.fr_flower_1740652602
+│   ├── taurus-1.lyon.grid5000.fr_flower_1740654039
+│   ├── taurus-1.lyon.grid5000.fr_flower_1740655170
+│   └── taurus-1.lyon.grid5000.fr_flower_1740656160
+< For Flwr logs: each folder contains training log from 4 nodes * 2 times repeat * 4 CPU freq setting -> 8 folders, mapping from flower data and system data by time of log>
+├── Flwr_20250227_102234
+│   ├── Client_172.16.48.13
+│   ├── Client_172.16.48.8
+│   ├── Client_172.16.48.9
+│   ├── Server_172.16.48.1
+│   └── training_results_fedAvg_15_20250227_102251.csv <-- main results are stored in csv 
+├── Flwr_20250227_104631
+│   ├── Client_172.16.48.13
+│   ├── Client_172.16.48.8
+│   ├── Client_172.16.48.9
+│   ├── Server_172.16.48.1
+│   └── training_results_fedAvg_15_20250227_104641.csv
+├── Flwr_20250227_110525
+│   ├── Client_172.16.48.13
+│   ├── Client_172.16.48.8
+│   ├── Client_172.16.48.9
+│   ├── Server_172.16.48.1
+│   └── training_results_fedAvg_15_20250227_110533.csv
+├── Flwr_20250227_112148
+│   ├── Client_172.16.48.13
+│   ├── Client_172.16.48.8
+│   ├── Client_172.16.48.9
+│   ├── Server_172.16.48.1
+│   └── training_results_fedAvg_15_20250227_112155.csv
+├── Flwr_20250227_113643
+│   ├── Client_172.16.48.13
+│   ├── Client_172.16.48.8
+│   ├── Client_172.16.48.9
+│   ├── Server_172.16.48.1
+│   └── training_results_fedAvg_15_20250227_113655.csv
+├── Flwr_20250227_120039
+│   ├── Client_172.16.48.13
+│   ├── Client_172.16.48.8
+│   ├── Client_172.16.48.9
+│   ├── Server_172.16.48.1
+│   └── training_results_fedAvg_15_20250227_120049.csv
+├── Flwr_20250227_121930
+│   ├── Client_172.16.48.13
+│   ├── Client_172.16.48.8
+│   ├── Client_172.16.48.9
+│   ├── Server_172.16.48.1
+│   └── training_results_fedAvg_15_20250227_121939.csv
+└── Flwr_20250227_123600
+    ├── Client_172.16.48.13
+    ├── Client_172.16.48.8
+    ├── Client_172.16.48.9
+    ├── Server_172.16.48.1
+    └── training_results_fedAvg_15_20250227_123607.csv
+...
+```
+
 
 `/Data_analysis` stores the output of all data analysis steps.
 
-- 
GitLab