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
Add nvbench.State methods to get Python dictionary representing
axis values of benchmark configuration state represents.
get_axis_values_as_string gives a string of space-separated
name=values pairs.
Add comments stating the need to keep implementation and Python stub
file in sync to both files. In the stub file to comment documents
use of mypy's stubgen to generate stubs and calls to compare that against
current stubs. It also calls out the need to keep docstrings and
doctring examples in sync with implementation.
Removed use of __all__ per PR feedback. Emit warnings.warn if
version information could not be retrieved from the package metadata,
e.g., package has been renamed by source code was not updated.
Introduce get_int64_or_default method, and counterparts for
float64 and string.
Provided names for Python arguments.
Tried generating Python stubs automatically with
```
stubgen -m cuda.nvbench._nvbench
```
Gave up on this, since it does not include doc-strings.
It would be nice to compare auto-generated _nvbench.pyi with
__init__.pyi for discrepancies though.
state.add_summary(column_name: str, value: Union[int, float, str])
This is used in examples/axes.py to map integral value from Int64Axis
to string description.
make batch/sync arguments of State.exec keyword-only
Provide default column_name value for State.addElementCount method,
so that it can be called state.addElementCount(count), or as
state.addElementCount(count, column_name="Descriptive Name")
