.\" 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-stat 1" .TH heri-stat 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\-stat \- calculates precision, recall, F1 and some other things .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBheri-stat\fR [\-R] [\-mrca] [\-u label] [\-t threshold] \fIoutcomes_file\fR \fIpredictions_file\fR .PP \&\fBheri-stat\fR \-1 [\-R] [\-mrca] [\-u label] [\-t threshold] [\fIfiles\fR...] .PP \&\fBheri-stat\fR \-g mode [\-R] [\-xy] \fIoutcomes_file\fR \fIpredictions_file\fR .PP \&\fBheri-stat\fR \-1 \-g mode [\-R] [\fIfiles\fR...] .PP \&\fBheri-stat\fR [\-h] .SH "DESCRIPTION" .IX Header "DESCRIPTION" The first and second types of \fBheri-stat\fR invocation takes classification dataset and predictions on input, and calculate precision, recall and F1. Unless option \fB\-1\fR was applied, \fBheri-stat\fR reads correct classes from \fIoutcomes_file\fR (one class per line) and predicted classes from \fIpredictions_file\fR (one class per line). It is allowed for \fIpredictions_file\fR to contain two tokens per line. The first one is a predicted class, the second one is a score, e.g. probability. .PP The third and forth type of \fBheri-stat\fR invocation takes regression outcomes and predictions on input (one value per line) and calculate mean absolute error (\s-1MAE\s0), mean squared error (\s-1MSE\s0) and/or mean absolute error (\s-1MAE\s0). .PP If \fB\-1\fR was applied, two or three tokens per line are expected on input: correct value (or class for classification), predicted value (or class), and optional score. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-h, \-\-help\fR" 6 .IX Item "-h, --help" Display help information. .IP "\fB\-R, \-\-raw\fR" 6 .IX Item "-R, --raw" Raw tab-separated output. .IP "\fB\-m, \-\-micro\-avg\fR" 6 .IX Item "-m, --micro-avg" Disable micro averaged P/R/F1 output. .IP "\fB\-r, \-\-macro\-avg\fR" 6 .IX Item "-r, --macro-avg" Disable macro averaged P/R/F1 output. .IP "\fB\-c, \-\-per\-class\fR" 6 .IX Item "-c, --per-class" Disable output of per-class statistics. .IP "\fB\-a, \-\-accuracy\fR" 6 .IX Item "-a, --accuracy" Disable output of accuracy. .IP "\fB\-1, \-\-single\fR" 6 .IX Item "-1, --single" 2 or 3 tokens per line are expected on input. .IP "\fB\-u, \-\-unclassified\fR \fIlabel\fR" 6 .IX Item "-u, --unclassified label" Set the label for \*(L"unclassified\*(R" object. If specified, micro-averaged P/R/F1 is calculated instead of accuracy. Also, statistics for this class is not calculated. .IP "\fB\-t, \-\-treshold\fR \fIvalue\fR" 6 .IX Item "-t, --treshold value" Consider classes with score less than the specified \fIvalue\fR as unclassified. .IP "\fB\-g, \-\-regression\fR \fImode\fR" 6 .IX Item "-g, --regression mode" Regression outcomes and predictions are expected on input. If \fImode\fR contains symbol \fIa\fR, \s-1MAE\s0 is output, \fIs\fR \*(-- \s-1MSE,\s0 and \fIr\fR \*(-- \s-1RMSE\s0 is output. .SH "HOME" .IX Header "HOME" .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBheri\-eval\fR\|(1) \&\fBheri\-split\fR\|(1)