Skip to main content

A Deep learning pipeline for segmentation of fluorescent labels in microscopy images

Project description

Welcome to

deepflash2

Official repository of deepflash2 - a deep learning pipeline for segmentation of fluorescent labels in microscopy images.

CI PyPI PyPI - Downloads Conda (channel only) Build fastai images GitHub stars GitHub forks


Quick Start in 30 seconds

Colab

deepflash2 training getting started

Examplary training workflow.

Why using deepflash2?

The best of two worlds: Combining state of the art deep learning with a barrier free environment for life science researchers.

  • End-to-end process for life science researchers
    • graphical user interface - no coding skills required
    • free usage on Google Colab at no costs
    • easy deployment on own hardware
  • Rigorously evaluated deep learning models
    • Model Library
    • easy integration new (pytorch) models
  • Best practices model training
    • leveraging the fastai library
    • mixed precision training
    • learning rate finder and fit one cycle policy
    • advanced augementation
  • Reliable prediction on new data
    • leveraging Bayesian Uncertainties

Kaggle Gold Medal and Innovation Price Winner

deepflash2 does not only work on fluorescent labels. The deepflash2 API built the foundation for winning the Innovation Award a Kaggle Gold Medal in the HuBMAP - Hacking the Kidney challenge. Have a look at our solution

Gold Medal

Citing

We're working on a peer reviewed publication. Until than, the preliminary citation is:

@misc{griebel2021deepflash2,
  author = {Matthias Griebel},
  title = {DeepFLasH2 - a deep learning pipeline for segmentation of fluorescent labels in microscopy images},
  year = {2021},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/matjesg/deepflash2}}
}

Workflow

tbd

Installing

You can use deepflash2 by using Google Colab. You can run every page of the documentation as an interactive notebook - click "Open in Colab" at the top of any page to open it.

  • Be sure to change the Colab runtime to "GPU" to have it run fast!
  • Use Firefox or Google Chrome if you want to upload your images.

You can install deepflash2 on your own machines with conda (highly recommended):

conda install -c fastai -c pytorch -c matjesg deepflash2 

To install with pip, use

pip install deepflash2

If you install with pip, you should install PyTorch first by following the PyTorch installation instructions.

Using Docker

Docker images for deepflash2 are built on top of the latest pytorch image and fastai images. You must install Nvidia-Docker to enable gpu compatibility with these containers.

  • CPU only

docker run -p 8888:8888 matjesg/deepflash

  • With GPU support (Nvidia-Docker must be installed.) has an editable install of fastai and fastcore.

docker run --gpus all -p 8888:8888 matjesg/deepflash All docker containers are configured to start a jupyter server. deepflash2 notebooks are available in the deepflash2_notebooks folder.

For more information on how to run docker see docker orientation and setup and fastai docker.

Creating segmentation masks with Fiji/ImageJ

If you don't have labelled training data available, you can use this instruction manual for creating segmentation maps. The ImagJ-Macro is available here.

Acronym

A Deep-learning pipeline for Fluorescent Label Segmentation that learns from Human experts

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

deepflash2-0.1.3.tar.gz (52.8 kB view details)

Uploaded Source

Built Distribution

deepflash2-0.1.3-py3-none-any.whl (61.9 kB view details)

Uploaded Python 3

File details

Details for the file deepflash2-0.1.3.tar.gz.

File metadata

  • Download URL: deepflash2-0.1.3.tar.gz
  • Upload date:
  • Size: 52.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.8.5

File hashes

Hashes for deepflash2-0.1.3.tar.gz
Algorithm Hash digest
SHA256 5fb9163cb27174d839bfa1c7ada799abe87df18a758999bf02d18a25c02a937f
MD5 76905449ff0918acb6570f3a312eb510
BLAKE2b-256 6240c022dc1bfd582b750b7ac4bb92d24d97c38d2a6d733ddb5a361d6074b57d

See more details on using hashes here.

File details

Details for the file deepflash2-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: deepflash2-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 61.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.8.5

File hashes

Hashes for deepflash2-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 5e44a22304ce8df7755f627128df48b3e759c436fada26e119ed408009fa07d6
MD5 0fae7237360123b63f49123f60265f40
BLAKE2b-256 97c45d3eea5fd579578d5fd7ae02d4ac1ee0f4a4c5f0dcbeb021bf6080873642

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page