Skip to content

Commit c2eb134

Browse files
committed
Updated docs to clarify behaviour of inference/training
Updating docs to clarify inference, based on #20
1 parent fc4af1e commit c2eb134

File tree

3 files changed

+14
-4
lines changed

3 files changed

+14
-4
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,3 +97,4 @@ venv/
9797
/napari_cellseg3d/models/saved_weights/
9898
/docs/res/logo/old_logo/
9999
/reqs/
100+
*.db

docs/res/guides/inference_module_guide.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,13 @@
33
Inference module guide
44
=================================
55

6-
This module allows you to use pre-trained segmentation algorithms (written in Pytorch) on volumes
6+
This module allows you to use pre-trained segmentation algorithms (written in Pytorch) on 3D volumes
77
to automatically label cells.
88

9+
.. important::
10+
Currently, only inference on **3D volumes is supported**. Your image and label folders should both contain a set of
11+
**3D image files**, currently either **.tif** or **.tiff**. Loading a folder of 2D images as a stack is not supported as of yet.
12+
913
Currently, the following pre-trained models are available :
1014

1115
============== ================================================================================================
@@ -31,7 +35,7 @@ Interface and functionalities
3135

3236
* **Loading data** :
3337

34-
| When launching the module, you will be asked to provide an **image folder** containing all the volumes you'd like to be labeled.
38+
| When launching the module, you will be asked to provide an **image folder** containing all the 3D volumes you'd like to be labeled.
3539
| All images with the chosen extension (**.tif** or **.tiff** currently supported) in this folder will be labeled.
3640
| You can then choose an **output folder**, where all the results will be saved.
3741

docs/res/guides/training_module_guide.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ Training module guide
66
This module allows you to train pre-defined Pytorch models for cell segmentation.
77
Pre-defined models are stored in napari-cellseg-3d/models.
88

9+
.. important::
10+
Currently, only inference on **3D volumes is supported**. Your image and label folders should both contain a set of
11+
**3D image files**, currently either **.tif** or **.tiff**. Loading a folder of 2D images as a stack is not supported as of yet.
12+
13+
914
Currently, the following pre-defined models are available :
1015

1116
============== ================================================================================================
@@ -31,8 +36,8 @@ The training module is comprised of several tabs.
3136

3237
1) The first one, **Data**, will let you set :
3338

34-
* The path to the images folder
35-
* The path to the labels folder
39+
* The path to the images folder (3D image files)
40+
* The path to the labels folder (3D image files)
3641
* The path to the results folder
3742

3843
* Whether to copy results to a zip file (for easier transferability)

0 commit comments

Comments
 (0)