amend to comments

Author: ianayl

devops/actions/run-tests/benchmark/action.yml

@@ -171,7 +171,7 @@ runs:
         --regression-filter '^[a-z_]+_sycl ' \
         --regression-filter-type 'SYCL' \
         --verbose \
-        --produce-github-summary "github_summary.md" \
+        --produce-github-summary \
         ${{ inputs.dry_run == 'true' && '--dry-run' || '' }} \
 
       echo "-----"

devops/scripts/benchmarks/compare.py

@@ -356,9 +356,8 @@ def to_hist(
     )
     parser_avg.add_argument(
         "--produce-github-summary",
-        type=str,
-        help="Create a github CI summary file using the provided filename",
-        default="",
+        action="store_true",
+        help=f"Create a summary file '{options.github_summary_filename}' for Github workflow summaries.",
     )
 
     args = parser.parse_args()
@@ -377,18 +376,14 @@ def to_hist(
             args.avg_type, args.name, args.compare_file, args.results_dir, args.cutoff
         )
 
-        # Initialize github summary variables:
+        # Initialize Github summary variables:
         if args.produce_github_summary:
             gh_summary = []
 
             filter_type_capitalized = (
                 args.regression_filter_type[0].upper() + args.regression_filter_type[1:]
             )
 
-            def write_summary_to_file(summary: list[str]):
-                with open(args.produce_github_summary, "w") as f:
-                    f.write("\n".join(summary))
-
         # Not all regressions are of concern: if a filter is provided, filter
         # regressions using filter
         regressions_ignored = []
@@ -402,7 +397,7 @@ def write_summary_to_file(summary: list[str]):
                     regressions_ignored.append(test)
 
         def print_regression(entry: dict, is_warning: bool = False):
-            """Print an entry outputted from Compare.to_hist[github_summary.md")
+            """Print an entry outputted from Compare.to_hist()
 
             Args:
                 entry (dict): The entry to print
@@ -421,6 +416,12 @@ def print_regression(entry: dict, is_warning: bool = False):
                 )
                 gh_summary.append(f"- Run result: {entry['value']}")
                 gh_summary.append(
+                    # Since we are dealing with floats, our deltas have a lot
+                    # of decimal places. For easier readability, we round our
+                    # deltas and format our Github summary output as:
+                    #
+                    # Delta: <rounded number>% (<full number>)
+                    #
                     f"- Delta: {round(entry['delta']*100, 2)}% ({entry['delta']})"
                 )
                 gh_summary.append("")
@@ -472,13 +473,15 @@ def print_regression(entry: dict, is_warning: bool = False):
 
             if not args.dry_run:
                 if args.produce_github_summary:
-                    write_summary_to_file(gh_summary)
-                exit(1)  # Exit 1 to trigger github test failure
+                    with open(options.github_summary_filename, "w") as f:
+                        f.write("\n".join(summary))
+                exit(1)  # Exit 1 to trigger Github test failure
 
         log.info("No unexpected regressions found!")
         if args.produce_github_summary:
             gh_summary.append("No unexpected regressions found!")
-            write_summary_to_file(gh_summary)
+            with open(options.github_summary_filename, "w") as f:
+                f.write("\n".join(summary))
 
     else:
         log.error("Unsupported operation: exiting.")

devops/scripts/benchmarks/options.py

@@ -92,6 +92,8 @@ class Options:
     # CI scripts vs SYCl build source.
     github_repo_override: str = None
     git_commit_override: str = None
+    # Filename used to store Github summary files:
+    github_summary_filename: str = "github_summary.md"
     # Archiving settings
     # Archived runs are stored separately from the main dataset but are still accessible
     # via the HTML UI when "Include archived runs" is enabled.