Skip to content

Commit ff83d72

Browse files
Update documentation
1 parent 933a255 commit ff83d72

24 files changed

+13215
-12425
lines changed

micro_sam.html

Lines changed: 77 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ <h2>Contents</h2>
5353
<li><a href="#choosing-a-model">Choosing a Model</a></li>
5454
<li><a href="#other-models">Other Models</a></li>
5555
</ul></li>
56+
<li><a href="#community-data-submissions">Community Data Submissions</a></li>
5657
<li><a href="#faq">FAQ</a>
5758
<ul>
5859
<li><a href="#installation-questions">Installation questions</a></li>
@@ -716,12 +717,12 @@ <h1 id="finetuned-models">Finetuned Models</h1>
716717
<li><code>vit_l</code>: Default Segment Anything model with ViT Large backbone.</li>
717718
<li><code>vit_b</code>: Default Segment Anything model with ViT Base backbone.</li>
718719
<li><code>vit_t</code>: Segment Anything model with ViT Tiny backbone. From the <a href="https://arxiv.org/abs/2306.14289">Mobile SAM publication</a>.</li>
719-
<li><code>vit_l_lm</code>: Finetuned Segment Anything model for cells and nuclei in light microscopy data with ViT Large backbone. (<a href="https://doi.org/10.5281/zenodo.11111176">Zenodo</a>) (<a href="TODO">idealistic-rat on BioImage.IO</a>)</li>
720-
<li><code>vit_b_lm</code>: Finetuned Segment Anything model for cells and nuclei in light microscopy data with ViT Base backbone. (<a href="https://zenodo.org/doi/10.5281/zenodo.11103797">Zenodo</a>) (<a href="TODO">diplomatic-bug on BioImage.IO</a>)</li>
721-
<li><code>vit_t_lm</code>: Finetuned Segment Anything model for cells and nuclei in light microscopy data with ViT Tiny backbone. (<a href="https://doi.org/10.5281/zenodo.11111328">Zenodo</a>) (<a href="TODO">faithful-chicken BioImage.IO</a>)</li>
722-
<li><code>vit_l_em_organelles</code>: Finetuned Segment Anything model for mitochodria and nuclei in electron microscopy data with ViT Large backbone. (<a href="https://doi.org/10.5281/zenodo.11111054">Zenodo</a>) (<a href="TODO">humorous-crab on BioImage.IO</a>)</li>
723-
<li><code>vit_b_em_organelles</code>: Finetuned Segment Anything model for mitochodria and nuclei in electron microscopy data with ViT Base backbone. (<a href="https://doi.org/10.5281/zenodo.11111293">Zenodo</a>) (<a href="TODO">noisy-ox on BioImage.IO</a>)</li>
724-
<li><code>vit_t_em_organelles</code>: Finetuned Segment Anything model for mitochodria and nuclei in electron microscopy data with ViT Tiny backbone. (<a href="https://doi.org/10.5281/zenodo.11110950">Zenodo</a>) (<a href="TODO">greedy-whale on BioImage.IO</a>)</li>
720+
<li><code>vit_l_lm</code>: Finetuned Segment Anything model for cells and nuclei in light microscopy data with ViT Large backbone. (<a href="https://doi.org/10.5281/zenodo.11111176">Zenodo</a>) (<a href="https://bioimage.io/#/?id=idealistic-rat">idealistic-rat on BioImage.IO</a>)</li>
721+
<li><code>vit_b_lm</code>: Finetuned Segment Anything model for cells and nuclei in light microscopy data with ViT Base backbone. (<a href="https://zenodo.org/doi/10.5281/zenodo.11103797">Zenodo</a>) (<a href="https://bioimage.io/#/?id=diplomatic-bug">diplomatic-bug on BioImage.IO</a>)</li>
722+
<li><code>vit_t_lm</code>: Finetuned Segment Anything model for cells and nuclei in light microscopy data with ViT Tiny backbone. (<a href="https://doi.org/10.5281/zenodo.11111328">Zenodo</a>) (<a href="https://bioimage.io/#/?id=faithful-chicken">faithful-chicken BioImage.IO</a>)</li>
723+
<li><code>vit_l_em_organelles</code>: Finetuned Segment Anything model for mitochodria and nuclei in electron microscopy data with ViT Large backbone. (<a href="https://doi.org/10.5281/zenodo.11111054">Zenodo</a>) (<a href="https://bioimage.io/#/?id=humorous-crab">humorous-crab on BioImage.IO</a>)</li>
724+
<li><code>vit_b_em_organelles</code>: Finetuned Segment Anything model for mitochodria and nuclei in electron microscopy data with ViT Base backbone. (<a href="https://doi.org/10.5281/zenodo.11111293">Zenodo</a>) (<a href="https://bioimage.io/#/?id=noisy-ox">noisy-ox on BioImage.IO</a>)</li>
725+
<li><code>vit_t_em_organelles</code>: Finetuned Segment Anything model for mitochodria and nuclei in electron microscopy data with ViT Tiny backbone. (<a href="https://doi.org/10.5281/zenodo.11110950">Zenodo</a>) (<a href="https://bioimage.io/#/?id=greedy-whale">greedy-whale on BioImage.IO</a>)</li>
725726
</ul>
726727

727728
<p>See the two figures below of the improvements through the finetuned model for LM and EM data. </p>
@@ -755,6 +756,16 @@ <h2 id="other-models">Other Models</h2>
755756

756757
<p>Previous versions of our models are available on Zenodo:</p>
757758

759+
<h3 id="v2-models">v2 Models</h3>
760+
761+
<ul>
762+
<li>vit_t_lm (<a href="https://zenodo.org/records/11111329">Zenodo</a>): the ViT-Tiny model for segmenting cells and nuclei in LM.</li>
763+
<li>vit_b_lm (<a href="https://zenodo.org/records/11103798">Zenodo</a>): the ViT-Base model for segmenting cells and nuclei in LM.</li>
764+
<li>vit_l_lm (<a href="https://zenodo.org/records/11111177">Zenodo</a>): the ViT-Large mopdel for segmenting cells and nuclei in LM.</li>
765+
</ul>
766+
767+
<h3 id="v1-models">v1 Models</h3>
768+
758769
<ul>
759770
<li><a href="https://zenodo.org/records/10524894">vit_b_em_boundaries</a>: for segmenting compartments delineated by boundaries such as cells or neurites in EM.</li>
760771
<li><a href="https://zenodo.org/records/10524828">vit_b_em_organelles</a>: for segmenting mitochondria, nuclei or other organelles in EM.</li>
@@ -780,6 +791,50 @@ <h2 id="other-models">Other Models</h2>
780791
<li><a href="https://doi.org/10.5281/zenodo.11117615">Finetuned Models for the user studies</a></li>
781792
</ul>
782793

794+
<h1 id="community-data-submissions">Community Data Submissions</h1>
795+
796+
<p>We are looking to further improve the <code><a href="">micro_sam</a></code> models by training on more diverse microscopy data.
797+
For this, we want to collect data where the models don't work well yet, and need your help!</p>
798+
799+
<p>If you are using <code><a href="">micro_sam</a></code> 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.
800+
To do this, please either create an <a href="https://github.com/computational-cell-analytics/micro-sam/issues">issue on github</a> or a post on <a href="https://forum.image.sc/">image.sc</a> and:</p>
801+
802+
<ul>
803+
<li>Use a title "Data submission for micro_sam: ..." ("..." should be a title for your data, e.g. "cells in brightfield microscopy")
804+
<ul>
805+
<li>On image.sc use the tag <code>micro-sam</code>.</li>
806+
</ul></li>
807+
<li>Briefly describe your data and add an image that shows the microscopy data and the segmentation masks you have.</li>
808+
<li>Make sure to describe:
809+
<ul>
810+
<li>The imaging modality and the structure(s) that you have segmented.</li>
811+
<li>The <code><a href="">micro_sam</a></code> model you have used for finetuning and segmenting the data.
812+
<ul>
813+
<li>You can also submit data that was not segmented with <code><a href="">micro_sam</a></code>, as long as you have sufficient annotations we are happy to include it!</li>
814+
</ul></li>
815+
<li>How many images and annotations you have / can submit and how you have created the annotations.
816+
<ul>
817+
<li>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.</li>
818+
</ul></li>
819+
<li>Which data-format your images and annotations are stored in. We recommend using either <code>tif</code> images or <code>ome.zarr</code> files.</li>
820+
</ul></li>
821+
<li>Please indicate that you are willing to share the data for training purpose (see also next paragraph).</li>
822+
</ul>
823+
824+
<p>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:</p>
825+
826+
<ul>
827+
<li>We will share an agreement for data sharing. You can find <strong>a draft</strong> <a href="https://docs.google.com/document/d/1X3VOf1qtJ5WtwDGcpGYZ-kfr3E2paIEquyuCtJnF_I0/edit?usp=sharing">here</a>.</li>
828+
<li>You will be able to choose how you want to submit / publish your data.
829+
<ul>
830+
<li>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.</li>
831+
<li>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.</li>
832+
<li>Share it for training only. In this case, we will re-train the model on it, but not make it publicly available.</li>
833+
</ul></li>
834+
<li>We encourage you to choose the first option (making the data available under CC0).</li>
835+
<li>We will then send you a link to upload your data, after you have agreed to these terms.</li>
836+
</ul>
837+
783838
<h1 id="faq">FAQ</h1>
784839

785840
<p>Here we provide frequently asked questions and common issues.
@@ -984,6 +1039,11 @@ <h3 id="16-some-parameters-in-the-annotator-finetuning-widget-are-unclear-to-me"
9841039

9851040
<p><code>micro-sam</code> 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.</p>
9861041

1042+
<h3 id="17-i-want-to-use-an-older-version-of-the-pretrained-models">17. I want to use an older version of the pretrained models.</h3>
1043+
1044+
<p>The older model versions are still available on zenodo. You can find the download links for all of them <a href="https://computational-cell-analytics.github.io/micro-sam/micro_sam.html#other-models">here</a>.
1045+
You can then use those models with the custom checkpoint option, see answer 15 for details.</p>
1046+
9871047
<h2 id="fine-tuning-questions">Fine-tuning questions</h2>
9881048

9891049
<h3 id="1-i-have-a-microscopy-dataset-i-would-like-to-fine-tune-segment-anything-for-is-it-possible-using-micro_sam">1. I have a microscopy dataset I would like to fine-tune Segment Anything for. Is it possible using <code><a href="">micro_sam</a></code>?</h3>
@@ -1344,16 +1404,17 @@ <h2 id="transfering-data-to-band">Transfering data to BAND</h2>
13441404
</span><span id="L-5"><a href="#L-5"><span class="linenos"> 5</span></a><span class="sd">.. include:: ../doc/cli_tools.md</span>
13451405
</span><span id="L-6"><a href="#L-6"><span class="linenos"> 6</span></a><span class="sd">.. include:: ../doc/python_library.md</span>
13461406
</span><span id="L-7"><a href="#L-7"><span class="linenos"> 7</span></a><span class="sd">.. include:: ../doc/finetuned_models.md</span>
1347-
</span><span id="L-8"><a href="#L-8"><span class="linenos"> 8</span></a><span class="sd">.. include:: ../doc/faq.md</span>
1348-
</span><span id="L-9"><a href="#L-9"><span class="linenos"> 9</span></a><span class="sd">.. include:: ../doc/contributing.md</span>
1349-
</span><span id="L-10"><a href="#L-10"><span class="linenos">10</span></a><span class="sd">.. include:: ../doc/band.md</span>
1350-
</span><span id="L-11"><a href="#L-11"><span class="linenos">11</span></a><span class="sd">&quot;&quot;&quot;</span>
1351-
</span><span id="L-12"><a href="#L-12"><span class="linenos">12</span></a>
1352-
</span><span id="L-13"><a href="#L-13"><span class="linenos">13</span></a><span class="kn">import</span> <span class="nn">os</span>
1353-
</span><span id="L-14"><a href="#L-14"><span class="linenos">14</span></a>
1354-
</span><span id="L-15"><a href="#L-15"><span class="linenos">15</span></a><span class="kn">from</span> <span class="nn">.__version__</span> <span class="kn">import</span> <span class="n">__version__</span>
1355-
</span><span id="L-16"><a href="#L-16"><span class="linenos">16</span></a>
1356-
</span><span id="L-17"><a href="#L-17"><span class="linenos">17</span></a><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">&quot;PYTORCH_ENABLE_MPS_FALLBACK&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;1&quot;</span>
1407+
</span><span id="L-8"><a href="#L-8"><span class="linenos"> 8</span></a><span class="sd">.. include:: ../doc/data_submission.md</span>
1408+
</span><span id="L-9"><a href="#L-9"><span class="linenos"> 9</span></a><span class="sd">.. include:: ../doc/faq.md</span>
1409+
</span><span id="L-10"><a href="#L-10"><span class="linenos">10</span></a><span class="sd">.. include:: ../doc/contributing.md</span>
1410+
</span><span id="L-11"><a href="#L-11"><span class="linenos">11</span></a><span class="sd">.. include:: ../doc/band.md</span>
1411+
</span><span id="L-12"><a href="#L-12"><span class="linenos">12</span></a><span class="sd">&quot;&quot;&quot;</span>
1412+
</span><span id="L-13"><a href="#L-13"><span class="linenos">13</span></a>
1413+
</span><span id="L-14"><a href="#L-14"><span class="linenos">14</span></a><span class="kn">import</span> <span class="nn">os</span>
1414+
</span><span id="L-15"><a href="#L-15"><span class="linenos">15</span></a>
1415+
</span><span id="L-16"><a href="#L-16"><span class="linenos">16</span></a><span class="kn">from</span> <span class="nn">.__version__</span> <span class="kn">import</span> <span class="n">__version__</span>
1416+
</span><span id="L-17"><a href="#L-17"><span class="linenos">17</span></a>
1417+
</span><span id="L-18"><a href="#L-18"><span class="linenos">18</span></a><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">&quot;PYTORCH_ENABLE_MPS_FALLBACK&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;1&quot;</span>
13571418
</span></pre></div>
13581419

13591420

micro_sam/__version__.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ <h1 class="modulename">
5252

5353
<label class="view-source-button" for="mod-__version__-view-source"><span>View Source</span></label>
5454

55-
<div class="pdoc-code codehilite"><pre><span></span><span id="L-1"><a href="#L-1"><span class="linenos">1</span></a><span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;1.2.1&quot;</span>
55+
<div class="pdoc-code codehilite"><pre><span></span><span id="L-1"><a href="#L-1"><span class="linenos">1</span></a><span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;1.3.0&quot;</span>
5656
</span></pre></div>
5757

5858

0 commit comments

Comments
 (0)