1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 package de.fu_berlin.ties.eval;
23
24 import org.apache.commons.math.stat.descriptive.StatisticalSummary;
25
26
27 /***
28 * Implementations of this interface can show
29 * {@linkplain org.apache.commons.math.stat.descriptive.StatisticalSummary
30 * statistical summaries} of precision, recall, and F1 metrics updated in
31 * several operations.
32 *
33 * @author Christian Siefkes
34 * @version $Revision: 1.5 $, $Date: 2006/10/21 16:04:11 $, $Author: siefkes $
35 */
36 public interface FMetricsSummary {
37
38 /***
39 * Returns a summary view on the F1 values. This is not a snapshot but
40 * will change whenever the underlying values are changed.
41 *
42 * @return a summary view on the F1 value
43 */
44 StatisticalSummary viewF1Summary();
45
46 /***
47 * Returns a summary view on the precision values. This is not a snapshot
48 * but will change whenever the underlying values are changed.
49 *
50 * @return a summary view on the precision value
51 */
52 StatisticalSummary viewPrecisionSummary();
53
54 /***
55 * Returns a summary view on the recall values. This is not a snapshot but
56 * will change whenever the underlying values are changed.
57 *
58 * @return a summary view on the recall value
59 */
60 StatisticalSummary viewRecallSummary();
61
62 }