Skip to content
This repository was archived by the owner on Aug 5, 2022. It is now read-only.

Commit 334a423

Browse files
committed
merge README.md from release_1.0.4b
2 parents e567ac4 + 2625949 commit 334a423

16 files changed

+27827
-132
lines changed

README.md

Lines changed: 76 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,76 @@
1-
# Caffe
2-
[![Build Status](https://travis-ci.org/BVLC/caffe.svg?branch=master)](https://travis-ci.org/BVLC/caffe)
3-
[![License](https://img.shields.io/badge/license-BSD-blue.svg)](LICENSE)
4-
5-
Caffe is a deep learning framework made with expression, speed, and modularity in mind.
6-
It is developed by the Berkeley Vision and Learning Center ([BVLC](http://bvlc.eecs.berkeley.edu)) and community contributors.
7-
8-
Check out the [project site](http://caffe.berkeleyvision.org) for all the details like
9-
- [DIY Deep Learning for Vision with Caffe](https://docs.google.com/presentation/d/1UeKXVgRvvxg9OUdh_UiC5G71UMscNPlvArsWER41PsU/edit#slide=id.p)
10-
- [Tutorial Documentation](http://caffe.berkeleyvision.org/tutorial/)
11-
- [BVLC reference models](http://caffe.berkeleyvision.org/model_zoo.html) and the [community model zoo](https://github.com/BVLC/caffe/wiki/Model-Zoo)
12-
- [Installation instructions](http://caffe.berkeleyvision.org/installation.html)
13-
14-
and step-by-step examples.
15-
16-
[![Join the chat at https://gitter.im/BVLC/caffe](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/BVLC/caffe?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
17-
18-
Please join the [caffe-users group](https://groups.google.com/forum/#!forum/caffe-users) or [gitter chat](https://gitter.im/BVLC/caffe) to ask questions and talk about methods and models.
19-
Framework development discussions and thorough bug reports are collected on [Issues](https://github.com/BVLC/caffe/issues).
20-
21-
Happy brewing!
22-
23-
24-
# SSD: Single Shot MultiBox Detector
25-
This repository contains merged code issued as pull request to BVLC caffe written by:
26-
[Wei Liu](http://www.cs.unc.edu/~wliu/), [Dragomir Anguelov](https://www.linkedin.com/in/dragomiranguelov), [Dumitru Erhan](http://research.google.com/pubs/DumitruErhan.html), [Christian Szegedy](http://research.google.com/pubs/ChristianSzegedy.html), [Scott Reed](http://www-personal.umich.edu/~reedscot/), [Cheng-Yang Fu](http://www.cs.unc.edu/~cyfu/), [Alexander C. Berg](http://acberg.com).
27-
28-
Original branch can be found at https://github.com/weiliu89/caffe/tree/ssd.
29-
30-
Read our [wiki page](https://github.com/intel/caffe/wiki/SSD:-Single-Shot-MultiBox-Detector) for more details.
31-
32-
# Intel® Distribution of Caffe*
33-
This fork is dedicated to improving Caffe performance when running on CPU, in particular Intel® Xeon processors (HSW, BDW, Xeon Phi)
34-
35-
## Building
36-
Build procedure is the same as on bvlc-caffe-master branch. Both Make and CMake can be used.
37-
When OpenMP is available will be used automatically.
38-
39-
## Running
40-
Run procedure is the same as on bvlc-caffe-master branch.
41-
42-
Current implementation uses OpenMP threads. By default the number of OpenMP threads is set
43-
to the number of CPU cores. Each one thread is bound to a single core to achieve best
44-
performance results. It is however possible to use own configuration by providing right
45-
one through OpenMP environmental variables like OMP_NUM_THREADS or GOMP_CPU_AFFINITY.
46-
47-
If some system tool like numactl is used to control CPU affinity, by default caffe will prevent
48-
to use more than one thread per core. When less than required cores are specified, caffe will
49-
limit execution of OpenMP threads to specified cores only.
50-
51-
## Best performance solution
52-
Please read [our Wiki](https://github.com/intel/caffe/wiki/Recommendations-to-achieve-best-performance) for our recommendations and configuration to achieve best performance on Intel CPUs.
53-
54-
## Multinode Training
55-
Intel® Distribution of Caffe* multi-node allows you to execute deep neural network training on multiple machines.
56-
57-
To understand how it works and read some tutorials, go to our Wiki. Start from [Multinode guide](https://github.com/intel/caffe/wiki/Multinode-guide).
58-
59-
## License and Citation
60-
Caffe is released under the [BSD 2-Clause license](https://github.com/BVLC/caffe/blob/master/LICENSE).
61-
The BVLC reference models are released for unrestricted use.
62-
63-
Please cite Caffe in your publications if it helps your research:
64-
65-
@article{jia2014caffe,
66-
Author = {Jia, Yangqing and Shelhamer, Evan and Donahue, Jeff and Karayev, Sergey and Long, Jonathan and Girshick, Ross and Guadarrama, Sergio and Darrell, Trevor},
67-
Journal = {arXiv preprint arXiv:1408.5093},
68-
Title = {Caffe: Convolutional Architecture for Fast Feature Embedding},
69-
Year = {2014}
70-
}
71-
72-
***
73-
*Other names and brands may be claimed as the property of others
74-
75-
76-
1+
# Caffe
2+
[![Build Status](https://travis-ci.org/BVLC/caffe.svg?branch=master)](https://travis-ci.org/BVLC/caffe)
3+
[![License](https://img.shields.io/badge/license-BSD-blue.svg)](LICENSE)
4+
5+
Caffe is a deep learning framework made with expression, speed, and modularity in mind.
6+
It is developed by the Berkeley Vision and Learning Center ([BVLC](http://bvlc.eecs.berkeley.edu)) and community contributors.
7+
8+
Check out the [project site](http://caffe.berkeleyvision.org) for all the details like
9+
- [DIY Deep Learning for Vision with Caffe](https://docs.google.com/presentation/d/1UeKXVgRvvxg9OUdh_UiC5G71UMscNPlvArsWER41PsU/edit#slide=id.p)
10+
- [Tutorial Documentation](http://caffe.berkeleyvision.org/tutorial/)
11+
- [BVLC reference models](http://caffe.berkeleyvision.org/model_zoo.html) and the [community model zoo](https://github.com/BVLC/caffe/wiki/Model-Zoo)
12+
- [Installation instructions](https://github.com/intel/caffe/wiki/Installation)
13+
14+
and step-by-step examples.
15+
16+
[![Join the chat at https://gitter.im/BVLC/caffe](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/BVLC/caffe?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
17+
18+
Please join the [caffe-users group](https://groups.google.com/forum/#!forum/caffe-users) or [gitter chat](https://gitter.im/BVLC/caffe) to ask questions and talk about methods and models.
19+
Framework development discussions and thorough bug reports are collected on [Issues](https://github.com/BVLC/caffe/issues).
20+
21+
Happy brewing!
22+
23+
24+
# SSD: Single Shot MultiBox Detector
25+
This repository contains merged code issued as pull request to BVLC caffe written by:
26+
[Wei Liu](http://www.cs.unc.edu/~wliu/), [Dragomir Anguelov](https://www.linkedin.com/in/dragomiranguelov), [Dumitru Erhan](http://research.google.com/pubs/DumitruErhan.html), [Christian Szegedy](http://research.google.com/pubs/ChristianSzegedy.html), [Scott Reed](http://www-personal.umich.edu/~reedscot/), [Cheng-Yang Fu](http://www.cs.unc.edu/~cyfu/), [Alexander C. Berg](http://acberg.com).
27+
28+
Original branch can be found at https://github.com/weiliu89/caffe/tree/ssd.
29+
30+
Read our [wiki page](https://github.com/intel/caffe/wiki/SSD:-Single-Shot-MultiBox-Detector) for more details.
31+
32+
# Intel® Distribution of Caffe*
33+
This fork is dedicated to improving Caffe performance when running on CPU, in particular Intel® Xeon processors (HSW, BDW, Xeon Phi)
34+
35+
## Building
36+
Build procedure is the same as on bvlc-caffe-master branch. Both Make and CMake can be used.
37+
When OpenMP is available will be used automatically.
38+
39+
## Running
40+
Run procedure is the same as on bvlc-caffe-master branch.
41+
42+
Current implementation uses OpenMP threads. By default the number of OpenMP threads is set
43+
to the number of CPU cores. Each one thread is bound to a single core to achieve best
44+
performance results. It is however possible to use own configuration by providing right
45+
one through OpenMP environmental variables like OMP_NUM_THREADS or GOMP_CPU_AFFINITY.
46+
47+
If some system tool like numactl is used to control CPU affinity, by default caffe will prevent
48+
to use more than one thread per core. When less than required cores are specified, caffe will
49+
limit execution of OpenMP threads to specified cores only.
50+
51+
## Best performance solution
52+
Please read [our Wiki](https://github.com/intel/caffe/wiki/Recommendations-to-achieve-best-performance) for our recommendations and configuration to achieve best performance on Intel CPUs.
53+
54+
## Multinode Training
55+
Intel® Distribution of Caffe* multi-node allows you to execute deep neural network training on multiple machines.
56+
57+
To understand how it works and read some tutorials, go to our Wiki. Start from [Multinode guide](https://github.com/intel/caffe/wiki/Multinode-guide).
58+
59+
## License and Citation
60+
Caffe is released under the [BSD 2-Clause license](https://github.com/BVLC/caffe/blob/master/LICENSE).
61+
The BVLC reference models are released for unrestricted use.
62+
63+
Please cite Caffe in your publications if it helps your research:
64+
65+
@article{jia2014caffe,
66+
Author = {Jia, Yangqing and Shelhamer, Evan and Donahue, Jeff and Karayev, Sergey and Long, Jonathan and Girshick, Ross and Guadarrama, Sergio and Darrell, Trevor},
67+
Journal = {arXiv preprint arXiv:1408.5093},
68+
Title = {Caffe: Convolutional Architecture for Fast Feature Embedding},
69+
Year = {2014}
70+
}
71+
72+
***
73+
*Other names and brands may be claimed as the property of others
74+
75+
76+

0 commit comments

Comments
 (0)