[caffe-contrib] 303/362: caffe.1: refresh manpage
Zhou Mo
cdluminate-guest at moszumanska.debian.org
Tue May 3 09:24:47 UTC 2016
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 2a1435fbc39e5b2e1968404ef386808803d67e24
Author: Zhou Mo <cdluminate at gmail.com>
Date: Wed Mar 9 10:01:43 2016 +0000
caffe.1: refresh manpage
---
debian/man/caffe.1 | 244 ++++++++++++-----------------------------------------
1 file changed, 54 insertions(+), 190 deletions(-)
diff --git a/debian/man/caffe.1 b/debian/man/caffe.1
index 358d1c0..a0e748b 100644
--- a/debian/man/caffe.1
+++ b/debian/man/caffe.1
@@ -1,25 +1,13 @@
.\" Hey, EMACS: -*- nroff -*-
.\" (C) Copyright 2015 Zhou Mo <cdluminate at gmail.com>,
.\"
-.TH CAFFE 1 "Sept 3. 2015"
-.\" Please adjust this date whenever revising the manpage.
-.\"
-.\" Some roff macros, for reference:
-.\" .nh disable hyphenation
-.\" .hy enable hyphenation
-.\" .ad l left justify
-.\" .ad b justify to both left and right margins
-.\" .nf disable filling
-.\" .fi enable filling
-.\" .br insert line break
-.\" .sp <n> insert n+1 empty lines
-.\" for manpage-specific macros, see man(7)
+.TH CAFFE 1 "Mar 9. 2016"
.SH NAME
-caffe \- command line brew for the deep learning framework
+caffe \- command line brew for a deep learning framework
.SH SYNOPSIS
.B caffe
-<COMMAND> <ARG>
+COMMAND ARGUMENTS
.SH DESCRIPTION
.P
@@ -27,7 +15,6 @@ Caffe is a deep learning framework made with expression, speed,
and modularity in mind. It is developed by the Berkeley Vision
and Learning Center (BVLC) and community contributors.
-
.SH COMMANDS
.TP
.B train
@@ -42,214 +29,88 @@ show GPU diagnostic information
.B time
benchmark model execution time
-.SH ARGS
-.SS Flags from /tmp/caffe/tools/caffe.cpp:
+.SH ARGUMENTS
.TP
.B \-gpu
-(Run in GPU mode on given device ID.)
+Optional;
+.br
+run in GPU mode on given device IDs separated by ','.
+.br
+Use '-gpu all' to run on all available GPUs.
+.br
+The effective training batch size is multiplied by the number of devices.
.br
-type: int32 default: -1
+type: string default: ""
+
.TP
.B \-iterations
-(The number of iterations to run.)
+The number of iterations to run.
.br
type: int32 default: 50
+
.TP
.B \-model
-(The model definition protocol buffer text file..)
+The model definition protocol buffer text file..
.br
type: string default: ""
+
.TP
.B \-sighup_effect
-(Optional; action to take when a SIGHUP signal is received:
-snapshot, stop or none.) type: string default: "snapshot"
+Optional;
+.br
+action to take when a SIGHUP signal is received:
+snapshot, stop or none.
+.br
+type: string default: "snapshot"
+
.TP
.B \-sigint_effect
-(Optional; action to take when a SIGINT signal is received:
-snapshot, stop or none.) type: string default: "stop"
-.TP
-.B \-snapshot
-(Optional; the snapshot solver state to resume training.)
-type: string default: ""
-.TP
-.B \-solver
-(The solver definition protocol buffer text file.) type: string
-default: ""
-.TP
-.B \-weights
-(Optional; the pretrained weights to initialize finetuning. Cannot
-be set simultaneously with snapshot.) type: string default: ""
+Optional;
+.br
+action to take when a SIGINT signal is received:
+snapshot, stop or none.
+.br
+type: string default: "stop"
-.SS Flags from src/gflags.cc:
-.TP
-.B \-flagfile
-(load flags from file) type: string default: ""
.TP
-.B \-fromenv
-(set flags from the environment [use 'export FLAGS_flag1=value'])
+.B \-snapshot
+Optional;
+.br
+the snapshot solver state to resume training.
+.br
type: string default: ""
-.TP
-.B \-tryfromenv
-(set flags from the environment if present) type: string
-default: ""
-.TP
-.B \-undefok
-(comma-separated list of flag names that it is okay to specify on
-the command line even if the program does not define a flag with that
-name. IMPORTANT: flags in this list that have arguments MUST use the
-flag=value format) type: string default: ""
-
-.SS Flags from src/gflags_completions.cc:
-.TP
-.B \-tab_completion_columns
-(Number of columns to use in output for tab
-completion) type: int32 default: 80
-.TP
-.B \-tab_completion_word
-(If non-empty, HandleCommandLineCompletions() will
-hijack the process and attempt to do bash-style command line flag
-completion on this value.) type: string default: ""
-.SS Flags from src/gflags_reporting.cc:
.TP
-.B \-help
-(show help on all flags [tip: all flags can have two dashes])
-type: bool default: false currently: true
-.TP
-.B \-helpfull
-(show help on all flags -- same as -help) type: bool
-default: false
-.TP
-.B \-helpmatch
-(show help on modules whose name contains the specified substr)
+.B \-solver
+The solver definition protocol buffer text file.
+.br
type: string default: ""
-.TP
-.B \-helpon
-(show help on the modules named by this flag value) type: string
-default: ""
-.TP
-.B \-helppackage
-(show help on all modules in the main package) type: bool
-default: false
-.TP
-.B \-helpshort
-(show help on only the main module for this program) type: bool
-default: false
-.TP
-.B \-helpxml
-(produce an xml version of help) type: bool default: false
-.TP
-.B \-version
-(show version and build info and exit) type: bool default: false
-.SS Flags from src/logging.cc:
-.TP
-.B \-alsologtoemail
-(log messages go to these email addresses in addition to
-logfiles) type: string default: ""
-.TP
-.B \-alsologtostderr
-(log messages go to stderr in addition to logfiles)
-type: bool default: false currently: true
-.TP
-.B \-colorlogtostderr
-(color messages logged to stderr (if supported by
-terminal)) type: bool default: false
-.TP
-.B \-drop_log_memory
-(Drop in-memory buffers of log contents. Logs can grow
-very quickly and they are rarely read before they need to be evicted from
-memory. Instead, drop them from memory as soon as they are flushed to
-disk.) type: bool default: true
.TP
-.B \-log_backtrace_at
-(Emit a backtrace when logging at file:linenum.)
-type: string default: ""
-.TP
-.B \-log_dir
-(If specified, logfiles are written into this directory instead of
-the default logging directory.) type: string default: ""
-.TP
-.B \-log_link
-(Put additional links to the log files in this directory)
+.B \-weights
+Optional;
+.br
+the pretrained weights to initialize finetuning, separated by ','.
+.br
+Cannot be set simultaneously with snapshot.
+.br
type: string default: ""
-.TP
-.B \-log_prefix
-(Prepend the log prefix to the start of each log line)
-type: bool default: true
-.TP
-.B \-logbuflevel
-(Buffer log messages logged at this level or lower (-1 means
-don't buffer; 0 means buffer INFO only; ...)) type: int32 default: 0
-.TP
-.B \-logbufsecs
-(Buffer log messages for at most this many seconds) type: int32
-default: 30
-.TP
-.B \-logemaillevel
-(Email log messages logged at this level or higher (0 means
-email all; 3 means email FATAL only; ...)) type: int32 default: 999
-.TP
-.B \-logmailer
-(Mailer used to send logging email) type: string
-default: "/bin/mail"
-.TP
-.B \-logtostderr
-(log messages go to stderr instead of logfiles) type: bool
-default: false
-.TP
-.B \-max_log_size
-(approx. maximum log file size (in MB). A value of 0 will be
-silently overridden to 1.) type: int32 default: 1800
-.TP
-.B \-minloglevel
-(Messages logged at a lower level than this don't actually get
-logged anywhere) type: int32 default: 0
-.TP
-.B \-stderrthreshold
-(log messages at or above this level are copied to stderr
-in addition to logfiles. This flag obsoletes --alsologtostderr.)
-type: int32 default: 2
-.TP
-.B \-stop_logging_if_full_disk
-(Stop attempting to log to disk if the disk is
-full.) type: bool default: false
-
-.SS Flags from src/utilities.cc:
-.TP
-.B \-symbolize_stacktrace
-(Symbolize the stack trace in the tombstone)
-type: bool default: true
-
-.SS Flags from src/vlog_is_on.cc:
-.TP
-.B \-v
-(Show all VLOG(m) messages for m <= this. Overridable by --vmodule.)
-type: int32 default: 0
-.TP
-.B \-vmodule
-(per-module verbose level. Argument is a comma-separated list of
-<module name>=<log level>. <module name> is a glob pattern, matched
-against the filename base (that is, name ignoring .cc/.h./-inl.h). <log
-level> overrides any value given by --v.) type: string default: ""
.SH EXAMPLES
-.SS Train Networks
-Train a new Network with CPU or GPU
+.SS Training a network
+Train a new Network without GPU
.RS
$ caffe train \-solver solver.prototxt
-.br
-$ caffe train \-solver solver.prototxt -gpu 0
.RE
-.SS Fine-tune
+.SS Fine-tuning a network
.RS
-$ caffe train \-solver solver.prototxt \-weights pre_trained.caffemodel \-gpu 0
+$ caffe train \-solver solver.prototxt \-weights pre_trained.caffemodel
.RE
-.SS Test a Trained Model
+.SS Testing (evaluating) a trained model for 100 iterations, on GPU 0
.RS
$ caffe test \-model train_val.prototxt \-weights bvlc_alexnet.caffemodel \-gpu 0 \-iterations 100
@@ -263,6 +124,7 @@ $ caffe device_query \-gpu 0
.SH HOMEPAGE
http://caffe.berkeleyvision.org
+
.SH BUGS
https://github.com/BVLC/caffe/issues
@@ -278,4 +140,6 @@ https://github.com/BVLC/caffe/issues
.BR upgrade_net_proto_binary(1),
.BR upgrade_net_proto_text(1).
.br
-This manpage is written by Zhou Mo according to the help message of upstream program "caffe".
+
+This manpage is written by Zhou Mo <cdluminate at gmail.com> for Debian
+according to program's help message, and may be used by others.
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/caffe-contrib.git
More information about the debian-science-commits
mailing list