From 57558a3a4ab55d8848fe2d0df884e7f6250cff82 Mon Sep 17 00:00:00 2001 From: Saurabh Misra Date: Fri, 30 May 2025 11:58:40 -0700 Subject: [PATCH 1/2] docs improvement --- docs/docs/codeflash-concepts/how-codeflash-works.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/docs/codeflash-concepts/how-codeflash-works.md b/docs/docs/codeflash-concepts/how-codeflash-works.md index 07942f0b8..e6c1756ca 100644 --- a/docs/docs/codeflash-concepts/how-codeflash-works.md +++ b/docs/docs/codeflash-concepts/how-codeflash-works.md @@ -38,9 +38,7 @@ Codeflash verifies these specific behaviors to be correct - Additionally, Codeflash checks for sufficient line coverage of the optimized code, increasing confidence in the testing process. -Codeflash also evaluates that there is sufficient line coverage of the code under optimization. This provides more confidence with testing. - -We recommend manually reviewing the optimized code, since there might be important input cases that we haven’t verified where the behavior could differ. +We recommend manually reviewing the optimized code since there might be important input cases that we haven’t verified where the behavior could differ. #### Test Generation @@ -55,7 +53,7 @@ Codeflash runs tests for the target function using either pytest or unittest fra #### Performance benchmarking -Codeflash implements several techniques to measure code performance accurately. In particular, it runs multiple iterations of the code in a loop to determine the best performance with the minimum runtime. Codeflash compares performance of the original code against the optimization, requiring at least a 10% speed improvement before considering it faster. This approach eliminates most runtime measurement variability, even on noisy CI systems and virtual machines. The final runtime Codeflash reports is the minimum total time it took to run all the test cases. +Codeflash implements [several techniques](/codeflash-concepts/benchmarking.md) to measure code performance accurately. In particular, it runs multiple iterations of the code in a loop to determine the best performance with the minimum runtime. Codeflash compares the performance of the original code against the optimization, requiring at least a 10% speed improvement before considering it faster. This approach eliminates most runtime measurement variability, even on noisy CI systems and virtual machines. The final runtime Codeflash reports is the minimum total time it took to run all the test cases. ## Creating Pull Requests From bfa2392cdf9cc0cf78d574465d2b4dcefb66410a Mon Sep 17 00:00:00 2001 From: Aseem Saxena Date: Fri, 30 May 2025 12:00:59 -0700 Subject: [PATCH 2/2] Update docs/docs/codeflash-concepts/how-codeflash-works.md --- docs/docs/codeflash-concepts/how-codeflash-works.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/codeflash-concepts/how-codeflash-works.md b/docs/docs/codeflash-concepts/how-codeflash-works.md index e6c1756ca..5f60a9372 100644 --- a/docs/docs/codeflash-concepts/how-codeflash-works.md +++ b/docs/docs/codeflash-concepts/how-codeflash-works.md @@ -53,7 +53,7 @@ Codeflash runs tests for the target function using either pytest or unittest fra #### Performance benchmarking -Codeflash implements [several techniques](/codeflash-concepts/benchmarking.md) to measure code performance accurately. In particular, it runs multiple iterations of the code in a loop to determine the best performance with the minimum runtime. Codeflash compares the performance of the original code against the optimization, requiring at least a 10% speed improvement before considering it faster. This approach eliminates most runtime measurement variability, even on noisy CI systems and virtual machines. The final runtime Codeflash reports is the minimum total time it took to run all the test cases. +Codeflash implements [several techniques](/codeflash-concepts/benchmarking.md) to measure code performance accurately. In particular, it runs multiple iterations of the code in a loop to determine the best performance with the minimum runtime. Codeflash compares the performance of the original code against the optimization, requiring at least a 10% speed improvement before considering it to be faster. This approach eliminates most runtime measurement variability, even on noisy CI systems and virtual machines. The final runtime Codeflash reports is the minimum total time it took to run all the test cases. ## Creating Pull Requests