CSIT-891: Add data sources for 1801 report

[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst

diff --git a/docs/report/vpp_performance_tests/csit_release_notes.rst b/docs/report/vpp_performance_tests/csit_release_notes.rst
index 6e3d631..7419a85 100644 (file)
--- a/docs/report/vpp_performance_tests/csit_release_notes.rst
+++ b/docs/report/vpp_performance_tests/csit_release_notes.rst
@@ -50,28 +50,24 @@ Changes in CSIT |release|
 \r
        - Overall stability improvements;\r
 \r
 \r
        - Overall stability improvements;\r
 \r

-Performance Improvements\r
-------------------------\r
+Performance Changes\r
+-------------------\r

 \r
 \r

-Substantial improvements in measured packet throughput have been observed in a\r
-number of CSIT |release| tests listed below, with relative increase of\r
-double-digit percentage points. Relative improvements for this release are\r
-calculated against the test results listed in CSIT |release-1| report. The\r
+Substantial changes in measured packet throughput have been observed in a\r
+number of CSIT |release| tests listed below. Relative changes for this release\r
+are calculated against the test results listed in CSIT |release-1| report. The\r

 comparison is calculated between the mean values based on collected and\r
 archived test results' samples for involved VPP releases. Standard deviation\r
 comparison is calculated between the mean values based on collected and\r
 archived test results' samples for involved VPP releases. Standard deviation\r

-has been also listed for CSIT |release|. Performance numbers since release\r
-VPP-16.09 are provided for reference.\r
+has been also listed for CSIT |release|.\r

 \r
 \r

-NDR Throughput\r
-~~~~~~~~~~~~~~\r
-\r
-Non-Drop Rate Throughput discovery tests:\r
+NDR Throughput: Best 20 Changes\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r

 \r
 .. only:: html\r
 \r
    .. csv-table::\r
       :align: center\r
 \r
 .. only:: html\r
 \r
    .. csv-table::\r
       :align: center\r

-      :file: performance_improvements/performance_improvements_ndr_top.csv\r
+      :file: performance_improvements/performance-changes-ndr-1t1c-top.csv\r

 \r
 .. only:: latex\r
 \r
 \r
 .. only:: latex\r
 \r


@@ -79,7 +75,7 @@ Non-Drop Rate Throughput discovery tests:
 \r
       \makeatletter\r
       \csvset{\r
 \r
       \makeatletter\r
       \csvset{\r

-        perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{m{4cm} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r
+        perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{m{4cm} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r

       }\r
       \makeatother\r
 \r
       }\r
       \makeatother\r
 \r


@@ -90,20 +86,17 @@ Non-Drop Rate Throughput discovery tests:
         perfimprovements column width=1cm,\r
         late after line={\\\hline},\r
         late after last line={\end{longtable}}\r
         perfimprovements column width=1cm,\r
         late after line={\\\hline},\r
         late after last line={\end{longtable}}\r

-        ]{../_tmp/src/vpp_performance_tests/performance_improvements/performance_improvements_ndr_top.csv}\r
+        ]{../_tmp/src/vpp_performance_tests/performance_improvements/performance-changes-ndr-1t1c-top.csv}\r

       }\r
 \r
       }\r
 \r

-\r
-PDR Throughput\r
-~~~~~~~~~~~~~~\r
-\r
-Partial Drop Rate thoughput discovery tests with packet Loss Tolerance of 0.5%:\r
+NDR Throughput: Worst 20 Changes\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r

 \r
 .. only:: html\r
 \r
    .. csv-table::\r
       :align: center\r
 \r
 .. only:: html\r
 \r
    .. csv-table::\r
       :align: center\r

-      :file: performance_improvements/performance_improvements_pdr_top.csv\r
+      :file: performance_improvements/performance-changes-ndr-1t1c-bottom.csv\r

 \r
 .. only:: latex\r
 \r
 \r
 .. only:: latex\r
 \r


@@ -111,7 +104,7 @@ Partial Drop Rate thoughput discovery tests with packet Loss Tolerance of 0.5%:
 \r
       \makeatletter\r
       \csvset{\r
 \r
       \makeatletter\r
       \csvset{\r

-        perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{m{4cm} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r
+        perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{m{4cm} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r

       }\r
       \makeatother\r
 \r
       }\r
       \makeatother\r
 \r


@@ -122,32 +115,32 @@ Partial Drop Rate thoughput discovery tests with packet Loss Tolerance of 0.5%:
         perfimprovements column width=1cm,\r
         late after line={\\\hline},\r
         late after last line={\end{longtable}}\r
         perfimprovements column width=1cm,\r
         late after line={\\\hline},\r
         late after last line={\end{longtable}}\r

-        ]{../_tmp/src/vpp_performance_tests/performance_improvements/performance_improvements_pdr_top.csv}\r
+        ]{../_tmp/src/vpp_performance_tests/performance_improvements/performance-changes-ndr-1t1c-bottom.csv}\r

       }\r
 \r
       }\r
 \r

+.. only:: html\r

 \r
 \r

-Measured improvements are in line with VPP code optimizations listed in\r
-`VPP-17.10 release notes\r
-<https://docs.fd.io/vpp/17.10/release_notes_1710.html>`_.\r
-\r
-Other Performance Changes\r
--------------------------\r
+      NDR Throughput: All Changes\r
+      ~~~~~~~~~~~~~~~~~~~~~~~~~~~\r

 \r
 \r

-Other changes in measured packet throughput, with either minor relative increase\r
-or decrease, have been observed in a number of CSIT |release| tests listed\r
-below. Relative changes are calculated against the test results listed in CSIT\r
-|release-1| report.\r
+      Complete results for all NDR tests are available in a CSV and pretty\r
+      ASCII formats:\r

 \r
 \r

-NDR Throughput\r
-~~~~~~~~~~~~~~\r
+        - `csv format for 1t1c <performance_improvements/performance-changes-ndr-1t1c-full.csv>`_,\r
+        - `csv format for 2t2c <performance_improvements/performance-changes-ndr-2t2c-full.csv>`_,\r
+        - `csv format for 4t4c <performance_improvements/performance-changes-ndr-4t4c-full.csv>`_,\r
+        - `pretty ASCII format for 1t1c <performance_improvements/performance-changes-ndr-1t1c-full.txt>`_,\r
+        - `pretty ASCII format for 2t2c <performance_improvements/performance-changes-ndr-2t2c-full.txt>`_,\r
+        - `pretty ASCII format for 4t4c <performance_improvements/performance-changes-ndr-4t4c-full.txt>`_.\r

 \r
 \r

-Non-Drop Rate Throughput discovery tests:\r
+PDR Throughput: Best 20 Changes\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r

 \r
 .. only:: html\r
 \r
    .. csv-table::\r
       :align: center\r
 \r
 .. only:: html\r
 \r
    .. csv-table::\r
       :align: center\r

-      :file: performance_improvements/performance_improvements_ndr_low.csv\r
+      :file: performance_improvements/performance-changes-pdr-1t1c-top.csv\r

 \r
 .. only:: latex\r
 \r
 \r
 .. only:: latex\r
 \r


@@ -155,7 +148,7 @@ Non-Drop Rate Throughput discovery tests:
 \r
       \makeatletter\r
       \csvset{\r
 \r
       \makeatletter\r
       \csvset{\r

-        perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{m{4cm} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r
+        perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{m{4cm} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r

       }\r
       \makeatother\r
 \r
       }\r
       \makeatother\r
 \r


@@ -166,20 +159,17 @@ Non-Drop Rate Throughput discovery tests:
         perfimprovements column width=1cm,\r
         late after line={\\\hline},\r
         late after last line={\end{longtable}}\r
         perfimprovements column width=1cm,\r
         late after line={\\\hline},\r
         late after last line={\end{longtable}}\r

-        ]{../_tmp/src/vpp_performance_tests/performance_improvements/performance_improvements_ndr_low.csv}\r
+        ]{../_tmp/src/vpp_performance_tests/performance_improvements/performance-changes-pdr-1t1c-top.csv}\r

       }\r
 \r
       }\r
 \r

-\r
-PDR Throughput\r
-~~~~~~~~~~~~~~\r
-\r
-Partial Drop Rate thoughput discovery tests with packet Loss Tolerance of 0.5%:\r
+PDR Throughput: Worst 20 Changes\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r

 \r
 .. only:: html\r
 \r
    .. csv-table::\r
       :align: center\r
 \r
 .. only:: html\r
 \r
    .. csv-table::\r
       :align: center\r

-      :file: performance_improvements/performance_improvements_pdr_low.csv\r
+      :file: performance_improvements/performance-changes-pdr-1t1c-bottom.csv\r

 \r
 .. only:: latex\r
 \r
 \r
 .. only:: latex\r
 \r


@@ -187,7 +177,7 @@ Partial Drop Rate thoughput discovery tests with packet Loss Tolerance of 0.5%:
 \r
       \makeatletter\r
       \csvset{\r
 \r
       \makeatletter\r
       \csvset{\r

-        perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{m{4cm} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r
+        perfimprovements column width/.style={after head=\csv@pretable\begin{longtable}{m{4cm} m{#1} m{#1} m{#1} m{#1} m{#1}}\csv@tablehead},\r

       }\r
       \makeatother\r
 \r
       }\r
       \makeatother\r
 \r


@@ -198,9 +188,27 @@ Partial Drop Rate thoughput discovery tests with packet Loss Tolerance of 0.5%:
         perfimprovements column width=1cm,\r
         late after line={\\\hline},\r
         late after last line={\end{longtable}}\r
         perfimprovements column width=1cm,\r
         late after line={\\\hline},\r
         late after last line={\end{longtable}}\r

-        ]{../_tmp/src/vpp_performance_tests/performance_improvements/performance_improvements_pdr_low.csv}\r
+        ]{../_tmp/src/vpp_performance_tests/performance_improvements/performance-changes-pdr-1t1c-bottom.csv}\r

       }\r
 \r
       }\r
 \r

+.. only:: html\r
+\r
+      PDR Throughput: All Changes\r
+      ~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+            Complete results for all PDR tests are available in a CSV and pretty\r
+            ASCII formats:\r
+\r
+              - `csv format for 1t1c <performance_improvements/performance-changes-pdr-1t1c-full.csv>`_,\r
+              - `csv format for 2t2c <performance_improvements/performance-changes-pdr-2t2c-full.csv>`_,\r
+              - `csv format for 4t4c <performance_improvements/performance-changes-pdr-4t4c-full.csv>`_,\r
+              - `pretty ASCII format for 1t1c <performance_improvements/performance-changes-pdr-1t1c-full.txt>`_,\r
+              - `pretty ASCII format for 2t2c <performance_improvements/performance-changes-pdr-2t2c-full.txt>`_,\r
+              - `pretty ASCII format for 4t4c <performance_improvements/performance-changes-pdr-4t4c-full.txt>`_.\r
+\r
+Measured improvements are in line with VPP code optimizations listed in\r
+`VPP-17.10 release notes\r
+<https://docs.fd.io/vpp/17.10/release_notes_1710.html>`_.\r

 \r
 Known Issues\r
 ------------\r
 \r
 Known Issues\r
 ------------\r