Rename section "Deviation" to "Stats" and add more details 35/23935/5
authorYujun Zhang <zhang.yujunz@zte.com.cn>
Thu, 3 Nov 2016 13:45:54 +0000 (21:45 +0800)
committerYujun Zhang <zhang.yujunz@zte.com.cn>
Sat, 5 Nov 2016 11:34:20 +0000 (19:34 +0800)
JIRA: QTIP-129
Change-Id: I7159b4f3f2912b5f15aa8ccc128d59170d2c4b52
Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
docs/designspec/dashboard.rst

index ad5520b..cf98818 100644 (file)
@@ -57,11 +57,32 @@ The condition of a benchmark result includes
 Conditions that do NOT have an obvious affect on the test result may be ignored,
 e.g. temperature, power supply.
 
-Deviation
----------
-
-Performance tests are usually repeated many times to reduce random disturbance.
-This view shall show an overview of deviation among different runs.
+Stats
+-----
+
+Performance tests are actually measurement of specific metrics. All measurement
+comes with uncertainty. The final result is normally one or a group of metrics
+calculated from many repeats.
+
+For each metric, the stats board shall consist of a diagram of all measured
+values and a box of stats::
+
+  ^                                                  +------------+
+  |                                                  |  count: ?  |
+  |                                                  |average: ?  |
+  |                                                  |    min: ?  |
+  |                   X                              |    max: ?  |
+  | XXXX          XXXX X              XXXXX          |            |
+  |X    XX      XX      XX XXX     XXX     XX        |            |
+  |       XXXXXX          X   XXXXX          XX      |            |
+  |                                                  |            |
+  |                                                  |            |
+  |                                                  |            |
+  |                                                  |            |
+  |                                                  |            |
+  +--------------------------------------------->    +------------+
+
+The type of diagram and selection of stats shall depend on what metric to show.
 
 Comparison
 ----------