change readme.md
[platform/upstream/caffeonacl.git] / acl_openailab / README.md
1 # CaffeOnACL\r
2 [![License](https://img.shields.io/badge/license-BSD-blue.svg)](LICENSE)\r
3 \r
4 CaffeOnACL is a project that is maintained by **OPEN** AI LAB, it uses Arm Compute Library (NEON+GPU) to speed up [Caffe](http://caffe.berkeleyvision.org/) and provide utilities to debug, profile and tune application performance. \r
5 \r
6 The release version is 0.3.0, is based on [Rockchip RK3399](http://www.rock-chips.com/plus/3399.html) Platform, target OS is Ubuntu 16.04. Can download the source code from [OAID/CaffeOnACL](https://github.com/OAID/CaffeOnACL)\r
7 \r
8 * The ARM Computer Vision and Machine Learning library is a set of functions optimised for both ARM CPUs and GPUs using SIMD technologies. See also [Arm Compute Library](https://github.com/ARM-software/ComputeLibrary).\r
9 * Caffe is a fast open framework for deep learning. See also [Caffe](https://github.com/BVLC/caffe).\r
10 \r
11 ### Documents\r
12 * [Installation instructions](https://github.com/OAID/CaffeOnACL/blob/master/acl_openailab/installation.md)\r
13 * [User Manuals PDF](https://github.com/OAID/CaffeOnACL/blob/master/acl_openailab/user_manual.pdf)\r
14 * [Performance Report PDF](https://github.com/OAID/CaffeOnACL/blob/master/acl_openailab/performance_report.pdf)\r
15 \r
16 ### Arm Compute Library Compatibility Issues :\r
17 There are some compatibility issues between ACL and Caffe Layers, we bypass it to Caffe's original layer class as the workaround solution for the below issues\r
18 \r
19 * Normalization in-channel issue\r
20 * Tanh issue\r
21 * Softmax supporting multi-dimension issue\r
22 * Group issue\r
23 \r
24 Performance need be fine turned in the future\r
25 \r
26 # Release History\r
27 The Caffe based version is [793bd96351749cb8df16f1581baf3e7d8036ac37](https://github.com/BVLC/caffe/tree/793bd96351749cb8df16f1581baf3e7d8036ac37).\r
28 \r
29 ### Version 0.3.0 - Aug 26, 2017\r
30 Support Arm Compute Library version 17.06 with 4 new layers added\r
31 \r
32 * Batch Normalization Layer\r
33 * Direct convolution Layer\r
34 * Locally Connect Layer\r
35 * Concatenate layer\r
36 \r
37 \r
38 ### Version 0.2.0 - Jul 2, 2017\r
39 \r
40 Fix the issues:\r
41 \r
42 * Compatible with Arm Compute Library version 17.06\r
43 * When OpenCL initialization fails, even if Caffe uses CPU-mode,it doesn't work properly.\r
44 \r
45 ### Version 0.1.0 - Jun 2, 2017 \r
46    \r
47   Initial version supports 10 Layers accelerated by Arm Compute Library version 17.05 : \r
48 \r
49 * Convolution Layer\r
50 * Pooling Layer\r
51 * LRN Layer\r
52 * ReLU Layer\r
53 * Sigmoid Layer\r
54 * Softmax Layer\r
55 * TanH Layer\r
56 * AbsVal Layer\r
57 * BNLL Layer\r
58 * InnerProduct Layer\r
59 \r
60 # 3 Issue Report\r
61 Encounter any issue, please report on [issue report](https://github.com/OAID/CaffeOnACL/issues). Issue report should contain the following information :\r
62 \r
63 *  The exact description of the steps that are needed to reproduce the issue \r
64 * The exact description of what happens and what you think is wrong \r