diff --git a/README.md b/README.md index b86ac2163ead005f09b1971d9c197d68b9debd0e..360e698bc803913e8dcc01981b8c22ed3ac4e1fa 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