Skip to content

Commit 8bf2a50

Browse files
Remove sam_ prefix from example scripts
1 parent 12cc614 commit 8bf2a50

File tree

8 files changed

+11
-11
lines changed

8 files changed

+11
-11
lines changed

doc/annotation_tools.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The `micro_sam` applications are mainly based on [the point layer](https://napar
2222
The 2d annotator can be started by
2323
- clicking `2d annotator` in the `micro_sam` GUI.
2424
- running `$ micro_sam.annotator_2d` in the command line. Run `micro_sam.annotator_2d -h` for details.
25-
- calling `micro_sam.sam_annotator.annotator_2d` in a python script. Check out [examples/sam_annotator_2d.py](https://github.com/computational-cell-analytics/micro-sam/blob/master/examples/sam_annotator_2d.py) for details.
25+
- calling `micro_sam.sam_annotator.annotator_2d` in a python script. Check out [examples/annotator_2d.py](https://github.com/computational-cell-analytics/micro-sam/blob/master/examples/annotator_2d.py) for details.
2626

2727
The user interface of the 2d annotator looks like this:
2828

@@ -46,14 +46,14 @@ Note that point prompts and box prompts can be combined. When you're using point
4646

4747
Check out [this video](https://youtu.be/DfWE_XRcqN8) for an example of how to use the interactive 2d annotator.
4848

49-
We also provide the `image series annotator`, which can be used for running the 2d annotator for several images in a folder. You can start by clicking `Image series annotator` in the GUI, running `micro_sam.image_series_annotator` in the command line or from a [python script](https://github.com/computational-cell-analytics/micro-sam/blob/master/examples/sam_image_series_annotator.py).
49+
We also provide the `image series annotator`, which can be used for running the 2d annotator for several images in a folder. You can start by clicking `Image series annotator` in the GUI, running `micro_sam.image_series_annotator` in the command line or from a [python script](https://github.com/computational-cell-analytics/micro-sam/blob/master/examples/image_series_annotator.py).
5050

5151
## Annotator 3D
5252

5353
The 3d annotator can be started by
5454
- clicking `3d annotator` in the `micro_sam` GUI.
5555
- running `$ micro_sam.annotator_3d` in the command line. Run `micro_sam.annotator_3d -h` for details.
56-
- calling `micro_sam.sam_annotator.annotator_3d` in a python script. Check out [examples/sam_annotator_3d.py](https://github.com/computational-cell-analytics/micro-sam/blob/master/examples/sam_annotator_3d.py) for details.
56+
- calling `micro_sam.sam_annotator.annotator_3d` in a python script. Check out [examples/annotator_3d.py](https://github.com/computational-cell-analytics/micro-sam/blob/master/examples/annotator_3d.py) for details.
5757

5858
The user interface of the 3d annotator looks like this:
5959

@@ -76,7 +76,7 @@ Check out [this video](https://youtu.be/5Jo_CtIefTM) for an overview of the inte
7676
The tracking annotator can be started by
7777
- clicking `Tracking annotator` in the `micro_sam` GUI.
7878
- running `$ micro_sam.annotator_tracking` in the command line. Run `micro_sam.annotator_tracking -h` for details.
79-
- calling `micro_sam.sam_annotator.annotator_tracking` in a python script. Check out [examples/sam_annotator_tracking.py](https://github.com/computational-cell-analytics/micro-sam/blob/master/examples/sam_annotator_tracking.py) for details.
79+
- calling `micro_sam.sam_annotator.annotator_tracking` in a python script. Check out [examples/annotator_tracking.py](https://github.com/computational-cell-analytics/micro-sam/blob/master/examples/annotator_tracking.py) for details.
8080

8181
The user interface of the tracking annotator looks like this:
8282

doc/python_library.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This functionality is used to implement the `micro_sam` annotation tools, but yo
1111
## Finetuned models
1212

1313
We provide fine-tuned Segment Anything models for microscopy data. They are still in an experimental stage and we will upload more and better models soon, as well as the code for fine-tuning.
14-
For using the current models, check out the [2d annotator example](https://github.com/computational-cell-analytics/micro-sam/blob/master/examples/sam_annotator_2d.py#L62) and set `use_finetuned_model` to `True`.
14+
For using the current models, check out the [2d annotator example](https://github.com/computational-cell-analytics/micro-sam/blob/master/examples/annotator_2d.py#L62) and set `use_finetuned_model` to `True`.
1515
See the difference between the normal and fine-tuned Segment Anything ViT-h model on an image from [LiveCELL](https://sartorius-research.github.io/LIVECell/):
1616

1717
<img src="https://raw.githubusercontent.com/computational-cell-analytics/micro-sam/master/doc/images/vanilla-v-finetuned.png" width="768">

examples/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# micro_sam examples
22

33
Examples for using the micro_sam annotation tools:
4-
- `sam_annotator_2d.py`: run the interactive 2d annotation tool
5-
- `sam_annotator_3d.py`: run the interactive 3d annotation tool
6-
- `sam_annotator_tracking.py`: run the interactive tracking annotation tool
7-
- `sam_image_series_annotator.py`: run the annotation tool for a series of images
4+
- `annotator_2d.py`: run the interactive 2d annotation tool
5+
- `annotator_3d.py`: run the interactive 3d annotation tool
6+
- `annotator_tracking.py`: run the interactive tracking annotation tool
7+
- `image_series_annotator.py`: run the annotation tool for a series of images
88

99
The folder `use_as_library` contains example scripts that show how `micro_sam` can be used as a python
1010
library to apply Segment Anything on mult-dimensional data.

examples/use_as_library/instance_segmentation.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
def cell_segmentation():
88
"""Run the instance segmentation functionality from micro_sam for segmentation of
9-
HeLA cells. You need to run examples/sam_annotator_2d.py:hela_2d_annotator once before
9+
HeLA cells. You need to run examples/annotator_2d.py:hela_2d_annotator once before
1010
running this script so that all required data is downloaded and pre-computed.
1111
"""
1212
image_path = "../data/hela-2d-image.png"
@@ -66,7 +66,7 @@ def cell_segmentation():
6666

6767
def segmentation_with_tiling():
6868
"""Run the instance segmentation functionality from micro_sam for segmentation of
69-
cells in a large image. You need to run examples/sam_annotator_2d.py:wholeslide_annotator once before
69+
cells in a large image. You need to run examples/annotator_2d.py:wholeslide_annotator once before
7070
running this script so that all required data is downloaded and pre-computed.
7171
"""
7272
image_path = "../data/whole-slide-example-image.tif"

0 commit comments

Comments
 (0)