[caffe-contrib] 04/15: man: update txt2man template and manpage

[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 e6441e042e7f356f018c3579a091ff257e33db4d
Author: Zhou Mo <cdluminate at gmail.com>
Date:   Sun Oct 2 14:27:40 2016 +0000

    man: update txt2man template and manpage
---
 debian/changelog     |  1 +
 debian/man/caffe.1   | 26 ++++++++++++++++++++++++--
 debian/man/caffe.txt |  9 +++++++++
 3 files changed, 34 insertions(+), 2 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index 8c81992..4a2525e 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -4,6 +4,7 @@ caffe-contrib (1.0.0~rc3+20160930-ga7f950b-1) UNRELEASED; urgency=medium
   * Suggest OpenBLAS/Atlas library for metapackage caffe-cuda.
   * Add git and libboost-dev to make cmake happy.
   * Update package description.
+  * Update txt2man template d/man/caffe.txt and its corresponding manpage.
 
  -- Zhou Mo <cdluminate at gmail.com>  Wed, 10 Aug 2016 14:08:06 +0000
 
diff --git a/debian/man/caffe.1 b/debian/man/caffe.1
index ea8959a..624b0bc 100644
--- a/debian/man/caffe.1
+++ b/debian/man/caffe.1
@@ -1,5 +1,5 @@
-.\"Text automatically generated by txt2man
-.TH CAFFE 1 "03 June 2016" "" ""
+.\" Text automatically generated by txt2man
+.TH CAFFE 1 "10 August 2016" "" ""
 .SH NAME
 \fBcaffe \fP- command line brew for Caffe
 .SH SYNOPSIS
@@ -45,11 +45,20 @@ type: string default: ""
 (The number of iterations to run.) type: int32 default: 50
 .TP
 .B
+\fB-level\fP
+(Optional; network level.) type: int32 default: 0
+.TP
+.B
 \fB-model\fP
 (The model definition protocol buffer text file..) type: string
 default: ""
 .TP
 .B
+\fB-phase\fP
+(Optional; network phase (TRAIN or TEST). Only used for 'time'.)
+type: string default: ""
+.TP
+.B
 \fB-sighup_effect\fP
 (Optional; action to take when a SIGHUP signal is received:
 snapshot, stop or none.) type: string default: "snapshot"
@@ -70,6 +79,11 @@ type: string default: ""
 default: ""
 .TP
 .B
+\fB-stage\fP
+(Optional; network stages (not to be confused with phase), separated
+by ','.) type: string default: ""
+.TP
+.B
 \fB-weights\fP
 (Optional; the pretrained weights to initialize finetuning,
 separated by ','. Cannot be set simultaneously with snapshot.)
@@ -110,6 +124,14 @@ Train a new Network
 
 .fam T
 .fi
+Resume training a network from a snapshot
+.PP
+.nf
+.fam C
+    $ caffe train -solver solver.prototxt -snapshot bvlc_alexnet.solverstate
+
+.fam T
+.fi
 Fine-tune a network
 .PP
 .nf
diff --git a/debian/man/caffe.txt b/debian/man/caffe.txt
index 2c2d51e..10a41e5 100644
--- a/debian/man/caffe.txt
+++ b/debian/man/caffe.txt
@@ -17,8 +17,11 @@ FREQUENTLY USED FLAGS
                   training batch size is multiplied by the number of devices.)
                   type: string default: ""
   -iterations     (The number of iterations to run.) type: int32 default: 50
+  -level          (Optional; network level.) type: int32 default: 0
   -model          (The model definition protocol buffer text file..) type: string
                   default: ""
+  -phase          (Optional; network phase (TRAIN or TEST). Only used for 'time'.)
+                  type: string default: ""
   -sighup_effect  (Optional; action to take when a SIGHUP signal is received:
                   snapshot, stop or none.) type: string default: "snapshot"
   -sigint_effect  (Optional; action to take when a SIGINT signal is received:
@@ -27,6 +30,8 @@ FREQUENTLY USED FLAGS
                   type: string default: ""
   -solver         (The solver definition protocol buffer text file.) type: string
                   default: ""
+  -stage          (Optional; network stages (not to be confused with phase), separated
+                  by ','.) type: string default: ""
   -weights        (Optional; the pretrained weights to initialize finetuning,
                   separated by ','. Cannot be set simultaneously with snapshot.)
                   type: string default: ""
@@ -50,6 +55,10 @@ EXAMPLES
 
     $ caffe train -solver solver.prototxt
 
+  Resume training a network from a snapshot
+
+    $ caffe train -solver solver.prototxt -snapshot bvlc_alexnet.solverstate
+
   Fine-tune a network
 
     $ caffe train -solver solver.prototxt -weights pre_trained.caffemodel

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