➡️The API doc is available here⬅️
FLamby is a benchmark for cross-silo Federated Learning with natural partitioning, currently focused in healthcare applications. It spans multiple data modalities and should allow easy interfacing with most Federated Learning frameworks (including Fed-BioMed, FedML, Substra...). It contains implementations of different standard federated learning strategies. A companion paper describing it was published at NeurIPS 2022 in the Datasets & Benchmarks track.
The FLamby package contains:
- Data loaders that automatically handle data preprocessing and partitions of distributed datasets.
- Evaluation functions to evaluate trained models on the different tracks as defined in the companion paper.
- Benchmark code using the utilities below to obtain the performances of baselines using different strategies.
It does not contain datasets, which have to be downloaded separately (see the section below).
FLamby was tested on Ubuntu and MacOS environment. If you are facing any problems installing or executing FLamby code please help us improve it by filing an issue on FLamby github page ensuring to explain it in detail.
FLamby is a dataset suite instead of a repository. We provide code to easily access existing datasets stored in other repositories. In particular, we do not distribute datasets in this repository, and we do not own copyrights on any of the datasets.
The use of any of the datasets included in FLamby requires accepting its corresponding license on the original website. We refer to each dataset's README for more details.
For any problem or question with respect to any license related matters, please open a github issue on this repository.
We recommend using anaconda and pip. You can install anaconda by downloading and executing appropriate installers from the Anaconda website, pip often comes included with python otherwise check the following instructions. We support all Python version starting from 3.8.
You may need make for simplification. The following command will install all packages used by all datasets within FLamby. If you already know you will only need a fraction of the datasets inside the suite you can do a partial installation and update it along the way using the options described below.
Create and launch the environment using:
git clone https://github.com/owkin/FLamby.git
cd FLamby
make install
conda activate flambyTo limit the number of installed packages you can use the enable argument to specify which dataset(s)
you want to build required dependencies for and if you need to execute the tests (tests) and build the documentation (docs):
git clone https://github.com/owkin/FLamby.git
cd FLamby
make enable=option_name install
conda activate flambywhere option_name can be one of the following:
cam16, heart, isic2019, ixi, kits19, lidc, tcga, docs, tests
if you want to use more than one option you can do it using comma
(WARNING: there should be no space after ,), eg:
git clone https://github.com/owkin/FLamby.git
cd FLamby
make enable=cam16,kits19,tests install
conda activate flambyBe careful, each command tries to create a conda environment named flamby therefore make install will fail if executed
numerous times as the flamby environment will already exist. Use make update as explained in the next section if you decide to
use more datasets than intended originally.
Use the following command if new dependencies have been added, and you want to update the environment for additional datasets:
make updateor you can use enable option:
make enable=cam16 updateYou can install the environment by running:
git clone https://github.com/owkin/FLamby.git
cd FLamby
conda env create -f environment.yml
conda activate flamby
pip install -e .[all_extra]or if you wish to install the environment for only one or more datasets, tests or documentation:
git clone https://github.com/owkin/FLamby.git
cd FLamby
conda env create -f environment.yml
conda activate flamby
pip install -e .[option_name]where option_name can be one of the following:
cam16, heart, isic2019, ixi, kits19, lidc, tcga, docs, tests. If you want to use more than one option you can do it
using comma (,) (no space after comma), eg:
pip install -e .[cam16,ixi]Then proceed to read and accept the different licenses and download the data from all the datasets you are interested in by following the instructions provided in each folder:
Follow the quickstart section to learn how to get started with FLamby.
The results are stored in flamby/results in corresponding subfolders results_benchmark_fed_dataset for each dataset.
These results can be plotted using:
python plot_results.py
which produces the plot at the end of the main article.
In order to re-run each of the benchmark on your machine, first download the dataset you are interested in and then run the following command replacing config_dataset.json by one of the listed config files (config_camelyon16.json, config_heart_disease.json, config_isic2019.json, config_ixi.json, config_kits19.json, config_lidc_idri.json, config_tcga_brca.json):
cd flamby/benchmarks
python fed_benchmark.py --seed 42 -cfp ../config_dataset.json
python fed_benchmark.py --seed 43 -cfp ../config_dataset.json
python fed_benchmark.py --seed 44 -cfp ../config_dataset.json
python fed_benchmark.py --seed 45 -cfp ../config_dataset.json
python fed_benchmark.py --seed 46 -cfp ../config_dataset.json
We have observed that results vary from machine to machine and are sensitive to GPU randomness. However you should be able to reproduce the results up to some variance and results on the same machine should be perfecty reproducible. Please open an issue if it is not the case.
The script extract_config.py allows to go from a results file to a config.py.
See the quickstart section to change parameters.
A good step towards float-perfect reproducibility in your future benchmarks is to use docker. We give a base docker image and examples containing dataset download and benchmarking.
For Fed-Heart-Disease, cd to the flamby dockers folder, replace myusername and mypassword with your git credentials (OAuth token) in the command below and run:
docker build -t flamby-heart -f Dockerfile.base --build-arg DATASET_PREFIX="heart" --build-arg GIT_USER="myusername" --build-arg GIT_PWD="mypassword" .
docker build -t flamby-heart-benchmark -f Dockerfile.heart .
docker run -it flamby-heart-benchmark
If you are convinced you will use many datasets with docker, build the base image using all_extra option for flamby's install, you will be able to reuse it for all datasets with multi-stage build:
docker build -t flamby-all -f Dockerfile.base --build-arg DATASET_PREFIX="all_extra" --build-arg GIT_USER="myusername" --build-arg GIT_PWD="mypassword" .
# modify Dockerfile.* line 1 to FROM flamby-all by replacing * with the dataset name of the dataset you are interested in
# Then run the following command replacing * similarly
#docker build -t flamby-* -f Dockerfile.* .
#docker run -it flamby-*-benchmark
Checkout Dockerfile.tcga.
Similar dockerfiles can be theoretically easily built for the other datasets as well by
replicating instructions found in each dataset folder following the model of Dockerfile.heart.
Note that for bigger datasets execution can be prohibitively slow and docker can run out of time/memory.
FLamby can be easily adapted to different frameworks as the pytorch abstractions are quite flexible. We give an example of interfacing with Fed-BioMed here, another one with FedML, here and last one with Substra there. All major FL-frameworks should be compatible with FLamby modulo some glue code. If you have a working example of using FLamby with another FL-framework please open a PR.
Most plots from the article can be reproduced using the following commands after having downloaded the corresponding datasets:
cd flamby/datasets/fed_tcga_brca
python plot_kms.py
cd flamby/datasets/fed_lidc_idri
python lidc_heterogeneity_plot.py
In order to exactly reproduce the plot in the article, one needs to first deactivate color constancy normalization when preprocessing the dataset (change cc to False in resize_images.py) when following download and preprocessing instructions here. Hence one might have to download the dataset a second time, if it was already downloaded, and therefore to potentially update dataset_location.yaml files accordingly.
cd flamby/datasets/fed_isic2019
python heterogeneity_pic.py
cd flamby/datasets/fed_ixi
python ixi_plotting.py
cd flamby/datasets/fed_kits19/dataset_creation_scripts
python kits19_heterogenity_plot.py
cd flamby/datasets/fed_heart_disease
python heterogeneity_plot.py
First concatenate as many 224x224 image patches extracted from regions on the slides containing matter from Hospital 0 and Hospital 1 (see what is done in the tiling script to collect image patches) as can be fit in
the RAM. Then compute both histograms per-color-channel using 256 equally sized bins with the np.histogram
function with density=True.
Then save the results respectively as: histogram_0.npy, histogram_1.npy and bins_0.npy
cp -t flamby/datasets/fed_camelyon16 histograms_{0, 1}.npy bins_0.npy
cd flamby/datasets/fed_camelyon16
python plot_camelyon16_histogram.py
We use sphinx to create FLamby's documentation. In order to build the doc locally, activate the environment then:
cd docs
make clean
make htmlThis will generate html pages in the folder _builds/html that can be accessed in your browser:
open _build/html/index.htmlFLamby is a living project and contributions by the FL community are welcome.
If you would like to add another cross-silo dataset with natural splits, please fork the repository and do a Pull-Request following the guidelines described below.
Similarly, you can propose pull requests introducing novel training algorithms or models.
After installing the package in dev mode (pip install -e .[all_extra])
You should also initialize pre-commit by running:
pre-commit install
The pre-commit tool will automatically run black and
isort and check flake8 compatibility.
Which will format the code automatically making the code more homogeneous and helping catching typos and errors.
Looking and or commenting the open issues is a good way to start. Once you have found a way to contribute the next steps are:
- Following the installation instructions but using the -e option when pip installing
- Installing pre-commit
- Creating a new branch following the convention name_contributor/short_explicit_name-wpi:
git checkout -b name_contributor/short_explicit_name-wpi - Potentially pushing the branch to origin with :
git push origin name_contributor/short_explicit_name-wpi - Working on the branch locally by making commits frequently:
git commit -m "explicit description of the commit's content" - Once the branch is ready or after considering you have made significant progresses opening a Pull Request using Github interface, selecting your branch as a source and the target to be the main branch and creating the PR in draft mode after having made a detailed description of the content of the PR and potentially linking to related issues.
Rebasing the branch onto main by doing
git fetch originandgit rebase origin/main, solving potential conflicts adding the resolved filesgit add myfile.pythen continuing withgit rebase --continueuntil the rebase is complete. Then pushing the branch to origin withgit push origin --force-with-lease. - Waiting for reviews then commiting and pushing changes to comply with the reviewer's requests
- Once the PR is approved click on the arrow on the right of the merge button to select rebase and click on it
To clean the environment you must execute (after being inside the FLamby folder cd FLamby/):
conda deactivate
make cleanTry running:
conda deactivate
make clean
pip3 install --upgrade pipand try running your make installation option again.
In that case, you should use
make install-macinstead of the standard installation. If you have already installed the flamby environment, just run
conda deactivate
make cleanbefore running the install-mac installation again. This is to avoid the following error, which will appear when running scripts.
I or someone else already downloaded a dataset using another copy of the flamby repository, my copy of flamby cannot find it and I don't want to download it again, what can I do ?
There are two options. The safest one is to cd to the flamby directory and run:
python create_dataset_config.py --dataset-name fed_camelyon16 OR fed_heart_disease OR ... --path /path/where/the/dataset/is/located
This will create the required dataset_location.yaml file in your copy of the repository allowing FLamby to find it.
One can also directly pass the data_path argument when instantiating the dataset but this is not recommended.
from flamby.datasets.fed_heart_disease import FedHeartDisease
center0 = FedHeartDisease(center=0, train=True, data_path="/path/where/the/dataset/is/located")Collaborative work on FLamby: I am working with FLamby on a server with other users, how can we share the datasets efficiently ?
The basic answer is to use the answer just above to recreate the config file in every copy of the repository.
It can possibly become more seamless in the future if we introduce checks for environment variables in FLamby, which would allow to setup a general server-wise config so that all users of the server have access to all needed paths. In the meantime one can fill/comment the following bash script after downloading the dataset and share it with all users of the server:
python create_dataset_config.py --dataset-name fed_camelyon16 --path TOFILL
python create_dataset_config.py --dataset-name fed_heart_disease --path TOFILL
python create_dataset_config.py --dataset-name fed_lidc_idri --path TOFILL
python create_dataset_config.py --dataset-name fed_kits19 --path TOFILL
python create_dataset_config.py --dataset-name fed_isic2019 --path TOFILL
python create_dataset_config.py --dataset-name fed_ixi --path TOFILLWhich allows users to set all necessary paths in their local copies.
FLamby is a lightweight and simple solution, designed to allow researchers to quickly use cleaned datasets with a standard API. As a consequence, the benchmark code performing the FL simulation is minimalistic. All clients run sequentially in the same python environment, without multithreading. Datasets are assigned to clients as different python objects.
FLamby supports GPU acceleration thanks to the underlying deep learning backend (pytorch for now).
This repository was made possible thanks to numerous contributors. We list them in the order of the companion article, following the CREDIT framework: Jean Ogier du Terrail, Samy-Safwan Ayed, Edwige Cyffers, Felix Grimberg, Chaoyang He, Régis Loeb, Paul Mangold, Tanguy Marchand, Othmane Marfoq, Erum Mushtaq, Boris Muzellec, Constantin Philippenko, Santiago Silva, Maria Telenczuk, Shadi Albarqouni, Salman Avestimehr, Aurélien Bellet, Aymeric Dieuleveut, Martin Jaggi, Sai Praneeth Karimireddy, Marco Lorenzi, Giovanni Neglia, Marc Tommasi, Mathieu Andreux.
FLamby was made possible thanks to the support of the following institutions:
- Owkin
- Inria
- Ecole polytechnique
- University of California - Berkeley
- University of Southern California (USC)
- EPFL
- Universitätsklinikum Bonn
@inproceedings{NEURIPS2022_232eee8e,
author = {Ogier du Terrail, Jean and Ayed, Samy-Safwan and Cyffers, Edwige and Grimberg, Felix and He, Chaoyang and Loeb, Regis and Mangold, Paul and Marchand, Tanguy and Marfoq, Othmane and Mushtaq, Erum and Muzellec, Boris and Philippenko, Constantin and Silva, Santiago and Tele\'{n}czuk, Maria and Albarqouni, Shadi and Avestimehr, Salman and Bellet, Aur\'{e}lien and Dieuleveut, Aymeric and Jaggi, Martin and Karimireddy, Sai Praneeth and Lorenzi, Marco and Neglia, Giovanni and Tommasi, Marc and Andreux, Mathieu},
booktitle = {Advances in Neural Information Processing Systems},
editor = {S. Koyejo and S. Mohamed and A. Agarwal and D. Belgrave and K. Cho and A. Oh},
pages = {5315--5334},
publisher = {Curran Associates, Inc.},
title = {FLamby: Datasets and Benchmarks for Cross-Silo Federated Learning in Realistic Healthcare Settings},
url = {https://proceedings.neurips.cc/paper_files/paper/2022/file/232eee8ef411a0a316efa298d7be3c2b-Paper-Datasets_and_Benchmarks.pdf},
volume = {35},
year = {2022}
}
