Skip to content

Commit 538a0b1

Browse files
committed
add installation guide
1 parent d8de142 commit 538a0b1

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

cuda_core/docs/source/install.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,16 @@ dependencies are as follows:
1212

1313
[^1]: Including `cuda-python`.
1414

15+
## Installing from PyPI
16+
17+
`cuda.core` works with `cuda.bindings` (part of `cuda-python`) 11 or 12. For example with CUDA 12:
18+
```console
19+
$ pip install cuda-core[cu12]
20+
```
21+
and likewise use `[cu11]` for CUDA 11.
22+
23+
Note that using `cuda.core` with NVRTC or nvJitLink installed from PyPI via `pip install` is currently
24+
not supported. This will be fixed in a future release.
1525

1626
## Installing from Source
1727

cuda_core/docs/source/release/0.1.1-notes.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ Released on Dec XX, 2024
1717

1818
- All APIs are currently *experimental* and subject to change without deprecation notice.
1919
Please kindly share your feedbacks with us so that we can make `cuda.core` better!
20+
- Using `cuda.core` with NVRTC or nvJitLink installed from PyPI via `pip install` is currently
21+
not supported. This will be fixed in a future release.
2022
- Some `LinkerOptions` are only available when using a modern version of CUDA. When using CUDA <12,
2123
the backend is the cuLink api which supports only a subset of the options that nvjitlink does.
2224
Further, some options aren't available on CUDA versions <12.6

0 commit comments

Comments
 (0)