Skip to content

Commit 6dc6a9e

Browse files
Add data submission section to the documentation (#881)
1 parent f81199d commit 6dc6a9e

File tree

3 files changed

+33
-0
lines changed

3 files changed

+33
-0
lines changed

doc/data_submission.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Community Data Submissions
2+
3+
We are looking to further improve the `micro_sam` models by training on more diverse microscopy data.
4+
For this, we want to collect data where the models don't work well yet, and need your help!
5+
6+
If you are using `micro_sam` for a task where the current models don't do a good job, but you have annotated data and successfully fine-tuned a model, then you can submit this data to us, so that we can use it to train our next version of improved microscopy models.
7+
To do this, please either create an [issue on github](https://github.com/computational-cell-analytics/micro-sam/issues) or a post on [image.sc](https://forum.image.sc/) and:
8+
- Use a title "Data submission for micro_sam: ..." ("..." should be a title for your data, e.g. "cells in brightfield microscopy")
9+
- On image.sc use the tag `micro-sam`.
10+
- Briefly describe your data and add an image that shows the microscopy data and the segmentation masks you have.
11+
- Make sure to describe:
12+
- The imaging modality and the structure(s) that you have segmented.
13+
- The `micro_sam` model you have used for finetuning and segmenting the data.
14+
- You can also submit data that was not segmented with `micro_sam`, as long as you have sufficient annotations we are happy to include it!
15+
- How many images and annotations you have / can submit and how you have created the annotations.
16+
- You should submit at least 5 images / 100 annotated objects to have a meaningful impact. If you are unsure if you have enough data please go ahead and create the issue / post and we can discuss the details.
17+
- Which data-format your images and annotations are stored in. We recommend using either `tif` images or `ome.zarr` files.
18+
- Please indicate that you are willing to share the data for training purpose (see also next paragraph).
19+
20+
Once you have created the post / issue, we will check if your data is suitable for submission or discuss with you how it could be extended to be suitable. Then:
21+
- We will share an agreement for data sharing. You can find **a draft** [here](https://docs.google.com/document/d/1X3VOf1qtJ5WtwDGcpGYZ-kfr3E2paIEquyuCtJnF_I0/edit?usp=sharing).
22+
- You will be able to choose how you want to submit / publish your data.
23+
- Share it under a CC0 license. In this case, we will use the data for re-training and also make it publicly available as soon as the next model versions become available.
24+
- Share it for training with the option to publish it later. For example, if your data is unpublished and you want to only published once the respective publication is available. In this case, we will use the data for re-training, but not make it freely available yet. We will check with you peridiodically to see if your data can now be published.
25+
- Share it for training only. In this case, we will re-train the model on it, but not make it publicly available.
26+
- We encourage you to choose the first option (making the data available under CC0).
27+
- We will then send you a link to upload your data, after you have agreed to these terms.

doc/faq.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,11 @@ NOTE: It is important to choose the correct model type when you opt for the abov
162162
`micro-sam` has tooltips for menu options across all widgets (i.e. an information window will appear if you hover over name of the menu), which briefly describe the utility of the specific menu option.
163163

164164

165+
### 17. I want to use an older version of the pretrained models.
166+
The older model versions are still available on zenodo. You can find the download links for all of them [here](https://computational-cell-analytics.github.io/micro-sam/micro_sam.html#other-models).
167+
You can then use those models with the custom checkpoint option, see answer 15 for details.
168+
169+
165170
## Fine-tuning questions
166171

167172

micro_sam/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
.. include:: ../doc/cli_tools.md
66
.. include:: ../doc/python_library.md
77
.. include:: ../doc/finetuned_models.md
8+
.. include:: ../doc/data_submission.md
89
.. include:: ../doc/faq.md
910
.. include:: ../doc/contributing.md
1011
.. include:: ../doc/band.md

0 commit comments

Comments
 (0)