Skip to content

Commit da15781

Browse files
committed
minor doc updates
1 parent bf4da12 commit da15781

File tree

1 file changed

+22
-21
lines changed

1 file changed

+22
-21
lines changed

docs/res/welcome.rst

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@ Introduction
22
===================
33

44

5-
Here you will find instructions on how to use the plug-in program.
5+
Here you will find instructions on how to use the plugin for direct-to-3D segmentation.
66
If the installation was successful, you'll see the napari-cellseg3D plugin
77
in the Plugins section of napari.
88

99
This plugin was initially developed for the review of labeled cell volumes [#]_ from mice whole-brain samples
1010
imaged by mesoSPIM microscopy [#]_ , and for training and using segmentation models from the MONAI project [#]_,
11-
or any custom model written in Pytorch.
11+
or any custom model written in PyTorch.
1212
It should be adaptable to other tasks related to detection of 3D objects, as long as labels are available.
1313

1414

@@ -26,32 +26,34 @@ From this page you can access the guides on the several modules available for yo
2626
* Defining custom models directly in the plugin (WIP) : :ref:`custom_model_guide`
2727

2828

29-
Requirements
29+
Installation
3030
--------------------------------------------
3131

32-
.. important::
33-
A **CUDA-capable GPU** is not needed but **very strongly recommended**, especially for training.
34-
35-
Requires installation of PyTorch and some optional dependencies of MONAI.
32+
You can install `napari-cellseg3d` via [pip]:
3633

37-
* For PyTorch, please see `PyTorch's website`_ for installation instructions, with or without CUDA depending on your hardware.
34+
``pip install napari-cellseg3d``
3835

39-
* 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.
36+
For local installation, please run:
4037

41-
.. _MONAI's optional dependencies: https://docs.monai.io/en/stable/installation.html#installing-the-recommended-dependencies
42-
.. _PyTorch's website: https://pytorch.org/get-started/locally/
38+
``pip install -e .``
4339

44-
Installation
40+
Requirements
4541
--------------------------------------------
4642

47-
You can install `napari-cellseg3d` via [pip]:
43+
.. important::
44+
A **CUDA-capable GPU** is not needed but **very strongly recommended**, especially for training.
4845

49-
``pip install napari-cellseg3d``
46+
This package requires you have napari installed first.
5047

51-
For local installation, please run:
48+
It also depends on PyTorch and some optional dependencies of MONAI. These come in the pip package above, but if
49+
you need further assistance see below.
5250

53-
``pip install -e .``
51+
* For help with PyTorch, please see `PyTorch's website`_ for installation instructions, with or without CUDA depending on your hardware.
5452

53+
* 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.
54+
55+
.. _MONAI's optional dependencies: https://docs.monai.io/en/stable/installation.html#installing-the-recommended-dependencies
56+
.. _PyTorch's website: https://pytorch.org/get-started/locally/
5557

5658

5759
Usage
@@ -61,7 +63,7 @@ To use the plugin, please run:
6163

6264
``napari``
6365

64-
Then go into Plugins > napari-cellseg3d, and choose which tool to use.
66+
Then go into Plugins > napari-cellseg3d, and choose which tool to use:
6567

6668

6769
- **Train**: This module allows you to train segmentation algorithms from labeled volumes.
@@ -73,11 +75,11 @@ See above for links to detailed guides regarding the usage of the modules.
7375

7476
Acknowledgments & References
7577
---------------------------------------------
76-
This plugin has been developed by Cyril Achard and Maxime Vidal for the `Mathis Laboratory of Adaptive Motor Control`_.
78+
This plugin has been developed by Cyril Achard and Maxime Vidal, supervised by Mackenzie Mathis for the `Mathis Laboratory of Adaptive Motor Control`_.
7779

7880
We also greatly thank Timokleia Kousi for her contributions to this project and the `Wyss Center`_ for project funding.
7981

80-
The TRAILMAP models and original weights used here all originate from the `TRAILMAP project on GitHub`_ [1]_.
82+
The TRAILMAP models and original weights used here were ported to PyTorch but originate from the `TRAILMAP project on GitHub`_ [1]_.
8183

8284
This plugin mainly uses the following libraries and software:
8385

@@ -88,7 +90,7 @@ This plugin mainly uses the following libraries and software:
8890
* `MONAI project website`_ (various models used here are credited `on their website`_)
8991

9092

91-
.. _Mathis Laboratory of adaptive motor control: http://www.mackenziemathislab.org/
93+
.. _Mathis Laboratory of Adaptive Motor Control: http://www.mackenziemathislab.org/
9294
.. _Wyss Center: https://wysscenter.ch/
9395
.. _TRAILMAP project on GitHub: https://github.com/AlbertPun/TRAILMAP
9496
.. _napari website: https://napari.org/
@@ -102,4 +104,3 @@ This plugin mainly uses the following libraries and software:
102104
.. [#] Mapping mesoscale axonal projections in the mouse brain using a 3D convolutional network, Friedmann et al., 2020 ( https://pnas.org/cgi/doi/10.1073/pnas.1918465117 )
103105
.. [#] The mesoSPIM initiative: open-source light-sheet microscopes for imaging cleared tissue, Voigt et al., 2019 ( https://doi.org/10.1038/s41592-019-0554-0 )
104106
.. [#] MONAI Project website ( https://monai.io/ )
105-

0 commit comments

Comments
 (0)