Skip to content

Commit 2b7bc49

Browse files
authored
Minor clarifications to benchmark reproduction steps in README
Updated instructions for reproducing the benchmark run with clearer formatting and additional details.
1 parent b218bef commit 2b7bc49

1 file changed

Lines changed: 11 additions & 7 deletions

File tree

data/experiments/README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,15 @@ For every entry in [benchmark_runs](benchmark_runs) the log file contains all th
2121
...
2222
```
2323

24-
Steps to reproduce this benchmark run:
24+
Steps to reproduce the benchmark run above:
2525
- Ensure the Rust toolchain (nightly) matches the one that was the most recent at the day of the experiment.
26-
- For example: `rustup override set nightly-2025-03-28`
27-
- Ensure the repo is checked out at the same commit
28-
- For example: `git checkout 4d70ca7f468957a046a74bbb614b896f0ad463e3`).
29-
- In [config.rs](../../src/config.rs), set the seed to the one that was randomly chosen for this particular benchmark run:
30-
- For example: `pub const RNG_SEED: Option<usize> = Some(12552852848582794543);`
31-
- `sparrow` is built and executed exactly the same as the [single_bench.yml](../../.github/workflows/single_bench.yml) action defines.
26+
- `rustup override set nightly-2025-03-28`
27+
- Ensure the repo is checked out at the same commit:
28+
- `git checkout 4d70ca7f468957a046a74bbb614b896f0ad463e3`).
29+
- Ensure, the seed in [config.rs](../../src/config.rs) is set to the randomly chosen one:
30+
- `pub const RNG_SEED: Option<usize> = Some(12552852848582794543);`
31+
- Ensure `sparrow` is built and executed exactly as [single_bench.yml](../../.github/workflows/single_bench.yml) defines.
32+
- ```
33+
export RUSTFLAGS='-C target-cpu=native'
34+
cargo run --profile release --features=only_final_svg,simd --bin bench -- data/input/swim.json 1200 100
35+
```

0 commit comments

Comments
 (0)