Contribute to the BioImage.IO models

name: inverse
layout: true
class: center, middle, inverse

</span></div>

<div class="my-footer" style="display: flex; justify-content: space-around;">
	<div>
		<img src="/training-material/topics/ai4life/images/AI4Life-logo_neg_giraffe-solid.png" alt="AI4Life Logo" style="height: 1.6em">
	</div>
	<div>
		<a href="www.ai4life.eurobioimaging.eu">www.ai4life.eurobioimaging.eu</a>
	</div>
	<div>
		<a href="mailto:ai4life@eurobioimaging.eu">ai4life@eurobioimaging.eu</a>
	</div>
	<div>
		<a href="https://twitter.com/AI4LifeTeam">@AI4LifeTeam</a>
	</div>
</div>

---

# Contribute to the BioImage.IO models

<div class="contributors-line">
		<a href="/training-material/hall-of-fame/cfusterbarcelo/" class="contributor-badge contributor-cfusterbarcelo"><img src="/training-material/assets/images/orcid.png" alt="orcid logo" width="36" height="36"/><img src="https://avatars.githubusercontent.com/cfusterbarcelo?s=36" alt="Caterina Fuster-Barceló avatar" width="36" class="avatar" />
    Caterina Fuster-Barceló</a>
	</div>

</div>

<div class="footnote" style="bottom: 8em;">
  <i class="far fa-calendar" aria-hidden="true"></i><span class="visually-hidden">last_modification</span> Updated:   
  <i class="fas fa-fingerprint" aria-hidden="true"></i><span class="visually-hidden">purl</span><abbr title="Persistent URL">PURL</abbr>: <a href="https://gxy.io/GTN:S00107">gxy.io/GTN:S00107</a>
</div>

<div class="footnote" style="bottom: 6em;">

<i class="far fa-play-circle" aria-hidden="true"></i><span class="visually-hidden">video-slides</span> <a href="/training-material/videos/watch.html?v=/ai4life/tutorials/contribute-materials/slides">Video slides</a> |

<i class="fas fa-file-alt" aria-hidden="true"></i><span class="visually-hidden">text-document</span><a href="slides-plain.html"> Plain-text slides</a>
</div>

<div class="footnote" style="bottom: 3.3em;">
    <strong>Tip: </strong>press <kbd>P</kbd> to view the presenter notes
    | <i class="fa fa-arrows" aria-hidden="true"></i><span class="visually-hidden">arrow-keys</span> Use arrow keys to move between slides

</div>

???
Presenter notes contain extra information which might be useful if you intend to use these slides for teaching.

Press `P` again to switch presenter notes off

Press `C` to create a new window where the same presentation will be displayed.
This window is linked to the main window. Changing slides on one will cause the
slide to change on the other.

Useful when presenting.

---

### <i class="far fa-question-circle" aria-hidden="true"></i><span class="visually-hidden">question</span> Questions

- What is contained in a BioImage.IO model?

- Which are the requirements to contribute?

- How to contribute?

---

### <i class="fas fa-bullseye" aria-hidden="true"></i><span class="visually-hidden">objectives</span> Objectives

- Get to know how to contribute with models to the BioImage.IO

---

## What is a BioImage.IO model?

A BioImage.IO model contains:
* A trained model in the correct format
* Example input image
* Example output
* An example cover image for visual representation of the model in the zoo
* Resource description file specifications

???
A BioImage.IO model is a zip file containing all the items, technical description and metadata of the model, together with the trained architecture of the model.
Hence, a BioImage.IO model contains different items such as the trained model, an example input image as a numpy array, an example output (also as a numpy array), an example cover image and, particularlly, a resource description file specifications as a r d f . yaml.
---

## Model contribution requirements

* Follow the [BioImage.IO Model RDF Specification](https://bioimage.io/docs/#/bioimageio_model_spec) with `format_version>= 0.4.5`
* The model is expected to be cross-compatible among the [consumer software](https://github.com/bioimage-io/spec-bioimage-io/blob/main/supported_formats_and_operations.md#consumers), and should always run on at least one.
* The model should be well documented (i.e., human readable name and rich description tailored for life-scientists, citations)
* The model should be public and can be used by anyone under the chosen licensing conditions.

???
If you want to contribute with models, there are some requirements that need to be followed. For example, you have to follow the bioimage.io model Resource Description File Specification with a certain format version.
The model is expected to be cross-compatible among the consumer software. It also should be well documented and, of course, it has to be public and can be used by anyone unde the chosen licensing conditions.
---

## Model contribution guidelines

1. Create a BioImage.IO model
2. Upload the model to the BioImage Model Zoo

???
To contribute with a model to the BioImage Model Zoo you will only need to follow two steps. Let's see them closely!
---

### Create a BioImage.IO model

Two steps:
1. Choose one way to create your model (automatically or manually)
2. Check that the model is correctly created

???
Firstly, you will need to create a Bioimage.io model. To do so, you will need to create the model and check that it is correct. To create the model, you will have to choose if you want to do it automatically or manually. After that, you will have to check that the model is correctly created.
---

#### Create a BioImage.IO model: Create your model

* Automatic export of the model using the [bioimage.core python library](https://github.com/bioimage-io/core-bioimage-io-python) (recomended). Example code [here](https://github.com/bioimage-io/core-bioimage-io-python/blob/main/example/model_creation.ipynb).
* The main function to build the model is `bioimageio.core.build_model`
* Manual generation of the model.
* Creating the [BioImage.IO Model Resource Description File Specifications](https://bioimage.io/docs/#/bioimageio_model_spec) (rdf.yaml file)
* Some examples can be found on the Bioimage Model Zoo webpage.

???
When creating your model, the first step would consist in choosing how to create this model: you can either do an automatic expoert of the model using the bioimageio.core python library (the recommended option with an example code available) or to generate the model manually.
If you choose to do it manually, you will have to create the r d f . yaml file where there exist mandatory or optional fields on it. In the Bioimage Model Zoo webpage you can find different examples.
---

#### Create a BioImage.IO model: Check that the model is correctly created

* Static Validation of the model format using the bioimage.core python library
```
bioimageio validate /../rdf.yaml
```
* Dynamic Validation of the model's deployment
```
bioimageio test-model --weights tensorflow_saved_model_bundle --device cpu /.../rdf.yaml
```

???
Then, you will need to check that the model is correctly created. To do so, you should perform a static and dynamic validation of the model format by executing those commands in the terminal.
---

### Upload the model to the BioImage Model Zoo

In the bioimage.IO click on the Upload button.

???
Now it is time to upload your crated model through several new steps that you need to follow.
---

#### Upload the model: Log in to Zenodo

???
The first step will be to log in to Zenodo and give access to the BioEngine application. You will see an automatic message once you are logged in. If not, refresh the page. This step needs to be done only for the first time you upload a model.
---

#### Upload your model: Upload your model RDF

???
The second step will be to upload your model r d f as you see in the image.
---

#### Upload your model: Complete fields

???
Then you will have to complete all the missing fields as in the image shown here.
---

#### Upload your model: Complete fields

???
And here.
---

#### Upload your model: pull request

1. A [Pull Request (PR)](https://github.com/bioimage-io/collection-bioimage-io/pulls/bioimageiobot) will be generated
2. Continious Integration (CI) workflow test
3. Review by a maintainer from the BioImage.IO terminal

???
A pull request (PR) is generated (this process may take some minutes). In the PR, the model is tested by a Continuous Integration (CI) workflow for its technical correctness. and reviewed by a maintainer from the BioImage.IO team. This PR is aimed for further discussions between model contributors and the BioImage.IO team.
---

#### Upload your model: you are done!

If everything went as it should be, your model will be uploaded and displayed in the webpage!

???
Once the model passes all checks and has the approval of a maintainer, it will be added to the BioImage.IO collection and displayed in the webpage (this process may take some minutes).
---

## Additional information

* [How to get most of your model documentation](https://bioimage.io/docs/#/contribute_models/README?id=how-to-get-most-of-your-model-documentation)
* [Considerations for the model description file](https://bioimage.io/docs/#/contribute_models/README?id=considerations-for-the-model-description-file-format_versiongt030)

???
Remember that you can always read our documentation or additional information on this topic or others in our resources.
For example, you could check how to get most of your model documentation and considerations for the model description file.
---

---

## Thank You!

This material is the result of a collaborative work. Thanks to the [Galaxy Training Network](https://training.galaxyproject.org) and all the contributors!

</div>

</div>

Tutorial Content is licensed under <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.