Skip to content

Commit 442e803

Browse files
committed
docs: update example and README
1 parent 2008d6f commit 442e803

File tree

2 files changed

+50
-99
lines changed

2 files changed

+50
-99
lines changed

README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,20 @@ Contains multi-task encoder-decoder architectures (U-Net-like) along with dedica
2828

2929
![Architecture](./images/architecture_overview.png)
3030

31+
## Installation
32+
33+
**Basic installation**
34+
35+
```shell
36+
pip install cellseg-models-pytorch
37+
```
38+
39+
**To install extra dependencies (training utilities and datamodules for open-source datasets) use**
40+
41+
```shell
42+
pip install cellseg-models-pytorch[all]
43+
```
44+
3145
## Features
3246

3347
- High level API to define cell/nuclei instance segmentation models.
@@ -55,19 +69,9 @@ Contains multi-task encoder-decoder architectures (U-Net-like) along with dedica
5569
| --------------------------- | ------------------------------------------------------------------------------------------------ |
5670
| [[5, 6](#Citation)] Pannuke | https://arxiv.org/abs/2003.10778 , https://link.springer.com/chapter/10.1007/978-3-030-23937-4_2 |
5771

58-
## Installation
59-
60-
**Basic installation**
72+
## Notebook examples
6173

62-
```shell
63-
pip install cellseg-models-pytorch
64-
```
65-
66-
**To install extra dependencies (training utilities and datamodules for open-source datasets) use**
67-
68-
```shell
69-
pip install cellseg-models-pytorch[all]
70-
```
74+
- [Training Stardist with Pannuke](https://github.com/okunator/cellseg_models.pytorch/blob/main/examples/pannuke_nuclei_segmentation_stardist.ipynb). Uses in-built training utilities and Pytorch-Lightning
7175

7276
## Code Examples
7377

examples/pannuke_nuclei_segmentation_stardist.ipynb

Lines changed: 34 additions & 87 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)