You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/res/welcome.rst
+20-17Lines changed: 20 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,10 @@
1
1
Introduction
2
2
===================
3
3
4
-
Welcome to napari-cellseg3d !
5
-
--------------------------------------------
6
4
7
-
Here you will find instructions on how to use the program.
8
-
If the installation was successful, you'll see the napari-cellseg3d plugin
5
+
Here you will find instructions on how to use the plug-in program.
6
+
If the installation was successful, you'll see the napari-cellseg3D plugin
7
+
9
8
in the Plugins section of napari.
10
9
11
10
This plugin is intended for the review of labeled cell volumes [#]_ from mice whole-brain samples
@@ -15,9 +14,9 @@ any custom model written in Pytorch.
15
14
From here you can access the guides on the several modules available for your tasks, such as :
16
15
17
16
* Main modules :
18
-
* Review : :ref:`loader_module_guide`
19
-
* Inference: :ref:`inference_module_guide`
20
17
* Training : :ref:`training_module_guide`
18
+
* Inference: :ref:`inference_module_guide`
19
+
* Review : :ref:`loader_module_guide`
21
20
* Utilities :
22
21
* Cropping (3D) : :ref:`cropping_module_guide`
23
22
* Convert labels : :ref:`convert_module_guide`
@@ -32,9 +31,9 @@ Requirements
32
31
.. important::
33
32
A **CUDA-capable GPU** is not needed but **very strongly recommended**, especially for training.
34
33
35
-
Requires manual installation of pytorch and some optional dependencies of MONAI.
34
+
Requires installation of PyTorch and some optional dependencies of MONAI.
36
35
37
-
* For Pytorch, please see `PyTorch's website`_ for installation instructions, with or without CUDA depending on your hardware.
36
+
* For PyTorch, please see `PyTorch's website`_ for installation instructions, with or without CUDA depending on your hardware.
38
37
39
38
* If you get errors from MONAI regarding missing readers, please see `MONAI's optional dependencies`_ page for instructions on getting the readers required by your images.
40
39
@@ -63,31 +62,35 @@ To use the plugin, please run:
63
62
64
63
Then go into Plugins > napari-cellseg3d, and choose which tool to use.
65
64
66
-
- **Review**: This module allows you to review your labels, from predictions or manual labeling, and correct them if needed. It then saves the status of each file in a csv, for easier monitoring.
67
-
- **Infer**: This module allows you to use pre-trained segmentation algorithms on volumes to automatically label cells.
65
+
68
66
- **Train**: This module allows you to train segmentation algorithms from labeled volumes.
67
+
- **Infer**: This module allows you to use pre-trained segmentation algorithms on volumes to automatically label cells.
68
+
- **Review**: This module allows you to review your labels, from predictions or manual labeling, and correct them if needed. It then saves the status of each file in a csv, for easier monitoring.
69
69
- **Utilities**: This module allows you to use several utilities, e.g. to crop your volumes and labels, compute prediction scores or convert labels
70
70
71
71
72
-
Credits & acknowledgments
72
+
Acknowledgments & References
73
73
---------------------------------------------
74
-
This plugin has been developed by Cyril Achard and Maxime Vidal for the `Mathis Laboratory of Adaptive Motor Control`_.
74
+
This plugin has been developed by Cyril Achard and Maxime Vidal for the `Mathis Laboratory of Adaptive Motor Control`_.
75
+
76
+
We also greatly thank Timokleia Kousi for her contributions to this project and the `Wyss Center`_ for project funding.
75
77
76
-
The TRAILMAP models and original weights used here all originate from the `TRAILMAP project on GitHub`_ [1]_
78
+
The TRAILMAP models and original weights used here all originate from the `TRAILMAP project on GitHub`_ [1]_.
77
79
78
80
This plugin mainly uses the following libraries and software:
79
81
80
-
* `Napari website`_
82
+
* `napari website`_
81
83
82
-
* `Pytorch website`_
84
+
* `PyTorch website`_
83
85
84
86
* `MONAI project website`_ (various models used here are credited `on their website`_)
85
87
86
88
87
89
.. _Mathis Laboratory of adaptive motor control: http://www.mackenziemathislab.org/
90
+
.. _Wyss Center: https://wysscenter.ch/
88
91
.. _TRAILMAP project on GitHub: https://github.com/AlbertPun/TRAILMAP
89
-
.. _Napari website: https://napari.org/
90
-
.. _Pytorch website: https://pytorch.org/
92
+
.. _napari website: https://napari.org/
93
+
.. _PyTorch website: https://pytorch.org/
91
94
.. _MONAI project website: https://monai.io/
92
95
.. _on their website: https://docs.monai.io/en/stable/networks.html#nets
0 commit comments