Skip to content

Commit 102b4b6

Browse files
Merge pull request #565 from codeflash-ai/note-about-replay-tests
docs add note
2 parents 553a192 + 0eadf0e commit 102b4b6

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/docs/optimizing-with-codeflash/trace-and-optimize.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ To optimize code called by pytest tests that you could normally run like `python
1717
codeflash optimize -m pytest tests/
1818
```
1919

20-
This powerful command creates high-quality optimizations, making it ideal when you need to optimize a workflow or script. The initial tracing process can be slow, so try to limit your script's runtime to under 1 minute for best results. If your workflow is longer, consider tracing it into smaller sections by using the Codeflash tracer as a context manager (point 3 below).
20+
This powerful command creates high-quality optimizations, making it ideal when you need to optimize a workflow or script. The initial tracing process can be slow, so try to limit your script's runtime to under 1 minute for best results. If your workflow is longer, consider tracing it into smaller sections by using the Codeflash tracer as a context manager (point 3 below).
21+
22+
The generated replay tests and the trace file are for the immediate optimization use, don't add them to git.
2123

2224
## What is the codeflash optimize command?
2325

0 commit comments

Comments
 (0)