.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.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.  \*(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-
.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" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" 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 "heri-eval 1"
.TH heri-eval 1 "2021-01-25" "" ""
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
heri\-eval \- evaluate classification algorithm
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBheri-eval\fR [\s-1OPTIONS\s0] \fIdataset\fR [\-\- \s-1SVM_TRAIN_OPTIONS\s0]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBheri-eval\fR runs training algorithm on \fIdataset\fR and then
evaluate it using testing set, specified by option \fI\-e\fR.
If option \fI\-n\fR was applied,
cross-validation is used for evaluation, training and testing on different folds
are run in parallel, thus utilizing available CPUs. If \fI\-r\fR is used, the
dataset is splitted into training and testing datasets randomly with
the specified ratio, and then holdout is run.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-h, \-\-help\fR" 6
.IX Item "-h, --help"
Display help information.
.IP "\fB\-f\fR" 6
.IX Item "-f"
Enable output of per-fold statistics. See \fB\-M\fR\fIf\fR.
.IP "\fB\-n\fR \fIN\fR" 6
.IX Item "-n N"
Enable T*\fIN\fR\-fold cross-validation mode and set the number of folds to \fIN\fR.
.IP "\fB\-r\fR \fIratio\fR" 6
.IX Item "-r ratio"
Split the dataset into training and testing parts with the specified ratio
of their sizes (in percents).
.IP "\fB\-t\fR \fIT\fR" 6
.IX Item "-t T"
Enable \fIT\fR*N\-fold cross-validation mode and set the number of runs to \fIT\fR
which 1 by default.
.IP "\fB\-e\fR \fItesting_dataset\fR" 6
.IX Item "-e testing_dataset"
Enable hold-out mode and set the testing dataset.
.IP "\fB\-T\fR \fIthreshold\fR" 6
.IX Item "-T threshold"
Set the minimum threshold for making a classification decision. If this flag is applied,
micro-average precision, recall, and F1 are calculated instead of accuracy.
.IP "\fB\-o\fR \fIfilename\fR" 6
.IX Item "-o filename"
Save predictions from testing sets
to the specified file.
.Sp
Format: outcome_class prediction_class [score]
.IP "\fB\-O\fR \fIfilename\fR" 6
.IX Item "-O filename"
Save incorrectly classified objects
to the specified file.
.Sp
Format: #object_number: outcome_class prediction_class [score])
.IP "\fB\-m\fR \fIfilename\fR" 6
.IX Item "-m filename"
Save confusion matrix to the specified file.
.Sp
Format: frequency : outcome_class prediction_class
.IP "\fB\-p\fR \fIopts\fR" 6
.IX Item "-p opts"
Pass the specified \fIopts\fR to \fB\fBheri\-stat\fB\|(1)\fR.
.IP "\fB\-s\fR \fIopts\fR" 6
.IX Item "-s opts"
Pass the specified \fIopts\fR to \fB\fBheri\-split\fB\|(1)\fR.
.IP "\fB\-M\fR \fIchars\fR" 6
.IX Item "-M chars"
Sets the output mode where chars are:
t \*(-- output total statistics,
f \*(-- output per-fold statistics,
c \*(-- output cross-fold statistics.
The default is \*(L"\-M tc\*(R".
.IP "\fB\-S\fR \fIseed\fR" 6
.IX Item "-S seed"
Pass the specified \fIseed\fR to \fB\fBheri\-split\fB\|(1)\fR.
.IP "\fB\-K\fR" 6
.IX Item "-K"
Keep temporary directory after exiting.
.IP "\fB\-D\fR" 6
.IX Item "-D"
Turn on the debugging mode, implies \-K.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.Vb 1
\& heri\-eval \-e testing_set.libsvm training_set.libsvm \-\- \-s 0 \-t 0
\&
\& export SVM_TRAIN_CMD=\*(Aqliblinear\-train\*(Aq
\& export SVM_PREDICT_CMD=\*(Aqliblinear\-predict\*(Aq
\& heri\-eval \-p \*(Aq\-mr\*(Aq \-n 5 training_set.libsvm \-\- \-s 4 \-q
\& heri\-eval \-p \*(Aq\-mr\*(Aq \-n 5 training_set.libsvm \-\- \-s 4 \-q
\&
\& export SVM_TRAIN_CMD=\*(Aqscikit_rf\-train \-\-estimators=400\*(Aq
\& export SVM_PREDICT_CMD=\*(Aqscikit_rf\-predict\*(Aq
\& heri\-eval \-p \*(Aq\-c\*(Aq \-Mt \-t 50 \-r 70 dataset.libsvm
.Ve
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
.IP "\fI\s-1SVM_TRAIN_CMD\s0\fR" 6
.IX Item "SVM_TRAIN_CMD"
Training utility, e.g., liblinear-train
(the default is svm-train).
.IP "\fI\s-1SVM_PREDICT_CMD\s0\fR" 6
.IX Item "SVM_PREDICT_CMD"
Predicting utility, e.g., liblinear-predict
(the default is svm-predict).
.IP "\fI\s-1SVM_HERI_STAT_CMD\s0\fR" 6
.IX Item "SVM_HERI_STAT_CMD"
Utility for calculating statistics (the default is \fB\fBheri\-stat\fB\|(1)\fR).
.IP "\fI\s-1SVM_HERI_STAT_ADDONS_CMD\s0\fR" 6
.IX Item "SVM_HERI_STAT_ADDONS_CMD"
Utility for calculating additional statistics (the default is \fB\fBheri\-stat\-addons\fB\|(1)\fR).
.IP "\fI\s-1SVM_HERI_SPLIT_CMD\s0\fR" 6
.IX Item "SVM_HERI_SPLIT_CMD"
Utility for splitting the dataset (the default is \fB\fBheri\-split\fB\|(1)\fR).
.IP "\fI\s-1TMPDIR\s0\fR" 6
.IX Item "TMPDIR"
Temporary directory (the default is /tmp).
.SH "HOME"
.IX Header "HOME"
<http://github.com/cheusov/herisvm>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBheri\-split\fR\|(1)
\&\fBheri\-stat\fR\|(1)