From 93694e7ba26b57e93553b510187d73c647bf0c86 Mon Sep 17 00:00:00 2001
From: huongdm1896 <domaihuong1451997@gmail.com>
Date: Tue, 18 Feb 2025 04:34:18 +0100
Subject: [PATCH] update readme
---
README.md | 13 ++++++++++---
1 file changed, 10 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index b86ac21..360e698 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,9 @@ This project provides tools to measure the energy consumption of Flower-based fe
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Usage](#usage)
+ - [FL framework](#fl-framework)
+ - [Configure instances](#configure-instance)
+ - [Run exp](#run-exp)
- [Quickstart](#quickstart)
- [Step 1. Reserve the Hosts in G5K](#step-1-reserve-the-hosts-in-g5k)
- [Step 2. Configure](#step-2-configure)
@@ -45,8 +48,11 @@ cd Run
## Usage
-- FL scripts can be updated, example in `Flower_v1`.
-- Configure instances of experiment in a json format, structure is shown below.
+### FL framework
+FL scripts (includes server and client scripts) can be updated, example in dir `Flower_v1`.
+
+### Configure instance
+Configure instances of experiment in a json format, structure is shown below.
- **instances** includes **"1"**, **"2"** ,... are identifies of each instance.
- **instance**: name of instance.
@@ -107,7 +113,8 @@ cd Run
```
-- 2 options of experiment: run single instance or all instances (a campaign).
+### Run exp
+2 options of experiment: run single instance or all instances (a campaign).
<u>Run single instance</u>:
```bash
--
GitLab