summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorYujun Zhang <zhang.yujunz@zte.com.cn>2016-11-03 21:45:54 +0800
committerYujun Zhang <zhang.yujunz@zte.com.cn>2016-11-05 19:34:20 +0800
commit50f910c58b269a8d4695f32eb769952503278b2b (patch)
treeab9e228fb436dc3517bb5608ee118a81b968f6bf /docs
parent1ebddd16525c9f82540b8cbfb76685acf1d1b218 (diff)
Rename section "Deviation" to "Stats" and add more details
JIRA: QTIP-129 Change-Id: I7159b4f3f2912b5f15aa8ccc128d59170d2c4b52 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
Diffstat (limited to 'docs')
-rw-r--r--docs/designspec/dashboard.rst31
1 files changed, 26 insertions, 5 deletions
diff --git a/docs/designspec/dashboard.rst b/docs/designspec/dashboard.rst
index ad5520b6..cf988184 100644
--- a/docs/designspec/dashboard.rst
+++ b/docs/designspec/dashboard.rst
@@ -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
----------