Skip to content

Sage-Bionetworks-Challenges/model-to-data-challenge-workflow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Model-to-Data Challenge Infrastructure Template

Ready-to-use workflow template for evaluating Docker images submitted on Synapse.org


GitHub release (latest by date) GitHub Release Date GitHub

💡 Should You Use This Template?

The model-to-data (m2d) workflow is ideal for scenarios where participants train their algorithm locally using provided training data. Participants will then submit their algorithm as a containerized Docker image to be run against the hold-out validation/test data (which they will have no access to) in order to generate a predictions file, which is then evaluated against the hidden groundtruth data.

🚀 Quick Start

  • Customize evaluation logic: modify the scoring and validation scripts within the evaluation folder
  • Configure workflow: adapt workflow.cwl (and writeup-workflow.cwl, if applicable) to define the inputs and steps specific to your challenge
  • Test your changes: use cwltool to test your CWL scripts within the steps folder

Technical Details & Resources

Repository structure

This template provides all necessary components for a full challenge pipeline:

.
├── evaluation      // core scoring and validation scripts
├── README.md
├── scripts         // scripts called by the individual CWL scripts in `steps`
├── steps           // individual CWL scripts (called by the main workflow CWLs)
├── workflow.cwl          // CWL workflow for evaluating submissions
└── writeup-workflow.cwl  // CWL workflow to validate and archive writeup submissions

Resource docs

This template is built using CWL and Docker, and is designed to be handled by the SynapseWorkflowOrchestrator orchestration tool. For detailed information on utilizing these core technologies, please refer to their docs below:

About

Workflow template for Synapse challenges that accept Docker submissions

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •