feat: allow basic CSV output for report summary

Author: jharlow-intel

README.md

@@ -178,3 +178,15 @@ SPDX-License-Identifier: Apache-2.0
     --skip-expected-failures, --no-skip-expected-failures
                             Either to save execution into database. (default: True)
     ```
+
+    ```
+    usage: dpbench report [--comparisons [COMPARISON_PAIRS]] [--csv]
+
+    Subcommand to generate a summary report from the local DB
+
+    options:
+    -c, --comparisons [COMPARISON_PAIRS]
+                            Comma separated list of implementation pairs to be compared
+    --csv
+                            Sets the general summary report to output in CSV format (default: False)
+    ```

dpbench/console/report.py

@@ -28,6 +28,13 @@ def add_report_arguments(parser: argparse.ArgumentParser):
         + " compared.",
     )
 
+    parser.add_argument(
+        "--csv",
+        action="store_true",
+        default=False,
+        help="Sets the summary reports to output in CSV format",
+    )
+
 
 def execute_report(args: Namespace, conn: sqlalchemy.Engine):
     """Execute report sub command.
@@ -63,4 +70,5 @@ def execute_report(args: Namespace, conn: sqlalchemy.Engine):
         conn=conn,
         run_id=args.run_id,
         comparison_pairs=comparison_pairs,
+        csv=args.csv,
     )

dpbench/infrastructure/reporter.py

@@ -110,17 +110,22 @@ def generate_legend(conn: sqlalchemy.Engine, run_id: int) -> list[str]:
     return legends["postfix"].values.tolist()
 
 
-def generate_summary(data: pd.DataFrame):
+def generate_summary(data: pd.DataFrame, report_csv: bool):
     """prints summary section"""
     print("Summary of current implementation")
     print("=================================")
-    print(data.to_string())
+
+    if report_csv:
+        print(data.to_csv(index=False))
+    else:
+        print(data.to_string())
 
 
 def generate_impl_summary_report(
     conn: sqlalchemy.Engine,
     run_id: int,
     implementations: list[str],
+    report_csv: bool,
 ):
     """generate implementation summary report with status of each benchmark"""
     columns = [
@@ -160,13 +165,14 @@ def generate_impl_summary_report(
         con=conn.connect(),
     )
 
-    generate_summary(df)
+    generate_summary(df, report_csv)
 
 
 def generate_performance_report(
     conn: sqlalchemy.Engine,
     run_id: int,
     implementations: list[str],
+    report_csv: bool,
 ):
     """generate performance report with median times for each benchmark"""
     columns = [
@@ -223,14 +229,15 @@ def generate_performance_report(
 
             df.at[index, impl] = time
 
-    generate_summary(df)
+    generate_summary(df, report_csv)
 
 
 def generate_comparison_report(
     conn: sqlalchemy.Engine,
     run_id: int,
     implementations: list[str],
     comparison_pairs: list[tuple[str, str]],
+    report_csv: bool,
 ):
     """generate comparison report with median times for each benchmark"""
     if len(comparison_pairs) == 0:
@@ -284,7 +291,7 @@ def generate_comparison_report(
     for impl in implementations:
         df = df.drop(impl, axis=1)
 
-    generate_summary(df)
+    generate_summary(df, report_csv)
 
 
 def get_failures_from_results(
@@ -333,26 +340,32 @@ def get_unexpected_failures(
 def print_report(
     conn: sqlalchemy.Engine,
     run_id: int,
+    csv: bool,
     comparison_pairs: list[tuple[str, str]] = [],
 ):
     generate_header(conn, run_id)
     implementations = generate_legend(conn, run_id)
 
     generate_impl_summary_report(
-        conn, run_id=run_id, implementations=implementations
+        conn,
+        run_id=run_id,
+        implementations=implementations,
+        report_csv=csv,
     )
 
     generate_performance_report(
         conn,
         run_id=run_id,
         implementations=implementations,
+        report_csv=csv,
     )
 
     generate_comparison_report(
         conn,
         run_id=run_id,
         implementations=implementations,
         comparison_pairs=comparison_pairs,
+        report_csv=csv,
     )
 
     unexpected_failures = get_unexpected_failures(conn, run_id=run_id)