Skip to content
Plug-and-Play cloud based deep learning for image segmentation of light, electron and X-ray microscopy
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
aws
mito_testsample
model
scripts added overlay function Feb 11, 2019
singularity/ubuntu-xenial64-sdsc-comet
tests
vagrant
.gitignore added singularity/ubuntu-xenial64-sdsc-comet/build/ to ignore list Mar 20, 2018
.travis.yml
CreateTrainJob.m updated function documentation to match name change Jan 26, 2018
DefDataPackages.m capitalized script to match other .m scripts in directory Apr 20, 2018
EnsemblePredictions.m
LICENSE
Makefile added logic to copy over motd to /etc and to put it into the distribu… Jun 26, 2018
Merge_LargeData.m
PlotValidation.m
PreprocessPackage.m fix so no data is put into input image directory Oct 11, 2018
PreprocessTrainingData.m
PreprocessValidation.m Added validation vs loss plotting May 2, 2018
README.md
StartPostprocessing.m Update StartPostprocessing.m Apr 18, 2018
VERSION
caffepredict.sh Update caffepredict.sh Jun 12, 2019
caffetrain.sh
commonfunctions.sh added get_number_of_models to get count of models which needed to fix… Sep 14, 2018
postprocessworker.sh Added rm calls to remove Pkg_* folders after Merge_LargeData.m has ru… Aug 29, 2018
predictworker.sh
preprocessworker.sh
runprediction.sh
runtraining.sh added --gpu flag to fix issue #48 Sep 14, 2018
runvalidation.sh Added code for plotting accuracy May 7, 2018
trainworker.sh moved caffetrain.sh script into main directory. also renamed run_all_… May 14, 2018

README.md

CDeep3M

Build Status

CDeep3M provides a plug-and-play cloud based deep learning solution for image segmentation of light, electron and X-ray microscopy.

Quickstart CDeep3M on the cloud

Click launch button to spin up the latest release of CDeep3M on the cloud (~20 minute spin up time): (Oregon region)

Launch Deep3m AWS CloudFormation link

NOTE: Running will result in EC2 charges (0.9-3$ per hour runtime)

First time users

Sign up for AWS Account

Just opened your AWS account? Request access to GPU nodes before starting: follow instructions here

SSH key

Follow the instructions on how to link your SSH key. You can directly create the SSH key on AWS.

Launch cloudformation stack

Once approved, launch cloudformation stack using the launch button. Click here for detailed instructions on launching CDeep3M. NOTE: Running CloudFormation stack requires AWS account and will result in EC2 charges (0.9-3$ per hour runtime)

Access your cloud

Click here for instruction how to access your cloudstack

Once you launched the stack:

Shutting AWS cloud down

Done with your segmentation? Don't forget to delete your Cloud Stack

Additional info for more experienced users

Hyperparameters can be adjusted by passing flags to runtraining.sh

References

If you use CDeep3M for your research please cite:

@article{,
  title={CDeep3M - Plug-and-Play cloud based deep learning for image segmentation},
  author={Haberl M., Churas C., Tindall L., Boassa D., Phan S., Bushong E.A., Madany M., Akay R., Deerinck T.J., Peltier S., and Ellisman M.H.},
  journal={Nature Methods},
  year={2018}
  DOI = {10.1038/s41592-018-0106-z}
}

Further reading:

  • CDeep3M open access article in NatureMethods
  • CDeep3M preprint
  • CDeep3M was developped based off a convolutional neural network implemented in DeepEM3D

Support

Please email to cdeep3m@gmail.com for additional questions.

Local install using Docker

Thanks to CrispyCrafter and Jurgen for making a Docker version of CDeep3M. If you want to run CDeep3M locally this should be the quickest way:

Local install, for advanced users/developers only

Installation requirements for local install

NOTE: Getting the following software and configuration setup is not trivial. To try out CDeep3M it is suggested one try CDeep3M in the cloud, desribed above, which eliminates all the following steps.

How to install locally

Step 1) Download release tarball

wget https://github.com/CRBS/cdeep3m/archive/v1.6.3rc3.tar.gz

Step 2) Uncompress

tar -zxf v1.6.3rc3.tar.gz
cd cdeep3m-1.6.3rc3

Step 3) Add to path

export PATH=$PATH:`pwd`

Step 4) Verify

runtraining.sh --version

License

LICENSE for CDeep3M

For contents of model/ see model/LICENSE file for license

Acknowledgements

  • CDeep3M was developped based off a convolutional neural network implemented in DeepEM3D

  • Support from NIH grants 5P41GM103412-29 (NCMIR), 5p41GM103426-24 (NBCR), 5R01GM082949-10 (CIL)

  • The DIVE lab for making DeepEM3D publicly available.

  • O. Tange (2011): GNU Parallel - The Command-Line Power Tool, ;login: The USENIX Magazine, February 2011:42-47.

  • This research benefitted from the use of credits from the National Institutes of Health (NIH) Cloud Credits Model Pilot, a component of the NIH Big Data to Knowledge (BD2K) program.

You can’t perform that action at this time.