Skip to content

Commit 44c84b1

Browse files
Update README
1 parent 03048ee commit 44c84b1

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,15 @@ We implement napari applications for:
88

99
**Early beta version**
1010

11-
This is an early beta version. Any feedback is welcome, but please be aware that the functionality is evolving fast and not fully tested.
11+
This is an early beta version. Any feedback is welcome, but please be aware that the functionality is under active development and that several features are not finalized or thoroughly tested yet.
12+
Once the functionality has matured we plan to release the interactive annotation applications as [napari plugins](https://napari.org/stable/plugins/index.html).
13+
1214

1315
## Functionality overview
1416

1517
TODO
18+
- quick explanation and gifs
19+
1620

1721
## Installation
1822

@@ -51,15 +55,32 @@ pip install -e .
5155

5256
## Usage
5357

58+
After the installation the three applications for interactive annotations can be started from the command line or within a python script:
59+
- **2d annotation**: via the command `micro_sam.annotator_2d` or with the function `micro_sam.sam_annotator.annotator_2d` from python. Run `micro_sam.annotator_2d -h` or check out [examples/sam_annotator_2d](https://github.com/computational-cell-analytics/micro-sam/blob/master/examples/sam_annotator_2d.py) for details.
60+
- **3d annotation**: via the command `micro_sam.annotator_3d` or with the function `micro_sam.sam_annotator.annotator_3d` from python. Run `micro_sam.annotator_3d -h` or check out [examples/sam_annotator_3d](https://github.com/computational-cell-analytics/micro-sam/blob/master/examples/sam_annotator_3d.py) for details.
61+
- **tracking**: via the command `micro_sam.annotator_tracking` or with the function `micro_sam.sam_annotator.annotator_tracking` from python. Run `micro_sam.annotator_tracking -h` or check out [examples/sam_annotator_tracking](https://github.com/computational-cell-analytics/micro-sam/blob/master/examples/sam_annotator_tracking.py) for details.
62+
5463
TODO
64+
- show image with annotated user interface (for 3d?!)
65+
- link to videos that explain the functionality for the 3 plugins
5566

5667
### Tips & Tricks
5768

5869
TODO
70+
- speeding things up: precomputing the embeddings with a gpu, making input images smaller
71+
- correcting existing segmentaitons via `segmentation_results`
72+
- saving and loading intermediate results via segmentation results
73+
74+
### Limitations
75+
76+
TODO
77+
- automatic instance segmentation limitations
5978

6079
## Using the micro_sam library
6180

6281
TODO
82+
- link to the example image series application
83+
6384

6485
## Contributing
6586

@@ -68,6 +89,7 @@ micro_sam <- library with utility functionality for using SAM for microscopy dat
6889
/sam_annotator <- the napari plugins for annotation
6990
```
7091

92+
7193
## Citation
7294

7395
If you are using this repository in your research please cite

0 commit comments

Comments
 (0)