Skip to content

Manage new model contributions

Jump to bottom
esgomezm edited this page Oct 31, 2022 · 1 revision

The final approval of any new model is always done by a member of the BioImage.IO. The steps are as follows:

  1. Every time a model is uploaded to the BioImage Model Zoo a pull request is generated automatically in the bioimageio collection repo.

  2. The member in charge of the model will need to review the following checklist:

    • Passed the BioImage.IO CI tests: static (and dynamic) validations
    • The meta information for the RDF item is complete
      • The tags are complete and describe the model
      • Naming is intuitive and descriptive, example: Multi-Organ Nucleus Segmentation (StarDist 2D)
      • Authors are provided
      • Documentation is complete
    • For models, include an overview, describe how the model is trained, what is the training data, how to use the model, how to validate the results and list the references. TODO: Model documentation template.
      • Approved by at least one BioImage.IO admin team member.

  3. If the model is correct and has passed all the tests, ensure that the current version of the model has status: accepted in the resource.yaml file created in the collection (see line 13 in the image). The resource.yaml file can be found in Files changed of the PR. Merge the PR.

  4. If the model is not correct, discuss with the maintainer of the model in the PR to find a solution before merging the PR.

  5. If the solution implies updating the model, then change the status of the model to status: blocked and merge the PR. This will avoid the CI checking and publishing this model, and it will let the contributor update it in the uploading process (i.e., if they preserved the model name, the BioEngine will suggest updating the existing previous model).

  6. When the model has been uploaded, a new PR is created and you will get back to step 3. Now the resource.yaml should display the previous version as blocked and the current one as accepted.

Updating the format version of a model that was already published.

It is the same as in previous step 6, but the older versions of the model have status: accepted as well.

Clone this wiki locally