.. include:: Overview ======== What is vantage6? ----------------- Vantage6 stands for pri\ **va**\ cy preservi\ **n**\ g federa\ **t**\ ed le\ **a**\ rnin\ **g** infrastructur\ **e** for \ **s**\ ecure \ **i**\ nsight e\ **x**\ change. .. raw:: html The project is inspired by the `Personal Health Train `_ (PHT) concept. In this analogy vantage6 is the *tracks* and *stations*. Compatible algorithms are the *trains*, and computation tasks are the *journey*. Vantage6 is completely open source under the `Apache License `_. What vantage6 does: * delivering algorithms to data stations and collecting their results * managing users, organizations, collaborations, computation tasks and their results * providing control (security) at the data-stations to their owners The vantage6 infrastructure is designed with three fundamental functional aspects of federated learning. 1. **Autonomy**. All involved parties should remain independent and autonomous. 2. **Heterogeneity**. Parties should be allowed to have differences in hardware and operating systems. 3. **Flexibility**. Related to the latter, a federated learning infrastructure should not limit the use of relevant data. Overview of this documentation ------------------------------ This documentation space consists of the following main sections: * **Overview** |rarr| *You are here now* * :doc:`/introduction/introduction` |rarr| *Introduction to vantage6 concepts* * :doc:`/introduction/architecture` |rarr| *An more extensive explanation of vantage6 components* * :doc:`/user/index` |rarr| *How to use vantage6 as a researcher* * :doc:`/node/index` |rarr| *How to install and configure vantage6 nodes* * :doc:`/server/index` |rarr| *How to configure and deploy vantage6 servers* * :doc:`/algorithm_store/index` |rarr| *How to configure and deploy vantage6 algorithm stores* * :doc:`/features/index` (Under construction) |rarr| *Documentation of vantage6 features* * :doc:`/devops/index` |rarr| *How to collaborate on the development of the vantage6 infrastructure* * :doc:`/algorithms/index` |rarr| *Develop algorithms that are compatible with vantage6* * :doc:`/function-docs/index` |rarr| *Documentation of the vantage6 infrastructure code* * :doc:`/glossary` |rarr| *A dictionary of common terms used in these docs* * :doc:`/release_notes` |rarr| *Log of what has been released and when* Vantage6 resources ------------------ This is a - non-exhaustive - list of vantage6 resources. **Documentation** * `docs.vantage6.ai `_ |rarr| *This documentation.* * `vantage6.ai `_ |rarr| *vantage6 project website* * `Academic papers `_ |rarr| *Technical insights into vantage6* **Source code** * `vantage6 `_ |rarr| *Contains all* *components (and the python-client).* * `Planning `_ |rarr| *Contains all features, bugfixes and feature requests we are working on. To submit one yourself, you can create a* `new issue `_. **Community** * `Discord `_ |rarr| *Chat with the vantage6 community* * :ref:`Community meetings ` |rarr| *Bi-monthly developer community meeting* ------------------------------------------------------------------------------- Index ===== .. toctree:: :maxdepth: 4 self introduction/introduction introduction/architecture .. toctree:: :numbered: 3 :maxdepth: 4 user/index node/index server/index algorithm_store/index algorithms/index features/index devops/index function-docs/index glossary .. toctree:: :maxdepth: 2 release_notes partners