Skip to content

Commit 8f8e98e

Browse files
authored
Update readme with latest instructions for python / CUDA 13 (#1000)
Signed-off-by: Ovidiu Mara <[email protected]>
1 parent 9dbd2e4 commit 8f8e98e

File tree

1 file changed

+39
-8
lines changed

1 file changed

+39
-8
lines changed

README.md

Lines changed: 39 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,24 @@ NVIDIA Inference Xfer Library (NIXL) is targeted for accelerating point to point
1313
## Pre-build Distributions
1414
### PyPI Wheel
1515

16-
The nixl python API and libraries, including UCX, are available directly through PyPI:
16+
The nixl python API and libraries, including UCX, are available directly through PyPI.
17+
18+
It can be installed for CUDA 12 with:
19+
20+
```
21+
pip install nixl[cu12]
22+
```
23+
24+
For CUDA 13 with:
1725

1826
```
19-
pip install nixl
27+
pip install nixl[cu13]
2028
```
2129

30+
For backwards compatibility, `pip install nixl` installs automatically `nixl[cu12]`, continuing to work seamlessly for CUDA 12 users without requiring changes to downstream project dependencies.
31+
32+
If both `nixl-cu12` and `nixl-cu13` are installed at the same time in an environment, `nixl-cu13` takes precedence.
33+
2234
## Prerequisites for source build
2335
### Ubuntu:
2436

@@ -30,7 +42,7 @@ pip install nixl
3042

3143
### Python
3244

33-
`$ pip3 install meson ninja pybind11`
45+
`$ pip3 install meson ninja pybind11 tomlkit`
3446

3547
### UCX
3648

@@ -151,18 +163,37 @@ $ ninja
151163

152164
NIXL provides Python bindings through pybind11. For detailed Python API documentation, see [docs/python_api.md](docs/python_api.md).
153165

154-
The preferred way to install the Python bindings is through pip:
166+
The preferred way to install the Python bindings is through pip from PyPI:
155167

156168
```bash
157-
pip install nixl
169+
pip install nixl[cu12]
158170
```
159171

160-
Or build from source:
172+
Or for CUDA 13 with:
161173

162174
```bash
163-
# From the root nixl directory
175+
pip install nixl[cu13]
176+
```
177+
178+
To build and install the Python bindings from source, you have to build and install separately the platform-specific package and the `nixl` meta-package:
179+
180+
On CUDA 12:
181+
182+
```
183+
pip install .
184+
meson setup build
185+
ninja -C build
186+
pip install build/src/bindings/python/nixl-meta/nixl-*-py3-none-any.whl
187+
```
188+
189+
On CUDA 13:
190+
191+
```
164192
pip install .
165-
pip install <name_of_build_dir>/src/bindings/python/nixl-meta/nixl-*.whl
193+
./contrib/tomlutil.py --wheel-name nixl-cu13 pyproject.toml
194+
meson setup build
195+
ninja -C build
196+
pip install build/src/bindings/python/nixl-meta/nixl-*-py3-none-any.whl
166197
```
167198

168199
For Python examples, see [examples/python/](examples/python/).

0 commit comments

Comments
 (0)