Skip to content

Commit 0154516

Browse files
committed
deploy: e52ecba
1 parent 2acbf7f commit 0154516

File tree

7 files changed

+28
-16
lines changed

7 files changed

+28
-16
lines changed
2.21 MB
Loading

_sources/source/guides/inference_module_guide.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ Simply load the csv file in the notebook and use the provided functions to plot
145145
Unsupervised model - WNet3D
146146
--------------------------------
147147

148-
| The `WNet3D model` is a fully unsupervised model used to segment images without any labels.
148+
| The `WNet3D model` is a fully self-supervised model used to segment images without any labels.
149149
| It functions similarly to the above models, with a few notable differences.
150150
151151
.. _WNet3D model: https://arxiv.org/abs/1711.08506
@@ -159,11 +159,17 @@ For the best inference performance, the model should be retrained on images of t
159159
Please see :ref:`training_wnet` for more details on how to train your own model.
160160

161161
.. hint::
162-
| WNet3D, as an unsupervised model, may not always output the background class in the same dimension.
163-
| This might cause the result from inference to appear densely populated.
162+
| WNet3D, as an unsupervised model, may not always output the background and foreground class in the same dimension, as this depends on initial conditions.
163+
| This might cause the result from inference to appear densely populated or empty.
164164
| The plugin will automatically attempt to show the foreground class, but this might not always succeed.
165165
| If the displayed output seems dominated by the background, you can manually adjust the visible class. To do this, **use the slider positioned at the bottom of the napari window**.
166166
167+
.. figure:: ../images/inference_results_example.png
168+
:alt: An example of inference with WNet3D on a 3D volume
169+
:align: center
170+
171+
Example of inference with WNet3D on a 3D volume
172+
167173
Source code
168174
--------------------------------
169175
* :doc:`../code/_autosummary/napari_cellseg3d.code_plugins.plugin_model_inference`

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

source/guides/cropping_module_guide.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -443,7 +443,7 @@ <h2> Contents </h2>
443443
<figure class="align-center" id="id1">
444444
<img alt="../../_images/plugin_crop.png" src="../../_images/plugin_crop.png" />
445445
<figcaption>
446-
<p><span class="caption-number">Fig. 11 </span><span class="caption-text">Layout of the cropping module</span><a class="headerlink" href="#id1" title="Permalink to this image">#</a></p>
446+
<p><span class="caption-number">Fig. 12 </span><span class="caption-text">Layout of the cropping module</span><a class="headerlink" href="#id1" title="Permalink to this image">#</a></p>
447447
</figcaption>
448448
</figure>
449449
<p><strong>Cropping</strong> allows you to crop your volumes and labels dynamically,
@@ -494,7 +494,7 @@ <h2>Interface &amp; functionalities<a class="headerlink" href="#interface-functi
494494
<figure class="align-center" id="id2">
495495
<img alt="../../_images/cropping_process_example.png" src="../../_images/cropping_process_example.png" />
496496
<figcaption>
497-
<p><span class="caption-number">Fig. 12 </span><span class="caption-text">Example of the cropping process interface.</span><a class="headerlink" href="#id2" title="Permalink to this image">#</a></p>
497+
<p><span class="caption-number">Fig. 13 </span><span class="caption-text">Example of the cropping process interface.</span><a class="headerlink" href="#id2" title="Permalink to this image">#</a></p>
498498
</figcaption>
499499
</figure>
500500
<p>Once you have launched the review process, you will gain control over three sliders, which will let

source/guides/detailed_walkthrough.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -467,7 +467,7 @@ <h2>Setting up images and labels<a class="headerlink" href="#setting-up-images-a
467467
<figure class="align-center" id="id1">
468468
<a class="reference internal image-reference" href="../../_images/init_image_labels.png"><img alt="../../_images/init_image_labels.png" src="../../_images/init_image_labels.png" style="width: 1188.0px; height: 738.0px;" /></a>
469469
<figcaption>
470-
<p><span class="caption-number">Fig. 13 </span><span class="caption-text">Example of an anisotropic volume (i.e., often times the z resolution is not the same as x and y) and its associated labels.</span><a class="headerlink" href="#id1" title="Permalink to this image">#</a></p>
470+
<p><span class="caption-number">Fig. 14 </span><span class="caption-text">Example of an anisotropic volume (i.e., often times the z resolution is not the same as x and y) and its associated labels.</span><a class="headerlink" href="#id1" title="Permalink to this image">#</a></p>
471471
</figcaption>
472472
</figure>
473473
<div class="admonition note">
@@ -499,7 +499,7 @@ <h3>Cropping<a class="headerlink" href="#cropping" title="Permalink to this head
499499
<figure class="align-center" id="id2">
500500
<img alt="../../_images/cropping_process_example.png" src="../../_images/cropping_process_example.png" />
501501
<figcaption>
502-
<p><span class="caption-number">Fig. 14 </span><span class="caption-text">Cropping module layout</span><a class="headerlink" href="#id2" title="Permalink to this image">#</a></p>
502+
<p><span class="caption-number">Fig. 15 </span><span class="caption-text">Cropping module layout</span><a class="headerlink" href="#id2" title="Permalink to this image">#</a></p>
503503
</figcaption>
504504
</figure>
505505
</section>
@@ -522,7 +522,7 @@ <h3>Label conversion utility<a class="headerlink" href="#label-conversion-utilit
522522
<figure class="align-center" id="id3">
523523
<a class="reference internal image-reference" href="../../_images/converted_labels.png"><img alt="../../_images/converted_labels.png" src="../../_images/converted_labels.png" style="width: 680.0px; height: 384.0px;" /></a>
524524
<figcaption>
525-
<p><span class="caption-number">Fig. 15 </span><span class="caption-text">Example of instance labels from above converted to semantic labels</span><a class="headerlink" href="#id3" title="Permalink to this image">#</a></p>
525+
<p><span class="caption-number">Fig. 16 </span><span class="caption-text">Example of instance labels from above converted to semantic labels</span><a class="headerlink" href="#id3" title="Permalink to this image">#</a></p>
526526
</figcaption>
527527
</figure>
528528
<p>To remove small objects, or to convert a single image, use the <strong>`CTRL+O`</strong> shortcut to open the image you wish to manipulate.
@@ -587,7 +587,7 @@ <h3>Training Guide<a class="headerlink" href="#training-guide" title="Permalink
587587
<figure class="align-center" id="id4">
588588
<img alt="../../_images/plots_train.png" src="../../_images/plots_train.png" />
589589
<figcaption>
590-
<p><span class="caption-number">Fig. 16 </span><span class="caption-text">Plots displayed by the training module after 40 epochs</span><a class="headerlink" href="#id4" title="Permalink to this image">#</a></p>
590+
<p><span class="caption-number">Fig. 17 </span><span class="caption-text">Plots displayed by the training module after 40 epochs</span><a class="headerlink" href="#id4" title="Permalink to this image">#</a></p>
591591
</figcaption>
592592
</figure>
593593
<ul class="simple">
@@ -662,7 +662,7 @@ <h3>Labels review<a class="headerlink" href="#labels-review" title="Permalink to
662662
<figure class="align-center" id="id5">
663663
<img alt="../../_images/review_process_example.png" src="../../_images/review_process_example.png" />
664664
<figcaption>
665-
<p><span class="caption-number">Fig. 17 </span><span class="caption-text">Layout of the review module</span><a class="headerlink" href="#id5" title="Permalink to this image">#</a></p>
665+
<p><span class="caption-number">Fig. 18 </span><span class="caption-text">Layout of the review module</span><a class="headerlink" href="#id5" title="Permalink to this image">#</a></p>
666666
</figcaption>
667667
</figure>
668668
<p>Once you finish reviewing, press the <strong>Not checked</strong> button to switch the status to
@@ -679,7 +679,7 @@ <h3>Analysis : Jupyter notebooks<a class="headerlink" href="#analysis-jupyter-no
679679
<figure class="align-center" id="id6">
680680
<img alt="../../_images/stat_plots.png" src="../../_images/stat_plots.png" />
681681
<figcaption>
682-
<p><span class="caption-number">Fig. 18 </span><span class="caption-text">Example of the plot present in the notebooks.
682+
<p><span class="caption-number">Fig. 19 </span><span class="caption-text">Example of the plot present in the notebooks.
683683
Coordinates are based on centroids, the size represents the volume, the color, and the sphericity.</span><a class="headerlink" href="#id6" title="Permalink to this image">#</a></p>
684684
</figcaption>
685685
</figure>

source/guides/inference_module_guide.html

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -598,7 +598,7 @@ <h2>Plotting results<a class="headerlink" href="#plotting-results" title="Permal
598598
<section id="unsupervised-model-wnet3d">
599599
<h2>Unsupervised model - WNet3D<a class="headerlink" href="#unsupervised-model-wnet3d" title="Permalink to this heading">#</a></h2>
600600
<div class="line-block">
601-
<div class="line">The <cite>WNet3D model</cite> is a fully unsupervised model used to segment images without any labels.</div>
601+
<div class="line">The <cite>WNet3D model</cite> is a fully self-supervised model used to segment images without any labels.</div>
602602
<div class="line">It functions similarly to the above models, with a few notable differences.</div>
603603
</div>
604604
<div class="admonition note">
@@ -612,12 +612,18 @@ <h2>Unsupervised model - WNet3D<a class="headerlink" href="#unsupervised-model-w
612612
<div class="admonition hint">
613613
<p class="admonition-title">Hint</p>
614614
<div class="line-block">
615-
<div class="line">WNet3D, as an unsupervised model, may not always output the background class in the same dimension.</div>
616-
<div class="line">This might cause the result from inference to appear densely populated.</div>
615+
<div class="line">WNet3D, as an unsupervised model, may not always output the background and foreground class in the same dimension, as this depends on initial conditions.</div>
616+
<div class="line">This might cause the result from inference to appear densely populated or empty.</div>
617617
<div class="line">The plugin will automatically attempt to show the foreground class, but this might not always succeed.</div>
618618
<div class="line">If the displayed output seems dominated by the background, you can manually adjust the visible class. To do this, <strong>use the slider positioned at the bottom of the napari window</strong>.</div>
619619
</div>
620620
</div>
621+
<figure class="align-center" id="id3">
622+
<img alt="An example of inference with WNet3D on a 3D volume" src="../../_images/inference_results_example.png" />
623+
<figcaption>
624+
<p><span class="caption-number">Fig. 11 </span><span class="caption-text">Example of inference with WNet3D on a 3D volume</span><a class="headerlink" href="#id3" title="Permalink to this image">#</a></p>
625+
</figcaption>
626+
</figure>
621627
</section>
622628
<section id="source-code">
623629
<h2>Source code<a class="headerlink" href="#source-code" title="Permalink to this heading">#</a></h2>

source/guides/training_wnet.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this
483483
<figure class="align-right" id="id1">
484484
<a class="reference internal image-reference" href="../../_images/training_tab_4.png"><img alt="../../_images/training_tab_4.png" src="../../_images/training_tab_4.png" style="width: 232.0px; height: 463.0px;" /></a>
485485
<figcaption>
486-
<p><span class="caption-number">Fig. 19 </span><span class="caption-text">Advanced tab</span><a class="headerlink" href="#id1" title="Permalink to this image">#</a></p>
486+
<p><span class="caption-number">Fig. 20 </span><span class="caption-text">Advanced tab</span><a class="headerlink" href="#id1" title="Permalink to this image">#</a></p>
487487
</figcaption>
488488
</figure>
489489
<p><span class="target" id="when-using-the-wnet3d-training-module">When using the WNet3D training module</span>, the <strong>Advanced</strong> tab contains a set of additional options:</p>

0 commit comments

Comments
 (0)