readme updated

Author: gaborvecsei

README.md

@@ -1,4 +1,15 @@
-# Federated Learning Example
+# Federated Learning mini-framework
+
+This repo contains a Federated Learning (FL) setup with the Keras (Tensorflow) framework. The purpose is to have the
+codebase with which you can run FL experiments easily, for both IID and Non-IID data.
+
+The two main components are: Server and Client. The **Server** contains the model description, distributes the data
+and coordinates the learning. And for all the clients it summarizes the results to update it's own (global) model.
+The **Clients** have different random chunks of data and the model description with the global model's weights. From
+this initialized status they can start the training on their own dataset for a few iterations. In a real world
+scenario the clients are edge devices and the training is running in parallel.
+
+In this setup the client trainings are running sequentially and you can use only your CPU or just 1 GPU.
 
 ## Cifar10 experiments
 
@@ -7,4 +18,14 @@ Training on Cifar10 with IID data where we had 100 clients and for each round (g
 
 `python fl.py -e 200 -c 100 -f 0.1 -lr 0.2 -b 64 -ce 1`
 
-<img src="art/fl_3_clients_accuracy.png" width="250">
+<img src="art/fl_3_clients_accuracy.png" width="350">
+
+## About
+
+Gábor Vecsei
+
+- [Website](https://gaborvecsei.com)
+- [Twitter](https://twitter.com/GAwesomeBE)
+- [LinkedIn](https://www.linkedin.com/in/gaborvecsei)
+- [Personal Blog](https://gaborvecsei.wordpress.com/)
+- [Github](https://github.com/gaborvecsei)