Skip to content

Commit 9a7b1b6

Browse files
committed
Improve wording and punctuation in benchmarks README
1 parent a5af979 commit 9a7b1b6

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

benchmarks/README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ git checkout main
8585
# Gather baseline data for tpch benchmark
8686
./benchmarks/bench.sh run tpch
8787

88-
# Switch to the branch the branch name is mybranch and gather data
88+
# Switch to the branch named mybranch and gather data
8989
git checkout mybranch
9090
./benchmarks/bench.sh run tpch
9191

@@ -158,21 +158,21 @@ Benchmark tpch_mem.json
158158
```
159159

160160
Note that you can also execute an automatic comparison of the changes in a given PR against the base
161-
just by including the trigger `/benchmark` in any comment.
161+
by including the trigger `/benchmark` in any comment.
162162

163163
### Running Benchmarks Manually
164164

165-
Assuming data in the `data` directory, the `tpch` benchmark can be run with a command like this
165+
Assuming data is in the `data` directory, the `tpch` benchmark can be run with a command like this:
166166

167167
```bash
168168
cargo run --release --bin dfbench -- tpch --iterations 3 --path ./data --format tbl --query 1 --batch-size 4096
169169
```
170170

171-
See the help for more details
171+
See the help for more details.
172172

173173
### Different features
174174

175-
You can enable `mimalloc` or `snmalloc` (to use either the mimalloc or snmalloc allocator) as features by passing them in as `--features`. For example
175+
You can enable `mimalloc` or `snmalloc` (to use either the mimalloc or snmalloc allocator) as features by passing them in as `--features`. For example:
176176

177177
```shell
178178
cargo run --release --features "mimalloc" --bin tpch -- benchmark datafusion --iterations 3 --path ./data --format tbl --query 1 --batch-size 4096
@@ -184,6 +184,7 @@ The benchmark program also supports CSV and Parquet input file formats and a uti
184184
```bash
185185
cargo run --release --bin tpch -- convert --input ./data --output /mnt/tpch-parquet --format parquet
186186
```
187+
187188
Or if you want to verify and run all the queries in the benchmark, you can just run `cargo test`.
188189

189190
### Comparing results between runs
@@ -206,7 +207,7 @@ $ cargo run --release --bin tpch -- benchmark datafusion --iterations 5 --path .
206207
./compare.py /tmp/output_main/tpch-summary--1679330119.json /tmp/output_branch/tpch-summary--1679328405.json
207208
```
208209

209-
This will produce output like
210+
This will produce output like:
210211

211212
```
212213
┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓

0 commit comments

Comments
 (0)