dFL

This project aims to build a decentralized federated learning library


Keywords
Federated, Learning, Decentralized
License
MIT
Install
pip install dFL==0.0.1

Documentation


Decentralized Federated Learning

This project aims to build a blockchain based decentralized federated learning


System Archeticture

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. License
  5. Contact

About The Project

Recently, Federated Learning (FL) has gained tremendous traction as it has the ability to provide a privacy-preserving mechanism to train Machine Learning models on hidden data. However, most of today's FL systems are centralized, in which a centralized server is typically used to build the global FL model.

Number of exchanged blocks

Getting Started

The following instructions will show you how to setup and installed required packages.

Prerequisites

The only requirements is to have python3 and pip installed in your machine.

Installation

  1. Download and Install MongoDB Comunity Server from https://www.mongodb.com/try/download/community

  2. Clone the repo, move to the project directory

git clone https://github.com/a-dirir/decentralized_FL.git

cd decentralized_FL

Installation for Windows

  1. Install virtualenv.
py -m pip install --user virtualenv
  1. Create and activate an environment called dfl
py -m venv dfl

.\dfl\Scripts\activate
  1. Install python packeges using pip
pip install -r requirements.txt

Installation for Unix/macOs

  1. Install virtualenv.
python3 -m pip install --user virtualenv
  1. Create and activate an environment called dfl
python3 -m venv dfl

source dfl/bin/activate
  1. Install python packeges using pip
pip install -r requirements.txt

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Ahmed Mukhtar Dirir - ahmed.m.dirir@gmail.com