ready to merge

Author: aseembits93

codeflash/code_utils/edit_generated_tests.py

@@ -5,7 +5,7 @@
 import libcst as cst
 
 from codeflash.cli_cmds.console import logger
-from codeflash.code_utils.time_utils import format_time
+from codeflash.code_utils.time_utils import format_perf, format_time
 from codeflash.models.models import GeneratedTests, GeneratedTestsList, InvocationId
 from codeflash.result.critic import performance_gain
 from codeflash.verification.verification_utils import TestConfig
@@ -131,11 +131,11 @@ def leave_SimpleStatementLine(
                 if matching_original_times and matching_optimized_times:
                     original_time = min(matching_original_times)
                     optimized_time = min(matching_optimized_times)
-                    perf_gain = (
+                    perf_gain = format_perf(
                         performance_gain(original_runtime_ns=original_time, optimized_runtime_ns=optimized_time) * 100
                     )
                     # Create the runtime comment
-                    comment_text = f"# {format_time(original_time)} -> {format_time(optimized_time)} ({perf_gain:.2f}%)"
+                    comment_text = f"# {format_time(original_time)} -> {format_time(optimized_time)} ({perf_gain}%)"
 
                     # Add comment to the trailing whitespace
                     new_trailing_whitespace = cst.TrailingWhitespace(

codeflash/code_utils/time_utils.py

@@ -85,3 +85,15 @@ def format_time(nanoseconds: int) -> str:
 
     # This should never be reached, but included for completeness
     return f"{nanoseconds}ns"
+
+
+def format_perf(percentage: float) -> str:
+    """Format percentage into a human-readable string with 3 significant digits when needed."""
+    percentage_abs = abs(percentage)
+    if percentage_abs >= 100:
+        return f"{percentage:.0f}"
+    if percentage_abs >= 10:
+        return f"{percentage:.1f}"
+    if percentage_abs >= 1:
+        return f"{percentage:.2f}"
+    return f"{percentage:.3f}"

codeflash/result/create_pr.py

@@ -18,7 +18,7 @@
 )
 from codeflash.code_utils.github_utils import github_pr_url
 from codeflash.code_utils.tabulate import tabulate
-from codeflash.code_utils.time_utils import format_time
+from codeflash.code_utils.time_utils import format_perf, format_time
 from codeflash.github.PrComment import FileDiffContent, PrComment
 from codeflash.result.critic import performance_gain
 
@@ -40,7 +40,7 @@ def existing_tests_source_for(
         return ""
     output: str = ""
     rows = []
-    headers = ["Test File::Test Function", "Original ⏱️", "Optimized ⏱️", "Improvement"]
+    headers = ["Test File::Test Function", "Original ⏱️", "Optimized ⏱️", "Speedup"]
     tests_root = test_cfg.tests_root
     module_root = test_cfg.project_root_path
     rel_tests_root = tests_root.relative_to(module_root)
@@ -84,23 +84,17 @@ def existing_tests_source_for(
         ].keys()  # both will have the same keys as some default values are assigned in the previous loop
         for qualified_name in sorted(all_qualified_names):
             # if not present in optimized output nan
-            if optimized_tests_to_runtimes[filename][qualified_name] == 0:
-                print_optimized_runtime = "NaN"
-            else:
-                print_optimized_runtime = format_time(optimized_tests_to_runtimes[filename][qualified_name])
-            if original_tests_to_runtimes[filename][qualified_name] == 0:
-                print_original_runtime = "NaN"
-            else:
-                print_original_runtime = format_time(original_tests_to_runtimes[filename][qualified_name])
             if (
                 original_tests_to_runtimes[filename][qualified_name] != 0
                 and optimized_tests_to_runtimes[filename][qualified_name] != 0
             ):
+                print_optimized_runtime = format_time(optimized_tests_to_runtimes[filename][qualified_name])
+                print_original_runtime = format_time(original_tests_to_runtimes[filename][qualified_name])
                 greater = (
                     optimized_tests_to_runtimes[filename][qualified_name]
                     > original_tests_to_runtimes[filename][qualified_name]
                 )
-                perf_gain = (
+                perf_gain = format_perf(
                     performance_gain(
                         original_runtime_ns=original_tests_to_runtimes[filename][qualified_name],
                         optimized_runtime_ns=optimized_tests_to_runtimes[filename][qualified_name],
@@ -113,7 +107,7 @@ def existing_tests_source_for(
                             f"`{filename}::{qualified_name}`",
                             f"{print_original_runtime}",
                             f"{print_optimized_runtime}",
-                            f"⚠️{perf_gain:.2f}%",
+                            f"⚠️{perf_gain}%",
                         ]
                     )
                 else:
@@ -122,14 +116,9 @@ def existing_tests_source_for(
                             f"`{filename}::{qualified_name}`",
                             f"{print_original_runtime}",
                             f"{print_optimized_runtime}",
-                            f"✅{perf_gain:.2f}%",
+                            f"✅{perf_gain}%",
                         ]
                     )
-            else:
-                # one of them is NaN
-                rows.append(
-                    [f"`{filename}::{qualified_name}`", f"{print_original_runtime}", f"{print_optimized_runtime}", "❌"]
-                )
     output += tabulate(  # type: ignore[no-untyped-call]
         headers=headers, tabular_data=rows, tablefmt="pipe", colglobalalign=None, preserve_whitespace=True
     )