User Tools

Site Tools


auto_2d_class_selection
This version is outdated by a newer approved version.DiffThis version (2020/03/10 13:11) is a draft.
Approvals: 0/1
The Previously approved version (2020/03/03 12:32) is available.Diff

This is an old revision of the document!


Cinderella: Deep learning based binary classification tool


"The good ones go into the pot, the bad ones go into your crop."

                                                        From the fairy tale Cinderella


Our binary classification tool (Cinderella) is based on a deep learning network to classify class averages, micrographs or subtomograms into good and bad categories. For class averages, it supports .hdf/.mrcs, for micrographs .mrc format and for subtomograms it expect that they are saved in a .hdf file. Cinderella was written to automate cryo-em data processing. It's open source and easy to use. We provide a pretrained general model for classifying class averages.(see tutorial). But you can easily train it with your own set of classes/micrographs/subtomograms.

2D class selection model

Our model was trained on a set of 2D classes from ISAC. During the creation of the training dataset, I tried to ask myself “Which class would I select If I would not know the particle?” to decide which is a good class. Here are a couple of examples for good / bad classes in Cinderella:

The training dataset does not contain any Relion classes, so it might be that Cinderella will not work with well them.

You can easily contribute your own classes!

Right now our model is trained on 20 datasets. But we will increase the number often!

Download

Cinderella

Version: 0.6.0

Uploaded: 10. March 2020

DOWNLOAD

Pretrained model (2D classes)

Uploaded: 10. March 2020, Datasets: 22

DOWNLOAD

Valid configuration file

Archive

Old versions of cinderella and the pretrained model can be found in the archive

Changelog

Version 0.6

  • Fix an issue for classes in mrcs format
  • Minor changes

Version 0.5

  • Add support for subtomograms
  • Faster file reading

Version 0.4

  • Balances unbalanced training datasets.
  • It is now possible to train Cinderella to select micrographs
  • Updated the general model for 2D class selection.

Version 0.3.1

  • Downgrade to tensorflow 1.10.1 again, as user report long initialization times
  • Only report the number of good / bad classes + their fraction.

Version 0.3.0

  • More data augmentation (add rotation)
  • Better sampling of validation data. It is now ensured that each file contributes some validation data.
  • Updated tensorflow to 1.12.3 to make it compatible to the crYOLO environment

Contribute

Here is the repository of our training data:

Download the public training data

Unfortunately, we cannot upload the complete training dataset, as some classes are from projects that are not yet published.

If you want to contribute with your own classes, please upload them here:

Contribute good / bad classes

Ideally, please upload separate HDF/mrcs files for good and bad classes. You can do this separation with EMAN2's e2display. However, you can also upload the classes without separation and we will try to do it.

Installation

The following instructions assume that pip and anaconda or miniconda are available. In case you have a old cinderella environment installed, first remove the old one with:

conda env remove --name cinderella

After that, create a new virtual environment:

conda create -n cinderella -c anaconda python=3.6 pyqt=5 cudnn=7.1.2 numpy==1.14.5

Activate the environment:

source activate cinderella

Install Cinderella for GPU:

pip install cinderella[gpu]

… or CPU:

pip install cinderella[cpu]

Tutorial

auto_2d_class_selection.1583842288.txt.gz · Last modified: 2020/03/10 13:11 by twagner