Skip to content

Commit 5c437b1

Browse files
committed
docs: update debian installation guide. Thanks to @lukeyeager for comments.
1 parent fb52c7c commit 5c437b1

File tree

2 files changed

+20
-11
lines changed

2 files changed

+20
-11
lines changed

docs/install_apt_debian.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ install_apt.html). Debian/testing (stretch) users may be able to get Caffe
1010
to work using the packages in Debian/unstable, but it is beyond the scope of
1111
this guide.
1212

13-
Only experienced linux users are recommended to try Debian/unstable (Sid).
13+
Only experienced linux users are recommended to try Debian/unstable (Sid).
1414

15-
Last update: Dec.21 2016
15+
Last update: 2017-01-04
1616

1717
## Debian/unstable
1818

@@ -52,13 +52,20 @@ $ sudo apt build-dep [ caffe-cpu | caffe-cuda ] # the most elegant wa
5252
$ apt source [ caffe-cpu | caffe-cuda ] # download the source tarball and extract
5353
$ cd caffe-XXXX
5454
[ ... optional, customize caffe code/build ... ]
55+
$ dch -llocal "Modified XXX in order to XXX" # write your one-line changelog
5556
$ debuild -B -j4 # build caffe with 4 parallel jobs (similar to make -j4)
5657
[ ... building ...]
5758
$ debc # optional, if you want to check the package contents
5859
$ sudo debi # optional, install the generated packages
5960
```
6061
The resulting deb packages can be found under the parent directory of the source tree.
6162

63+
Note, the `dch ...` command line above is for bumping the package version number
64+
and adding an entry to the package changelog. If you would like to write
65+
more than one changelog entry, use subsequent `dch` command (see `man 1 dch`)
66+
instead of manually modifing `debian/changelog` unless you know how to keep its format correct.
67+
The changelog will be installed at e.g. `/usr/share/doc/caffe-cpu/changelog.Debian.gz`.
68+
6269
### Source installation
6370

6471
Source installation under Debian/unstable is similar to that of Ubuntu, but
@@ -71,15 +78,13 @@ Note, this requires a `deb-src` entry in your `/etc/apt/sources.list`.
7178
### Notes
7279

7380
* Consider re-compiling OpenBLAS locally with optimization flags for sake of
74-
performance. This is highly recommended if you are writing a paper.
81+
performance. This is highly recommended for any kind of production use, including
82+
academic research.
7583

7684
* If you are installing `caffe-cuda`, APT will automatically pull some of the
77-
CUDA packages and the nvidia driver packages. Please take care if you have
85+
CUDA packages and the nvidia driver packages. Please be careful if you have
7886
manually installed or hacked nvidia driver or CUDA toolkit or any other
79-
related stuff, because in this case it may fail.
80-
81-
* If you encountered any problem when installing `caffe-*`, please report bug
82-
to Debian via Debian's bug tracking system. See https://www.debian.org/Bugs/ .
87+
related stuff, because in this case APT may fail.
8388

8489
* Additionally, a manpage (`man caffe`) and a bash complementation script
8590
(`caffe <TAB><TAB>`, `caffe train <TAB><TAB>`) are provided.
@@ -88,6 +93,10 @@ Both of the two files are still not merged into caffe master.
8893
* The python interface is Python 3 version: `python3-caffe-{cpu,cuda}`.
8994
No plan to support python2.
9095

96+
* If you encountered any problem related to the packaging system (e.g. failed to install `caffe-*`),
97+
please report bug to Debian via Debian's bug tracking system. See https://www.debian.org/Bugs/ .
98+
Patches and suggestions are also welcome.
99+
91100
## FAQ
92101

93102
* where is caffe-cudnn?
@@ -96,11 +105,11 @@ CUDNN library seems not redistributable currently. If you really want the
96105
caffe-cudnn deb packages, the workaround is to install cudnn by yourself,
97106
and hack the packaging scripts, then build your customized package.
98107

99-
* I installed the CPU version, How can I switch to the CUDA version?
108+
* I installed the CPU version. How can I switch to the CUDA version?
100109

101110
`sudo apt install caffe-cuda`, apt's dependency resolver is smart enough to deal with this.
102111

103-
* Where is the examples, the models and other documentation stuff?
112+
* Where are the examples, the models and other documentation stuff?
104113

105114
```
106115
sudo apt install caffe-doc

docs/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The official Makefile and `Makefile.config` build are complemented by a [communi
1212

1313
- [Docker setup](https://github.com/BVLC/caffe/tree/master/docker) *out-of-the-box brewing*
1414
- [Ubuntu installation](install_apt.html) *the standard platform*
15-
- [Debian installation](install_apt_debian.html) *deploy caffe with a single command*
15+
- [Debian installation](install_apt_debian.html) *install caffe with a single command*
1616
- [OS X installation](install_osx.html)
1717
- [RHEL / CentOS / Fedora installation](install_yum.html)
1818
- [Windows](https://github.com/BVLC/caffe/tree/windows) *see the Windows branch led by Guillaume Dumont*

0 commit comments

Comments
 (0)