Skip to content

Commit b757fbb

Browse files
committed
add info about comparing and storing bench results
1 parent 3c12bbc commit b757fbb

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

scripts/benchmarks/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,16 @@ By default, all benchmark runs are compared against `baseline`, which is a well-
3131

3232
You must be a member of the `oneapi-src` organization to access these features.
3333

34+
## Comparing results
35+
36+
By default, the benchmark results are not stored. To store them, use the option `--save <name>`. This will make the results available for comparison during the next benchmark runs.
37+
38+
To compare a benchmark run with a previously stored result, use the option `--compare <name>`. You can compare with more than one result.
39+
40+
If no `--compare` option is specified, the benchmark run is compared against a previously stored `baseline`. This baseline is **not** automatically updated. To update it, use the `--save baseline` option.
41+
The recommended way of updating the baseline is running the benchmarking
42+
job on main after a merge of relevant changes.
43+
3444
## Requirements
3545

3646
### Python

0 commit comments

Comments
 (0)