Blame view

tools/sctk-2.4.10/doc/asclite.1 16.7 KB
8dcb6dfcb   Yannick Estève   first commit
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
  .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
  .\"
  .\" 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 (
  (.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  .    if (
  (.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 
  (.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
  ..
  .if !
  F .nr F 0
  .if 
  F>0 \{\
  .    de IX
  .    tm Index:\\$1\t\
  %\t"\\$2"
  ..
  .    if !
  F==2 \{\
  .        nr % 0
  .        nr F 2
  .    \}
  .\}
  .\"
  .\" 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-(\\\
  (.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'-(\
  (.wu*8/10-\*(#H)'\'\h"|\
  :u"
  .    ds ` \\k:\h'-(\
  (.wu*8/10-\*(#H)'\`\h'|\
  :u'
  .    ds ^ \\k:\h'-(\
  (.wu*10/11-\*(#H)'^\h'|\
  :u'
  .    ds , \\k:\h'-(\
  (.wu*8/10)',\h'|\
  :u'
  .    ds ~ \\k:\h'-(\
  (.wu-\*(#H-.1m)'~\h'|\
  :u'
  .    ds / \\k:\h'-(\
  (.wu*8/10-\*(#H)'\z\(sl\h'|\
  :u'
  .\}
  .    \" troff and (daisy-wheel) nroff accents
  .ds : \\k:\h'-(\
  (.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\
  :u'\v'\*(#V'
  .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
  .ds o \\k:\h'-(\
  (.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\
  :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'|\
  :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'-(\
  (.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\
  :u'
  .if v .ds ^ \\k:\h'-(\
  (.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\
  :u'
  .    \" for low resolution devices (crt and lpr)
  .if 
  (.H>23 .if 
  (.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 "ASCLITE 1"
  .TH ASCLITE 1 "2007-11-26" "perl v5.26.1" "Perl Programmers Reference Guide"
  .\" 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"
  asclite \- Multi\-dimensional alignment program.
  .SH "SYNOPSIS"
  .IX Header "SYNOPSIS"
  .Vb 1
  \&        asclite <Input Options> [<Alignment Options>] [<Output Options>] [Scoring Report Options>]
  .Ve
  .SH "DESCRIPTION"
  .IX Header "DESCRIPTION"
  Asclite is multi-dimensional extension of the Dynamic Programming solution to Levenshtein Edit Distance calculations capable of evaluating \s-1STT\s0 and \s-1SASTT\s0 systems during periods of overlapping, simultaneous speech. It handles different input formats: \s-1RTTM, CTM, STM,\s0 and \s-1TRN\s0 and generates several data and statistical formats: \s-1SGML, SUM, RSUM,\s0 and Alignment Information. \s-1STDOUT\s0 is used to generate reports and \s-1STDERR\s0 is used for logging purposes. The alignment information is considered as a log information.
  .SH "USAGE"
  .IX Header "USAGE"
  Examples:
  .PP
  .Vb 2
  \&        asclite \-r example.rttm rttm \-h example2.rttm rttm Example \-adaptive\-cost \-f 6 \-o sgml
  \&        asclite \-r example.rttm rttm \-h example2.rttm rttm Example \-f 0 \-o sum stdout
  .Ve
  .SH "OPTIONS"
  .IX Header "OPTIONS"
  .IP "\fBInput Options:\fR" 4
  .IX Item "Input Options:"
  .RS 4
  .PD 0
  .IP "\fB\-r <reffilename\fR [ rttm | stm | trn ]>" 4
  .IX Item "-r <reffilename [ rttm | stm | trn ]>"
  .PD
  Defines the reference file and its format.
  The default format is 'trn'.
  .IP "\fB\-h <hypfilename\fR [ ctm | rttm | trn ] [ <title> ]>" 4
  .IX Item "-h <hypfilename [ ctm | rttm | trn ] [ <title> ]>"
  Defines the hypothesis file, its format, and the 'title' used for reports. The default title is the filename.
  This option may be used more than once.
  The default format is 'trn'.
  .IP "\fB\-i <ids\fR>" 4
  .IX Item "-i <ids>"
  Set the utterance id type (for trn mode only)
  .RE
  .RS 4
  .RE
  .IP "\fBFilter Options:\fR" 4
  .IX Item "Filter Options:"
  .RS 4
  .PD 0
  .IP "\fB\-spkrautooverlap [ ref | hyp | both ]\fR" 4
  .IX Item "-spkrautooverlap [ ref | hyp | both ]"
  .PD
  Check if the speakers are self-overlaping or not.
  .IP "\fB\-uem <uemfilename\fR [ ref | hyp | both ]>" 4
  .IX Item "-uem <uemfilename [ ref | hyp | both ]>"
  Apply the \s-1UEM\s0 rules.
  The default value is 'both'.
  .IP "\fB\-noisg\fR" 4
  .IX Item "-noisg"
  Do not creates the Inter Segment Gaps.
  .RE
  .RS 4
  .RE
  .IP "\fBAlignment Options:\fR" 4
  .IX Item "Alignment Options:"
  .RS 4
  .PD 0
  .IP "\fB\-s\fR" 4
  .IX Item "-s"
  .PD
  Do case-sensitive alignments.
  .IP "\fB\-F\fR" 4
  .IX Item "-F"
  Score fragments as correct.
  .IP "\fB\-D [ ref | hyp | both ]\fR" 4
  .IX Item "-D [ ref | hyp | both ]"
  Score optional tokens as correct based on the flag's value:
  hyp: a hypothesis word is optional and the work is deleted,
  ref: a reference word is optional and the word is inserted,
  both: both 'ref' and 'hyp' are in effect.
  The default value is 'both'.
  .IP "\fB\-time\-base\-cost\fR" 4
  .IX Item "-time-base-cost"
  Used the time base cost model for the alignment (Note that only ctm and rttm format are supported for this mode).
  .IP "\fB\-time\-prune <time_threshold\fR>" 4
  .IX Item "-time-prune <time_threshold>"
  Activates the time pruning optimization with allowed error of <time_threshold> millisecond(s).
  .IP "\fB\-word\-time\-align <time_threshold\fR>" 4
  .IX Item "-word-time-align <time_threshold>"
  Activates the time optimization for word alignment with allowed error of <time_threshold> millisecond(s).
  .IP "\fB\-spkr\-align <mdm_spkr_align_file_csv\fR>" 4
  .IX Item "-spkr-align <mdm_spkr_align_file_csv>"
  Activates the speaker alignment optimization regarding the <mdm_spkr_align_file_csv> csv file.
  .IP "\fB\-adaptive\-cost\fR" 4
  .IX Item "-adaptive-cost"
  Activates the adaptive cost based on the time.
  .IP "\fB\-wordalign\-cost\fR" 4
  .IX Item "-wordalign-cost"
  Activates the word align cost based on the edit distance.
  .IP "\fB\-overlap\-limit <max_nb_of_overlaping speaker\fR>" 4
  .IX Item "-overlap-limit <max_nb_of_overlaping speaker>"
  Change the maximum number of overlaping speaker (default: 1).
  .IP "\fB\-memory\-compression <block_KB\fR>" 4
  .IX Item "-memory-compression <block_KB>"
  Set the memory compression with compressed <block_KB> \s-1KB\s0 block (default: off / recommanded: 64).
  .IP "\fB\-force\-memory\-compression\fR" 4
  .IX Item "-force-memory-compression"
  Force the memory compression.
  .IP "\fB\-memory\-limit <max_GB\fR>" 4
  .IX Item "-memory-limit <max_GB>"
  Set the maximum memory allocation in \s-1GB\s0 for the \s-1LCM\s0 (default: 2.0).
  If <max_GB> is smaller then 2 \s-1GB\s0 then every segmentation above <max_GB> will not be aligned.
  If <max_GB> is bigger 2 \s-1GB\s0 and memory compression has been activated then every segmentation above <max_GB> will not be aligned and every segmentation between 2 \s-1GB\s0 and <max_GB> will be aligned.
  If <max_GB> is bigger 2 \s-1GB\s0 and memory compression has not been activated every segmentation above 2 \s-1GB\s0 will not be aligned.
  .IP "\fB\-difficulty\-limit <max_GB\fR>" 4
  .IX Item "-difficulty-limit <max_GB>"
  Set the maximum difficulty limit in \s-1GB\s0 for the \s-1LCM\s0 (disabled).
  Every segmentation above this limit will not be aligned.
  .IP "\fB\-min\-difficulty\-limit <max_GB\fR>" 4
  .IX Item "-min-difficulty-limit <max_GB>"
  Set the min difficulty limit in \s-1GB\s0 for the \s-1LCM\s0 (disabled).
  Every segmentation below this limit will not be aligned.
  .IP "\fB\-generic\-cost\fR" 4
  .IX Item "-generic-cost"
  This options trigger the generic cost model computing the results disregarding the notion of hyp and ref, the results will be a multiple-alignment.
  The hypotheses files are the only input.
  There is only one output sgml.
  .RE
  .RS 4
  .RE
  .IP "\fBOutput Options:\fR" 4
  .IX Item "Output Options:"
  .RS 4
  .PD 0
  .IP "\fB\-O <output_dir\fR>" 4
  .IX Item "-O <output_dir>"
  .PD
  Writes all output files into output_dir.
  The default directory is the hypfile's.
  .IP "\fB\-f <level\fR>" 4
  .IX Item "-f <level>"
  Defines feedback mode.
  The default value is 4.
  Silent: 0.
  Alignment: 6.
  Alignment only: 7.
  .IP "\fB\-l <width\fR>" 4
  .IX Item "-l <width>"
  Defines the line width used for reports.
  .RE
  .RS 4
  .RE
  .IP "\fBScoring Report Options:\fR" 4
  .IX Item "Scoring Report Options:"
  .RS 4
  .PD 0
  .IP "\fB\-o [ sum | rsum | sgml ] [ sdtout ]\fR" 4
  .IX Item "-o [ sum | rsum | sgml ] [ sdtout ]"
  .PD
  Defines the output reports.
  The default value is 'sum stdout'.
  .RE
  .RS 4
  .RE
  .IP "\fBOther options:\fR" 4
  .IX Item "Other options:"
  .RS 4
  .PD 0
  .IP "\fB\-h\fR, \fB\-\-help\fR" 4
  .IX Item "-h, --help"
  .PD
  Display the help.
  .RE
  .RS 4
  .RE
  .SH "BUGS"
  .IX Header "BUGS"
  No known bugs.
  .SH "NOTES"
  .IX Header "NOTES"
  .SS "Cost Models"
  .IX Subsection "Cost Models"
  There 2 different cost models used in \s-1ASCLITE:\s0 Word-base cost and Time-base cost.
  .PP
  \fIWord-base cost\fR
  .IX Subsection "Word-base cost"
  .PP
  The default one is based on the words.
  It assigns costs regarding the action taken on the word (correct, insertion, deletion, substitution, etc.):
  Correct (the two word are aligned together but have not the same syntax) [cost of 0], Substitution (the two word are aligned together and have the same syntax) [cost of 400], Deletion (word that appears in the hypothesis but not in the system output) [cost of 300], Insertion (word that not appears in the hypothesis but in the system output).
  .PP
  If there is no distinction between hypotheses and system outputs, it uses a 'generic' cost model.
  The 'generic' cost model is not working on pair of words but by set of words; the set of words representing the state of the alignment matrix. It calculates the number of 'insertions' and 'deletions' and the number of words that have the same syntax. It adds the costs of all the insertions and deletions, plus the cost of correct to the maximum number of words which have the same syntax and the cost of substitution to the rest, and this to the set of words.
  .PP
  \fITime-base cost\fR
  .IX Subsection "Time-base cost"
  .PP
  The second one is based on the times.
  It assigns costs regarding the times of the words. The cost if the sum of the differences between the begin times and end times of the words.
  .PP
  For example:
  .PP
  .Vb 3
  \&        B   E
  \&        |\-\-\-| is the word in the timeline.
  \&        ***** is the difference.
  \&        
  \&               B        E
  \&        Word1: |\-\-\-\-\-\-\-|******   
  \&        Word2: *****|\-\-\-\-\-\-\-\-|
  \&                    B        E
  \&
  \&        Cost: 11 (number of *)
  .Ve
  .PP
  If there is no distinction between hypotheses and system outputs, it uses a 'generic' cost model.
  The 'generic' cost model, as for thw word-base model, is not working on pair of words but by set of words; the set of words representing the state of the alignment matrix.
  It uses the minimum and maximum times of all the words. Uses that times to calculates the costs by adding the differences between the minimum time versus the begin times, and the maximum time versus the end times.
  For the deletions, it just add to the cost the difference between the 2 maxima.
  .PP
  For example:
  .PP
  .Vb 3
  \&        B   E
  \&        |\-\-\-| is the word in the timeline.
  \&        ***** is the difference.
  \&        
  \&               
  \&        Word1:     **|\-\-\-\-\-\-\-\-\-\-\-\-|*****   
  \&        Word2:     *****|\-\-\-\-\-\-\-\-|******
  \&        Word3:     **|\-\-\-|**************
  \&        Word4:     |\-\-\-\-\-\-\-\-|***********
  \&        Deletion1: *********************
  \&        Word5:     ************|\-\-\-\-\-\-\-|
  \&       
  \&        Cost: 78 (number of *)
  .Ve
  .SS "Filtering"
  .IX Subsection "Filtering"
  \fI\s-1UEM\s0 and References\fR
  .IX Subsection "UEM and References"
  .PP
  The \s-1UEM\s0 filtering works as both a filter and a semantic checker.   The times within the \s-1UEM\s0 and reference files are expected to be coherent meaning there are no \s-1UEM\s0 segment times that are within the bounds of a reference segment.
  .PP
  It works as a filter because it keeps and scores only the reference segments that are encapsulated by the begin/end time definitions in the \s-1UEM\s0 (Seg4 in the example).  Conversely, reference segments fully outside the \s-1UEM\s0 (Seg5\-6 in the example) are removed from the scoring. If there is no \s-1UEM\s0 entry defined for a particular file/channel, then the segments with the same file/channel are removed as well.
  .PP
  It works as a checker by detecting if some segments are not fully inside (or outside) the \s-1UEM\s0 time definitions (Seg1\-3 in the example).  These conditions are fatal errors.
  .PP
  .Vb 2
  \&        B   E
  \&        |\-\-\-| is the segment in the timeline.
  \&
  \&
  \&        UEM:       |\-\-\-\-\-\-\-\-\-\-\-\-\-|
  \&        Seg1:  |\-\-\-\-\-\-\-|                   [out \- error]
  \&        Seg2:                   |\-\-\-\-\-\-\-|  [out \- error]
  \&        Seg3:   |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-|      [out \- error]
  \&        Seg4:        |\-\-\-\-\-\-\-|             [ in \-  ok  ]
  \&        Seg5:  |\-\-|                        [out \- info ]
  \&        Seg6:                       |\-\-\-|  [out \- info ]
  .Ve
  .PP
  The program reports an error when a reference segment is not fully inside the \s-1UEM\s0 (Seg1\-3 in the example) then exits. If a reference segment is fully outside the \s-1UEM\s0 (Seg5\-6 in the example) then asclite outputs informational messages about the segment.
  .PP
  Where errors are found in the \s-1UEM\s0 filtering, asclite exits.
  .PP
  \fI\s-1UEM\s0 and Hypotheses\fR
  .IX Subsection "UEM and Hypotheses"
  .PP
  The \s-1UEM\s0 filtering works not with the begin and end time of every hypothesis segments/tokens, but rather the mid-time. If the mid-time is outside the \s-1UEM\s0 time definitions then the segment/token is removed from scoring and an information message is outputted.
  .SS "Publications"
  .IX Subsection "Publications"
  [1] \fBMultiple Dimension Levenshtein Edit Distance Calculations for Evaluating Automatic Speech Recognition Systems During Simultaneous Speech\fR, Jonathan Fiscus, Jerome Ajot, Nicolas Radde and Christophe Laprun, Proceedings of Language Resources and Evaluation (\s-1LREC\s0), Genoa, Italy, May 2006.
  .SH "AUTHORS"
  .IX Header "AUTHORS"
  .IP "Jerome Ajot <jerome.ajot@nist.gov>" 4
  .IX Item "Jerome Ajot <jerome.ajot@nist.gov>"
  .PD 0
  .IP "Jon Fiscus <jon.fiscus@nist.gov>" 4
  .IX Item "Jon Fiscus <jon.fiscus@nist.gov>"
  .IP "Nicolas Radde <retired>" 4
  .IX Item "Nicolas Radde <retired>"
  .IP "Chris Laprun <retired>" 4
  .IX Item "Chris Laprun <retired>"
  .PD
  .SH "COPYRIGHT"
  .IX Header "COPYRIGHT"
  Public Domain
  .SH "DISCLAIMER"
  .IX Header "DISCLAIMER"
  This software was developed at the National Institute of Standards and Technology by 
  employees of the Federal Government in the course of their official duties. Pursuant
  to title 17 Section 105 of the United States Code this software is not subject to
  copyright protection and is in the public domain. \s-1ASCLITE\s0 is an experimental system.
  \&\s-1NIST\s0 assumes no responsibility whatsoever for its use by other parties, and makes no
  guarantees, expressed or implied, about its quality, reliability, or any other
  characteristic. We would appreciate acknowledgement if the software is used.
  .PP
  \&\s-1THIS SOFTWARE IS PROVIDED \*(L"AS IS.\*(R"\s0  With regard to this software, \s-1NIST MAKES NO EXPRESS
  OR IMPLIED WARRANTY AS TO ANY MATTER WHATSOEVER, INCLUDING MERCHANTABILITY,
  OR FITNESS FOR A PARTICULAR PURPOSE.\s0