Skip to content

Commit a4e2f4e

Browse files
authored
Merge pull request #48 from C-Achard/mwmw/docs-welcomeRST
minor doc edits
2 parents 93f5ea8 + 639b38b commit a4e2f4e

File tree

1 file changed

+20
-17
lines changed

1 file changed

+20
-17
lines changed

docs/res/welcome.rst

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
Introduction
22
===================
33

4-
Welcome to napari-cellseg3d !
5-
--------------------------------------------
64

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+
98
in the Plugins section of napari.
109

1110
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.
1514
From here you can access the guides on the several modules available for your tasks, such as :
1615

1716
* Main modules :
18-
* Review : :ref:`loader_module_guide`
19-
* Inference: :ref:`inference_module_guide`
2017
* Training : :ref:`training_module_guide`
18+
* Inference: :ref:`inference_module_guide`
19+
* Review : :ref:`loader_module_guide`
2120
* Utilities :
2221
* Cropping (3D) : :ref:`cropping_module_guide`
2322
* Convert labels : :ref:`convert_module_guide`
@@ -32,9 +31,9 @@ Requirements
3231
.. important::
3332
A **CUDA-capable GPU** is not needed but **very strongly recommended**, especially for training.
3433

35-
Requires manual installation of pytorch and some optional dependencies of MONAI.
34+
Requires installation of PyTorch and some optional dependencies of MONAI.
3635

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.
3837

3938
* 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.
4039

@@ -63,31 +62,35 @@ To use the plugin, please run:
6362

6463
Then go into Plugins > napari-cellseg3d, and choose which tool to use.
6564

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+
6866
- **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.
6969
- **Utilities**: This module allows you to use several utilities, e.g. to crop your volumes and labels, compute prediction scores or convert labels
7070

7171

72-
Credits & acknowledgments
72+
Acknowledgments & References
7373
---------------------------------------------
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.
7577

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]_.
7779

7880
This plugin mainly uses the following libraries and software:
7981

80-
* `Napari website`_
82+
* `napari website`_
8183

82-
* `Pytorch website`_
84+
* `PyTorch website`_
8385

8486
* `MONAI project website`_ (various models used here are credited `on their website`_)
8587

8688

8789
.. _Mathis Laboratory of adaptive motor control: http://www.mackenziemathislab.org/
90+
.. _Wyss Center: https://wysscenter.ch/
8891
.. _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/
9194
.. _MONAI project website: https://monai.io/
9295
.. _on their website: https://docs.monai.io/en/stable/networks.html#nets
9396

0 commit comments

Comments
 (0)