-
Notifications
You must be signed in to change notification settings - Fork 22
Add notice about the considerations when running codeflash --all #218
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.
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
Conversation
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨No code suggestions found for the PR. |
| ## Important considerations | ||
| - **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. | ||
|
|
||
| - **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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let's reorganize to something like this:
Important Considerations
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 task for the following reasons:
-
Long Runtime Duration:
A full codebase optimization is a time-intensive operation. Using a dedicated machine ensures the process runs uninterrupted and doesn't interfere with your main development environment. -
Minimize Background Processes:
Codeflash relies on runtime measurements to guide optimizations. Running additional processes on the machine can introduce noise, reducing the accuracy of these measurements and thus the quality of the optimizations. Although Codeflash tolerates some fluctuations, a clean and idle environment ensures the best possible results.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
newlines between a markdown list breaks the flow. Simple bulleted lists with bolded headings is good enough.
PR Type
Documentation
Description
Add "Important considerations" guidance section
Recommend dedicated optimization machine usage
Advise minimizing background processes
Explain checkpoint and recovery process
Changes walkthrough 📝
codeflash-all.md
Add guidance for optimization considerationsdocs/docs/optimizing-with-codeflash/codeflash-all.md
codeflash --all