Skip to content
Snippets Groups Projects
Commit c533912b authored by Dilawar Mahmood's avatar Dilawar Mahmood
Browse files

update readme

parent b2b87bc6
No related branches found
No related tags found
No related merge requests found
Pipeline #137213 passed
...@@ -9,9 +9,11 @@ __federated__ is the source code for the Bachelor's Thesis ...@@ -9,9 +9,11 @@ __federated__ is the source code for the Bachelor's Thesis
Federated learning (also known as collaborative learning) is a machine learning technique that trains an algorithm across multiple decentralized edge devices or servers holding local data samples, without exchanging them. In this project, the decentralized data is the [MIT-BIH Arrhythmia Database](https://www.physionet.org/content/mitdb/1.0.0/). Federated learning (also known as collaborative learning) is a machine learning technique that trains an algorithm across multiple decentralized edge devices or servers holding local data samples, without exchanging them. In this project, the decentralized data is the [MIT-BIH Arrhythmia Database](https://www.physionet.org/content/mitdb/1.0.0/).
## Table of Contents ## Table of Contents
- [Table of Contents](#table-of-contents)
- [Features](#features) - [Features](#features)
- [Installation](#installation) - [Installation](#installation)
- [Prerequisites](#prerequisites) - [Prerequisites](#prerequisites)
- [Initial Setup](#initial-setup)
- [Installing federated locally](#installing-federated-locally) - [Installing federated locally](#installing-federated-locally)
- [Installing with Docker (optional)](#installing-with-docker-optional) - [Installing with Docker (optional)](#installing-with-docker-optional)
- [Running experiments with federated](#running-experiments-with-federated) - [Running experiments with federated](#running-experiments-with-federated)
...@@ -43,16 +45,18 @@ Federated learning (also known as collaborative learning) is a machine learning ...@@ -43,16 +45,18 @@ Federated learning (also known as collaborative learning) is a machine learning
* make * make
* [Docker 20.10 (optional)](https://docs.docker.com/get-docker/) * [Docker 20.10 (optional)](https://docs.docker.com/get-docker/)
### Installing federated locally ### Initial Setup
__1. Cloning federated__ __Cloning federated__
```bash ```bash
$ git clone https://gitlab.stud.idi.ntnu.no/dilawarm/federated.git $ git clone https://gitlab.stud.idi.ntnu.no/dilawarm/federated
$ cd federated $ cd federated
``` ```
__2. Install the Python development environment__ ### Installing federated locally
__1. Install the Python development environment__
<u>On Ubuntu:</u> <u>On Ubuntu:</u>
```bash ```bash
...@@ -72,7 +76,7 @@ $ brew install make # make ...@@ -72,7 +76,7 @@ $ brew install make # make
$ sudo pip3 install --user --upgrade virtualenv $ sudo pip3 install --user --upgrade virtualenv
``` ```
__3. Create a virtual environment__ __2. Create a virtual environment__
```bash ```bash
$ virtualenv --python python3 "venv" $ virtualenv --python python3 "venv"
...@@ -80,13 +84,13 @@ $ source "venv/bin/activate" ...@@ -80,13 +84,13 @@ $ source "venv/bin/activate"
(venv) $ pip install --upgrade pip (venv) $ pip install --upgrade pip
``` ```
__4. Install the dependencies__ __3. Install the dependencies__
```bash ```bash
(venv) $ make install (venv) $ make install
``` ```
__5. Test TensorFlow Federated__ __4. Test TensorFlow Federated__
```bash ```bash
(venv) $ python -c "import tensorflow_federated as tff; print(tff.federated_computation(lambda: 'Hello World')())" (venv) $ python -c "import tensorflow_federated as tff; print(tff.federated_computation(lambda: 'Hello World')())"
...@@ -196,7 +200,7 @@ See the [Makefile](Makefile) for more commands to test the modules in **federate ...@@ -196,7 +200,7 @@ See the [Makefile](Makefile) for more commands to test the modules in **federate
1. Clone repo and create a new branch: 1. Clone repo and create a new branch:
```bash ```bash
$ git checkout https://gitlab.stud.idi.ntnu.no/dilawarm/federated.git -b name_for_new_branch` $ git checkout https://gitlab.stud.idi.ntnu.no/dilawarm/federated -b name_for_new_branch
``` ```
2. Make changes and test. 2. Make changes and test.
3. Submit Pull Request with comprehensive description of changes. 3. Submit Pull Request with comprehensive description of changes.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment