-
Notifications
You must be signed in to change notification settings - Fork 10
/
DumpResults.java
1086 lines (1029 loc) · 41.3 KB
/
DumpResults.java
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
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* (C) Copyright 2012-2013 A-cube lab - Università di Pisa - Dipartimento di Informatica.
* BAT-Framework is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
* BAT-Framework is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
* You should have received a copy of the GNU General Public License along with BAT-Framework. If not, see <http://www.gnu.org/licenses/>.
*/
package it.unipi.di.acube.batframework.utils;
import it.unipi.di.acube.batframework.cache.BenchmarkCache;
import it.unipi.di.acube.batframework.data.*;
import it.unipi.di.acube.batframework.metrics.*;
import it.unipi.di.acube.batframework.problems.*;
import java.io.*;
import java.util.*;
/**
* This class contains all the methods to dump the result of an experiment, both
* to the screen (methods print*), in latex form (methods latex*), or as gnuplot
* data used to generate charts (methods gnuplot*).
*
*/
public class DumpResults {
private static final Locale LOCALE = Locale.US;
private static final String CHARTS_DIR = "charts/";
private static class StringLengthComparator implements Comparator<String> {
public int compare(String o1, String o2) {
return o1.length() - o2.length();
}
}
/**
* Writes (as {@code .dat} gnuplot data) the micro-F1, micro-precision and
* micro-recall achieved for each combination of Match relation - Annotator
* - Dataset, varying the score threshold in [0,1], to a file in the form
* matchrelation_datasetname_f1_threshold_annotatorname.dat. Note that this
* will generate
* {@code 3 * matchRels.size() * annotators.size() * dss.size()} files. Also
* note that the experiments must have already been performed and their
* results stored in {@code threshRecords}.
*
* @param matchRels
* the set of Match relations.
* @param annotators
* the set of annotators.
* @param dss
* the set of datasets.
* @param api
* the API to Wikipedia (needed to print information about
* annotations/tags).
* @param threshRecords
* the hashmap in the form metric -> annotator -> dataset ->
* (threshold, results) where the results are stored.
* @param <T1>
* the type of system.
* @param <T2>
* the type of system's output.
* @param <T3>
* the type of dataset.
* @throws IOException
* if something went wrong while querying the Wikipedia API.
*/
public static <T1 extends TopicSystem, T2 extends Tag, T3 extends TopicDataset> void gnuplotCorrectnessPerformance(
Vector<MatchRelation<T2>> matchRels,
List<T1> annotators,
Vector<T3> dss,
WikipediaInterface api,
HashMap<String, HashMap<String, HashMap<String, HashMap<Float, MetricsResultSet>>>> threshRecords)
throws IOException {
for (MatchRelation<T2> m : matchRels)
for (T3 ds : dss) {
for (T1 t : annotators) {
System.out.println("Writing to gnuplot-file "
+ ds.getName() + "/" + t.getName()
+ " with varying score threshold...");
String prefix = CHARTS_DIR
+ m.getName().replaceAll("[^a-zA-Z0-9]", "")
.toLowerCase();
String suffix = t.getName().replaceAll("[^a-zA-Z0-9]", "")
.toLowerCase()
+ "_"
+ ds.getName().replaceAll("[^a-zA-Z0-9]", "")
.toLowerCase() + ".dat";
OutputStreamWriter precOs = new OutputStreamWriter(
new FileOutputStream(prefix
+ "_precision_threshold_" + suffix));
OutputStreamWriter recOs = new OutputStreamWriter(
new FileOutputStream(prefix + "_recall_threshold_"
+ suffix));
OutputStreamWriter f1Os = new OutputStreamWriter(
new FileOutputStream(prefix + "_f1_threshold_"
+ suffix));
HashMap<Float, MetricsResultSet> records = RunExperiments
.getRecords(threshRecords, m.getName(),
t.getName(), ds.getName());
List<Float> thresholds = new Vector<Float>(records.keySet());
Collections.sort(thresholds);
for (Float thr : thresholds) {
MetricsResultSet rs = records.get(thr);
System.out.printf(
LOCALE,
t.getName() + " - " + ds.getName() + " " + thr
+ " tp:" + rs.getGlobalTp() + " fp:"
+ rs.getGlobalFp() + " fn:"
+ rs.getGlobalFn() + " prec:"
+ rs.getMicroPrecision() + " rec:"
+ rs.getMicroRecall() + " f1:"
+ rs.getMicroF1() + "\n");
precOs.write(String.format(LOCALE, "%f\t%f%n", thr,
rs.getMicroPrecision()));
recOs.write(String.format(LOCALE, "%f\t%f%n", thr,
rs.getMicroRecall()));
f1Os.write(String.format(LOCALE, "%f\t%f%n", thr,
rs.getMicroF1()));
}
precOs.close();
recOs.close();
f1Os.close();
}
}
System.out.println("Flushing Wikipedia API cache...");
api.flush();
}
/**
* Writes a file {@code runtime_f1.dat} storing (avg. runtime, achieved best
* micro-F1) pairs for a single dataset and a single match relation. Note
* that the experiments must have already been performed and their results
* stored in {@code threshRecords}.
*
* @param matchRelName
* The match relation used to compute the micro-F1.
* @param a2wAnnotators
* The set of A2W Annotators for which a pair must be included in
* the output.
* @param sa2wAnnotators
* The set of Sa2W Annotators for which a pair must be included.
* @param datasetName
* The name of the dataset for which the pairs must be included.
* @param api
* the API to Wikipedia (needed to print information about
* annotations/tags).
* @param threshRecords
* the hashmap in the form metric -> annotator -> dataset ->
* (threshold, results) where the results are stored.
* @throws IOException
* if something went wrong while querying the Wikipedia API.
* @throws Exception
* if the cache does not contain records about the given
* dataset/annotator avg. time.
*/
public static void gnuplotRuntimeF1(
String matchRelName,
Vector<A2WSystem> a2wAnnotators,
Vector<Sa2WSystem> sa2wAnnotators,
String datasetName,
WikipediaInterface api,
HashMap<String, HashMap<String, HashMap<String, HashMap<Float, MetricsResultSet>>>> threshRecords)
throws IOException, Exception {
OutputStreamWriter runTimeF1Stream = new OutputStreamWriter(
new FileOutputStream(CHARTS_DIR + "runtime_f1.dat"));
if (a2wAnnotators != null)
for (A2WSystem t : a2wAnnotators)
runTimeF1Stream.write(String.format(LOCALE, "%f\t%d\t\"%s\"\n",
RunExperiments.getBestRecord(threshRecords,
matchRelName, t.getName(), datasetName).second
.getMicroF1(), (int) BenchmarkCache
.getAvgA2WTimingsForDataset(t.getName(),
datasetName), t.getName()));
if (sa2wAnnotators != null)
for (Sa2WSystem t : sa2wAnnotators)
runTimeF1Stream.write(String.format(LOCALE, "%f\t%d\t\"%s\"\n",
RunExperiments.getBestRecord(threshRecords,
matchRelName, t.getName(), datasetName).second
.getMicroF1(), (int) BenchmarkCache
.getAvgSa2WTimingsForDataset(t.getName(),
datasetName), t.getName()));
runTimeF1Stream.close();
}
/**
* Print a latex tables reporting the best micro-F1 achieved by each
* (annotator, dataset) pair. A Latex table is printed for the metrics based
* on each match relation passed in {@code matchRels}.
*
* @param matchRels
* the set of Match relations for which a table will be printed.
* @param a2wAnnotators
* The set of A2W Annotators for which the best result will be
* included in the output.
* @param d2wAnnotators
* The set of D2W Annotators for which the best result will be
* included in the output.
* @param sa2wAnnotators
* The set of Sa2W Annotators for which the best result will be
* included.
* @param sc2wAnnotators
* The set of Sc2W Annotators for which the best result will be
* included.
* @param c2wAnnotators
* The set of C2W Annotators for which the best result will be
* included in the output.
* @param dss
* The datasets for which the best result will be included.
* @param includeTpFpFn
* true if the output table has to include the total number of
* tp/fp/fn
* @param threshRecords
* the hashmap in the form metric -> annotator -> dataset ->
* (threshold, results) where the results are stored.
* @param includeMicro
* whether or not to include micro-measures in the table
* @param includeMacro
* whether or not to include macro-measures in the table
* @param includeTpFpFn
* whether or not to include TP, FP and FN count in the table
* @param <T>
* the type of data on which the match relation operates.
* @param <D>
* the type of dataset.
*/
public static <T extends Tag, D extends TopicDataset> void latexCorrectnessPerformance(
Vector<MatchRelation<T>> matchRels,
Vector<A2WSystem> a2wAnnotators,
Vector<D2WSystem> d2wAnnotators,
Vector<Sa2WSystem> sa2wAnnotators,
Vector<Sc2WSystem> sc2wAnnotators,
Vector<C2WSystem> c2wAnnotators,
Vector<D> dss,
boolean includeTpFpFn,
boolean includeMicro,
boolean includeMacro,
HashMap<String, HashMap<String, HashMap<String, HashMap<Float, MetricsResultSet>>>> threshRecords) {
System.out.println("Correctness performance - latex output");
Vector<TopicSystem> allAnns = new Vector<TopicSystem>();
if (sa2wAnnotators != null)
allAnns.addAll(sa2wAnnotators);
if (sc2wAnnotators != null)
allAnns.addAll(sc2wAnnotators);
if (a2wAnnotators != null)
allAnns.addAll(a2wAnnotators);
if (d2wAnnotators != null)
allAnns.addAll(d2wAnnotators);
if (c2wAnnotators != null)
allAnns.addAll(c2wAnnotators);
for (MatchRelation<T> m : matchRels) {
System.out.println("+++ Match Relation: " + m.getName());
System.out
.printf(LOCALE,
"\\hline \n Dataset & Annotator & Best Threshold"
+ (includeMicro ? " & $F1_{micro}$ & $P_{micro}$ & $R_{micro}$ "
: "")
+ (includeMacro ? " & $F1_{macro}$ & $P_{macro}$ & $R_{macro}$ "
: "")
+ (includeTpFpFn ? "& tp & fp & fn" : "")
+ "\\\\ \n \\hline%n");
for (TopicDataset d : dss) {
long len = 0;
for (String s : d.getTextInstanceList())
len += s.length();
System.out
.printf(LOCALE,
"\\multirow{%d}{*}{\\parbox{.20\\textwidth}{%s \\newline(avg-len\\newline %d chars)}} %n",
allAnns.size(), d.getName(),
(int) ((float) len / (float) d.getSize()));
for (TopicSystem t : allAnns) {
Pair<Float, MetricsResultSet> values = RunExperiments
.getBestRecord(threshRecords, m.getName(),
t.getName(), d.getName());
System.out.printf(LOCALE, "& %s & $%.3f$ ", t.getName(),
values.first);
if (includeMicro)
System.out.printf(LOCALE,
"& $%.1f$ & $%.1f$ & $%.1f$ ",
values.second.getMicroF1() * 100f,
values.second.getMicroPrecision() * 100f,
values.second.getMicroRecall() * 100f);
if (includeMacro)
System.out.printf(LOCALE,
"& $%.1f$ & $%.1f$ & $%.1f$ ",
values.second.getMacroF1() * 100f,
values.second.getMacroPrecision() * 100f,
values.second.getMacroRecall() * 100f);
if (includeTpFpFn)
System.out.printf(LOCALE, "& $%d$ & $%d$ & $%d$",
values.second.getGlobalTp(),
values.second.getGlobalFp(),
values.second.getGlobalFn());
int nColumns = 3 + (includeTpFpFn?3:0)+(includeMacro?3:0)+(includeMicro?3:0);
System.out.printf(LOCALE, " \\\\ \\cline{2-"
+ nColumns + "}%n");
}
System.out.printf(LOCALE, "\\hline%n");
}
}
}
/**
* Print a set of latex tables reporting the similarity between annotators
* in solving the Sa2W problem, for each dataset given in {@code dssA2W}. A
* table will be printed for each of these focuses:<br>
* 1- similarity of the whole output ("wholeOutput")<br>
* 2- similarity of the output, restricted to the true positives ("TPonly")<br>
* 3- similarity of the mentions ("mention")<br>
* 4- similarity of the concepts ("concept")
*
* @param dssA2W
* the datasets for which the set of tables will be printed.
* @param sa2wAnnotators
* the Sa2W annotators whose similarity will be printed.
* @param threshRecords
* the hashmap in the form metric -> annotator -> dataset ->
* (threshold, results) where the results are stored.
* @param api
* the API to Wikipedia (needed to print information about
* annotations/tags).
* @param <D>
* the type of dataset.
* @throws Exception
* if anything went wrong while retrieving the results.
*/
public static <D extends A2WDataset> void latexSimilarityA2W(
Vector<D> dssA2W,
Vector<Sa2WSystem> sa2wAnnotators,
HashMap<String, HashMap<String, HashMap<String, HashMap<Float, MetricsResultSet>>>> threshRecords,
WikipediaInterface api) throws Exception {
/** Difference between systems & "Jaccard" measure */
for (String focus : new String[] { "wholeOutput", "TPonly", "mention",
"concept", "mention/concept" }) {
System.out.println("Similarity measures - latex output - " + focus);
for (A2WDataset ds : dssA2W) {
System.out.println("Dataset: " + ds.getName());
for (Sa2WSystem t : sa2wAnnotators)
System.out.printf(LOCALE, "&%s", t.getName());
System.out.printf(LOCALE, "\\\\%n");
System.out.printf(LOCALE, "\\hline%n");
for (int i = 0; i < sa2wAnnotators.size(); i++) {
Sa2WSystem t1 = sa2wAnnotators.get(i);
System.out.printf(LOCALE, t1.getName());
for (int j = 0; j < sa2wAnnotators.size(); j++) {
if (j < i) {
System.out.printf(LOCALE, "&");
continue;
}
Sa2WSystem t2 = sa2wAnnotators.get(j);
List<HashSet<ScoredAnnotation>> t1Annotations = BenchmarkCache
.doSa2WAnnotations(t1, ds, null, 0);
List<HashSet<ScoredAnnotation>> t2Annotations = BenchmarkCache
.doSa2WAnnotations(t2, ds, null, 0);
List<HashSet<Annotation>> out1 = null;
List<HashSet<Annotation>> out2 = null;
MatchRelation<Annotation> m = null;
Metrics<Annotation> metrics = new Metrics<Annotation>();
if (focus.equals("wholeOutput")) {
m = new WeakAnnotationMatch(api);
out1 = ProblemReduction.Sa2WToA2WList(
t1Annotations, RunExperiments
.getBestRecord(threshRecords,
m.getName(), t1.getName(),
ds.getName()).first);
out2 = ProblemReduction.Sa2WToA2WList(
t2Annotations, RunExperiments
.getBestRecord(threshRecords,
m.getName(), t2.getName(),
ds.getName()).first);
System.out
.printf(LOCALE, "&$%.1f$",
metrics.macroSimilarity(out1, out2,
m) * 100);
} else if (focus.equals("TPonly")) {
m = new WeakAnnotationMatch(api);
List<HashSet<Annotation>> reducedT1Tags = ProblemReduction
.Sa2WToA2WList(
t1Annotations,
RunExperiments.getBestRecord(
threshRecords, m.getName(),
t1.getName(), ds.getName()).first);
List<HashSet<Annotation>> reducedT2Tags = ProblemReduction
.Sa2WToA2WList(
t2Annotations,
RunExperiments.getBestRecord(
threshRecords, m.getName(),
t2.getName(), ds.getName()).first);
out1 = metrics.getTp(ds.getA2WGoldStandardList(),
reducedT1Tags, m);
out2 = metrics.getTp(ds.getA2WGoldStandardList(),
reducedT2Tags, m);
System.out
.printf(LOCALE, "&$%.1f$",
metrics.macroSimilarity(out1, out2,
m) * 100);
} else if (focus.equals("mention")) {
m = new MentionAnnotationMatch();
List<HashSet<Annotation>> reducedT1Tags = ProblemReduction
.Sa2WToA2WList(
t1Annotations,
RunExperiments.getBestRecord(
threshRecords, m.getName(),
t1.getName(), ds.getName()).first);
List<HashSet<Annotation>> reducedT2Tags = ProblemReduction
.Sa2WToA2WList(
t2Annotations,
RunExperiments.getBestRecord(
threshRecords, m.getName(),
t2.getName(), ds.getName()).first);
out1 = metrics.getTp(ds.getA2WGoldStandardList(),
reducedT1Tags, m);
out2 = metrics.getTp(ds.getA2WGoldStandardList(),
reducedT2Tags, m);
System.out
.printf(LOCALE, "&$%.1f$",
metrics.macroSimilarity(out1, out2,
m) * 100);
} else if (focus.equals("concept")) {
m = new ConceptAnnotationMatch(api);
List<HashSet<Annotation>> reducedT1Tags = ProblemReduction
.Sa2WToA2WList(
t1Annotations,
RunExperiments.getBestRecord(
threshRecords, m.getName(),
t1.getName(), ds.getName()).first);
List<HashSet<Annotation>> reducedT2Tags = ProblemReduction
.Sa2WToA2WList(
t2Annotations,
RunExperiments.getBestRecord(
threshRecords, m.getName(),
t2.getName(), ds.getName()).first);
out1 = metrics.getTp(ds.getA2WGoldStandardList(),
reducedT1Tags, m);
out2 = metrics.getTp(ds.getA2WGoldStandardList(),
reducedT2Tags, m);
System.out
.printf(LOCALE, "&$%.1f$",
metrics.macroSimilarity(out1, out2,
m) * 100);
} else if (focus.equals("mention/concept")) {
m = new MentionAnnotationMatch();
List<HashSet<Annotation>> reducedT1Tags = ProblemReduction
.Sa2WToA2WList(
t1Annotations,
RunExperiments.getBestRecord(
threshRecords, m.getName(),
t1.getName(), ds.getName()).first);
List<HashSet<Annotation>> reducedT2Tags = ProblemReduction
.Sa2WToA2WList(
t2Annotations,
RunExperiments.getBestRecord(
threshRecords, m.getName(),
t2.getName(), ds.getName()).first);
out1 = metrics.getTp(ds.getA2WGoldStandardList(),
reducedT1Tags, m);
out2 = metrics.getTp(ds.getA2WGoldStandardList(),
reducedT2Tags, m);
m = new ConceptAnnotationMatch(api);
System.out
.printf(LOCALE, "&$%.0f$/",
metrics.macroSimilarity(out1, out2,
m) * 100);
reducedT1Tags = ProblemReduction.Sa2WToA2WList(
t1Annotations, RunExperiments
.getBestRecord(threshRecords,
m.getName(), t1.getName(),
ds.getName()).first);
reducedT2Tags = ProblemReduction.Sa2WToA2WList(
t2Annotations, RunExperiments
.getBestRecord(threshRecords,
m.getName(), t2.getName(),
ds.getName()).first);
out1 = metrics.getTp(ds.getA2WGoldStandardList(),
reducedT1Tags, m);
out2 = metrics.getTp(ds.getA2WGoldStandardList(),
reducedT2Tags, m);
System.out
.printf(LOCALE, "$%.0f$",
metrics.macroSimilarity(out1, out2,
m) * 100);
}
}
System.out.printf(LOCALE, "\\\\%n");
System.out.printf(LOCALE, "\\hline%n");
}
}
}
}
/**
* Print a set of latex tables reporting the similarity between annotators
* in solving the C2W problem, for each dataset given in {@code dssC2W}.<br>
*
* @param dssC2W
* the datasets for which the set of tables will be printed.
* @param sa2wAnnotators
* the Sa2W annotators whose similarity will be printed.
* @param threshRecords
* the hashmap in the form metric -> annotator -> dataset ->
* (threshold, results) where the results are stored.
* @param api
* the API to Wikipedia (needed to print information about
* annotations/tags).
* @throws Exception
* if anything went wrong while retrieving the results.
*/
public static void latexSimilarityC2W(
Vector<C2WDataset> dssC2W,
Vector<Sa2WSystem> sa2wAnnotators,
HashMap<String, HashMap<String, HashMap<String, HashMap<Float, MetricsResultSet>>>> threshRecords,
WikipediaInterface api) throws Exception {
System.out.println("Similarity measures - latex output - tp C2W");
for (C2WDataset ds : dssC2W) {
System.out.println("Dataset: " + ds.getName());
for (Sa2WSystem t : sa2wAnnotators)
System.out.printf(LOCALE, "&" + t.getName());
System.out.printf(LOCALE, "\\\\%n");
System.out.printf(LOCALE, "\\hline%n");
for (int i = 0; i < sa2wAnnotators.size(); i++) {
Sa2WSystem t1 = sa2wAnnotators.get(i);
System.out.printf(LOCALE, t1.getName());
for (int j = 0; j < sa2wAnnotators.size(); j++) {
if (j < i) {
System.out.printf(LOCALE, "&");
continue;
}
Sa2WSystem t2 = sa2wAnnotators.get(j);
MatchRelation<Tag> m = new StrongTagMatch(api);
Metrics<Tag> metrics = new Metrics<Tag>();
List<HashSet<ScoredAnnotation>> t1Annotations = BenchmarkCache
.doSa2WAnnotations(t1, ds, null, 0);
List<HashSet<ScoredAnnotation>> t2Annotations = BenchmarkCache
.doSa2WAnnotations(t2, ds, null, 0);
List<HashSet<Annotation>> reducedT1Anns = ProblemReduction
.Sa2WToA2WList(t1Annotations, RunExperiments
.getBestRecord(threshRecords, m.getName(),
t1.getName(), ds.getName()).first);
List<HashSet<Annotation>> reducedT2Anns = ProblemReduction
.Sa2WToA2WList(t2Annotations, RunExperiments
.getBestRecord(threshRecords, m.getName(),
t2.getName(), ds.getName()).first);
List<HashSet<Tag>> reducedT1Tags = ProblemReduction
.A2WToC2WList(reducedT1Anns);
List<HashSet<Tag>> reducedT2Tags = ProblemReduction
.A2WToC2WList(reducedT2Anns);
List<HashSet<Tag>> tponlyTagsT1 = metrics.getTp(
ds.getC2WGoldStandardList(), reducedT1Tags, m);
List<HashSet<Tag>> tponlyTagsT2 = metrics.getTp(
ds.getC2WGoldStandardList(), reducedT2Tags, m);
System.out.printf(LOCALE, "&$%.3f$", metrics
.macroSimilarity(tponlyTagsT1, tponlyTagsT2, m));
}
System.out.printf(LOCALE, "\\\\%n");
System.out.printf(LOCALE, "\\hline%n");
}
}
}
/**
* Prints (in latex form) a table representing the average time needed by
* all systems to solve the instance of a dataset. Rows are grouped by
* dataset and are in the form (dataset, annotator, avg. time).
*
* @param a2wAnnotators
* The A2W annotators that will be included in the output.
* @param sa2wAnnotators
* The Sa2W annotators that will be included in the output.
* @param sc2wAnnotators
* The Sc2W annotators that will be included in the output.
* @param dss
* The datasets that will be included in the output.
* @param <D>
* the type of dataset.
* @throws Exception
* if the cache does not contain records about the given
* dataset/annotator avg. time.
*/
public static <D extends TopicDataset> void latexTimingPerformance(
Vector<A2WSystem> a2wAnnotators, Vector<Sa2WSystem> sa2wAnnotators,
Vector<Sc2WSystem> sc2wAnnotators, Vector<D> dss) throws Exception {
System.out.println("Timing performance - latex output");
int allAnnsSize = 0;
if (sa2wAnnotators != null)
allAnnsSize += sa2wAnnotators.size();
if (a2wAnnotators != null)
allAnnsSize += a2wAnnotators.size();
if (sc2wAnnotators != null)
allAnnsSize += sc2wAnnotators.size();
System.out.printf(LOCALE,
"\\hline \nDataset & Tagger & Average Time\\\\ \n \\hline%n");
for (TopicDataset d : dss) {
long len = 0;
for (String s : d.getTextInstanceList())
len += s.length();
System.out
.printf(LOCALE,
"\\multirow{%d}{*}{\\parbox{.40\\textwidth}{%s \\newline(len %d)}} %n",
allAnnsSize, d.getName(),
(int) ((float) len / (float) d.getSize()));
if (a2wAnnotators != null)
for (A2WSystem t : a2wAnnotators)
System.out.printf(
LOCALE,
"& %s & $%d$ms \\\\ \\cline{2-3}%n",
t.getName(),
(int) BenchmarkCache.getAvgA2WTimingsForDataset(
t.getName(), d.getName()));
if (sa2wAnnotators != null)
for (Sa2WSystem t : sa2wAnnotators)
System.out.printf(
LOCALE,
"& %s & $%d$ms \\\\ \\cline{2-3}%n",
t.getName(),
(int) BenchmarkCache.getAvgSa2WTimingsForDataset(
t.getName(), d.getName()));
System.out.printf(LOCALE, "\\hline%n");
}
}
/**
* Prints (in latex form) a table representing the average time needed by a
* system to solve the instance of a dataset. Rows are in the form
* (annotator, avg. time for system 1, avg. time for system 2, ...).
*
* @param sa2wAnnotators
* The Sa2W annotators that will be included in the output.
* @param sc2wAnnotators
* The Sc2W annotators that will be included in the output.
* @param dss
* The datasets that will be included in the output.
* @param <D>
* the type of dataset.
* @throws Exception
* if the cache does not contain records about the given
* dataset/annotator avg. time.
*/
public static <D extends TopicDataset> void latexTimingPerformance2(
Vector<Sa2WSystem> sa2wAnnotators, Vector<Sc2WSystem> sc2wAnnotators,
Vector<D> dss) throws Exception {
System.out.println("Timing performance - latex output 2");
System.out.printf(LOCALE, "\\hline \nSystem ");
for (TopicDataset ds : dss)
System.out.printf(LOCALE, " & " + ds.getName());
System.out.printf(LOCALE, " \n \\hline%n");
if (sa2wAnnotators != null)
for (Sa2WSystem t : sa2wAnnotators) {
System.out.printf(LOCALE, t.getName());
for (TopicDataset d : dss)
System.out.printf(
LOCALE,
" & $%d$ ",
(int) BenchmarkCache.getAvgSa2WTimingsForDataset(
t.getName(), d.getName()));
System.out.printf(LOCALE, "\\\\%n");
System.out.printf(LOCALE, "\\hline%n");
}
if (sc2wAnnotators != null)
for (Sc2WSystem t : sc2wAnnotators) {
System.out.printf(LOCALE, t.getName());
for (TopicDataset d : dss)
System.out.printf(
LOCALE,
" & $%d$ ",
(int) BenchmarkCache.getAvgSa2WTimingsForDataset(
t.getName(), d.getName()));
System.out.printf(LOCALE, "\\\\%n");
System.out.printf(LOCALE, "\\hline%n");
}
}
public static <T extends Tag, D extends TopicDataset> void printCorrectnessPerformance(
Vector<MatchRelation<T>> matchRels,
Vector<A2WSystem> a2wAnnotators,
Vector<Sa2WSystem> sa2wAnnotators,
Vector<Sc2WSystem> c2wAnnotators,
Vector<D2WSystem> d2wAnnotators,
Vector<D> dss,
HashMap<String, HashMap<String, HashMap<String, HashMap<Float, MetricsResultSet>>>> threshRecords,
boolean printMicro, boolean printMacro, boolean printTpFpFn,
float threshold) {
Vector<TopicSystem> allAnns = new Vector<TopicSystem>();
if (sa2wAnnotators != null)
allAnns.addAll(sa2wAnnotators);
if (c2wAnnotators != null)
allAnns.addAll(c2wAnnotators);
if (a2wAnnotators != null)
allAnns.addAll(a2wAnnotators);
if (d2wAnnotators != null)
allAnns.addAll(d2wAnnotators);
System.out.println("Correctness performance [F1/prec/rec]");
for (MatchRelation<T> metric : matchRels) {
System.out.printf(LOCALE, "Best results (metrics: %s):%n",
metric.getName());
for (TopicDataset d : dss)
for (TopicSystem t : allAnns) {
Pair<Float, MetricsResultSet> result = null;
if (threshold >= 0)
result = new Pair<Float, MetricsResultSet>(threshold,
RunExperiments.getRecords(threshRecords,
metric.getName(), t.getName(),
d.getName()).get(threshold));
else
result = RunExperiments.getBestRecord(threshRecords,
metric.getName(), t.getName(), d.getName());
System.out.printf(LOCALE, "%s\t%s\t%.3f\t", d.getName(),
t.getName(), result.first);
if (printMicro)
System.out.printf(LOCALE, "[mic: %.3f\t%.3f\t%.3f] ",
result.second.getMicroF1(),
result.second.getMicroPrecision(),
result.second.getMicroRecall());
if (printMacro)
System.out.printf(LOCALE, "[mac: %.3f\t%.3f\t%.3f] ",
result.second.getMacroF1(),
result.second.getMacroPrecision(),
result.second.getMacroRecall());
if (printTpFpFn)
System.out.printf(LOCALE, "TP/FP/FN: %d/%d/%d",
result.second.getGlobalTp(),
result.second.getGlobalFp(),
result.second.getGlobalFn());
System.out.println();
}
}
}
/**
* Print the best micro- and macro- measures achieved by each (annotator,
* dataset) pair along with other data. Data is printed for the metrics
* based on each match relation passed in {@code matchRels}.
*
* @param matchRels
* the set of Match relations for which a table will be printed.
* @param a2wAnnotators
* The set of A2W Annotators for which the best result will be
* included in the output.
* @param d2wAnnotators
* The set of D2W Annotators for which the best result will be
* included in the output.
* @param sa2wAnnotators
* The set of Sa2W Annotators for which the best result will be
* included.
* @param c2wAnnotators
* The set of Sc2W Annotators for which the best result will be
* included.
* @param dss
* The datasets for which the best result will be included.
* @param threshRecords
* the hashmap in the form metric -> annotator -> dataset ->
* (threshold, results) where the results are stored.
* @param <T>
* the type of data on which the match relation operates.
* @param <D>
* the type of dataset.
*/
public static <T extends Tag, D extends TopicDataset> void printCorrectnessPerformance(
Vector<MatchRelation<T>> matchRels,
Vector<A2WSystem> a2wAnnotators,
Vector<Sa2WSystem> sa2wAnnotators,
Vector<Sc2WSystem> c2wAnnotators,
Vector<D2WSystem> d2wAnnotators,
Vector<D> dss,
HashMap<String, HashMap<String, HashMap<String, HashMap<Float, MetricsResultSet>>>> threshRecords) {
printCorrectnessPerformance(matchRels, a2wAnnotators, sa2wAnnotators,
c2wAnnotators, d2wAnnotators, dss, threshRecords, true, true,
false, -1);
}
/**
* Prints the similarity, dissimilarity, and union of the results for each
* pair of annotators.
*
* @param dssA2W
* The datasets for which the data will be printed.
* @param sa2wAnnotators
* The annotators for which the data will be printed.
* @param api
* the API to Wikipedia (needed to print information about
* annotations/tags).
* @param threshRecords
* the hashmap in the form metric -> annotator -> dataset ->
* (threshold, results) where the results are stored.
* @throws Exception
* if something went wrong while retrieving the results.
*/
public static void printDissimilarityA2W(
Vector<A2WDataset> dssA2W,
Vector<Sa2WSystem> sa2wAnnotators,
HashMap<String, HashMap<String, HashMap<String, HashMap<Float, MetricsResultSet>>>> threshRecords,
WikipediaInterface api) throws Exception {
Metrics<Annotation> metrics = new Metrics<Annotation>();
WeakAnnotationMatch m = new WeakAnnotationMatch(api);
for (A2WDataset ds : dssA2W) {
System.out.println("Dataset: " + ds.getName());
for (int i = 0; i < sa2wAnnotators.size(); i++) {
Sa2WSystem t1 = sa2wAnnotators.get(i);
for (int j = 0; j < sa2wAnnotators.size(); j++) {
if (j <= i)
continue;
Sa2WSystem t2 = sa2wAnnotators.get(j);
System.out.println("Annotator1: " + t1.getName());
System.out.println("Annotator2: " + t2.getName());
List<HashSet<ScoredAnnotation>> t1Annotations = BenchmarkCache
.doSa2WAnnotations(t1, ds, null, 0);
List<HashSet<ScoredAnnotation>> t2Annotations = BenchmarkCache
.doSa2WAnnotations(t2, ds, null, 0);
List<HashSet<Annotation>> reducedT1Tags = ProblemReduction
.Sa2WToA2WList(t1Annotations, RunExperiments
.getBestRecord(threshRecords, m.getName(),
t1.getName(), ds.getName()).first);
List<HashSet<Annotation>> reducedT2Tags = ProblemReduction
.Sa2WToA2WList(t2Annotations, RunExperiments
.getBestRecord(threshRecords, m.getName(),
t2.getName(), ds.getName()).first);
List<HashSet<Annotation>> out1Tp = metrics.getTp(
ds.getA2WGoldStandardList(), reducedT1Tags, m);
List<HashSet<Annotation>> out2Tp = metrics.getTp(
ds.getA2WGoldStandardList(), reducedT2Tags, m);
List<HashSet<Annotation>> out1Fp = metrics.getFp(
ds.getA2WGoldStandardList(), reducedT1Tags, m);
List<HashSet<Annotation>> out2Fp = metrics.getFp(
ds.getA2WGoldStandardList(), reducedT2Tags, m);
long tpUnion = metrics.listUnion(out1Tp, out2Tp, m);
int tpdiss1 = metrics.dissimilarityListCount(out1Tp,
out2Tp, m);
int tpdiss2 = metrics.dissimilarityListCount(out2Tp,
out1Tp, m);
int tpsim = metrics.similarityListCount(out1Tp, out2Tp, m);
long fpUnion = metrics.listUnion(out1Fp, out2Fp, m);
int fpdiss1 = metrics.dissimilarityListCount(out1Fp,
out2Fp, m);
int fpdiss2 = metrics.dissimilarityListCount(out2Fp,
out1Fp, m);
int fpsim = metrics.similarityListCount(out1Fp, out2Fp, m);
System.out.printf(LOCALE,
"Ann1 dissimilarity tp/fp: %d(%.2f)/%d(%.2f)%n",
tpdiss1, (float) tpdiss1
/ (float) (tpdiss1 + fpdiss1), fpdiss1,
(float) fpdiss1 / (float) (tpdiss1 + fpdiss1));
System.out.printf(LOCALE,
"Ann2 dissimilarity tp/fp: %d(%.2f)/%d(%.2f)%n",
tpdiss2, (float) tpdiss2
/ (float) (tpdiss2 + fpdiss2), fpdiss2,
(float) fpdiss2 / (float) (tpdiss2 + fpdiss2));
System.out.printf(LOCALE,
"Anns similarity tp/fp: %d(%.2f)/%d(%.2f)%n",
tpsim, (float) tpsim / (float) (tpsim + fpsim),
fpsim, (float) fpsim / (float) (tpsim + fpsim));
System.out.printf(LOCALE,
"Anns union tp/fp: %d(%.2f)/%d(%.2f)%n", tpUnion,
(float) tpUnion / (float) (tpUnion + fpUnion),
fpUnion, (float) fpUnion
/ (float) (tpUnion + fpUnion));
}
}
}
}
/**
* Prints the document in a dataset with the most redirect documents for
* each (dataset, annotator) pair. (Mainly for debug purposes.)
*
* @param dss
* The datasets.
* @param sa2wAnnotators
* The annotators.
* @param api
* the API to Wikipedia (needed to find out if an
* annotations/tags is a redirect).
* @throws Exception
* if something went wrong while retrieving the results.
*/
public static void printMostRedirectDocument(Vector<A2WDataset> dss,
Vector<Sa2WSystem> sa2wAnnotators, WikipediaInterface api)
throws Exception {
System.out.println("Returned Redirect");
for (A2WDataset ds : dss) {
for (Sa2WSystem t : sa2wAnnotators) {
int totalTags = 0;
int totalRedirects = 0;
System.out
.printf(LOCALE,
"Finding document with most redirect tags for dataset:%s tagger:%s%n",
ds.getName(), t.getName());
List<HashSet<ScoredAnnotation>> compRes = BenchmarkCache
.doSa2WAnnotations(t, ds, null, 0);
int bestCount = -1;
for (int i = 0; i < compRes.size(); i++) {
HashSet<ScoredAnnotation> comp = compRes.get(i);
int count = 0;
HashSet<Integer> distinctRedirects = new HashSet<Integer>();
for (ScoredAnnotation tag : comp)
if (api.isRedirect(tag.getConcept())) {
count++;
distinctRedirects.add(tag.getConcept());
}
if (bestCount < distinctRedirects.size())
bestCount = distinctRedirects.size();
totalTags += compRes.size();
totalRedirects += count;
}
System.out.printf(LOCALE,
"Tags found=%d Redirects=%d redirect/total=%.3f",
totalTags, totalRedirects, (float) totalRedirects
/ (float) totalTags);
}
}
}
/**
* Print data about correctness performance (f1, precision, recall, ...) for
* a given (annotator, dataset) pair.
*
* @param ann
* the annotator.
* @param m
* the match relation which the measurements are based upon.
* @param goldStandard
* the gold standard for the dataset.
* @param output
* the output found by the tagger.
* @param api
* the API to Wikipedia (needed to print information about
* annotations/tags).
* @param <E>
* the type of system output and dataset.
* @throws IOException
* if something went wrong while querying the Wikipedia API.
*/
public static <E extends Tag> void printCorrectnessPerformance(
TopicSystem ann, MatchRelation<E> m, List<HashSet<E>> goldStandard,
List<HashSet<E>> output, WikipediaInterface api)
throws IOException {
Metrics<E> metrics = new Metrics<E>();
MetricsResultSet rs = metrics.getResult(output, goldStandard, m);
System.out.format(LOCALE,
"%s tp:%d fp:%d fn:%d precision: %.3f recall:%.3f F1:%.3f%n",
ann.getName(), rs.getGlobalTp(), rs.getGlobalFp(),
rs.getGlobalFn(), rs.getMacroPrecision(), rs.getMacroRecall(),
rs.getMacroF1());
System.out.format(LOCALE,
"%s micro-precision:%.3f micro-recall:%.3f micro-F1:%.3f%n",
ann.getName(), rs.getMicroPrecision(), rs.getMicroRecall(),
rs.getMicroF1());
}
/**
* Prints a table representing the average time needed by all systems to
* solve the instance of a dataset. Rows are grouped by dataset and are in
* the form (dataset, annotator, avg. time).
*
* @param a2wAnnotators
* The A2W annotators that will be included in the output.
* @param sa2wAnnotators
* The Sa2W annotators that will be included in the output.
* @param sc2wAnnotators
* The Sa2W annotators that will be included in the output.
* @param dss
* The datasets that will be included in the output.
* @throws Exception
* if the cache does not contain records about the given
* dataset/annotator avg. time.
*/
public static void printTimingPerformance(Vector<A2WSystem> a2wAnnotators,
Vector<Sa2WSystem> sa2wAnnotators,
Vector<Sc2WSystem> sc2wAnnotators, Vector<A2WDataset> dss)