Update docs for codeflash optimize

[misrasaurabh1]

PR Type

Documentation

---

Description

• Update CLI examples to use codeflash optimize

• Revise trace-and-optimize docs with new usage steps

• Adjust feature tables and headings

• Add script optimization instructions

---

Changes walkthrough 📝

Relevant files

Documentation

README.md Revise README usage for `codeflash optimize`                          README.md Replace tracer CLI with codeflash optimize command Add script optimization usage example Extend supported code types (add PyTorch) Update user team references +7/-3      local-installation.md Streamline local installation and examples                              docs/docs/getting-started/local-installation.md Remove redundant project-root reminder Adjust link capitalization in navigation Add script optimization step in list +1/-10    intro.md Update intro feature table and commands                                    docs/docs/intro.md Reorder feature table rows Update commands to show codeflash optimize Fix table formatting and descriptions +7/-6      benchmarking.md Refine benchmarking documentation header                                  docs/docs/optimizing-with-codeflash/benchmarking.md Rename heading to "Using Benchmarks in CI" Clarify benchmark mode context +1/-1      trace-and-optimize.md Revamp trace-and-optimize instructions                                      docs/docs/optimizing-with-codeflash/trace-and-optimize.md Replace python -m codeflash.tracer with codeflash optimize Add separate trace-only and replay steps Expand command examples and flags Restructure sections and improve descriptions +67/-54

---

Need help?

Type /help how to ... in the comments thread for any questions about PR-Agent usage.

Check out the documentation for more information.

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review List formatting The new "3. Optimize a script" entry is numbered while the preceding items use bullets, which may render inconsistently. Consider using a uniform bullet or numbered list style. - Optimize a Python workflow `python myscript.py` end-to-end by running `codeflash optimize myscript.py` Codeflash is used by top engineering teams at [Pydantic](https://github.com/pydantic/pydantic/pulls?q=is%3Apr+author%3Amisrasaurabh1+is%3Amerged), [Langflow](https://github.com/langflow-ai/langflow/issues?q=state%3Aclosed%20is%3Apr%20author%3Amisrasaurabh1), [Roboflow](https://github.com/roboflow/inference/pulls?q=is%3Apr+is%3Amerged+codeflash+sort%3Acreated-asc), [Albumentations](https://github.com/albumentations-team/albumentations/issues?q=state%3Amerged%20is%3Apr%20author%3Akrrt7%20OR%20state%3Amerged%20is%3Apr%20author%3Aaseembits93%20) and many others to ship performant, expert level code. Codeflash is great at optimizing AI Agents, Computer Vision algorithms, PyTorch code, numerical code, backend code or anything else you might write with Python. Removed checklist item The project-root requirement ("You're running codeflash from your project root") was removed. If running from root is still necessary for correct operation, clarify or reinstate this step. Make sure: - ✅ Your virtual environment is activated - ✅ All project dependencies are installed Table rendering The new markdown table may have alignment or wrapping issues. Verify that all pipes (|) and header separators are correct and render as expected in the site. | Feature | Description | |-----------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Optimize a single function](optimizing-with-codeflash/one-function) | `codeflash --file path.py --function myfunctionpy` Basic unit of optimization by asking Codeflash to optimize a particular function | [Optimize an entire workflow](optimizing-with-codeflash/trace-and-optimize) | `codeflash optimize myscript.py` End to end optimization for all the functions called in a workflow, by tracing to collect real inputs to ensure correctness and e2e performance optimization | | [Optimize all code in a repo](optimizing-with-codeflash/codeflash-all) | `codeflash --all` Codeflash discovers all functions in a repo and optimizes all of them! | | [Optimize every new pull request](optimizing-with-codeflash/optimize-prs) | `codeflash init-actions` Codeflash runs as a GitHub action and GitHub app and reviews all new code for Optimizations |

[github-actions]

PR Code Suggestions ✨

No code suggestions found for the PR.