[caffe] 185/249: d/*: update README.Debian

[Zhou Mo]

This is an automated email from the git hooks/post-receive script.

cdluminate-guest pushed a commit to branch debian/experimental
in repository caffe.

commit 84a2e2281d9cfa20d9cbf9bb2bb00660a386e269
Author: Zhou Mo <cdluminate at gmail.com>
Date:   Wed Sep 2 08:02:08 2015 +0000

    d/*: update README.Debian
---
 debian/README.Debian | 112 ++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 107 insertions(+), 5 deletions(-)

diff --git a/debian/README.Debian b/debian/README.Debian
index d53af56..1189639 100644
--- a/debian/README.Debian
+++ b/debian/README.Debian
@@ -1,8 +1,110 @@
-caffe for Debian
+                   Caffe for Debian
+                   ================
 
-Please edit this to provide information specific to 
-this caffe Debian package.
+ In short, package "Caffe" for Debian is designed as following 2
+ suites, which are conflicting with each other[1] (i.e. you cannot 
+ install them together on your system):
 
-    (Automatically generated by debmake Version 4.2.1)
+  * Caffe-CPU suite:
+    - caffe-cpu
+	- libcaffe-cpu0     (i.e. libcaffe-cpu${SOVERSION})
+	- libcaffe-cpu-dev
+	- python3-caffe-cpu
+ 
+  * Caffe-CUDA suite:
+    - caffe-cuda
+    - libcaffe-cuda0     (i.e. libcaffe-cuda${SOVERSION})
+    - libcaffe-cuda-dev
+    - python3-caffe-cuda
 
- -- Zhou Mo <cdluminate at gmail.com>  Thu, 09 Jul 2015 01:04:53 +0000
+ Where 
+  - caffe-{cpu,cuda} are the command line interface of caffe
+  - libcaffe* are the core shared library of caffe
+  - libcaffe-*-dev are the development files of caffe (incl. headers)
+  - python3-caffe-* are the python3 interfaces of caffe
+
+ So pick a suite and enjoy Deep Learning ! :-)
+
+
+                   Custom Build Caffe
+                   ==================
+
+ As we know, for computation-intensive applications such as caffe,
+ compiling it locally would bring you better machine performance.
+ Inspired by Debian's OpenBLAS packaging, the packager [A] of caffe
+ provided 2 custom targets for you to build customed local Debian 
+ Package of caffe: "custom-cpu" and "custom-cuda".
+
+ Instructions for doing local custom build [2]:
+
+  1. Install Debian Packaging toolchain:
+     $ apt install build-essential debhelper devscripts
+
+  2. Install Build-Dependencies:
+     $ apt-get build-dep caffe    <- this may work in the future[3]
+
+	 Currently please follow this work-around:
+	 * Take a look at debian/control
+	 * Satisfy build dependencies manually........
+
+  3. Have a look at tail part of debian/rules, and tweak some
+     variables as you need:
+     (please note that debian/rules is a Makefile)
+
+     * CUSTOM_JOBS   := "-j4"
+       This is the "--jobs" argument passed to "make", by default I
+       set it to 4 jobs.
+
+     * CONFFLAG_CPU_CUSTOM = ...
+       Only tweak this when you are going to customize the
+       caffe-cpu suite, and this variable stores cmake options.
+
+     * CONFFLAG_CUDA_CUSTOM = ...
+       Only tweak this when you are going to customize the
+       caffe-cuda suite, and this variable stores cmake options.
+
+  4. Start compiling:
+     (make sure you are stading at the root of source tree)
+
+     If you are going to compile caffe-cpu suite:
+       $ debian/rules custom-cpu
+
+     If you are going to compile caffe-cuda suite:
+       $ debian/rules custom-cuda
+
+     By the default custom options, it should finely build packages.
+     However there's no any promise that the custom build will work,
+     Especially after tweaked.
+
+  5. Install freshly cooked Caffe Package:
+     * change directory to the parent directory of source tree root
+	   $ cd ..
+     * see the build result
+       $ ls	*.deb
+
+     If nothing went wrong, install them running [4]
+	 $ sudo dpkg -i libcaffe-*.deb
+     $ sudo dpkg -i caffe-* python3-caffe*
+
+  6. Done.
+
+                   Footnotes
+                   =========
+
+[1] It's nonsence to install caffe-cpu and caffe-cuda together,
+    as all function of caffe-cpu can be provided by caffe-cuda,
+    which means functions caffe-cpu provided are a subset of
+	those provided by caffe-cuda.
+	Since CUDA is only availabe on "amd64" and "i386", caffe-cpu
+    is created.
+
+[2] This should work Debian (at least Debian), Ubuntu, and etc...
+    but you may have to give up when you are running non-dpkg-based OS.
+
+[3] After package Caffe is accepted into Debian Archive
+
+[4] Make sure to firstly install libcaffe-* which include libcaffe.so.0,
+    the true shared object file of caffe.
+
+[A]
+ -- Zhou Mo <cdluminate at gmail.com>  Wed, 02 Sep 2015 07:04:53 +0000

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/caffe.git