4. Algorithm Development

This section will helps you to develop vantage6 algorithms. You are not going to find a list of algorithms here - see the community store section for that.

Contents:

• 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