[caffe-contrib] 06/11: readme: import README.Debian from cpu version

[Zhou Mo]

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

cdluminate-guest pushed a commit to branch master
in repository caffe-contrib.

commit b7eacce51ebf12258277992cc1fc692fbeaa72f6
Author: Zhou Mo <cdluminate at gmail.com>
Date:   Mon Nov 28 02:42:07 2016 +0000

    readme: import README.Debian from cpu version
---
 debian/README.Debian | 47 +++++++++++++++++++++++++++++++++--------------
 debian/changelog     |  1 +
 2 files changed, 34 insertions(+), 14 deletions(-)

diff --git a/debian/README.Debian b/debian/README.Debian
index 17fe399..e3b3cea 100644
--- a/debian/README.Debian
+++ b/debian/README.Debian
@@ -4,39 +4,58 @@
                             Zhou Mo
                       cdluminate at gmail.com
 
-                   Last update: May. 18 2016
+                   Last update: Nov. 28 2016
 
 Package Scheme
 ==============
 
-Caffe supports 2 modes: CPU_ONLY mode and CUDA mode, and actually the
-caffe configureed in CUDA mode can run in CPU_ONLY mode. So providing
-two sets of Caffe packages, with the CPU_ONLY one in main/science
-section and the CUDA one in contrib/science section. Users need to
-choose a set of packages to install.
+Caffe supports 2 modes: CPU_ONLY mode and CUDA mode, and actually the caffe
+instance compiled in CUDA mode can run in CPU_ONLY mode. Both versions are
+provided. You can find the CPU_ONLY version at main/science section of Debian
+archive and the CUDA version at contrib/science section. However the two
+versions cannot co-exist, users need to make a choice according to their need.
 
- * source package "caffe" compiles the CPU_ONLY set.
- * source package "caffe-contrib" compiles the CUDA set.
+ * source package "caffe" compiles the CPU_ONLY version.
+ * source package "caffe-contrib" compiles the CUDA version.
 
-Both of the sources are hosted on Alioth, debian-science.
-Here is what binary package can be built from the sources:
+Both of the sources are hosted on Alioth, maintained by debian-science team.
+Here are what binary packages will be built from the sources:
 
- * CPU_ONLY set from source "caffe"
+ * CPU_ONLY version from source "caffe"
    - caffe-cpu          -- metapackage, pulls tools and python3 interface
    - caffe-tools-cpu    -- command line utilities
    - libcaffe-cpu*      -- core library
    - libcaffe-cpu-dev   -- development files
    - python3-caffe-cpu   -- python3 interface
 
- * CUDA set from source "caffe-contrib"
+ * CUDA version from source "caffe-contrib"
    - caffe-cuda         -- ...
    - caffe-tools-cuda   -- ...
    - libcaffe-cuda*     -- ...
    - libcaffe-cuda-dev  -- ...
    - python3-caffe-cuda -- ...
 
-Just choose one that fits your need and enjoy Deep Learning,
-then good luck in research or playing around!
+If both of them don't meet your need, then you should consider building
+the packages by your self (which is also recommended for users pursuing high
+performance). Anyway, happy hacking!
+
+
+Performance Note
+================
+
+I'd kindly point out that, please at least recompile your BLAS library and
+your Caffe in scientific/production environment for sake of performance.
+If you decided to recompile them from Debian source tarball, this hacky way
+may be helpful to you:
+
+  * Make sure you have the Build-Dependencies satisfied (See debian/control).
+    $ sudo apt build-dep caffe-cpu
+  * Edit debian/rules, append some flags to DEB_*_MAINT_APPEND variable,
+    e.g. -march=native, -mtune=native, etc.
+  * Update changelog
+    $ dch -n "Local rebuild for $(uname -a)"
+  * Build package and install
+    $ dpkg-buildpackage -us -uc ; sudo debi
 
 
 Why do We Link Caffe Against libblas.so.3 ?
diff --git a/debian/changelog b/debian/changelog
index 9133553..8ecb68c 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -7,6 +7,7 @@ caffe-contrib (1.0.0~rc3+20160930-ga7f950b-2) UNRELEASED; urgency=medium
   * Add python3-protobuf to B-D.
   * Import files from src:caffe_1.0.0~rc3+20160930-ga7f950b-3 :
     + autopkgtest files
+    + README.Debian
 
  -- Zhou Mo <cdluminate at gmail.com>  Sat, 26 Nov 2016 07:18:43 +0000
 

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