Skip to content

Commit ae31adc

Browse files
keirjeffdonahue
authored andcommitted
Make the two separate build systems clearer in the documentation
1 parent 2172ede commit ae31adc

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

docs/installation.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,15 +87,20 @@ There is an unofficial Windows port of Caffe at [niuzhiheng/caffe:windows](https
8787

8888
## Compilation
8989

90-
Now that you have the prerequisites, edit your `Makefile.config` to change the paths for your setup The defaults should work, but uncomment the relevant lines if using Anaconda Python.
90+
Caffe can be compiled with either Make or CMake. Make is officially supported while CMake is supported by the community.
91+
92+
### Compilation with Make
93+
94+
Configure the build by copying and modifying the example `Makefile.config` for your setup. The defaults should work, but uncomment the relevant lines if using Anaconda Python.
9195

9296
cp Makefile.config.example Makefile.config
93-
# Adjust Makefile.config (for example, if using Anaconda Python)
97+
# Adjust Makefile.config (for example, if using Anaconda Python, or if cuDNN is desired)
9498
make all
9599
make test
96100
make runtest
97101

98-
- For cuDNN acceleration, you should uncomment the `USE_CUDNN := 1` switch in `Makefile.config`.
102+
- For CPU & GPU accelerated Caffe, no changes are needed.
103+
- For cuDNN acceleration using NVIDIA's proprietary cuDNN software, uncomment the `USE_CUDNN := 1` switch in `Makefile.config`. cuDNN is sometimes but not always faster than Caffe's GPU acceleration.
99104
- For CPU-only Caffe, uncomment `CPU_ONLY := 1` in `Makefile.config`.
100105

101106
To compile the Python and MATLAB wrappers do `make pycaffe` and `make matcaffe` respectively.
@@ -107,7 +112,7 @@ Be sure to set your MATLAB and Python paths in `Makefile.config` first!
107112

108113
Now that you have installed Caffe, check out the [MNIST tutorial](gathered/examples/mnist.html) and the [reference ImageNet model tutorial](gathered/examples/imagenet.html).
109114

110-
### CMake Compilation
115+
### Compilation with CMake
111116

112117
In lieu of manually editing `Makefile.config` to configure the build, Caffe offers an unofficial CMake build thanks to @Nerei, @akosiorek, and other members of the community. It requires CMake version >= 2.8.7.
113118
The basic steps are as follows:
@@ -116,6 +121,7 @@ The basic steps are as follows:
116121
cd build
117122
cmake ..
118123
make all
124+
make install
119125
make runtest
120126

121127
See [PR #1667](https://github.com/BVLC/caffe/pull/1667) for options and details.

0 commit comments

Comments
 (0)