NOTE: This repository has a new home. New development and release will be available via https://github.com/AllenCell/aics-ml-segmentation
The Allen Cell Structure Segmenter is a Python-based open source toolkit developed for 3D segmentation of intracellular structures in fluorescence microscope images, developed at the Allen Institute for Cell Science. This toolkit consists of two complementary elements, a classic image segmentation workflow with a restricted set of algorithms and parameters and an iterative deep learning segmentation workflow. We created a collection of 20 classic image segmentation workflows based on 20 distinct and representative intracellular structure localization patterns as a lookup table reference and starting point for users. The iterative deep learning workflow can take over when the classic segmentation workflow is insufficient. Two straightforward human-in-the-loop curation strategies convert a set of classic image segmentation workflow results into a set of 3D ground truth images for iterative model training without the need for manual painting in 3D. The Allen Cell Structure Segmenter thus leverages state of the art computer vision algorithms in an accessible way to facilitate their application by the experimental biology researcher. More details including algorithms, validations, examples, and video tutorials can be found at allencell.org/segmenter or in our bioRxiv paper.
Note: This repository has only the code for the "Iterative Deep Learning Workflow". The classic part can be found at https://github.com/AllenInstitute/aics-segmentation
- prerequisite:
To perform training/prediction of the deep learning models in this package, we assume an NVIDIA GPU has been set up properly on a Linux operating system, either on a local machine or on a remote computation cluster. Make sure to check if your GPU supports at least CUDA 8.0 (CUDA 9.0 and up is preferred): NVIDIA Driver check.
The GPUs we used to develop and test our package are two types: (1) GeForce GTX 1080 Ti GPU (about 11GB GPU memory), (2) Titan Xp GPU (about 12GB GPU memory), (3) Tesla V100 for PCIe (with about 33GB memory). These cover common chips for personal workstations and data centers.
Note 1: As remote GPU clusters could be set up differently from institute to institute, we will assume a local machine use case through out the installation and demos.
Note 2: We are investigating alternative cloud computing service to deploy our package and will have updates in the next few months. Stay tuned :)
- create a conda environment:
conda create --name mlsegmenter python=3.6(For how to install conda, see here)
- activate your environment and do the installation within the environment:
conda activate mlsegmenter (Note: always check out conda documentation for updates. If you are using an older version of conda, you may need to activate the environment by source activate mlsegmenter.)
- Install Pytorch
Go to PyTorch website, and find the right installation command for you.
- we use version 1.0 (which is the stable version at the time of our development)
- we use Linux (OS), Conda (package), python 3.6 (Language), CUDA=10.0 (Question about CUDA? see setup CUDA).
Make sure you use either the automatically generated command on PyTorch website, or the command recommended on PyTorch website for installing older version
- Install Allen Cell Segmenter (deep learning part)
git clone https://github.com/AllenInstitute/aics-ml-segmentation.git
cd ./aics-ml-segmentation
pip install -e .The -e flag when doing pip install will allow users to modify any the source code without the need of re-installing the package afterward. You may do the installation without -e, if you don't want any change on the code.
We are offering it to the community AS IS; we have used the toolkit within our organization. We are not able to provide guarantees of support. However, we welcome feedback and submission of issues. Users are encouraged to sign up on our Allen Cell Discussion Forum for community quesitons and comments.