.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.35
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "ME.WRAPPER 1"
.TH ME.WRAPPER 1 "1998-11-20" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
ME.wrapper.pl \- a wrapper around \f(CW\*(C`Statistics::MaxEntropy\*(C'\fR and \f(CW\*(C`Statistics::Candidates\*(C'\fR
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 21
\& ME.wrapper.pl --help
\&               --debug
\&               --i_events <filename>
\&               --i_candidates <filename>
\&               --i_dump <filename>
\&               --o_events <filename>
\&               --o_candidates <filename>
\&               --o_parameters <filename>
\&               --special <filename>
\&               --o_dump <filename>
\&               --KL_max_it <integer>
\&               --NEWTON_max_it <integer>
\&               --KL_min <float>
\&               --NEWTON_min <float>
\&               --nr_to_add <integer>
\&               --SAMPLE <integer>
\&               --GIS
\&               --IIS
\&               --MC
\&               --CORPUS
\&               --ENUM
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`ME.wrapper.pl\*(C'\fR is a command-line interface to
\&\f(CW\*(C`Statistics::MaxEntropy\*(C'\fR and \f(CW\*(C`Statistics::Candidates\*(C'\fR. The wrapper
and its command line options provide an easy-to-use and transparent
connection to the MaxEntropy modules. Below we explain the meaning of
the options.
.SH "COMMAND LINE ARGUMENTS"
.IX Header "COMMAND LINE ARGUMENTS"
We explain the command line options, and state the at which moment
they are applied or executed. For this we assume the main program of
\&\f(CW\*(C`ME.wrapper.pl\*(C'\fR to have the following form
.PP
.Vb 3
\& prologue();
\& run();
\& epilogue();
.Ve
.PP
If both candidates and events are specified, the feature induction
algorithm is called. If only events are specified a scaling algorithm
is called (\s-1GIS\s0 by default).
.ie n .IP """\-\-KL_max_it integer""" 4
.el .IP "\f(CW\-\-KL_max_it integer\fR" 4
.IX Item "--KL_max_it integer"
(set in prologue) The maximum number of iterations performed by the
scaling algorithms.
.ie n .IP """\-\-NEWTON_max_it integer""" 4
.el .IP "\f(CW\-\-NEWTON_max_it integer\fR" 4
.IX Item "--NEWTON_max_it integer"
(set in prologue) The maximum number of iteration in Newton's method
(\s-1IIS\s0 only).
.ie n .IP """\-\-KL_min integer""" 4
.el .IP "\f(CW\-\-KL_min integer\fR" 4
.IX Item "--KL_min integer"
(set in prologue) The minimum difference in Kullback-Leibler
divergence that a new scale iteration should bring. Otherwise Scaling
is stopped.
.ie n .IP """\-\-NEWTON_min float""" 4
.el .IP "\f(CW\-\-NEWTON_min float\fR" 4
.IX Item "--NEWTON_min float"
(set in prologue) The minimum difference between the new x and the old
x in Newton's method (\s-1IIS\s0 only).
.ie n .IP """\-\-nr_to_add integer""" 4
.el .IP "\f(CW\-\-nr_to_add integer\fR" 4
.IX Item "--nr_to_add integer"
(used in run) Passed to the feature induction algorithm (if
called). It states the number of candidates that should be added.
.ie n .IP """\-\-SAMPLE integer""" 4
.el .IP "\f(CW\-\-SAMPLE integer\fR" 4
.IX Item "--SAMPLE integer"
(used in run) Passed to the feature induction algorithm (if
called). It determines the size of the Monte Carlo sample. Only makes
sense if \f(CW\*(C`\-\-MC\*(C'\fR is set.
.ie n .IP """\-\-GIS""" 4
.el .IP "\f(CW\-\-GIS\fR" 4
.IX Item "--GIS"
(used in run) Sets the scaling algorithm to to Generalised Iterative
Scaling.
.ie n .IP """\-\-IIS""" 4
.el .IP "\f(CW\-\-IIS\fR" 4
.IX Item "--IIS"
(used in run) Sets the scaling algorithm to Improved Iterative
Scaling.
.ie n .IP """\-\-MC""" 4
.el .IP "\f(CW\-\-MC\fR" 4
.IX Item "--MC"
(used in run) Sets the sampling method to Monte Carlo. See also the
\&\f(CW\*(C`\-\-SAMPLE\*(C'\fR option.
.ie n .IP """\-\-CORPUS""" 4
.el .IP "\f(CW\-\-CORPUS\fR" 4
.IX Item "--CORPUS"
(used in run) Tells the scaling algorithm to consider the event space
a good sample (risky: overtraining).
.ie n .IP """\-\-ENUM""" 4
.el .IP "\f(CW\-\-ENUM\fR" 4
.IX Item "--ENUM"
(used in run) For scaling the complete event space (all bitvectors)
should be enumerated. This is done in memory, so beware!
.ie n .IP """\-\-help""" 4
.el .IP "\f(CW\-\-help\fR" 4
.IX Item "--help"
(done in prologue) Exits after showing the name of the program, and
the list of command line options.
.ie n .IP """\-\-debug""" 4
.el .IP "\f(CW\-\-debug\fR" 4
.IX Item "--debug"
(set in prologue) Tells the \f(CW\*(C`MaxEntropy\*(C'\fR and \f(CW\*(C`Candidates\*(C'\fR modules to
output a lot of text.
.ie n .IP """\-\-i_events filename""" 4
.el .IP "\f(CW\-\-i_events filename\fR" 4
.IX Item "--i_events filename"
(done in prologue) The events are read from <filename>.
.ie n .IP """\-\-i_candidates filename""" 4
.el .IP "\f(CW\-\-i_candidates filename\fR" 4
.IX Item "--i_candidates filename"
(done in prologue) The candidates are read from <filename>.
.ie n .IP """\-\-i_dump filename""" 4
.el .IP "\f(CW\-\-i_dump filename\fR" 4
.IX Item "--i_dump filename"
(done in prologue) An event space read from the dump in
<filename>. This option overrules \f(CW\*(C`\-\-i_events\*(C'\fR option.
.ie n .IP """\-\-o_events filename""" 4
.el .IP "\f(CW\-\-o_events filename\fR" 4
.IX Item "--o_events filename"
(done in epilogue) The events (including candidates that were added)
are written to \f(CW\*(C`filename\*(C'\fR.
.ie n .IP """\-\-o_candidates filename""" 4
.el .IP "\f(CW\-\-o_candidates filename\fR" 4
.IX Item "--o_candidates filename"
(done in epilogue) The candidates (if present) are written to
\&\f(CW\*(C`filename\*(C'\fR. Only candidates that were not added to the event space
are written.
.ie n .IP """\-\-o_parameters filename""" 4
.el .IP "\f(CW\-\-o_parameters filename\fR" 4
.IX Item "--o_parameters filename"
(done in epilogue) The parameters are written to \f(CW\*(C`filename\*(C'\fR.
.ie n .IP """\-\-special filename""" 4
.el .IP "\f(CW\-\-special filename\fR" 4
.IX Item "--special filename"
(done in epilogue) The parameters are written to \f(CW\*(C`filename\*(C'\fR in a
\&\fBspecial\fR format I like.
.ie n .IP """\-\-o_dump filename""" 4
.el .IP "\f(CW\-\-o_dump filename\fR" 4
.IX Item "--o_dump filename"
(done in epilogue) The event space is dumped to \f(CW\*(C`filename\*(C'\fR. It can
be read in again using \f(CW\*(C`\-\-i_dump\*(C'\fR (the next time you use
\&\f(CW\*(C`ME.wrapper.pl\*(C'\fR).
.SH "BUGS"
.IX Header "BUGS"
Options \f(CW\*(C`\-\-MC\*(C'\fR, \f(CW\*(C`\-\-CORPUS\*(C'\fR, \f(CW\*(C`\-\-ENUM\*(C'\fR should be put under one
argument that has a parameter, for instance \f(CW\*(C`\-\-sample_type [corpus,
enum, mc]\*(C'\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIperl\fR\|(1), \fIStatistics::Candidates\fR\|(3), \fIStatistics::MaxEntropy\fR\|(3).
.SH "VERSION"
.IX Header "VERSION"
Version 0.2.
.SH "AUTHOR"
.IX Header "AUTHOR"
Hugo WL ter Doest, terdoest@cs.utwente.nl

.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 1998 Hugo WL ter Doest, terdoest@cs.utwente.nl
Univ. of Twente, Dept. of Comp. Sc., Parlevink Research, Enschede,
The Netherlands.

\&\f(CW\*(C`ME.wrapper.pl\*(C'\fR comes with \s-1ABSOLUTELY\s0 \s-1NO\s0 \s-1WARRANTY\s0 and may be copied
only under the terms of the \s-1GNU\s0 Library General Public License (version 2, or
later), which may be found in the distribution.
