From: itraviv <itraviv@cisco.com>
Date: Mon, 6 Mar 2017 08:06:33 +0000 (+0200)
Subject: added error description to asciidoc
X-Git-Url: https://gerrit.fd.io/r/gitweb?a=commitdiff_plain;h=e0c6303f6a9a8a808c9460dd070d9ff171685082;p=trex.git

added error description to asciidoc

Signed-off-by: itraviv <itraviv@cisco.com>
---

diff --git a/doc/trex_analytics.asciidoc b/doc/trex_analytics.asciidoc
index a5b223ea..85a83b37 100755
--- a/doc/trex_analytics.asciidoc
+++ b/doc/trex_analytics.asciidoc
@@ -38,6 +38,17 @@ How to run these tests? +
 ----
        trex-core/scripts> ./run_regression --stl -t <name of test> --cfg setups/<name of setup>
 ----
+The Error (%) metric: +
+ +
+You will see a column titled 'Error (%)' next to other metrics (avg,std etc) +
+Error(%) is calculated for each batch of test results +
+ +
+Taking the Max value (max) and the Min value (min), calculating the difference max-min +
+We take the difference and then normalize it to the Average value to get (max-min)/Avg +
+Then, we present it as percentage +
+ +
+Error (%) = ((max-min)/Avg)*100 +
+ +
 
 == Setup: XL710 (4x40GbE)  trex-08