doc update
[jacinto-ai/caffe-jacinto.git] / README.md
1 # Caffe-jacinto
3 ###### Notice: 
4 - If you have not visited our landing page in github, please do so: [https://github.com/TexasInstruments/jacinto-ai-devkit](https://github.com/TexasInstruments/jacinto-ai-devkit)
5 - **Issue Tracker for jacinto-ai-devkit:** You can file issues or ask questions at **e2e**: [https://e2e.ti.com/support/processors/f/791/tags/jacinto_2D00_ai_2D00_devkit](https://e2e.ti.com/support/processors/f/791/tags/jacinto_2D00_ai_2D00_devkit). While creating a new issue kindly include **jacinto-ai-devkit** in the tags (as you create a new issue, there is a space to enter tags, at the bottom of the page). 
6 - **Issue Tracker for TIDL:** [https://e2e.ti.com/support/processors/f/791/tags/TIDL](https://e2e.ti.com/support/processors/f/791/tags/TIDL). Please include the tag **TIDL** (as you create a new issue, there is a space to enter tags, at the bottom of the page). 
7 - If you do not get a reply within two days, please contact us at: jacinto-ai-devkit@list.ti.com
9 ###### Caffe-jacinto - embedded deep learning framework
11 Caffe-jacinto is a fork of [NVIDIA/caffe](https://github.com/NVIDIA/caffe), which in-turn is derived from [BVLC/Caffe](https://github.com/BVLC/caffe). The modifications in this fork enable training of sparse, quantized CNN models - resulting in low complexity models that can be used in embedded platforms. 
13 For example, the semantic segmentation example (see below) shows how to train a model that is nearly 80% sparse (only 20% non-zero coefficients) and 8-bit quantized. This reduces the complexity of convolution layers by <b>5x</b>. An inference engine designed to efficiently take advantage of sparsity can run <b>significantly faster</b> by using such a model. 
15 Care has to be taken to strike the right balance between quality and speedup. We have obtained more than 4x overall speedup for CNN inference on embedded device by applying sparsity. Since 8-bit multiplier is sufficient (instead of floating point), the speedup can be even higher on some platforms. See the section on quantization below for more details.
17 **Important note - Support for SSD Object detection has been added. The relevant SSD layers have been ported over from the [original Caffe SSD implementation](https://github.com/weiliu89/caffe/tree/ssd).** This is probably the first time that SSD object detection is added to a fork of [NVIDIA/caffe](https://github.com/NVIDIA/caffe). This enables fast training of SSD object detection with all the additional speedup benefits that [NVIDIA/caffe](https://github.com/NVIDIA/caffe) offers. 
19 **Examples for training and inference (image classification, semantic segmentation and SSD object detection) are in [tidsp/caffe-jacinto-models](https://github.com/tidsp/caffe-jacinto-models).**
21 ### Installation
22 * After cloning the source code, switch to the branch caffe-0.17, if it is not checked out already.
23 -- *git checkout caffe-0.17*
25 * Please see the [**installation instructions**](INSTALL.md) for installing the dependencies and building the code. 
27 ### Training procedure
28 **After cloning and building this source code, please visit [tidsp/caffe-jacinto-models](https://github.com/tidsp/caffe-jacinto-models) to do the training.**
30 ### Additional Information (can be skipped)
32 **SSD Object detection is supported. The relevant SSD layers have been ported over from the [original Caffe SSD implementation](https://github.com/weiliu89/caffe/tree/ssd).** Note: caffe-0.16 branch allows us to set different types (float, float16 for forward, backward and math types). However for the SSD specific layers, forward, backward and math must use the same type - this limitation can probably be overcome by spending some more time in the porting - but it doesn't look like a serious limitation.
34 New layers and options have been added to support sparsity and quantization. A brief explanation is given in this section, but more details can be found by [clicking here](FEATURES.md). 
36 Note that Caffe-jacinto does not directly support any embedded/low-power device. But the models trained by it can be used for fast inference on such a device due to the sparsity and quantization.
38 ###### Additional layers
39 * ImageLabelData and IOUAccuracy layers have been added to train for semantic segmentation.
41 ###### Sparsity
42 * Sparse training methods: zeroing out of small coefficients during training, or fine tuning without updating the zero coefficients - similar to caffe-scnn [paper](https://arxiv.org/abs/1608.03665), [code](https://github.com/wenwei202/caffe/tree/scnn). It is possible to set a target sparsity and the training will try to achieve that.
43 * Measuring sparsity in convolution layers while training is in progress. 
44 * Thresholding tool to zero-out some convolution weights in each layer to attain certain sparsity in each layer.
46 ###### Quantization
47 * **Estimate the accuracy drop by simulating quantization. Note that caffe-jacinto does not actually do quantization - it only simulates the accuracy loss due to quantization - by quantizing the coefficients and activations and then converting it back to float.** And embedded implementation can use the methods used here to achieve speedup by using only integer arithmetic.
48 * Variuos options are supported to control the quantization. Important features include: power of 2 quantization, non-power of 2 quantization, bitwidths, applying of offset to control bias around zero. See definition of NetQuantizationParameter for more details.
49 * Dynamic -8 bit fixed point quantization, improved from Ristretto [paper](https://arxiv.org/abs/1605.06402), [code](https://github.com/pmgysel/caffe).
51 ###### Absorbing Batch Normalization into convolution weights
52 * A tool is provided to absorb batch norm values into convolution weights. This may help to speedup inference. This will also help if Batch Norm layers are not supported in an embedded implementation.
54 ### Acknowledgements
55 This repository was forked from [NVIDIA/caffe](http://www.github.com/NVIDIA/caffe) and we have added several enhancements on top of it. We acknowledge use of code from other soruces as listed below, and sincerely thank their authors. See the [LICENSE](/LICENSE) file for the COPYRIGHT and LICENSE notices.
56 * [BVLC/caffe](https://github.com/BVLC/caffe) - base code.
57 * [NVIDIA/caffe](http://www.github.com/NVIDIA/caffe) - base code.
58 * [weiliu89/caffe/tree/ssd](https://github.com/weiliu89/caffe/tree/ssd) - Caffe SSD Object Detection source code and related scripts, which were later incorporated into [NVIDIA/caffe](http://www.github.com/NVIDIA/caffe).
59 * [Ristretto](https://github.com/pmgysel/caffe) - Quantization accuracy simulation
60 * [dilation](https://github.com/fyu/dilation) - Semantic Segmentation data loading layer ImageLabelListData layer (not used in the latest branch) and some parameters.
61 * [MobileNet-Caffe](https://github.com/shicai/MobileNet-Caffe) - Mobilenet scripts are inspired by Mobilenet-Caffe pre-trained models and scripts.
62 * [sp2823/caffe](https://github.com/sp2823/caffe/tree/convolution-depthwise), [BVCL/caffe/pull/5665](https://github.com/BVLC/caffe/pull/5665) - ConvolutionDepthwise layer for faster depthwise separable convolutions.
63 <!---
64 * [drnikolaev/caffe](https://github.com/drnikolaev/caffe) - experimental commits that are not yet integrated into [NVIDIA/caffe](http://www.github.com/NVIDIA/caffe).
65 --->
66 <br>
68 The following sections are kept as it is from the original Caffe.
69 # Caffe
71 Caffe is a deep learning framework made with expression, speed, and modularity in mind.
72 It is developed by the Berkeley Vision and Learning Center ([BVLC](http://bvlc.eecs.berkeley.edu))
73 and community contributors.
75 # NVCaffe
77 NVIDIA Caffe ([NVIDIA Corporation &copy;2017](http://nvidia.com)) is an NVIDIA-maintained fork
78 of BVLC Caffe tuned for NVIDIA GPUs, particularly in multi-GPU configurations.
79 Here are the major features:
80 * **16 bit (half) floating point train and inference support**.
81 * **Mixed-precision support**. It allows to store and/or compute data in either 
82 64, 32 or 16 bit formats. Precision can be defined for every layer (forward and 
83 backward passes might be different too), or it can be set for the whole Net.
84 * **Layer-wise Adaptive Rate Control (LARC) and adaptive global gradient scaler** for better
85  accuracy, especially in 16-bit training.
86 * **Integration with  [cuDNN](https://developer.nvidia.com/cudnn) v7**.
87 * **Automatic selection of the best cuDNN convolution algorithm**.
88 * **Integration with v2.2 of [NCCL library](https://github.com/NVIDIA/nccl)**
89  for improved multi-GPU scaling.
90 * **Optimized GPU memory management** for data and parameters storage, I/O buffers 
91 and workspace for convolutional layers.
92 * **Parallel data parser, transformer and image reader** for improved I/O performance.
93 * **Parallel back propagation and gradient reduction** on multi-GPU systems.
94 * **Fast solvers implementation with fused CUDA kernels for weights and history update**.
95 * **Multi-GPU test phase** for even memory load across multiple GPUs.
96 * **Backward compatibility with BVLC Caffe and NVCaffe 0.15 and higher**.
97 * **Extended set of optimized models** (including 16 bit floating point examples).
100 ## License and Citation
102 Caffe is released under the [BSD 2-Clause license](https://github.com/BVLC/caffe/blob/master/LICENSE).
103 The BVLC reference models are released for unrestricted use.
105 Please cite Caffe in your publications if it helps your research:
107     @article{jia2014caffe,
108       Author = {Jia, Yangqing and Shelhamer, Evan and Donahue, Jeff and Karayev, Sergey and Long, Jonathan and Girshick, Ross and Guadarrama, Sergio and Darrell, Trevor},
109       Journal = {arXiv preprint arXiv:1408.5093},
110       Title = {Caffe: Convolutional Architecture for Fast Feature Embedding},
111       Year = {2014}
112     }
114 ## Useful notes
116 Libturbojpeg library is used since 0.16.5. It has a packaging bug. Please execute the following (required for Makefile, optional for CMake):
117 ```
118 sudo apt-get install libturbojpeg
119 sudo ln -s /usr/lib/x86_64-linux-gnu/libturbojpeg.so.0.1.0 /usr/lib/x86_64-linux-gnu/libturbojpeg.so
120 ```