This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
downloads:cryolo_1 [2019/02/12 13:22] twagner [crYOLO] |
downloads:cryolo_1 [2020/02/07 13:50] twagner [Installation] |
||
---|---|---|---|
Line 7: | Line 7: | ||
If you are interested in using crYOLO in a commercial context please contact [[stefan.raunser@mpi-dortmund.mpg.de|stefan.raunser@mpi-dortmund.mpg.de]] | If you are interested in using crYOLO in a commercial context please contact [[stefan.raunser@mpi-dortmund.mpg.de|stefan.raunser@mpi-dortmund.mpg.de]] | ||
- | ====== Download ====== | ||
+ | ====== Paper ====== | ||
+ | You can find more technical details in our paper: | ||
- | ---- | + | Nature Communications Biology: |
+ | [[https:// | ||
+ | Preprint: | ||
+ | [[https:// | ||
+ | |||
+ | < | ||
+ | <a href=" | ||
+ | </ | ||
+ | |||
+ | ====== Download ====== | ||
+ | |||
+ | <note important> | ||
Before downloading or using this product, make sure you **understand and accept the [[: | Before downloading or using this product, make sure you **understand and accept the [[: | ||
+ | </ | ||
- | ---- | ||
====crYOLO==== | ====crYOLO==== | ||
- | Version: 1.2.2 | ||
- | Uploaded: 21. December 2018 | + | Version: 1.5.6 |
- | [[ftp://ftp.gwdg.de/pub/ | + | Uploaded: |
+ | |||
+ | [[https://pypi.org/project/cryolo/#files|DOWNLOAD]] | ||
+ | |||
+ | Please see [[downloads: | ||
====crYOLO boxmanager==== | ====crYOLO boxmanager==== | ||
- | Version: 1.1.1 | + | Version: 1.2.9 |
- | Uploaded: | + | Uploaded: |
- | [[ftp://ftp.gwdg.de/pub/misc/sphire/ | + | [[https://pypi.org/project/cryoloBM/#files|DOWNLOAD]] |
[{{ : | [{{ : | ||
- | ==== General PhosaurusNet | + | ==== General PhosaurusNet |
- | | + | |
- | Uploaded: 21. December 2018 | + | [[pipeline:window: |
- | [[ftp:// | + | === For cryo images (low-pass filtered) === |
+ | Number of datasets: 43 real, 10 simulated, 10 particle free datasets on various grids with contamination | ||
+ | |||
+ | Uploaded: 15. Oktober 2019 | ||
+ | |||
+ | [[ftp:// | ||
|DOWNLOAD]] | |DOWNLOAD]] | ||
- | [[pipeline:window: | + | === For cryo images (neural network denoised with JANNI) === |
+ | Number of datasets: 43 real, 10 simulated, 10 particle free datasets on various grids with contamination | ||
- | Info: Trained on cryo images, therefore negative stain will not work. | + | Uploaded: 15. Oktober 2019 |
+ | [[ftp:// | ||
+ | |DOWNLOAD]] | ||
+ | < | ||
+ | The performance of the general model based on JANNI denoised data compared to low-pass filtered data did not improve. The average AUC on the validation data was in both cases the same (0.85). But this might be because of the data selected for the general model. I assume that especially on very noisy micrographs JANNI will improve the results. | ||
+ | </ | ||
+ | |||
+ | |||
+ | === For negative stain images === | ||
+ | Number of datasets: 10 real datasets | ||
+ | |||
+ | Uploaded: 26. February 2019 | ||
+ | |||
+ | [[ftp:// | ||
+ | |DOWNLOAD]] | ||
====ARCHIVE==== | ====ARCHIVE==== | ||
Previous versions of crYOLO, the boxmanager and the general models can be found here: [[http:// | Previous versions of crYOLO, the boxmanager and the general models can be found here: [[http:// | ||
- | ====== | + | |
+ | ====== | ||
+ | |||
+ | **System requirements: | ||
+ | |||
+ | crYOLO was tested on **Ubuntu 16.04.4 LTS** and **Ubuntu 18.04** with an NVIDIA Geforce 1080 / Geforce 1080Ti. | ||
+ | |||
+ | However, it should run on **Windows** as well. | ||
+ | |||
+ | As the GPU accelerated version of tensorflow does not support **MacOS**, crYOLO does not support it either. | ||
+ | |||
+ | |||
+ | crYOLO depends on CUDA Toolkit 9.0 and the cuDNN 7.1.2 library. | ||
+ | It will be automatically installed during crYOLO installation. | ||
+ | |||
+ | **Install crYOLO!** | ||
+ | |||
+ | The following instructions assume that pip and [[https:// | ||
+ | In case you have a old cryolo environment installed, first remove the old one with: | ||
+ | < | ||
+ | conda env remove --name cryolo | ||
+ | </ | ||
+ | After that, create a new virtual environment: | ||
+ | < | ||
+ | conda create -n cryolo -c anaconda python=3.6 pyqt=5 cudnn=7.1.2 numpy==1.14.5 cython wxPython==4.0.4 intel-openmp==2019.4 | ||
+ | </ | ||
+ | |||
+ | Activate the environment: | ||
+ | < | ||
+ | source activate cryolo | ||
+ | </ | ||
+ | |||
+ | In case you run **crYOLO on a GPU** run: | ||
+ | < | ||
+ | pip install ' | ||
+ | </ | ||
+ | |||
+ | But if you want to run **crYOLO on a CPU** run: | ||
+ | < | ||
+ | pip install ' | ||
+ | </ | ||
+ | |||
+ | < | ||
+ | During the installation of crYOLO you will see the following error message: | ||
+ | '' | ||
+ | However, you can ignore it. It is actually also working with numpy==1.14.5 | ||
+ | </ | ||
+ | |||
+ | <note tip> | ||
+ | In case you want to integrate crYOLO in your module system, [[pipeline: | ||
+ | </ | ||
+ | |||
+ | |||
+ | <note important> | ||
+ | **Known issues** | ||
* Issue 0: Training on multiple GPUs sometimes lead to worse performance (higher loss). We currently recommend to train on single gpus. | * Issue 0: Training on multiple GPUs sometimes lead to worse performance (higher loss). We currently recommend to train on single gpus. | ||
+ | * Issue 17: On the fly filtering (%%--%%otf) is slower than using it not, as the filtering is not parallelized in this case. | ||
+ | * Issue 27: Filament mode is not working with micrographs motion corrected by unblur. Will be fixed in the next release. | ||
+ | |||
+ | |||
+ | |||
+ | <hidden Closed issues> | ||
* < | * < | ||
* < | * < | ||
Line 66: | Line 161: | ||
* < | * < | ||
* < | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | * < | ||
+ | </ | ||
+ | </ | ||
- | ====== Change log ===== | + | **That' |
- | ====crYOLO==== | + | You might want to check if everything is running as expected. Here is a reference example: |
- | **crYOLO Version 1.2.3:** | + | [[http:// |
- | * crYOLO now saves the anchors which were used to train a model inside the model and takes care that it is used during prediction. | + | ===== Run it on the CPU ==== |
- | * LineEnhancer dependency is now installed via PyPi, as --follow-dependency-links is removed in pip 19. | + | |
- | * Fix Issue 9: Removed zignor dependency as it leads to problems for some users (Thanks to Jason Kaelber) | + | |
- | * Attempt to fix Issue 10: Removed opencv dependency which was connected to this problem (Thanks to Shaun Rawson) | + | |
- | * Fix issue 11: crYOLO uses now GPU 0 by default if not specified otherwise (e.g. by CUDA_VISIBLE_DEVICES) | + | |
- | **crYOLO Version 1.2.2:** | + | There is also a way to run crYOLO |
- | * Added the PhosaurusNet | + | |
- | * crYOLO now outputs separate folders for EMAN box files and STAR files. | + | |
- | * When picking filaments | + | |
- | * Fix Issue 4: The filament mode will crash if crYOLO cannot identify a single particle in the image. | + | |
- | * Fix Issue 5: If movies were aligned with cisTEM and picked with crYOLO, the box positions were vertically flipped. (Thanks to Wei-Chun Kao) | + | |
- | * Fix Issue 6: crYOLO overwrote the CUDA_VISIBLE_DEVICES variable if the -g parameter is not passed. (Thanks to Shaun Rawson) | + | |
- | * Fix Issue 7: crYOLO introduces a shift for non square images proportional to the aspect ratio. (Thanks to Shaun Rawson) | + | |
- | * Fix Issue 8: crYOLO sometimes connects two parallel filaments. The filament tracing was optimized and seems now working properly. | + | |
- | * Fix a severe bug in filament tracing. Curved filaments splitted by crYOLO in more straight sub pieces. However, during the division, one half of the splitted filament was lost. (Thanks to Sabrina Pospich) | + | |
- | * Added a wiki entry about the [[:cryolo_nets|networks which are supported by crYOLO]] | + | |
- | * Added a wiki entry about the [[: | + | |
- | * Added a wiki entry [[: | + | |
- | **crYOLO | + | Picking with crYOLO is also quite fast on the CPU. On my local machine |
- | * Fix Issue 2: Tiff files are now written as 32 bit when internal filtering | + | |
- | * cryolo_evaluation now additionally estimates the optimal threshold based on the F2 score, which puts more weight on recall than on precision | + | |
- | * File ending of filament box files is now .box instead of .txt (Thanks to Jesse M. Hansen) | + | |
- | **crYOLO | + | Training |
- | * Switch | + | |
- | * (Hopefully) fixed that crYOLO sometimes freezes during/ | + | |
- | * Fix that training with multiple GPUs did not speed up small datasets | + | |
- | * Low-pass filtering is now [[http:// | + | |
- | * Fix two bugs in cryolo_evaluation that lead to an underestimation the performance parameters | + | |
- | * cryolo_evaluation is now multithreaded if your training data is organised in subfolders | + | |
- | * cryolo_evaluation now contains a better method for optimal picking threshold estimation | + | |
- | * Refactoring | + | |
- | * Minor bug fixes | + | |
- | **crYOLO Version 1.1.4:** | + | ====== Tutorials ====== |
- | * Hot fix for filament mode when applied to non square images. | + | |
- | **crYOLO Version 1.1.3:** | + | Use our **__'' |
- | * Improved non-maximum-suppression brings 60% speedup during picking! | + | |
- | * Multi GPU support for training and prediction (e.g by adding | + | |
- | | + | |
- | **crYOLO Version 1.1.2:** | + | ====== Change log ====== |
- | * STAR files could now used for training. However, as they don't contain size information the size specified in the anchors in the config.json is used. | + | |
- | * Slightly improved speed of the filament-mode | + | |
- | * Fixed another bug running filament mode on non-square images (Thanks to Gregory Alushin) | + | |
- | **crYOLO | + | ====crYOLO==== |
- | * More efficient MRC reading and batch prediction leads to ~50% faster training and ~70% faster picking when crYOLO | + | {{page> |
- | * 6x faster filament picking | + | ====crYOLO |
- | * Reading of annotation data is now super-fast :-) (Box filename has to be contained into image filename) | + | |
- | * Optimized filament picking parameters | + | |
- | * Fixed bug which made training fail for some 16 bit images | + | |
- | * Fixed bug which could lead to double picked filaments | + | |
- | * Fixed bug running filament mode on non-square images (Thanks to Gregory Alushin) | + | |
- | * Supports EMAN1 helix coordinates | + | |
- | * Support for star file format. During prediction, both box and star files are written. | + | |
- | **crYOLO Version 1.1.0:** | + | **crYOLO |
- | * crYOLO now supports filaments | + | * Fixed a problem that only one filament is shown |
- | * New evaluation tool | + | |
- | * Supports empty box files for training on particle-free images | + | |
- | * Extended data augmentation: | + | |
- | * Experimental support of periodic restarts during training (with --warm_restarts) | + | |
- | **crYOLO Version 1.0.4:** | + | **crYOLO |
- | * Fix a problem reading backend weights from read-only filesystem (Thanks to Michael Cianfrocco and Jason Key) | + | * Add a low pass filter |
- | * Make sure that tensorflow version is >= 1.5.0 and < 1.9.0 | + | |
- | * Add support for subfolders in training and validation directories | + | |
- | * More clear error message when the trained model does not fit to the architecture specified in the config file. | + | |
- | **crYOLO | + | < |
- | * Ignore non-image files during training and predction (Thanks to Kellie Woll) | + | |
- | * Fixed misleading error when non existing folder is used as input for prediction (Thanks to Kellie Woll) | + | |
- | * Add distance threshold during prediction by adding -d distanceInPixel parameter to prediction command (Thanks to Lifei Fu) | + | |
- | * Add " | + | |
- | **crYOLO Version 1.0.2:** | + | **crYOLO |
- | * Fix problem when mrc image has dimensions (1, | + | * Make it compatible with current new environment |
- | **crYOLO Version 1.0.1:** | + | **crYOLO |
- | * Normalization technique | + | * Make it compatible with current new environment |
- | * Unify image augmentation | + | |
+ | **crYOLO Boxmanager Version | ||
+ | * Makes sure that the correct version of MatplotLib | ||
+ | |||
+ | **crYOLO Boxmanager Version 1.2.1:** | ||
+ | * Press " | ||
+ | * Fix for loading different box sets with different colors for the case that on of the box sets are cbox files. | ||
+ | |||
+ | **crYOLO Boxmanager Version 1.2: | ||
+ | * Add interactive threshold selection using cbox files | ||
- | ====crYOLO Boxmanager==== | ||
**crYOLO Boxmanager Version 1.1.1: | **crYOLO Boxmanager Version 1.1.1: | ||
* Fix Issue 3 | * Fix Issue 3 | ||
Line 184: | Line 250: | ||
* Fix crash when cancel import boxfiles | * Fix crash when cancel import boxfiles | ||
* Fix crash with qt4 | * Fix crash with qt4 | ||
+ | </ | ||
==== General PhosaurusNet model ==== | ==== General PhosaurusNet model ==== | ||
+ | **Version 201912:**: | ||
+ | * Added two more datasets. | ||
- | Same datasets | + | **Version 20190516: |
+ | * Added four more inhouse | ||
+ | * Added SNRNP (Thanks to Clement Charenton) | ||
- | ==== General | + | <hidden Old General |
+ | **Version 20190315: | ||
+ | * Added KLH | ||
+ | * Added one inhouse dataset | ||
+ | **Version 20190218:** | ||
+ | * Added K3 apoferritin (Thanks to Shaun Rawson) | ||
+ | * Added two more inhouse datasets | ||
+ | |||
+ | **Version 20181221:** | ||
+ | * Same datasets as the general YOLO network model version 20181120 but with trained with PhosaurusNet. | ||
+ | </ | ||
+ | ==== General YOLO network model in patch mode ==== | ||
+ | <hidden Old general YOLO network model in patch mode> | ||
**Version 20181120:** | **Version 20181120:** | ||
Line 240: | Line 322: | ||
* picornavirus (EMPIAR 10033) and | * picornavirus (EMPIAR 10033) and | ||
* an internal dataset. | * an internal dataset. | ||
- | + | </hidden> | |
- | + | ||
- | ====== System requirements ===== | + | |
- | crYOLO was tested on **Ubuntu 16.04.4 LTS** and **Ubuntu 18.04** with an NVIDIA Geforce 1080 / Geforce 1080Ti. | + | |
- | + | ||
- | However, it should run on **Windows** as well. | + | |
- | + | ||
- | As the GPU accelerated version of tensorflow does not support **MacOS**, crYOLO does not support it either. | + | |
- | + | ||
- | ====== Installation ====== | + | |
- | + | ||
- | crYOLO depends on CUDA Toolkit 9.0 and the cuDNN 7.1.2 library. | + | |
- | It will be automatically installed during crYOLO installation. | + | |
- | + | ||
- | **Install crYOLO!** | + | |
- | + | ||
- | The following instructions assume that pip and [[https:// | + | |
- | In case you have a old cryolo environment installed, first remove the old one with: | + | |
- | < | + | |
- | conda env remove --name cryolo | + | |
- | </ | + | |
- | After that, create a new virtual environment: | + | |
- | < | + | |
- | conda create -n cryolo -c anaconda python=3.6 pyqt=5 cudnn=7.1.2 | + | |
- | </ | + | |
- | + | ||
- | Activate the environment: | + | |
- | < | + | |
- | source activate cryolo | + | |
- | </ | + | |
- | + | ||
- | Install crYOLO: | + | |
- | < | + | |
- | pip install numpy | + | |
- | pip install cryolo-X.Y.Z.tar.gz --process-dependency-links | + | |
- | pip install cryoloBM-X.Y.Z.tar.gz | + | |
- | </ | + | |
- | + | ||
- | That's it! | + | |
- | + | ||
- | ===== Run it on the CPU ==== | + | |
- | + | ||
- | There is also a way to run crYOLO on CPU. This is especially usefull when you would like to apply the generalized model and don't have a NVIDIA GPU. Picking with crYOLO is also quite fast on the CPU. On my local machine (Intel i9) it takes roughly 1 second per micrograph and on our low-performance notebooks (Intel i3) 4 seconds. | + | |
- | + | ||
- | After you followed the crYOLO installation instructions just replace tensorflow-gpu by tensorflow: | + | |
- | < | + | |
- | pip uninstall tensorflow-gpu | + | |
- | pip install tensorflow==1.10.1 | + | |
- | </code> | + | |
- | + | ||
- | Now crYOLO should work on the CPU as well! | + | |
- | + | ||
- | ====== Start picking! ====== | + | |
- | + | ||
- | Use the **__'' | + | |