https://github.com/carrier-project/vantage6

The main vantage6 repository: code for the central server, nodes, CLI and Python Client

https://github.com/carrier-project/vantage6

Repository

The main vantage6 repository: code for the central server, nodes, CLI and Python Client

https://github.com/CARRIER-project/vantage6/blob/main/

  

  


 A privacy preserving federated learning solution



[![Release](https://github.com/vantage6/vantage6/actions/workflows/release.yml/badge.svg)](https://github.com/vantage6/vantage6/actions/workflows/release.yml)
[![PyPI vantage6](https://badge.fury.io/py/vantage6.svg)](https://badge.fury.io/py/vantage6)
[![Unittests](https://github.com/vantage6/vantage6/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/vantage6/vantage6/actions/workflows/unit_tests.yml)
[![Coverage Status](https://coveralls.io/repos/github/vantage6/vantage6/badge.svg?branch=main)](https://coveralls.io/github/vantage6/vantage6?branch=main)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/2e60ac3b3f284620805f7399cba317be)](https://www.codacy.com/gh/vantage6/vantage6/dashboard?utm_source=github.com&utm_medium=referral&utm_content=vantage6/vantage6&utm_campaign=Badge_Grade)
[![DOI](https://zenodo.org/badge/492818831.svg)](https://zenodo.org/badge/latestdoi/492818831)



  Documentation 
  Contributing 
  References




-----------------------------------------------------------------------------------------------------
This repository is part of **vantage6**, our **privacy preserving federated learning infrastructure for secure insight exchange**, and contains all the **vantage6** infrastructure source/ code. Please visit our [website (vantage6.ai)](https://vantage6.ai) to learn more!

## :books: Documentation
This repository is home to 4 PyPi packages:

* [vantage6](https://pypi.org/project/vantage6) -> _CLI for managing node and server instances_
* [vantage6-client](https://pypi.org/project/vantage6-client) -> _Python client for interacting with the vantage6-server_
* [vantage6-node](https://pypi.org/project/vantage6-node) -> _Node application package_
* [vantage6-server](https://pypi.org/project/vantage6-server) -> _Server application package_

**Note that when using vantage6 you do not install the _server_ and _node_ packages. These are delivered to you in Docker images.**

Two docker images are published which contain the Node and Server applications:

* `harbor2.vantage6.ai/infrastructure/node:VERSION`
* `harbor2.vantage6.ai/infrastructure/server:VERSION`

These docker images are used by the _vantage6 CLI_ package, which can be installed by running:

`pip install vantage6`

This will install the CLI which enables you to use the commands:

* `vnode CMD [OPTIONS]`
* `vserver CMD [OPTIONS]`

You can find more (user) documentation at [Gitbook (docs.vantage6.ai)](https://docs.vantage6.ai). If you have any questions, suggestions or just want to chat about federated learning: join our [Dircord (https://discord.gg/yAyFf6Y)](https://discord.gg/yAyFf6Y) channel.

## :gift_heart: Contributing
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](https://docs.vantage6.ai/how-to-contribute/how-to-contribute)

## :black_nib: References
If you are using **vantage6**, please cite this repository as well as the accompanying papers as follows:

> * F. Martin, M. Sieswerda, H. Alradhi, et al. vantage6. Available at https://doi.org/10.5281/zenodo.3686944. Accessed on MONTH, 20XX.
> * A. Moncada-Torres, F. Martin, M. Sieswerda, J. van Soest, G. Gelijnse. VANTAGE6: an open source priVAcy preserviNg federaTed leArninG infrastructurE for Secure Insight eXchange. AMIA Annual Symposium Proceedings, 2020, p. 870-877. [[BibTeX](https://arturomoncadatorres.com/bibtex/moncada-torres2020vantage6.txt), [PDF](https://vantage6.ai/vantage6/)]
> * D. Smits\*, B. van Beusekom\*, F. Martin, L. Veen, G. Geleijnse, A. Moncada-Torres, An Improved Infrastructure for Privacy-Preserving Analysis of Patient Data, Proceedings of the International Conference of Informatics, Management, and Technology in Healthcare (ICIMTH), vol. 25, 2022, p. 144-147. [[BibTeX](https://arturomoncadatorres.com/bibtex/smits2022improved.txt), [PDF](https://ebooks.iospress.nl/volumearticle/60190)]



-----------------------------------------------------------------------------------------------------

  vantage6.ai 
  Discord 
  Discourse 
  User documentation 

Owner

GitHub Events