Skip to content

Commit af12fe1

Browse files
Expand README
Make it explicit in README that we build and locally install NVBench first, and then build Python package use the library as a dependency. The nvbench library is installed into Python layout alongside the native extension.
1 parent ff7a0f6 commit af12fe1

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

python/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,18 @@ Now switch to python folder, configure and install NVBench library, and install
1919
cd nvbench/python
2020
cmake -B nvbench_build --preset nvbench-ci -S $(pwd)/.. -DCMAKE_CUDA_COMPILER=/usr/local/cuda/bin/nvcc -DNVBench_ENABLE_EXAMPLES=OFF -DCMAKE_INSTALL_PREFIX=$(pwd)/nvbench_install
2121
cmake --build nvbench_build/ --config Release --target install
22+
```
23+
24+
### Build Python extension
25+
26+
Specify location local installation of `NVBench` library and perform editable `pip install`:
2227

28+
```
2329
nvbench_DIR=$(pwd)/nvbench_install/lib/cmake CUDACXX=/usr/local/cuda/bin/nvcc pip install -e .
2430
```
2531

32+
Note that `CUDACXX` must be set for NVBench cmake script to work, but Python extension itself only uses host compiler.
33+
2634
### Verify that package works
2735

2836
```

0 commit comments

Comments
 (0)