Skip to content

Commit

Permalink
chore: bump version, up readme, changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
okunator committed Jan 13, 2023
1 parent 345b4bd commit 4950020
Show file tree
Hide file tree
Showing 12 changed files with 30 additions and 34 deletions.
17 changes: 5 additions & 12 deletions BENCHMARKS.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,6 @@ The model latencies depend on the hardware. I'll benhmark the latencies on my la

**Pannuke** and **Lizard** datasets are divided in three splits. For these datasets, we report the mean of the 3-fold cross-validation. The **CIN2** and **HGSOC** datasets contain only a training splits and relatively small validation splits, thus, for those datasets we report the metrics on the validation split.

#### Regularization methods

The models are regularized during training via multiple regularization techniques to tackle distrubution shifts. Specific techniques (among augmentations) that are used in this benchmark are:

- [Spectral decoupling](https://arxiv.org/abs/2011.09468)
- [Label Smoothing](https://arxiv.org/abs/1512.00567)
- [Spatially Varying Label Smoothing](https://arxiv.org/abs/2104.05788)

#### Pre-trained backbone encoders

All the models are trained/fine-tuned with an IMAGENET pre-trained backbone encoder that is naturally reported.
Expand All @@ -77,12 +69,11 @@ Note that even if these benchmarks are not SOTA or differ from the original manu
| ---------------------- | ----------------------------------------- |
| Optimizer | [AdamP](https://arxiv.org/abs/2006.08217) |
| Auxilliary Branch Loss | MSE-SSIM |
| Type Branch Loss | Focal-DICE |
| Encoder LR | 0.00005 |
| Decoder LR | 0.0005 |
| Type Branch Loss | IoU-DICE |
| LR | Lightning in-built auto-lr-finder |
| Scheduler | Reduce on plateau |
| Batch Size | 10 |
| Training Epochs | 50 |
| Training Epochs | 100 |
| Augmentations | Blur, Hue Saturation |

#### Results Lizard
Expand All @@ -94,3 +85,5 @@ Same as above.
##### Patching Set-up

##### Sliding-window Inference Hyperparams

## The Great Regularization Benchmark
21 changes: 21 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
<a id='changelog-0.1.20'></a>

# 0.1.20 — 2023-01-13

## Fixes

- Enable only writing folder&hdf5 datasets with only images
- Enable writing datasets without patching.

- Add long missing h5 reading utility function to `FileHandler`

## Features

- Add hdf5 input file reading to `Inferer` classes.

- Add option to write pannuke dataset to h5 db in `PannukeDataModule` and `LizardDataModule`.

- Add a generic model builder function `get_model` to `models.__init__.py`

- Rewrite segmentation benchmarker. Now it can take in hdf5 datasets.

<a id='changelog-0.1.19'></a>

# 0.1.19 — 2023-01-04
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ pip install cellseg-models-pytorch[all]

- [Training Stardist with Pannuke](https://github.com/okunator/cellseg_models.pytorch/blob/main/examples/pannuke_nuclei_segmentation_stardist.ipynb). Train the Stardist model with constant sized Pannuke patches.
- [Training Cellpose with Lizard](https://github.com/okunator/cellseg_models.pytorch/blob/main/examples/lizard_nuclei_segmentation_cellpose.ipynb). Train the Cellpose model with Lizard dataset that is composed of varying sized images.
- [Benchmarking Cellpose Trained on Pannuke](https://github.com/okunator/cellseg_models.pytorch/blob/main/examples/pannuke_cellpose_benchmark.ipynb). Benchmark Cellpose trained on Pannuke. Both the model performance and latency.

## Code Examples

Expand Down
2 changes: 1 addition & 1 deletion cellseg_models_pytorch/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
from . import inference, models, utils
from .models import CellPoseUnet, HoverNet, StarDistUnet

__version__ = "0.1.19"
__version__ = "0.1.20"
submodules = ["utils", "models", "inference"]
__all__ = [
"__version__",
Expand Down
4 changes: 0 additions & 4 deletions changelog.d/20230113_170849_oskari.lehtonen.md

This file was deleted.

3 changes: 0 additions & 3 deletions changelog.d/20230113_171230_oskari.lehtonen.md

This file was deleted.

3 changes: 0 additions & 3 deletions changelog.d/20230113_171503_oskari.lehtonen.md

This file was deleted.

3 changes: 0 additions & 3 deletions changelog.d/20230113_171853_oskari.lehtonen.md

This file was deleted.

3 changes: 0 additions & 3 deletions changelog.d/20230113_172102_oskari.lehtonen.md

This file was deleted.

3 changes: 0 additions & 3 deletions changelog.d/20230113_172259_oskari.lehtonen.md

This file was deleted.

2 changes: 1 addition & 1 deletion examples/pannuke_cellpose_benchmark.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -1325,7 +1325,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.12"
"version": "3.9.12 (main, Apr 5 2022, 06:56:58) \n[GCC 7.5.0]"
},
"orig_nbformat": 4,
"vscode": {
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "cellseg_models_pytorch"
version = "0.1.19"
version = "0.1.20"
description = "Python library for 2D cell/nuclei instance segmentation models written with PyTorch."
authors = ["Okunator <[email protected]>"]
license = "MIT"
Expand Down

0 comments on commit 4950020

Please sign in to comment.