Skip to content

Commit

Permalink
add dry run docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dmah42 committed Sep 13, 2024
1 parent 72ecc4e commit 3fd1e6a
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,13 @@ line interface or by setting environment variables before execution. For every
prevails). A complete list of CLI options is available running benchmarks
with the `--help` switch.

### Dry runs

To confirm that benchmarks can run successfully without needing to wait for
multiple repetitions and iterations, the `--benchmark_dry_run` flag can be
used. This will run the benchmarks as normal, but for 1 iteration and 1
repetition only.

<a name="running-a-subset-of-benchmarks" />

## Running a Subset of Benchmarks
Expand Down

0 comments on commit 3fd1e6a

Please sign in to comment.