Overview

What is vantage6?

Vantage6 is a privacy-enhancing technology (PET) platform that allows organizations to collaborate on data analysis tasks without sharing the data itself. Vantage6 is open source and completely free to use.

What vantage6 does:

• deliver algorithms to data stations and collecting their results

• manage users, organizations, collaborations, computation tasks and their results

• provide control (security) at the data stations to the data 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 → You are here now

• Introduction → Introduction to vantage6 concepts

• Quickstart → Quickstart guide - run vantage6 locally

• User guide → How to use vantage6 as a researcher

• Node admin guide → How to install and configure vantage6 nodes

• Hub admin guide → How to configure and deploy the central vantage6 components

• Community → How to collaborate on the development of vantage6

• Algorithm Development → Develop vantage6 algorithms

• Technical reference → In-depth documentation of vantage6 features

• Code documentation → Documentation of the vantage6 infrastructure code

• Glossary → A dictionary of common terms used in these docs

• Release notes → Log of what has been released and when

Vantage6 resources

This is a - non-exhaustive - list of vantage6 resources.

Documentation

• docs.vantage6.ai → This documentation.

• vantage6.ai → vantage6 project website

• Academic papers → Technical insights into vantage6

Source code

• vantage6 → Contains all components (and the python-client).

• Planning → Contains all features, bugfixes and feature requests we are working on. To submit one yourself, you can create a new issue.

Community

• Github Discussions → Ask questions or share your ideas with the vantage6 community

• Community meetings → Bi-monthly developer community meeting

Video overview

This video provides an overview of the vantage6 project. The video is from 2020 and therefore does not reflect the latest features and developments, but the core concepts are still valid. The architecture of the vantage6 infrastructure is also still valid, however, many new components have been added and terminology has changed since the video was recorded.

---

Index

• Overview
• Introduction
  • Vantage6 components
  • Vantage6 resources
  • A simple federated average algorithm
  • How algorithms work in vantage6
  • How to run algorithms in vantage6
• Quickstart
  • Requirements
  • Installation
  • Start a local vantage6 network
  • Stopping the network
• Available algorithms

• 1. User guide
  • 1.1. User interface
  • 1.2. Python client
    • 1.2.1. Requirements
    • 1.2.2. Install
    • 1.2.3. Use
      • Overview
      • Authentication
      • Creating an organization
      • Creating a collaboration
      • Registering a node
      • Creating a task
  • 1.3. API
• 2. Node admin guide
  • 2.1. Requirements
    • 2.1.1. Python
    • 2.1.2. Kubernetes environment
    • 2.1.3. Helm
  • 2.2. Install
  • 2.3. Use
    • 2.3.1. Quick start
    • 2.3.2. Available commands
      • Local test setup
  • 2.4. Configure
    • 2.4.1. How to create a configuration file?
    • 2.4.2. Where is my configuration file?
    • 2.4.3. All configuration options
    • 2.4.4. Configuration file location
    • 2.4.5. Security
      • Configuring algorithm access to the data
    • 2.4.6. Logging
• 3. Hub admin guide
  • 3.1. Required components
  • 3.2. Recommended components
  • 3.3. Optional components
  • 3.4. Table of contents
    • 3.4.1. Components
      • Headquarters
      • Authentication service
      • Store
      • UI
      • Image registry
      • Mailserver
      • Message broker
      • Azure Blob Storage
      • Prometheus
    • 3.4.2. Requirements
      • Python
      • Kubernetes environment
      • Helm
    • 3.4.3. Install
      • Local installation
      • Production installation
    • 3.4.4. Use
      • Hub
      • Managing individual components
    • 3.4.5. Deployment
      • Helm charts
      • Configuration
      • Deployment
      • Configuring secrets
      • External databases
      • Configuring access to the services
• 4. Algorithm Development
  • 4.1. Algorithm concepts
    • 4.1.1. Algorithm structure
    • 4.1.2. Input & output
    • 4.1.3. Wrappers
    • 4.1.4. Child containers
    • 4.1.5. Networking
    • 4.1.6. Cross language
  • 4.2. Algorithm development step-by-step guide
    • 4.2.1. Starting point
    • 4.2.2. Setting up your environment
    • 4.2.3. Implementing your algorithm
    • 4.2.4. Returning results
    • 4.2.5. Environment variables
    • 4.2.6. Example functions
      • Central function
      • Partial function
      • Data extraction function
      • Preprocessing function
    • 4.2.7. Functions provided by the vantage6 infrastructure
    • 4.2.8. Testing your algorithm
    • 4.2.9. Writing documentation
    • 4.2.10. Package & distribute
    • 4.2.11. Uploading your algorithm to the algorithm store
    • 4.2.12. Calling your algorithm from vantage6
    • 4.2.13. Updating your algorithm
  • 4.3. Algorithm code structure
    • 4.3.1. Defining functions
    • 4.3.2. Implementing the algorithm functions
    • 4.3.3. Advanced decorators
    • 4.3.4. Algorithm wrappers
    • 4.3.5. Dockerfile structure
  • 4.4. Production-ready algorithm guidelines
    • 4.4.1. Reviewing code and documentation
    • 4.4.2. Prevent common federated learning exploits
  • 4.5. Classic Tutorial
    • 4.5.1. Mathematical decomposition
    • 4.5.2. Federated implementation
      • Federated part
      • Central part
      • Local testing
    • 4.5.3. Vantage6 integration
      • 📂Algorithm Structure
      • Local testing
      • Building and Distributing
• 5. Community
  • 5.1. Contribute
    • 5.1.1. Support questions
    • 5.1.2. Reporting issues
    • 5.1.3. Security vulnerabilities
    • 5.1.4. Community sprints
    • 5.1.5. Community Meetings
    • 5.1.6. Submitting patches
      • Setup your environment
      • Coding
      • Code style
      • Unit tests & coverage
      • Verifying local code changes
      • Pull Request
      • Documentation
    • 5.1.7. Roles in the vantage6 community
      • Community access tiers
  • 5.2. Documentation
    • 5.2.1. How this documentation is created
  • 5.3. Release
    • 5.3.1. Version format
    • 5.3.2. Testing a release
    • 5.3.3. Start the release process
    • 5.3.4. The release pipeline
    • 5.3.5. Distribute release
    • 5.3.6. Post-release checks
  • 5.4. Development environment
    • 5.4.1. Requirements
    • 5.4.2. First time running the development environment
    • 5.4.3. Running the development environment
    • 5.4.4. Using the development environment
• 6. Technical reference
  • 6.1. Architecture
    • 6.1.1. Network Actors
      • Hub
      • Data Station
      • User or Application
      • Learn more?
  • 6.2. Hub features
    • 6.2.1. API response structure
  • 6.3. Node features
    • 6.3.1. Whitelisting
      • Setting up whitelisting
  • 6.4. Algorithm features
    • 6.4.1. Algorithm container isolation
    • 6.4.2. Sessions
      • Algorithm Step Types
      • Dependent tasks
      • Session storage
  • 6.5. Communication between components
    • 6.5.1. SocketIO connection
      • Permissions
      • Usage in vantage6
    • 6.5.2. End to end encryption
    • 6.5.3. Blob Storage
      • Developer documentation
• 7. Code documentation
• 8. Glossary

• Release notes
  • 5.0.0
  • 4.15.0
  • 4.14.0
  • 4.13.7
  • 4.13.6
  • 4.13.5
  • 4.13.4
  • 4.13.3
  • 4.13.2
  • 4.13.1
  • 4.13.0
  • 4.12.2
  • 4.12.1
  • 4.12.0
  • 4.11.0
  • 4.10.2
  • 4.10.1
  • 4.10.0
  • 4.9.1
  • 4.9.0
  • 4.8.2
  • 4.8.1
  • 4.8.0
  • 4.7.1
  • 4.7.0
  • 4.6.1
  • 4.6.0
  • 4.5.5
  • 4.5.4
  • 4.5.3
  • 4.5.2
  • 4.5.1
  • 4.5.0
  • 4.4.1
  • 4.4.0
  • 4.3.4
  • 4.3.3
  • 4.3.2
  • 4.3.1
  • 4.3.0
  • 4.2.3
  • 4.2.2
  • 4.2.1
  • 4.2.0
  • 4.1.3
  • 4.1.2
  • 4.1.1
  • 4.1.0
  • 4.0.3
  • 4.0.2
  • 4.0.1
  • 4.0.0
  • 3.11.1
  • 3.11.0
  • 3.10.4
  • 3.10.3
  • 3.10.1
  • 3.10.0
  • 3.9.0
  • 3.8.8
  • 3.8.7
  • 3.8.6
  • 3.8.3 - 3.8.5
  • 3.8.2
  • 3.8.1
  • 3.8.0
  • 3.7.3
  • 3.7.2
  • 3.7.1
  • 3.7.0
  • 3.6.1
  • 3.5.2
  • 3.5.1
  • 3.5.0
  • 3.4.2
  • 3.4.0 & 3.4.1
  • 3.3.7
  • 3.3.6
  • 3.3.5
  • 3.3.3
  • 3.3.2
  • 3.3.1
  • 3.3.0
  • 3.2.0
  • 3.1.0
  • 3.0.0
  • 2.3.0 - 2.3.4
  • 2.2.0
  • 2.1.2 & 2.1.3
  • 2.1.1
  • 2.1.0
  • 2.0.0.post1
  • 2.0.0
  • 1.2.3
  • 1.2.2
  • 1.2.1
  • 1.2.0
  • 1.1.0
  • 1.0.0
• Partners