Skip to content

Commit af869e6

Browse files
authored
minor doc edits
1 parent 3e8b8c0 commit af869e6

File tree

1 file changed

+20
-19
lines changed

1 file changed

+20
-19
lines changed

docs/res/welcome.rst

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

4-
Welcome to napari-cellseg-3d !
4+
Welcome to napari-cellseg3D !
55
--------------------------------------------
66

7-
Here you will find instructions on how to use the program.
8-
If the installation was successful, you'll see the napari-cellseg-3d plugin
7+
Here you will find instructions on how to use the plug-in program.
8+
If the installation was successful, you'll see the napari-cellseg3D plugin
99
in the Plugins section of napari.
1010

1111
This plugin is intended for the review of labeled cell volumes [#]_ from mice whole-brain samples
@@ -15,9 +15,9 @@ any custom model written in Pytorch.
1515
From here you can access the guides on the several modules available for your tasks, such as :
1616

1717
* Main modules :
18-
* Review : :ref:`loader_module_guide`
19-
* Inference: :ref:`inference_module_guide`
2018
* Training : :ref:`training_module_guide`
19+
* Inference: :ref:`inference_module_guide`
20+
* Review : :ref:`loader_module_guide`
2121
* Utilities :
2222
* Cropping (3D) : :ref:`cropping_module_guide`
2323
* Convert labels : :ref:`convert_module_guide`
@@ -32,9 +32,9 @@ Requirements
3232
.. important::
3333
A **CUDA-capable GPU** is not needed but **very strongly recommended**, especially for training.
3434

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

37-
* For Pytorch, please see `PyTorch's website`_ for installation instructions, with or without CUDA depending on your hardware.
37+
* For PyTorch, please see `PyTorch's website`_ for installation instructions, with or without CUDA depending on your hardware.
3838

3939
* 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.
4040

@@ -44,9 +44,9 @@ Requires manual installation of pytorch and some optional dependencies of MONAI.
4444
Installation
4545
--------------------------------------------
4646

47-
You can install `napari-cellseg-3d` via [pip]:
47+
You can install `napari-cellseg3D` via [pip]:
4848

49-
``pip install napari-cellseg-3d``
49+
``pip install napari-cellseg3D``
5050

5151
For local installation, please run:
5252

@@ -61,33 +61,34 @@ To use the plugin, please run:
6161

6262
``napari``
6363

64-
Then go into Plugins > napari-cellseg-3d, and choose which tool to use.
64+
Then go into Plugins > napari-cellseg3D, and choose which tool to use.
6565

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.
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`_. We also greatly Timokleia Kousi for her contributions to this project and the `Wyss Center` for project funding.
7575

76-
The TRAILMAP models and original weights used here all originate from the `TRAILMAP project on GitHub`_ [1]_
76+
The TRAILMAP models and original weights used here all originate from the `TRAILMAP project on GitHub`_ [1]_.
7777

7878
This plugin mainly uses the following libraries and software:
7979

80-
* `Napari website`_
80+
* `napari website`_
8181

82-
* `Pytorch website`_
82+
* `PyTorch website`_
8383

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

8686

8787
.. _Mathis Laboratory of adaptive motor control: http://www.mackenziemathislab.org/
88+
.. _Wyss Center: https://wysscenter.ch/
8889
.. _TRAILMAP project on GitHub: https://github.com/AlbertPun/TRAILMAP
89-
.. _Napari website: https://napari.org/
90-
.. _Pytorch website: https://pytorch.org/
90+
.. _napari website: https://napari.org/
91+
.. _PyTorch website: https://pytorch.org/
9192
.. _MONAI project website: https://monai.io/
9293
.. _on their website: https://docs.monai.io/en/stable/networks.html#nets
9394

0 commit comments

Comments
 (0)