Skip to content

Commit

Permalink
corrected typo in python library.md and updated installer isntaructio…
Browse files Browse the repository at this point in the history
…ns in installation.md (#581)
  • Loading branch information
lufre1 authored May 3, 2024
1 parent fa4318e commit fc1efa5
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
12 changes: 7 additions & 5 deletions doc/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,13 @@ The installers will not enable you to use a GPU, so if you have one then please

To use the installer:
- Unpack the zip file you have downloaded.
- Make the installer executable: `$ chmod +x micro_sam-0.2.0post1-Linux-x86_64.sh`
- Run the installer: `$./micro_sam-0.2.0post1-Linux-x86_64.sh$`
- Make the installer executable: `$ chmod +x micro_sam-1.0.0post0-Linux-x86_64.sh`
- Run the installer: `./micro_sam-1.0.0post0-Linux-x86_64.sh`
- You can select where to install `micro_sam` during the installation. By default it will be installed in `$HOME/micro_sam`.
- The installer will unpack all `micro_sam` files to the installation directory.
- After the installation you can start the annotator with the command `.../micro_sam/bin/micro_sam.annotator`.
- To make it easier to run the annotation tool you can add `.../micro_sam/bin` to your `PATH` or set a softlink to `.../micro_sam/bin/micro_sam.annotator`.
- After the installation you can start the annotator with the command `.../micro_sam/bin/napari`.
- Proceed with the steps described in [Annotation Tools](#annotation-tools)
- To make it easier to run the annotation tool you can add `.../micro_sam/bin` to your `PATH` or set a softlink to `.../micro_sam/bin/napari`.

**Windows Installer:**

Expand All @@ -89,7 +90,8 @@ To use the installer:
- Choose installation type: `Just Me(recommended)` or `All Users(requires admin privileges)`.
- Choose installation path. By default it will be installed in `C:\Users\<Username>\micro_sam` for `Just Me` installation or in `C:\ProgramData\micro_sam` for `All Users`.
- The installer will unpack all micro_sam files to the installation directory.
- After the installation you can start the annotator by double clicking on `.\micro_sam\Scripts\micro_sam.annotator.exe` or with the command `.\micro_sam\Scripts\micro_sam.annotator.exe` from the Command Prompt.
- After the installation you can start the annotator by double clicking on `.\micro_sam\Scripts\micro_sam.annotator.exe` or with the command `.\micro_sam\Scripts\napari.exe` from the Command Prompt.
- Proceed with the steps described in [Annotation Tools](#annotation-tools)

<!---
**Mac Installer:**
Expand Down
2 changes: 1 addition & 1 deletion doc/python_library.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ We provide jupyter notebooks that demonstrate how to use it [here](https://githu

We reimplement the training logic described in the [Segment Anything publication](https://arxiv.org/abs/2304.02643) to enable finetuning on custom data.
We use this functionality to provide the [finetuned microscopy models](#finetuned-models) and it can also be used to train models on your own data.
In fact the best results can be expected when finetuning on your own data, and we found that it does not require much annotated training data to get siginficant improvements in model performance.
In fact the best results can be expected when finetuning on your own data, and we found that it does not require much annotated training data to get significant improvements in model performance.
So a good strategy is to annotate a few images with one of the provided models using our interactive annotation tools and, if the model is not working as good as required for your use-case, finetune on the annotated data.
<!--
TODO: provide link to the paper with results on how much data is needed
Expand Down

0 comments on commit fc1efa5

Please sign in to comment.