Report: Add DPDK speedup graphs
[csit.git] / docs / report / dpdk_performance_tests / throughput_speedup_multi_core / index.rst
diff --git a/docs/report/dpdk_performance_tests/throughput_speedup_multi_core/index.rst b/docs/report/dpdk_performance_tests/throughput_speedup_multi_core/index.rst
new file mode 100644 (file)
index 0000000..626d675
--- /dev/null
@@ -0,0 +1,63 @@
+
+.. raw:: latex
+
+    \clearpage
+
+.. _dpdk_throughput_speedup_multi_core:
+
+Speedup Multi-Core
+==================
+
+Speedup Multi-Core throughput graphs are generated by multiple
+executions of the same performance tests across physical testbeds hosted
+LF FD.io labs: 2n-skx, 3n-skx, 2n-clx, 3n-tsh, 2n-tx2, 2n-zn2.
+Grouped bars illustrate the 64B packet throughput speedup ratio for
+2- and 4-core multi-threaded DPDK configurations relative to 1-core
+configurations.
+
+Additional information about graph data:
+
+#. **Graph Title**: describes tested packet path, testbed topology,
+   processor model, NIC model, packet size used by data plane workers and
+   indication of VPP DUT configuration.
+
+#. **X-axis Labels**: number of cores.
+
+#. **Y-axis Labels**: measured Packets Per Second [pps] throughput
+   values.
+
+#. **Graph Legend**: lists CSIT test suites executed to generate graphed test
+   results.
+
+#. **Hover Information**: lists number of runs executed, specific test
+   substring, mean value of the measured packet throughput, calculated perfect
+   throughput value, difference between measured and perfect values and
+   relative speedup value.
+
+.. note::
+
+    Test results are stored in
+    `build logs from FD.io dpdk performance job 2n-skx`_,
+    `build logs from FD.io dpdk performance job 3n-skx`_,
+    `build logs from FD.io dpdk performance job 2n-clx`_,
+    `build logs from FD.io dpdk performance job 2n-zn2`_,
+    `build logs from FD.io dpdk performance job 3n-tsh`_,
+    `build logs from FD.io dpdk performance job 2n-tx2`_ with RF
+    result files csit-vpp-perf-|srelease|-\*.zip
+    `archived here <../../_static/archive/>`_.
+    Required per test case data set size is **10**, but for VPP tests
+    the actual size varies per test case and is <=10.
+
+.. toctree::
+    :maxdepth: 3
+
+    2n-skx-xxv710
+    2n-skx-x710
+    3n-skx-xxv710
+    3n-skx-x710
+    2n-clx-xxv710
+    2n-clx-x710
+    2n-zn2-xxv710
+    2n-zn2-x710
+    3n-tsh-x520
+    2n-tx2-xl710