Documentation • Installation • How To Use • Contributing • References
This repository is part of vantage6, our priVAcy preserviNg federaTed leArninG infrastructurE for Secure Insight eXchange. Other repositories include:
- vantage6
- vantage6-common
- vantage6-server (you are here)
- vantage6-node
- vantage6-client
- vantage6-UI
- vantage6-master
The following is a short cheat sheet of how to setup a vantage6 server. For a more detailed, comprehensive guide, please refer to our website https://vantage6.ai and the official documentation: https://docs.vantage6.ai/.
This repository contains the code for a vantage6 server. Installation can be done in two different ways:
pip install vantage6-server# Clone repository
git clone https://github.com/iknl/vantage6-server
# Go into the repository
cd vantage6-server
# install vantage6 and dependencies
pip install -e .# Show available commands
vserver --help
# Create new server
vserver new [OPTIONS]
# Start a server
vserver start [OPTIONS]
# Attach the log output of a server to the console
vserver attach [OPTIONS]
# Batch import multiple entities into the server
vserver import PATH [OPTIONS]
# Show usefull files per server
vserver files [OPTIONS]
# Stop one ore more
vserver stop [OPTIONS]We hope to continue developing, improving, and supporting vantage6 with the help of the federated learning community. If you are interested in contributing, first of all, thank you! Second, please take a look at our contributing guidelines
Deploying Federated Learning solutions in real life often requires careful analysis and approval of a variety of legal entities. As part of these processes, we at IKNL have written a Data Protection Impact Assessment (DPIA), which you can find here. Please note that this DPIA was executed by IKNL and is specific for our situation. It can be used as an example by other organizations, but it cannot be used verbatim.
If you are using vantage6, please cite this repository as well as the accompanying paper as follows:
- Frank Martin, Melle Sieswerda, Hasan Alradhi, et al. vantage6. Available at https://doi.org/10.5281/zenodo.3686944. Accessed on [MONTH, 20XX].
- Arturo Moncada-Torres, Frank Martin, Melle Sieswerda, Johan van Soest, Gijs Gelijnse. VANTAGE6: an open source priVAcy preserviNg federaTed leArninG infrastructurE for Secure Insight eXchange. AMIA Annual Symposium Proceedings, 2020, p. 870-877. [BibTeX, PDF]