Skip to content

Commit

Permalink
resolving conflicts
Browse files Browse the repository at this point in the history
  • Loading branch information
ouaelesi committed Jul 22, 2024
2 parents 1941ff8 + 6a67971 commit ac7680f
Show file tree
Hide file tree
Showing 6 changed files with 1,084 additions and 61 deletions.
674 changes: 674 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

35 changes: 7 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# MEDfl : Federated Learning and Differential Privacy Simulation Tool for Tabular Data
# MEDfl: Federated Learning and Differential Privacy Simulation Tool for Tabular Data
![Python Versions](https://img.shields.io/badge/python-3.9-blue)
![Build Status](https://travis-ci.org/MEDomics-UdeS/MEDfl.svg?branch=main)

Expand All @@ -7,28 +7,23 @@




## Table of Contents
* [1. Introduction](#1-introduction)
* [2. Installation](#2-installation)
* [3. Documentation](#3-documentation)
* [4. Getting started](#4-Getting-started)
* [5. Acknowledgement](#5-acknowledgement)
* [6. Authors](#6-authors)
* [7. Statement](#7-statement)

## 1. Introduction
This Python package is an open-source tool designed for simulating federated learning and incorporating differential privacy. It empowers researchers and developers to effortlessly create, execute, and assess federated learning pipelines while seamlessly working with various tabular datasets.





## 2. Installation

### Python installation
The MEDfl package requires *python 3.9* or more to be run. If you don't have it installed on your machine, check out the following link [Python ](https://www.python.org/downloads/).
It also requires MySQL database
The MEDfl package requires *python 3.9* or more to be run. If you don't have it installed on your machine, check out the following link [Python](https://www.python.org/downloads/).
It also requires MySQL database.

### Package installation
For now, you can install the ``MEDfl``package as:
Expand Down Expand Up @@ -62,29 +57,13 @@ python -m http.server
```

## 4. Getting started

We have created a complete tutorial for the different functionalities of the package. it can be found here [tutorial](https://github.com/MEDomics-UdeS/MEDfl/notebooks/First_tuto.ipynb)

We have created a complete tutorial for the different functionalities of the package. It can be found here: [Tutorial](https://github.com/MEDomics-UdeS/MEDfl/blob/main/notebooks/First_Tuto.ipynb).


## 5. Acknowledgment
MEDfl is an open-source package that welcomes any contribution and feedback. We wish that this package could serve the growing private AI research community.
MEDfl is an open-source package that welcomes any contribution and feedback. We wish that this package could serve the growing research community in federated learning for health.

## 6. Authors
* [MEDomics](https://github.com/medomics/): MEDomics consortium.

## 7. Statement
* [MEDomics-UdeS](https://www.medomics-udes.org/en/)
* [Hithem Lamri](https://github.com/HaithemLamri)

This package is part of https://github.com/medomics, a package providing research utility tools for developing precision medicine applications.

```
MIT License
Copyright (C) 2022 MEDomics consortium
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```
10 changes: 5 additions & 5 deletions medfl.egg-info/PKG-INFO
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
Metadata-Version: 2.1
Name: MEDfl
Version: 0.1.37
Version: 0.1.0
Summary: Python Open-source package for simulating federated learning and differential privacy
Home-page: https://github.com/MEDomics-UdeS/MEDfl
Home-page: https://github.com/HaithemLamri/MEDfl
Author: MEDomics consortium
Author-email: medomics.info@gmail.com
Project-URL: Documentation, https://
Project-URL: Github, https://github.com/MEDomics-UdeS/MEDfl
Project-URL: Github, https://github.com/HaithemLamri/MEDfl
Keywords: federated learning differential privacy medical research
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.8,<3.11
Requires-Python: >=3.8,<3.10
Description-Content-Type: text/markdown

# MEDfl : Federated Learning and Differential Privacy Simulation Tool for Tabular Data
Expand Down Expand Up @@ -57,7 +57,7 @@ cd MEDfl
pip install -e .
```
### MySQL DB configuration
MEDfl requires a MySQL DB connection, and this is in order to allow users to work with their own tabular datasets, we have created a bash script to install and configure A MySQL DB with phpmyadmin monitoring system, run the following command then change your credential on the MEDfl/scripts/base.py and MEDfl/scripts/db_config.ini files
MEDfl requires a MySQL DB connection, and this is in order to allow users to work with their own tabular datasets, we have created a bash script to install and configure A MySQL DB with phpmyadmin monitoring system, run the following command then change your credential on the MEDfl/scripts/base.py and MEDfl/scripts/config.ini files
```
sudo bash MEDfl/scripts/setup_mysql.sh
```
Expand Down
Loading

0 comments on commit ac7680f

Please sign in to comment.