Skip to content

Commit c47f28c

Browse files
committed
updates
Signed-off-by: Saurabh Misra <[email protected]>
1 parent 50dca68 commit c47f28c

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

docs/getting-started/local-installation.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ Before installing Codeflash, ensure you have:
1414
2. **A Python project** with a virtual environment
1515
3. **Project dependencies installed** in your virtual environment
1616

17+
Good to have (optional):
18+
1. **Unit Tests** that Codeflash uses to ensure correctness of the optimizations
19+
1720
<Warning>
1821
**Virtual Environment Required**
1922

docs/optimizing-with-codeflash/benchmarking.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,9 @@ It will then try to optimize the new code for the benchmark and calculate the im
6767

6868
4. **Run Codeflash :**
6969

70-
Benchmark mode is best used together with Codeflash as a GitHub Action. This way, if new code in a Pull Request touches the benchmark workflow, Codeflash will try to optimize the code for the benchmark, and you will know the impact of Codeflash's optimizations on your benchmarks.
70+
Benchmark mode is best used together with Codeflash as a GitHub Action. This way,
71+
Codeflash will trace through your benchmark and optimize the functions modified in your Pull Request to speed up the benchmark.
72+
It will also report the impact of Codeflash's optimizations on your benchmarks.
7173

7274
Use `codeflash init` for an easy way to set up Codeflash as a GitHub Action.
7375

0 commit comments

Comments
 (0)