Skip to content

Commit 23b54d3

Browse files
committed
Fixed docs build issues
1 parent 634f5a4 commit 23b54d3

File tree

6 files changed

+18
-10
lines changed

6 files changed

+18
-10
lines changed

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Welcome to napari-cellseg3d's documentation!
2424
:maxdepth: 2
2525
:caption: Advanced guides and walk-through:
2626

27+
res/guides/training_wnet
2728
res/guides/detailed_walkthrough
2829
res/guides/custom_model_template
2930

docs/res/code/instance_segmentation.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,6 @@ clear_small_objects
4444
**************************************
4545
.. autofunction:: napari_cellseg3d.code_models.instance_segmentation::clear_small_objects
4646

47-
to_instance
48-
**************************************
49-
.. autofunction:: napari_cellseg3d.code_models.instance_segmentation::to_instance
50-
5147
to_semantic
5248
**************************************
5349
.. autofunction:: napari_cellseg3d.code_models.instance_segmentation::to_semantic

docs/res/guides/detailed_walkthrough.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _detailed_walkthrough:
22

33
Detailed walkthrough - Supervised learning
4-
===================================
4+
===================================================
55

66
The following guide will show you how to use the plugin's workflow, starting from human-labeled annotation volume, to running inference on novel volumes.
77

docs/res/guides/inference_module_guide.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,13 +132,17 @@ WNet
132132
The WNet model, from the paper `WNet, A Deep Model for Fully Unsupervised Image Segmentation`_, is a fully unsupervised model that can be used to segment images without any labels.
133133
It clusters pixels based on brightness, and can be used to segment cells in a variety of modalities.
134134
Its use and available options are similar to the above models, with a few differences :
135+
135136
.. note::
136137
| Our provided, pre-trained model should use an input size of 64x64x64. As such, window inference is always enabled
137138
| and set to 64. If you want to use a different size, you will have to train your own model using the provided notebook.
138-
All it requires are images; for nucleus segmentation, it is recommended to use 2 classes (default).
139+
140+
All it requires are 3D .tif images (you can also load a 2D stack as 3D via napari).
139141

140142
Source code
141143
--------------------------------
142144
* :doc:`../code/plugin_model_inference`
143145
* :doc:`../code/model_framework`
144146
* :doc:`../code/workers`
147+
148+

docs/res/guides/training_module_guide.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
11
.. _training_module_guide:
22

3-
Training module guide
4-
=================================
3+
Training module guide - Unsupervised models
4+
==============================================
5+
6+
.. important::
7+
The WNet training is for now only available in the provided jupyter notebook, in the ``notebooks`` folder.
8+
Please see the :ref:`training_wnet` section for more information.
9+
10+
Training module guide - Supervised models
11+
==============================================
512

613
This module allows you to train pre-defined Pytorch models for cell segmentation.
714
Pre-defined models are stored in napari-cellseg-3d/models.

docs/res/welcome.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ From this page you can access the guides on the several modules available for yo
2828
* Compute scores : :ref:`metrics_module_guide`
2929
3030
* Advanced :
31+
* Training WNet (in jupyter, support might be added for plugin later) : :ref:`training_wnet`
3132
* Defining custom models directly in the plugin (WIP) : :ref:`custom_model_guide`
3233

3334

@@ -51,8 +52,7 @@ Requirements
5152
.. important::
5253
This package requires you have napari installed with PyQt5 or PySide2 first.
5354
If you do not have a Qt backend you can use :
54-
55-
``pip install napari-cellseg3d[all]``
55+
``pip install napari-cellseg3d[all]``
5656
to install PyQt5 by default.
5757

5858
It also depends on PyTorch and some optional dependencies of MONAI. These come in the pip package as requirements, but if

0 commit comments

Comments
 (0)