[caffe-contrib] 10/10: d/man: import manpages from cpu version
Zhou Mo
cdluminate-guest at moszumanska.debian.org
Mon Jul 4 13:32:33 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 8846127ee1c72d11b3b481a8dfb64e6ef3401587
Author: Zhou Mo <cdluminate at gmail.com>
Date: Mon Jul 4 13:32:15 2016 +0000
d/man: import manpages from cpu version
---
debian/man/caffe.1 | 235 +++++++++++++++++-----------------
debian/man/caffe.txt | 75 +++++++++++
debian/man/classification.1 | 28 ----
debian/man/compute_image_mean.1 | 29 -----
debian/man/convert_imageset.1 | 83 ------------
debian/man/extract_features.1 | 31 -----
debian/man/upgrade_net_proto_binary.1 | 28 ----
debian/man/upgrade_net_proto_text.1 | 28 ----
8 files changed, 195 insertions(+), 342 deletions(-)
diff --git a/debian/man/caffe.1 b/debian/man/caffe.1
index 8598a48..ea8959a 100644
--- a/debian/man/caffe.1
+++ b/debian/man/caffe.1
@@ -1,146 +1,151 @@
-.\" Hey, EMACS: -*- nroff -*-
-.\" (C) Copyright 2015 Zhou Mo <cdluminate at gmail.com>,
-.\"
-.TH CAFFE 1 "Mar 9. 2016"
+.\"Text automatically generated by txt2man
+.TH CAFFE 1 "03 June 2016" "" ""
.SH NAME
-caffe \- command line brew for a deep learning framework
-
+\fBcaffe \fP- command line brew for Caffe
.SH SYNOPSIS
-.B caffe
-COMMAND ARGUMENTS
-
+.nf
+.fam C
+ \fBcaffe\fP <COMMAND> <FLAGS>
+.fam T
+.fi
+.fam T
+.fi
.SH DESCRIPTION
-.P
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
+.TP
+.B
+train
train or finetune a model
.TP
-.B test
+.B
+test
score a model
.TP
-.B device_query
+.B
+device_query
show GPU diagnostic information
.TP
-.B time
+.B
+time
benchmark model execution time
-
-.SH ARGUMENTS
+.SH FREQUENTLY USED FLAGS
.TP
-.B \-gpu
-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
+.B
+\fB-gpu\fP
+(Optional; run in GPU mode on given device IDs separated by ','.
+Use '\fB-gpu\fP all' to run on all available GPUs. The effective
+training batch size is multiplied by the number of devices.)
type: string default: ""
-
.TP
-.B \-iterations
-The number of iterations to run.
-.br
-type: int32 default: 50
-
+.B
+\fB-iterations\fP
+(The number of iterations to run.) type: int32 default: 50
.TP
-.B \-model
-The model definition protocol buffer text file..
-.br
-type: string default: ""
-
+.B
+\fB-model\fP
+(The model definition protocol buffer text file..) type: string
+default: ""
.TP
-.B \-sighup_effect
-Optional;
-.br
-action to take when a SIGHUP signal is received:
-snapshot, stop or none.
-.br
-type: string default: "snapshot"
-
+.B
+\fB-sighup_effect\fP
+(Optional; action to take when a SIGHUP signal is received:
+snapshot, stop or none.) type: string default: "snapshot"
.TP
-.B \-sigint_effect
-Optional;
-.br
-action to take when a SIGINT signal is received:
-snapshot, stop or none.
-.br
-type: string default: "stop"
-
+.B
+\fB-sigint_effect\fP
+(Optional; action to take when a SIGINT signal is received:
+snapshot, stop or none.) type: string default: "stop"
.TP
-.B \-snapshot
-Optional;
-.br
-the snapshot solver state to resume training.
-.br
+.B
+\fB-snapshot\fP
+(Optional; the snapshot solver state to resume training.)
type: string default: ""
-
.TP
-.B \-solver
-The solver definition protocol buffer text file.
-.br
-type: string default: ""
-
+.B
+\fB-solver\fP
+(The solver definition protocol buffer text file.) type: string
+default: ""
.TP
-.B \-weights
-Optional;
-.br
-the pretrained weights to initialize finetuning, separated by ','.
-.br
-Cannot be set simultaneously with snapshot.
-.br
+.B
+\fB-weights\fP
+(Optional; the pretrained weights to initialize finetuning,
+separated by ','. Cannot be set simultaneously with snapshot.)
type: string default: ""
-
.TP
-.B \-help
+.B
+\fB-help\fP
Show complete help messages.
-
+.SH OTHER CAFFE UTILITIES
+Apart from the "\fBcaffe\fP" command line utility, there are also some utilities
+available, run them with "\fB-h\fP" or "\fB--help\fP" argument to see corresponding help.
+.IP \(bu 3
+convert_imageset
+.IP \(bu 3
+convert_cifar_data
+.IP \(bu 3
+compute_image_mean
+.IP \(bu 3
+convert_mnist_siamese_data
+.IP \(bu 3
+upgrade_net_proto_binary
+.IP \(bu 3
+extract_features
+.IP \(bu 3
+upgrade_solver_proto_text
+.IP \(bu 3
+classification
+.IP \(bu 3
+upgrade_net_proto_text
+.IP \(bu 3
+convert_mnist_data
.SH EXAMPLES
-.SS Training a network
-Train a new Network without GPU
-
-.RS
-$ caffe train \-solver solver.prototxt
-.RE
-
-.SS Fine-tuning a network
-
-.RS
-$ caffe train \-solver solver.prototxt \-weights pre_trained.caffemodel
-.RE
-
-.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
-.RE
-
-.SS Check CUDA device availability
-
-.RS
-$ caffe device_query \-gpu 0
-.RE
-
+Train a new Network
+.PP
+.nf
+.fam C
+ $ caffe train -solver solver.prototxt
+
+.fam T
+.fi
+Fine-tune a network
+.PP
+.nf
+.fam C
+ $ caffe train -solver solver.prototxt -weights pre_trained.caffemodel
+
+.fam T
+.fi
+Test (evaluate) a trained model for 100 iterations, on GPU 0
+.PP
+.nf
+.fam C
+ $ caffe test -model train_val.prototxt -weights bvlc_alexnet.caffemodel -gpu 0 -iterations 100
+
+.fam T
+.fi
+Run a benchmark against AlexNet on GPU 0
+.PP
+.nf
+.fam C
+ $ caffe time -model deploy.prototxt -gpu 0
+
+.fam T
+.fi
+Check CUDA device availability of GPU 0
+.PP
+.nf
+.fam C
+ $ caffe device_query -gpu 0
+
+.fam T
+.fi
.SH HOMEPAGE
http://caffe.berkeleyvision.org
-
.SH BUGS
-https://github.com/BVLC/caffe/issues
-
-.SH SEE ALSO
-.BR caffe(1),
-.BR classification(1),
-.BR compute_image_mean(1),
-.BR convert_imageset(1),
-.BR extract_features(1),
-.BR upgrade_net_proto_binary(1),
-.BR upgrade_net_proto_text(1).
-.br
-
-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.
+https://github.com/BVLC/\fBcaffe\fP/issues
+.SH AUTHOR
+This manpage is written by Zhou Mo <cdluminate at gmail.com> with the help of txt2man for Debian
+according to program's help message.
diff --git a/debian/man/caffe.txt b/debian/man/caffe.txt
new file mode 100644
index 0000000..2c2d51e
--- /dev/null
+++ b/debian/man/caffe.txt
@@ -0,0 +1,75 @@
+NAME
+ caffe - command line brew for Caffe
+SYNOPSIS
+ caffe <COMMAND> <FLAGS>
+DESCRIPTION
+ 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.
+COMMANDS
+ train train or finetune a model
+ test score a model
+ device_query show GPU diagnostic information
+ time benchmark model execution time
+FREQUENTLY USED FLAGS
+ -gpu (Optional; run in GPU mode on given device IDs separated by ','.
+ Use '-gpu all' to run on all available GPUs. The effective
+ training batch size is multiplied by the number of devices.)
+ type: string default: ""
+ -iterations (The number of iterations to run.) type: int32 default: 50
+ -model (The model definition protocol buffer text file..) 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:
+ snapshot, stop or none.) type: string default: "stop"
+ -snapshot (Optional; the snapshot solver state to resume training.)
+ type: string default: ""
+ -solver (The solver definition protocol buffer text file.) type: string
+ default: ""
+ -weights (Optional; the pretrained weights to initialize finetuning,
+ separated by ','. Cannot be set simultaneously with snapshot.)
+ type: string default: ""
+ -help Show complete help messages.
+OTHER CAFFE UTILITIES
+ Apart from the "caffe" command line utility, there are also some utilities
+ available, run them with "-h" or "--help" argument to see corresponding help.
+ * convert_imageset
+ * convert_cifar_data
+ * compute_image_mean
+ * convert_mnist_siamese_data
+ * upgrade_net_proto_binary
+ * extract_features
+ * upgrade_solver_proto_text
+ * classification
+ * upgrade_net_proto_text
+ * convert_mnist_data
+
+EXAMPLES
+ Train a new Network
+
+ $ caffe train -solver solver.prototxt
+
+ Fine-tune a network
+
+ $ caffe train -solver solver.prototxt -weights pre_trained.caffemodel
+
+ Test (evaluate) a trained model for 100 iterations, on GPU 0
+
+ $ caffe test -model train_val.prototxt -weights bvlc_alexnet.caffemodel -gpu 0 -iterations 100
+
+ Run a benchmark against AlexNet on GPU 0
+
+ $ caffe time -model deploy.prototxt -gpu 0
+
+ Check CUDA device availability of GPU 0
+
+ $ caffe device_query -gpu 0
+
+HOMEPAGE
+ http://caffe.berkeleyvision.org
+BUGS
+ https://github.com/BVLC/caffe/issues
+AUTHOR
+ This manpage is written by Zhou Mo <cdluminate at gmail.com> with the help of txt2man for Debian
+ according to program's help message.
diff --git a/debian/man/classification.1 b/debian/man/classification.1
deleted file mode 100644
index 4776cab..0000000
--- a/debian/man/classification.1
+++ /dev/null
@@ -1,28 +0,0 @@
-.\" Hey, EMACS: -*- nroff -*-
-.\" (C) Copyright 2015 Zhou Mo <cdluminate at gmail.com>,
-.\"
-.TH CAFFE 1 "Mar 9. 2016"
-.SH NAME
-classification \- command line tool for the deep learning framework
-
-.SH SYNOPSIS
-.B classification
-deploy.prototxt network.caffemodel mean.binaryproto labels.txt img.jpg
-
-.SH HOMEPAGE
-http://caffe.berkeleyvision.org
-.SH BUGS
-https://github.com/BVLC/caffe/issues
-
-.SH SEE ALSO
-.BR caffe(1),
-.BR classification(1),
-.BR compute_image_mean(1),
-.BR convert_imageset(1),
-.BR extract_features(1),
-.BR upgrade_net_proto_binary(1),
-.BR upgrade_net_proto_text(1).
-.br
-
-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.
diff --git a/debian/man/compute_image_mean.1 b/debian/man/compute_image_mean.1
deleted file mode 100644
index 52509fd..0000000
--- a/debian/man/compute_image_mean.1
+++ /dev/null
@@ -1,29 +0,0 @@
-.\" Hey, EMACS: -*- nroff -*-
-.\" (C) Copyright 2015 Zhou Mo <cdluminate at gmail.com>,
-.\"
-.TH CAFFE 1 "Mar 9. 2015"
-.SH NAME
-compute_image_mean - Compute the mean_image of a set of images given by a leveldb/lmdb
-
-.SH SYNOPSIS
-.B compute_image_mean
-[FLAGS] INPUT_DB [OUTPUT_FILE]
-
-.SH HOMEPAGE
-http://caffe.berkeleyvision.org
-
-.SH BUGS
-https://github.com/BVLC/caffe/issues
-
-.SH SEE ALSO
-.BR caffe(1),
-.BR classification(1),
-.BR compute_image_mean(1),
-.BR convert_imageset(1),
-.BR extract_features(1),
-.BR upgrade_net_proto_binary(1),
-.BR upgrade_net_proto_text(1).
-.br
-
-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.
diff --git a/debian/man/convert_imageset.1 b/debian/man/convert_imageset.1
deleted file mode 100644
index 022fc19..0000000
--- a/debian/man/convert_imageset.1
+++ /dev/null
@@ -1,83 +0,0 @@
-.\" Hey, EMACS: -*- nroff -*-
-.\" (C) Copyright 2015 Zhou Mo <cdluminate at gmail.com>,
-.\"
-.TH CAFFE 1 "Mar 9. 2016"
-.SH NAME
-convert_imageset \- Convert a set of images to the leveldb/lmdb
-format used as input for Caffe.
-
-.SH SYNOPSIS
-.B convert_imageset
-[FLAGS] ROOTFOLDER/ LISTFILE DB_NAME
-
-.SH DESCRIPTION
-The ImageNet dataset for the training demo is at
-http://www.image-net.org/download-images
-
-.SH FLAGS
-.TP
-.B \-backend
-(The backend {lmdb, leveldb} for storing the result) type: string
-default: "lmdb"
-
-.TP
-.B \-backend
-The backend {lmdb, leveldb} for storing the result
-.br
-type: string default: "lmdb"
-.TP
-.B \-check_size
-When this option is on, check that all the datum have the same size
-.br
-type: bool default: false
-.TP
-.B \-encode_type
-Optional:
-.br
-What type should we encode the image as ('png','jpg',...).
-.br
-type: string default: ""
-.TP
-.B \-encoded
-When this option is on, the encoded image will be save in datum
-.br
-type: bool default: false
-.TP
-.B \-gray
-When this option is on, treat images as grayscale ones
-.br
-type: bool default: false
-.TP
-.B \-resize_height
-Height images are resized to
-.br
-type: int32 default: 0
-.TP
-.B \-resize_width
-Width images are resized to
-.br
-type: int32 default: 0
-.TP
-.B \-shuffle
-Randomly shuffle the order of images and their labels
-.br
-type: bool default: false
-
-.SH HOMEPAGE
-http://caffe.berkeleyvision.org
-
-.SH BUGS
-https://github.com/BVLC/caffe/issues
-
-.SH SEE ALSO
-.BR caffe(1),
-.BR classification(1),
-.BR compute_image_mean(1),
-.BR convert_imageset(1),
-.BR extract_features(1),
-.BR upgrade_net_proto_binary(1),
-.BR upgrade_net_proto_text(1).
-.br
-
-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.
diff --git a/debian/man/extract_features.1 b/debian/man/extract_features.1
deleted file mode 100644
index 0ba3e6f..0000000
--- a/debian/man/extract_features.1
+++ /dev/null
@@ -1,31 +0,0 @@
-.\" Hey, EMACS: -*- nroff -*-
-.\" (C) Copyright 2015 Zhou Mo <cdluminate at gmail.com>,
-.\"
-.TH CAFFE 1 "Mar 9. 2015"
-.SH NAME
-extract_features \- takes in a trained network and an input data layer, and then extract features of the input data produced by the net.
-
-.SH SYNOPSIS
-.B extract_features
-pretrained_net_param feature_extraction_proto_file extract_feature_blob_name1[,name2,...] save_feature_dataset_name1[,name2,...] num_mini_batches db_type [CPU/GPU] [DEVICE_ID=0]
-
-.SH DESCRIPTION
-you can extract multiple features in one pass by specifying multiple feature blob names and dataset names separated by ','. The names cannot contain white space characters and the number of blobs and datasets must be equal.
-
-.SH HOMEPAGE
-http://caffe.berkeleyvision.org
-.SH BUGS
-https://github.com/BVLC/caffe/issues
-
-.SH SEE ALSO
-.BR caffe(1),
-.BR classification(1),
-.BR compute_image_mean(1),
-.BR convert_imageset(1),
-.BR extract_features(1),
-.BR upgrade_net_proto_binary(1),
-.BR upgrade_net_proto_text(1).
-.br
-
-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.
diff --git a/debian/man/upgrade_net_proto_binary.1 b/debian/man/upgrade_net_proto_binary.1
deleted file mode 100644
index b486762..0000000
--- a/debian/man/upgrade_net_proto_binary.1
+++ /dev/null
@@ -1,28 +0,0 @@
-.\" Hey, EMACS: -*- nroff -*-
-.\" (C) Copyright 2015 Zhou Mo <cdluminate at gmail.com>,
-.\"
-.TH CAFFE 1 "Mar 9. 2015"
-.SH NAME
-upgrade_net_proto_binary \- command line tool for caffe
-
-.SH SYNOPSIS
-.B upgrade_net_proto_binary
-v0_net_proto_file_in net_proto_file_out
-
-.SH HOMEPAGE
-http://caffe.berkeleyvision.org
-.SH BUGS
-https://github.com/BVLC/caffe/issues
-
-.SH SEE ALSO
-.BR caffe(1),
-.BR classification(1),
-.BR compute_image_mean(1),
-.BR convert_imageset(1),
-.BR extract_features(1),
-.BR upgrade_net_proto_binary(1),
-.BR upgrade_net_proto_text(1).
-.br
-
-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.
diff --git a/debian/man/upgrade_net_proto_text.1 b/debian/man/upgrade_net_proto_text.1
deleted file mode 100644
index 8791b99..0000000
--- a/debian/man/upgrade_net_proto_text.1
+++ /dev/null
@@ -1,28 +0,0 @@
-.\" Hey, EMACS: -*- nroff -*-
-.\" (C) Copyright 2015 Zhou Mo <cdluminate at gmail.com>,
-.\"
-.TH CAFFE 1 "Mar 9. 2015"
-.SH NAME
-upgrade_net_proto_text \- command line tool for caffe
-
-.SH SYNOPSIS
-.B upgrade_net_proto_text
-v0_net_proto_file_in net_proto_file_out
-
-.SH HOMEPAGE
-http://caffe.berkeleyvision.org
-.SH BUGS
-https://github.com/BVLC/caffe/issues
-
-.SH SEE ALSO
-.BR caffe(1),
-.BR classification(1),
-.BR compute_image_mean(1),
-.BR convert_imageset(1),
-.BR extract_features(1),
-.BR upgrade_net_proto_binary(1),
-.BR upgrade_net_proto_text(1).
-.br
-
-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