Merge pull request #1887 from shelhamer/docs
[platform/upstream/caffe.git] / README.md
1 # Caffe
2
3 Caffe is a deep learning framework made with expression, speed, and modularity in mind.
4 It is developed by the Berkeley Vision and Learning Center ([BVLC](http://bvlc.eecs.berkeley.edu)) and community contributors.
5
6 Check out the [project site](http://caffe.berkeleyvision.org) for all the details like
7
8 - [DIY Deep Learning for Vision with Caffe](https://docs.google.com/presentation/d/1UeKXVgRvvxg9OUdh_UiC5G71UMscNPlvArsWER41PsU/edit#slide=id.p)
9 - [Tutorial Documentation](http://caffe.berkeleyvision.org/tutorial/)
10 - [BVLC reference models](http://caffe.berkeleyvision.org/model_zoo.html) and the [community model zoo](https://github.com/BVLC/caffe/wiki/Model-Zoo)
11 - [Installation instructions](http://caffe.berkeleyvision.org/installation.html)
12
13 and step-by-step examples.
14
15 Please join the [caffe-users group](https://groups.google.com/forum/#!forum/caffe-users) to ask questions and talk about methods and models.
16 Framework development discussions and thorough bug reports are collected on [Issues](https://github.com/BVLC/caffe/issues).
17
18 Happy brewing!
19
20 ## License and Citation
21
22 Caffe is released under the [BSD 2-Clause license](https://github.com/BVLC/caffe/blob/master/LICENSE).
23 The BVLC reference models are released for unrestricted use.
24
25 Please cite Caffe in your publications if it helps your research:
26
27     @article{jia2014caffe,
28       Author = {Jia, Yangqing and Shelhamer, Evan and Donahue, Jeff and Karayev, Sergey and Long, Jonathan and Girshick, Ross and Guadarrama, Sergio and Darrell, Trevor},
29       Journal = {arXiv preprint arXiv:1408.5093},
30       Title = {Caffe: Convolutional Architecture for Fast Feature Embedding},
31       Year = {2014}
32     }