Commit Graph

19 Commits

Author SHA1 Message Date
Bryce Adelstein Lelbach aka wash
39b2770b62 Fix typo in documentation: set_type_axis_names should be set_type_axes_names 2023-10-05 13:16:16 -04:00
Paul Große-Bley
7f51ead595 Add --disable-blocking-kernel and --profile options. 2022-04-08 20:03:44 +02:00
Allison Vacanti
48d94259b4 Fix typo in new docs. 2022-02-11 14:01:49 -05:00
Allison Vacanti
039d455727 Move documentation on streams to new subsection.
Also update to use `nvbench::make_cuda_stream_view`.
2022-02-11 13:29:06 -05:00
Yunsong Wang
e7c29c1c1b Update docs 2022-02-06 19:34:57 -05:00
Yunsong Wang
a2a12c689c Update docs/benchmarks.md
Co-authored-by: Jake Hemstad <jhemstad@nvidia.com>
2022-02-06 19:31:20 -05:00
Yunsong Wang
76cbbcc8f9 Update benchmarks.md 2022-02-04 17:20:40 -05:00
Allison Vacanti
b948e79cab Add NVML support for persistence mode, locking clocks.
Locking clocks is currently only implemented for Volta+ devices.

Example usage:

my_bench -d [0,1,3] --persistence-mode 1 --lock-gpu-clocks base

See the cli_help.md docs for more info.
2021-12-17 13:59:43 -05:00
Allison Vacanti
1875d9962d Document new --version option. 2021-10-26 17:45:20 -04:00
Allison Vacanti
6d79c80152 Add --run-once option.
Fixes #10.

Adds a mode that forces a benchmark to only run once, simplifying
profiling usecases. This can be enabled by any of the following methods:

* Passing `--run-once` on the command line
* `NVBENCH_CREATE(...).set_run_once(true)` when declaring a benchmark
* `state.set_run_once(true)` from within the benchmark implementation.
2021-10-07 16:28:15 -04:00
Allison Vacanti
ff507596bf Fix typo in docs. 2021-04-12 14:48:45 -04:00
Allison Vacanti
4e83e048ba Store percentages as ratios.
Human-readable outputs (md) and CLI inputs still use percentages.
In-memory and machine-readable outputs (csv, json) use ratios.

This is the convention that spreadsheet apps expect. Fixes #2.
2021-03-18 13:42:43 -04:00
Allison Vacanti
60c94d9ed6 Add enum_type_axis and examples/enums.cu.
- `enum_type_axis` simplifies using integral_constants with type axes.
- `examples/enums.cu` demonstrates various ways of implementing parameter
  sweeps with enum types.
2021-03-16 13:57:52 -04:00
Yunsong Wang
a097e6d90d Minor corrections in doc 2021-03-11 16:47:03 -05:00
Allison Vacanti
3fc75f5ea6 Add more examples.
- exec_tag_timer
- exec_tag_sync
- skip
- throughput
2021-03-09 16:03:14 -05:00
Allison Vacanti
33aa9e1a07 Update README to link to the new example. 2021-03-08 18:26:26 -05:00
Allison Vacanti
922a6d09d0 Add --json option to CLI docs. 2021-03-05 16:37:23 -05:00
Allison Vacanti
33fa0c773f Typo. 2021-03-04 23:24:37 -05:00
Allison Vacanti
65bc2c1e3f Documentation overhaul.
Revamp README, split into multiple files. Add docs on CLI.

Add `--help` and `--help-axis`.
2021-03-04 18:40:23 -05:00