Skip to content

Commit 6b70a02

Browse files
authored
Update README.md (#67)
1 parent 9dd5b39 commit 6b70a02

File tree

1 file changed

+37
-36
lines changed

1 file changed

+37
-36
lines changed

README.md

Lines changed: 37 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,41 @@
1-
# napari-cellseg3D: a napari plug-in for direct 3D cell segmentation with deep learning
2-
1+
# CellSeg3D: self-supervised (and supervised) 3D cell segmentation for lightsheet microscopy
32
<img src="https://images.squarespace-cdn.com/content/v1/57f6d51c9f74566f55ecf271/838605d0-9723-4e43-83cd-6dbfe4adf36b/cellseg-logo.png?format=1500w" title="cellseg3d" alt="cellseg3d logo" width="350" align="right" vspace = "80"/>
43

54
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
6-
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/AdaptiveMotorControlLab/CellSeg3d/raw/main/LICENSE)
75
[![PyPI](https://img.shields.io/pypi/v/napari-cellseg3d.svg?color=green)](https://pypi.org/project/napari-cellseg3d)
6+
[![Downloads](https://static.pepy.tech/badge/napari-cellseg3d)](https://pepy.tech/project/napari-cellseg3d)
7+
[![Downloads](https://static.pepy.tech/badge/napari-cellseg3d/month)](https://pepy.tech/project/napari-cellseg3d)
8+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/AdaptiveMotorControlLab/CellSeg3d/raw/main/LICENSE)
89
[![Python Version](https://img.shields.io/pypi/pyversions/napari-cellseg-annotator.svg?color=green)](https://python.org)
910
[![codecov](https://codecov.io/gh/AdaptiveMotorControlLab/CellSeg3d/branch/main/graph/badge.svg?token=hzUcn3XN8F)](https://codecov.io/gh/AdaptiveMotorControlLab/CellSeg3d)
1011
[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-cellseg3d)](https://www.napari-hub.org/plugins/napari-cellseg3d)
1112

12-
A napari plugin for 3D cell segmentation: training, inference, and data review. In particular, this project was developed for analysis of mesoSPIM-acquired (cleared tissue + lightsheet) datasets.
13+
- A napari plugin for 3D cell segmentation: training, inference, and data review. In particular, this project was developed for analysis of mesoSPIM-acquired (cleared tissue + lightsheet) datasets.
1314

14-
**Help us make the code better by reporting issues and adding your feature requests!**
15+
![demo](https://images.squarespace-cdn.com/content/v1/57f6d51c9f74566f55ecf271/0d16a71b-3ff2-477a-9d83-18d96cb1ce28/full_demo.gif?format=500w)
16+
17+
## Installation
18+
19+
💻 See the [Installation page] in the documentation for detailed instructions.
20+
21+
## Documentation
22+
23+
📚 A lot of documentation is available at https://AdaptiveMotorControlLab.github.io/CellSeg3d
1524

16-
----------------------------------
25+
You can also generate docs by running ``make html`` in the docs/ folder.
26+
27+
## Quick Start
28+
29+
To use the plugin, please run:
30+
```
31+
napari
32+
```
33+
Then go into Plugins > napari-cellseg3d, and choose which tool to use.
34+
35+
- **Review (label)**: 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.
36+
- **Inference**: This module allows you to use pre-trained segmentation algorithms on volumes to automatically label cells and compute statistics.
37+
- **Train**: This module allows you to train segmentation algorithms from labeled volumes.
38+
- **Utilities**: This module allows you to perform several actions like cropping your volumes and labels dynamically, by selecting a fixed size volume and moving it around the image; computing prediction scores from ground truth and predicition labels; or converting labels from instance to segmentation and the opposite.
1739

1840
## News
1941

@@ -24,9 +46,9 @@ A napari plugin for 3D cell segmentation: training, inference, and data review.
2446
Previous additions :
2547

2648
- Improved training interface
27-
- Unsupervised model : WNet
28-
- Generate labels directly from raw data !
29-
- Can be trained in napari directly or in Colab
49+
- Unsupervised model : WNet3D
50+
- Generate labels directly from raw data!
51+
- Can be trained in napari directly or in Google Colab
3052
- Pretrained weights for mesoSPIM whole-brain cell segmentation
3153
- WandB support (install wandb and login to use automatically when training)
3254
- Remade and improved documentation
@@ -35,15 +57,9 @@ Previous additions :
3557
- New utilities
3658
- Many small improvements and many bug fixes
3759

38-
## Demo
3960

40-
![demo](https://images.squarespace-cdn.com/content/v1/57f6d51c9f74566f55ecf271/0d16a71b-3ff2-477a-9d83-18d96cb1ce28/full_demo.gif?format=500w)
41-
42-
## Installation
4361

44-
See the [Installation page] in the documentation for detailed instructions.
45-
46-
### M1 Mac users
62+
### Install note for M1/M2 Mac users
4763

4864
To avoid issues when installing on the ARM64 architecture, please follow these steps.
4965

@@ -64,24 +80,6 @@ To avoid issues when installing on the ARM64 architecture, please follow these s
6480

6581
OR directly via [napari-hub] (see Installation section above)
6682

67-
## Documentation
68-
69-
Available at https://AdaptiveMotorControlLab.github.io/CellSeg3d
70-
71-
You can also generate docs by running ``make html`` in the docs/ folder.
72-
73-
## Usage
74-
75-
To use the plugin, please run:
76-
```
77-
napari
78-
```
79-
Then go into Plugins > napari-cellseg3d, and choose which tool to use.
80-
81-
- **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.
82-
- **Inference**: This module allows you to use pre-trained segmentation algorithms on volumes to automatically label cells and compute statistics.
83-
- **Train**: This module allows you to train segmentation algorithms from labeled volumes.
84-
- **Utilities**: This module allows you to perform several actions like cropping your volumes and labels dynamically, by selecting a fixed size volume and moving it around the image; computing prediction scores from ground truth and predicition labels; or converting labels from instance to segmentation and the opposite.
8583

8684
## Requirements
8785

@@ -96,6 +94,9 @@ If you get errors from MONAI regarding missing readers, please see [MONAI's opti
9694

9795
## Issues
9896

97+
**Help us make the code better by reporting issues and adding your feature requests!**
98+
99+
99100
If you encounter any problems, please [file an issue] along with a detailed description.
100101

101102
## Testing
@@ -147,8 +148,8 @@ Distributed under the terms of the [MIT] license.
147148

148149
## Acknowledgements
149150

150-
This plugin was developed by Cyril Achard, Maxime Vidal, Mackenzie Mathis.
151-
This work was funded, in part, from the Wyss Center to the [Mathis Laboratory of Adaptive Motor Control](https://www.mackenziemathislab.org/).
151+
This plugin was developed by originally Cyril Achard, Maxime Vidal, Mackenzie Mathis.
152+
This work was funded, in part, from the Wyss Center to the [Mathis Laboratory of Adaptive Intelligence](https://www.mackenziemathislab.org/).
152153
Please refer to the documentation for full acknowledgements.
153154

154155
## Plugin base

0 commit comments

Comments
 (0)