Report: Add DPDK speedup graphs
[csit.git] / docs / report / dpdk_performance_tests / packet_throughput_graphs / index.rst
1
2 .. raw:: latex
3
4     \clearpage
5
6 Packet Throughput
7 =================
8
9 Throughput graphs are generated by multiple executions of the same
10 performance tests across physical testbeds hosted LF FD.io labs:
11 2n-skx, 3n-skx, 2n-clx, 2n-tx2, 2n-zn2, 3n-tsh.
12 Box-and-Whisker plots are used to display variations in
13 measured throughput values, without making any assumptions of the
14 underlying statistical distribution.
15
16 For each test case, Box-and-Whisker plots show the quartiles (Min, 1st
17 quartile / 25th percentile, 2nd quartile / 50th percentile / mean, 3rd
18 quartile / 75th percentile, Max) across collected data set. Outliers are
19 plotted as individual points.
20
21 Additional information about graph data:
22
23 #. **Graph Title**: describes tested packet path, testbed topology,
24    processor model, NIC model, packet size, number of cores and
25    threads used by data plane workers and indication of DPDK DUT
26    configuration.
27
28 #. **X-axis Labels**: indices of individual test suites as listed in
29    Graph Legend.
30
31 #. **Y-axis Labels**: measured Packets Per Second [pps] throughput
32    values.
33
34 #. **Graph Legend**: lists X-axis indices with associated CSIT test
35    suites executed to generate graphed test results.
36
37 #. **Hover Information**: lists minimum, first quartile, median,
38    third quartile, and maximum. If either type of outlier is present the
39    whisker on the appropriate side is taken to 1.5×IQR from the quartile
40    (the "inner fence") rather than the max or min, and individual outlying
41    data points are displayed as unfilled circles (for suspected outliers)
42    or filled circles (for outliers). (The "outer fence" is 3×IQR from the
43    quartile.)
44
45 .. note::
46
47     Test results are stored in
48     `build logs from FD.io dpdk performance job 2n-skx`_,
49     `build logs from FD.io dpdk performance job 3n-skx`_,
50     `build logs from FD.io dpdk performance job 2n-clx`_,
51     `build logs from FD.io dpdk performance job 2n-zn2`_,
52     `build logs from FD.io dpdk performance job 3n-tsh`_,
53     `build logs from FD.io dpdk performance job 2n-tx2`_ with RF
54     result files csit-dpdk-perf-|srelease|-\*.zip
55     `archived here <../../_static/archive/>`_.
56     Required per test case data set size is **10** and for DPDK tests
57     this is the actual size, as all scheduled test executions completed
58     successfully.
59
60 .. toctree::
61     :maxdepth: 3
62
63     2n-skx-xxv710
64     2n-skx-x710
65     3n-skx-xxv710
66     3n-skx-x710
67     2n-clx-xxv710
68     2n-clx-x710
69     2n-zn2-xxv710
70     2n-zn2-x710
71     3n-tsh-x520
72     2n-tx2-xl710
73
74 ..
75     2n-dnv-x553
76     3n-dnv-x553