[libocas] 07/60: Updated skeleton man pages for svmocas/msvmocas

Mon Aug 25 03:34:41 UTC 2014

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

chrisk-guest pushed a commit to branch master
in repository libocas.

commit 4774e53c873be3749d8b8c8a08ee596dfa57fe72
Author: Christian Kastner <debian at kvr.at>
Date:   Thu Jun 17 15:52:18 2010 +0200

    Updated skeleton man pages for svmocas/msvmocas
---
 debian/msvmocas.1 | 105 ++++++++++++++++++++++++++++++++++++------------
 debian/svmocas.1  | 118 ++++++++++++++++++++++++++++++++++++++++++------------
 2 files changed, 171 insertions(+), 52 deletions(-)

diff --git a/debian/msvmocas.1 b/debian/msvmocas.1
index 596bd13..91d2b34 100644
--- a/debian/msvmocas.1
+++ b/debian/msvmocas.1
@@ -1,41 +1,94 @@
 .\"                                      Hey, EMACS: -*- nroff -*-
-.TH MSVMOCAS 1 "June 12, 2010"
-.\" 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 MSVMOCAS 1 "June 16, 2010"
 .SH NAME
-msvmocas \- bla
+msvmocas \- train a multi-class linear SVM classifier
 .SH SYNOPSIS
 .B msvmocas
-.RI [ options ] " files" ...
+.RI [ options ] " example_file " \fImodel_file\fP
 .SH DESCRIPTION
-This manual page documents briefly the
-.B msvmocas
-command.
+\fBmsvmocas\fP is a program that trains a multi-class linear SVM classifier
+using the Optimized Cutting Plane Algorithm for Support Vector Machines (OCAS)
+and produces a model file.
 .PP
-\fBmsvmocas\fP is a program that...
+\fIexample_file\fP is a file with training examples in SVM^light format, and
+\fImodel_file\fP is the file in which to store the learned linear rule
+\fBf(x)=W'*x\fP. \fImodel_file\fP contains \fBM\fP columns and \fBD\fP lines,
+where \fBM\fP is the number of classes and \fBD\fP the number of dimensions,
+corresponding to the elements of the matrix \fBW [D x M]\fP.
 .SH OPTIONS
-These programs follow the usual GNU command line syntax, with long
-options starting with two dashes (`-').
 A summary of options is included below.
-For a complete description, see the Info files.
+.PP
+\fBGeneral options:\fP
 .TP
-.B \-h, \-\-help
+.B \-h
 Show summary of options.
 .TP
-.B \-v, \-\-version
-Show version of program.
+.B \-v \fI(0|1)\fP
+Set the verbosity level (default: \fB1\fP)
+.PP
+\fBLearning options:\fP
+.TP
+.B \-c \fIfloat\fB
+Regularization constant C. (default: \fB1\fP)
+.TP
+.B \-n \fIinteger\fP
+Use only the first \fIinteger\fP examples for training. By default,
+\fIinteger\fP equals the number of examples in \fIexample_file\fP.
+.PP
+\fBOptimization options:\fP
+.TP
+.B \-m \fI(0|1)\fP
+Solver to be used:
+.sp
+.RS 12
+.nf
+0 ... standard cutting plane (equivalent to BMRM, SVM^perf)
+.sp
+1 ... OCAS (default)
+.fi
+.RE
+.TP
+.B \-s \fIinteger\fP
+Cache size for cutting planes. (default: \fB2000\fP)
+.PP
+\fBStopping conditions:\fP
+.TP
+.B \-a \fIfloat\fP
+Absolute tolerance TolAbs: halt if \fBQP-QD <= TolAbs\fP. (default: \fB0\fP)
+.TP
+.B \-r \fIfloat\fP
+Relative tolerance TolAbs: halt if \fBQP-QD <= abs(QP)*TolRel\fP.
+(default: \fB0.01\fP)
+.TP
+.B \-q \fIfloat\fP
+Desired objective value QPValue: halt is \fBQP <= QPValue\fP. (default: \fB0\fP)
+.TP
+.B \-t \fIfloat\fP
+Halts if the solver time (loading time is not counted) exceeds the time given
+in seconds. (default: \fBinfinity\fP)
+.SH EXAMPLES
+Train the multi-class SVM classifier from example file
+\fIexample4_train.light\fP, with the regularization constant C=10, verbosity
+switched off, and save model to \fImsvmocas.model\fP:
+.sp
+.RS 12
+.nf
+ msvmocas \-c 10 \-v 0 example4_train.light msvmocas.model
+.fi
+.RE
+.sp
+Compute the testing error of the classifier stored in \fImsvmocas.model\fP
+with \fBlinclass\fP(1) using testing examples from \fIexample4_test.light\fP
+and save the predicted labels to \fIexample4_test.pred\fP:
+.sp
+.RS 12
+.nf
+ linclass \-e \-o example4_test.pred example4_test.light msvmocas.model
+.fi
+.RE
 .SH SEE ALSO
-.BR svmocas (1).
+.BR svmocas (1),
+.BR linclass (1).
 .SH AUTHORS
 msvmocas was written by Vojtech Franc <xfrancv at cmp.felk.cvut.cz> and
 Soeren Sonnenburg <Soeren.Sonnenburg at tu-berlin.de>.
diff --git a/debian/svmocas.1 b/debian/svmocas.1
index be8916a..cc7a0a6 100644
--- a/debian/svmocas.1
+++ b/debian/svmocas.1
@@ -1,41 +1,107 @@
 .\"                                      Hey, EMACS: -*- nroff -*-
-.TH SVMOCAS 1 "June 12, 2010"
-.\" 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 SVMOCAS 1 "June 16, 2010"
 .SH NAME
-svmocas \- bla
+svmocas \- train a binary linear SVM classifier
 .SH SYNOPSIS
 .B svmocas
-.RI [ options ] " files" ...
+.RI [ options ] " example_file " \fImodel_file\fP
 .SH DESCRIPTION
-This manual page documents briefly the
-.B svmocas
-command.
+\fBsvmocas\fP is a program that trains a binary linear SVM classifier using the
+Optimized Cutting Plane Algorithm for Support Vector Machines (OCAS) and
+produces a model file.
 .PP
-\fBsvmocas\fP is a program that...
+\fIexample_file\fP is a file with training examples in SVM^light format, and
+\fImodel_file\fP is the file in which to store the learned linear rule
+\fBf(x)=w'*x+w0\fP. \fImodel_file\fP contains \fBd\fP lines, where \fBd\fP
+is the number of data dimensions. The first n lines are coordinates of \fBw\fP
+and the last line is \fBw0\fP.
 .SH OPTIONS
-These programs follow the usual GNU command line syntax, with long
-options starting with two dashes (`-').
 A summary of options is included below.
-For a complete description, see the Info files.
+.PP
+\fBGeneral options:\fP
 .TP
-.B \-h, \-\-help
+.B \-h
 Show summary of options.
 .TP
-.B \-v, \-\-version
-Show version of program.
+.B \-v \fI(0|1)\fP
+Set the verbosity level (default: \fB1\fP)
+.PP
+\fBLearning options:\fP
+.TP
+.B \-c \fIfloat\fB
+Regularization constant C. (default: \fB1\fP)
+.TP
+.B \-C \fIconstants_file\fB
+If specified, each example has a different regularization constant, taken from
+the text file \fIconstants_file\fP. Each line of the text file must contain a
+single constant (positive double) for the corresponding example. If \fB-C\fP
+is used, then the \fB-c\fP option is ignored.
+.TP
+.B \-b \fI(0|1)\fP
+Value of the L2-bias feature. A value of 0 implies not having bias.
+(default: \fB0\fP)
+.TP
+.B \-n \fIinteger\fP
+Use only the first \fIinteger\fP examples for training. By default,
+\fIinteger\fP equals the number of examples in \fIexample_file\fP.
+.PP
+\fBOptimization options:\fP
+.TP
+.B \-m \fI(0|1)\fP
+Solver to be used:
+.sp
+.RS 12
+.nf
+0 ... standard cutting plane (equivalent to BMRM, SVM^perf)
+.sp
+1 ... OCAS (default)
+.fi
+.RE
+.TP
+.B \-s \fIinteger\fP
+Cache size for cutting planes. (default: \fB2000\fP)
+.TP
+.B \-p \fIinteger\fP
+Number of threads. (default: \fB1\fP)
+.PP
+\fBStopping conditions:\fP
+.TP
+.B \-a \fIfloat\fP
+Absolute tolerance TolAbs: halt if \fBQP-QD <= TolAbs\fP. (default: \fB0\fP)
+.TP
+.B \-r \fIfloat\fP
+Relative tolerance TolAbs: halt if \fBQP-QD <= abs(QP)*TolRel\fP.
+(default: \fB0.01\fP)
+.TP
+.B \-q \fIfloat\fP
+Desired objective value QPValue: halt is \fBQP <= QPValue\fP. (default: \fB0\fP)
+.TP
+.B \-t \fIfloat\fP
+Halts if the solver time (loading time is not counted) exceeds the time given
+in seconds. (default: \fBinfinity\fP)
+.SH EXAMPLES
+Train the binary SVM classifier from \fIriply_trn.light\fP, with the
+regularization constant C=10, bias switched on, verbosity switched off,
+and save model to \fIsvmocas.model\fP:
+.sp
+.RS 12
+.nf
+ svmocas \-c 10 \-b 1 \-v 0 riply_trn.light svmocas.model
+.fi
+.RE
+.sp
+Compute the testing error of the classifier stored in \fIsvmocas.model\fP
+with \fBlinclass\fP(1) using testing examples from \fIriply_tst.light\fP
+and save the predicted labels to \fIriply_tst.pred\fP:
+.sp
+.RS 12
+.nf
+ linclass \-e \-o riply_tst.pred riply_tst.light svmocas.model
+.fi
+.RE
 .SH SEE ALSO
-.BR msvmocas (1).
+.BR msvmocas (1),
+.BR linclass (1).
 .SH AUTHORS
 svmocas was written by Vojtech Franc <xfrancv at cmp.felk.cvut.cz> and
 Soeren Sonnenburg <Soeren.Sonnenburg at tu-berlin.de>.

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

