mirror of
https://github.com/NVIDIA/nvbench.git
synced 2026-07-01 11:47:33 +00:00
10a5d1fcaa
Skip UNKNOWN rows when collecting summary plot entries so non-numeric fractional differences cannot reach the plotting path. Add a regression test that exercises compare_benches(..., plot=True) with an UNKNOWN row. Document the supported pow2 axis-filter syntax and update the CLI help example to use NAME[pow2]=EXP, matching the parser behavior for axes displayed as 2^N. * Document when status ???? (UNKNOWN) is emitted * Clarify --no-color behavior * nvbench_compare.md: clarify --no-color behavior, fix example * Document display options in nvbench_compare.md * Small mention of plotting capabilities in nvbench_compare.md * Call out that example requires shell with process substitution capabilities
CUDA Kernel Benchmarking Package
This package provides a Python API to the CUDA Kernel Benchmarking
Library NVBench.
Installation
Install from PyPi
pip install cuda-bench[cu13] # For CUDA 13.x
pip install cuda-bench[cu12] # For CUDA 12.x
Building from source
Ensure recent version of CMake
Since nvbench requires a rather new version of CMake (>=3.30.4), either build CMake from sources, or create a conda environment with a recent version of CMake, using
conda create -n build_env --yes cmake ninja
conda activate build_env
Ensure CUDA compiler
Since building NVBench library requires CUDA compiler, ensure that appropriate environment variables
are set. For example, assuming CUDA toolkit is installed system-wide, and assuming Ampere GPU architecture:
export CUDACXX=/usr/local/cuda/bin/nvcc
export CUDAARCHS=86
Build Python project
Now switch to python folder, configure and install NVBench library, and install the package in editable mode:
cd nvbench/python
pip install -e .
Verify that package works
python test/run_1.py
Run examples
# Example benchmarking numba.cuda kernel
python examples/throughput.py
# Example benchmarking kernels authored using cuda.core
python examples/axes.py
# Example benchmarking algorithms from cuda.cccl.parallel
python examples/cccl_parallel_segmented_reduce.py
# Example benchmarking CuPy function
python examples/cupy_extract.py