Submit a model
Contributing a model means listing it in the Chap Marketplace, so that anyone running the Chap Modeling Platform can find it, install it and use it from the DHIS2 Modeling App. Your name and organization are shown on the model's page. The model stays yours: its code lives in your own repository, and you keep developing and maintaining it there.
What you need
- A model packaged as a chapkit service, with its image published. If your model is not packaged yet, the chapkit guide explains how.
- A short description of the model: what it does, which disease and setting it was developed for, and what data it needs.
What happens when you submit
- 1
You submit
You describe your model in a single YAML file and open a pull request in the Chap Marketplace repository on GitHub. The example file and checklist below show what to include.
- 2
We review and verify it
The Chap team checks that the model works with Chap: that it is a chapkit service whose published image matches the listed code, that it registers with Chap and can train and predict, and that the file is valid. This is what we call verification. Read Model verification for what it covers and what it does not.
- 3
Your model is listed
Once the review is approved, the model appears in the marketplace under your name. If you opt in, by setting
benchmarking: truein the model file, it is also run in our benchmarks.
To publish a new version later, open a pull request that adds it to your file. Each version is verified separately.
Verification checks that a model runs in Chap. It does not judge how good its forecasts are. Describe honestly in your file what the model was developed and tested for, so users can judge whether it fits their needs.
Example file
Full format in models/README.md.