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 ambiguous microscopic images.

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


Quick Start in 30 seconds

Colab

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
  • Reliable prediction on new data
    • Quality assurance and out-of-distribution detection

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}}
}

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 fastchan -c matjesg deepflash2 

To install with pip, use

pip install deepflash2

If you install with pip, you should install PyTorch first by following the installation instructions of pytorch or fastai.

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.4.tar.gz (54.0 kB view details)

Uploaded Source

Built Distribution

deepflash2-0.1.4-py3-none-any.whl (63.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: deepflash2-0.1.4.tar.gz
  • Upload date:
  • Size: 54.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.23.0 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.8.12

File hashes

Hashes for deepflash2-0.1.4.tar.gz
Algorithm Hash digest
SHA256 c7eae4137a276afbae6a6a5305efd14187328d0038cd5f8e803d62c42ff1524d
MD5 b9102d99b44fedb886036fae823db55f
BLAKE2b-256 1d4dfa670bd4a4234b770c65a12a41677ebbac59430221c7f73991c8daf70de7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: deepflash2-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 63.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.23.0 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.8.12

File hashes

Hashes for deepflash2-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ef73d4b1c487e247c3b72c489ec40449dfeacf500cbf27506d799a875593c5e3
MD5 bd1ae07fb0f307a7d885f749ade9516d
BLAKE2b-256 db89c2e0ea80b46e008dbbee54c61ad2c00480ee154efaefe998dc8463a7594f

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