Skip to main content

Synapse SDK

Latest Version: latest

Build ML and data processing plugins for the Synapse platform.

Overview​

Synapse SDK is a Python framework for creating modular, reusable plugins. Run your plugins as distributed jobs, background tasks, or REST API endpoints.

Key Features​

  • Plugin Development: Create modular components organized by categories
  • Distributed Execution: Scale across multiple nodes with Ray
  • Multiple Run Modes: Execute as Jobs (batch processing), Tasks (async operations), or Serve (REST APIs)
  • Isolated Environments: Each plugin runs with its own dependencies
  • Progress Tracking: Monitor execution and report metrics

Plugin Categories​

CategoryCodeDescription
Neural NetworkNEURAL_NETML model training, inference, and deployment
ExportEXPORTData export and transformation
UploadUPLOADFile and data upload
Smart ToolsSMART_TOOLIntelligent automation tools
Post-AnnotationPOST_ANNOTATIONPost-processing after annotation
Pre-AnnotationPRE_ANNOTATIONPre-processing before annotation
Data ValidationDATA_VALIDATIONData quality checks
CustomCUSTOMUser-defined plugins

Getting Started​

  1. Install the SDK
  2. Follow the Quickstart
  3. Explore the API Reference
  4. Learn about Plugin System