Skip to content

Commit 55f4464

Browse files
committed
Update readme
1 parent 0cf9238 commit 55f4464

1 file changed

Lines changed: 11 additions & 27 deletions

File tree

README.md

Lines changed: 11 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -31,42 +31,26 @@ https://micronuclai.streamlit.app
3131

3232
Inference of micronuclei can be achieved in small to medium-sized example images that can be uploaded to the streamlit app. Image data is processed within a virtual machine (VM) on Heicloud, a local Cloud infrastructure provided by University Computing Center Heidelberg, and images are immediately deleted after micronuclei inference. Once micronuclei are inferred, results predictions as well as several plots describing the results are generated and presented to the user within the streamlit app which can also be downloaded as csv files.
3333

34-
### Local Installation
34+
## Installation
3535

36-
### Prerequisites
37-
38-
Two input files are required for micronuclAI
39-
1. Nuclei-stained Image
40-
2. Associated Mask
41-
42-
### Local Installation
43-
44-
A step by step series of examples that tell you how to get a development
45-
environment running locally
46-
47-
Please ensure you have Python>=3.10 but less than Python<=3.13 installed with
48-
49-
``` bash
50-
python -version
51-
```
52-
53-
Pull the repo into your local device
36+
We recomend to install micronuclAI in a clean environment with Python 3.10, 3.11, or 3.12.
37+
micronuclAI uses PyTorch as the main deep learning framework, check the [official website](https://pytorch.org/) for the specific installation instructions for your system.
5438

39+
### Install micronuclAI from PyPI.
5540
```bash
56-
git clone https://github.com/SchapiroLabor/micronuclAI
41+
pip install micronuclai
5742
```
58-
Install the required libraries
43+
## Usage
5944

60-
``` bash
61-
pip install -r requirements.txt
62-
```
45+
Two input files are required for micronuclAI
46+
1. Nuclei-stained Image
47+
2. Associated Mask
6348

64-
## Usage
6549

66-
To use micronuclAI on your own images:
50+
You can use micronuclAI to predict micronuclei in an image using the following command:
6751

6852
```
69-
python src/model/micronuclai_predict.py -i <path/to/image> -m <path/to/mask> -mod <path/to/model> -o <path/to/output/folder>
53+
micronuclai-predict.py -i <path/to/image> -m <path/to/mask> -mod <path/to/model> -o <path/to/output/folder>
7054
```
7155

7256
A test dataset has been provided in the [test_data](test) folder with a [mask](test/test_mask.tiff) and its corresponding [image](test/test_image.tiff) file.

0 commit comments

Comments
 (0)