Skip to content

Commit 7112c5e

Browse files
committed
add more info
1 parent 78e2d65 commit 7112c5e

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/docs/optimizing-with-codeflash/codeflash-all.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,11 @@ This requires the Codeflash GitHub App to be installed in your repository.
1717

1818
This is a powerful feature that can help you optimize your entire codebase in one go.
1919
Since it runs on all the functions in your codebase, it can take some time to complete, please be patient.
20-
As this runs you will see Codeflash opening pull requests for each function it successfully optimizes.
20+
As this runs you will see Codeflash opening pull requests for each function it successfully optimizes.
21+
22+
## Important considerations
23+
- **Dedicated Optimization Machine:** Optimizing the entire codebase may require considerable time—up to one day. It's recommended to allocate a dedicated machine specifically for this long-running optimization task.
24+
25+
- **Minimize Background Processes:** To achieve optimal results, avoid running other processes on the optimization machine. Additional processes can introduce noise into Codeflash's runtime measurements, reducing the quality of the optimizations. Although Codeflash tolerates some runtime fluctuations, minimizing noise ensures the highest optimization quality.
26+
27+
- **Checkpoint and Recovery:** Codeflash automatically creates checkpoints as it identifies optimizations. If the optimization process is interrupted or encounters issues, you can resume the process by re-running `codeflash --all`. The command will prompt you to continue from the most recent checkpoint.

0 commit comments

Comments
 (0)