Skip to content

docs improvement #257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 30, 2025
Merged

docs improvement #257

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
57558a3
docs improvement
misrasaurabh1 May 30, 2025
bfa2392
Update docs/docs/codeflash-concepts/how-codeflash-works.md
aseembits93 May 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions docs/docs/codeflash-concepts/how-codeflash-works.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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 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

Expand Down
Loading