Add sphinx-combined folder that builds combined C++ & Python docs
Fixed relative text alignment in docstrings to fix autodoc warnigns
Renamed cuda.bench.test_cpp_exception and cuda.bench.test_py_exception functions
to start with underscore, signaling that these functions are internal and should
not be documented
Account for test_cpp_exceptions -> _test_cpp_exception, same for *_py_*
Fix cpp_benchmarks, add py_benchmarks
1. Fixed xrefs in docs/sphinx-combined/cpp_benchmarks.md, which is built on top of
docs/benchmarks.md
Added level-1 heading, and pushed existing headings one level down.
2. Added py_benchmarks.md to document benchmarking of Python scripts.
3. Rearranged entries in index.rst so that overview documents come before
API enumeration.
Make sure to reset __module__ of reexported symbols to be cuda.bench
Enumerate free functions in nvbench:: namespace
Tweak to index.rst intro sentence and title
Changed title, fixed references, added intro borrowed from README
Fix punctuation in one of the itemlist item text
Hide TOC from the index page. It is too long and confusing
The option sets m_skip_batched boolean member in benchmark_base class.
Methods `bool get_skip_batched()` and `void set_skip_batched(bool)` added.
m_skip_batched is also added to state class. Similarly named methods
are added.
CLI help file documents `--no-batched` option.
Text for --profile modified to be self-consistent, i.e., not to refer
to removed --run-once and --disable-blocking-kernel for explanantion
of what it does.
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.
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.
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.
