You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: cuda_bindings/README.md
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -19,9 +19,9 @@ Differences between these options are described in [Installation](https://nvidia
19
19
CUDA Python is supported on all platforms that CUDA is supported. Specific dependencies are as follows:
20
20
21
21
* Driver: Linux (450.80.02 or later) Windows (456.38 or later)
22
-
* CUDA Toolkit 12.0 to 12.6
22
+
* CUDA Toolkit 12.x
23
23
24
-
Only the NVRTC redistributable component is required from the CUDA Toolkit. [CUDA Toolkit Documentation](https://docs.nvidia.com/cuda/index.html)Installation Guides can be used for guidance. Note that the NVRTC component in the Toolkit can be obtained via PYPI, Conda or Local Installer.
24
+
Only the NVRTC and nvJitLink redistributable components are required from the CUDA Toolkit, which can be obtained via PyPI, Conda, or local installers (as described in the CUDA Toolkit [Windows](https://docs.nvidia.com/cuda/cuda-installation-guide-microsoft-windows/index.html)and [Linux](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html) Installation Guides).
25
25
26
26
### Supported Python Versions
27
27
@@ -73,18 +73,18 @@ Multiple testing options are available:
73
73
Responsible for validating different binding usage patterns. Unit test `test_kernelParams.py` is particularly special since it demonstrates various approaches in setting up kernel launch parameters.
74
74
75
75
To run these tests:
76
-
*`python -m pytest tests/` against local builds
76
+
*`python -m pytest tests/` against editable installations
77
77
*`pytest tests/` against installed packages
78
78
79
79
### Cython Unit Tests
80
80
81
-
Cython tests are located in `tests/cython` and need to be built. These builds have the same CUDA Toolkit header requirements as [Installing from Source](https://nvidia.github.io/cuda-python/cuda-bindings/latest/install.html#requirements) where the major.minor version must match `cuda-python`. To build them:
81
+
Cython tests are located in `tests/cython` and need to be built. These builds have the same CUDA Toolkit header requirements as [Installing from Source](https://nvidia.github.io/cuda-python/cuda-bindings/latest/install.html#requirements) where the major.minor version must match `cuda.bindings`. To build them:
82
82
83
83
1. Setup environment variable `CUDA_HOME` with the path to the CUDA Toolkit installation.
84
84
2. Run `build_tests` script located in `test/cython` appropriate to your platform. This will both cythonize the tests and build them.
85
85
86
86
To run these tests:
87
-
*`python -m pytest tests/cython/` against local builds
87
+
*`python -m pytest tests/cython/` against editable installations
88
88
*`pytest tests/cython/` against installed packages
89
89
90
90
### Samples
@@ -102,13 +102,13 @@ In addition, extra examples are included:
102
102
wrappers of the driver API.
103
103
104
104
To run these samples:
105
-
*`python -m pytest tests/cython/` against local builds
105
+
*`python -m pytest tests/cython/` against editable installations
106
106
*`pytest tests/cython/` against installed packages
107
107
108
108
### Benchmark (WIP)
109
109
110
110
Benchmarks were used for performance analysis during initial release of CUDA Python. Today they need to be updated the 12.x toolkit and are work in progress.
111
111
112
112
The intended way to run these benchmarks was:
113
-
*`python -m pytest --benchmark-only benchmark/` against local builds
113
+
*`python -m pytest --benchmark-only benchmark/` against editable installations
114
114
*`pytest --benchmark-only benchmark/` against installed packages
Copy file name to clipboardExpand all lines: cuda_bindings/docs/source/install.md
+11-25Lines changed: 11 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,13 @@
2
2
3
3
## Runtime Requirements
4
4
5
-
`cuda-python` supports the same platforms as CUDA. Runtime dependencies are:
5
+
`cuda.bindings` supports the same platforms as CUDA. Runtime dependencies are:
6
6
7
7
* Driver: Linux (450.80.02 or later) Windows (456.38 or later)
8
-
* CUDA Toolkit 12.0 to 12.6
8
+
* CUDA Toolkit 12.x
9
9
10
-
```{note} Only the NVRTC redistributable component is required from the CUDA Toolkit. [CUDA Toolkit Documentation](https://docs.nvidia.com/cuda/index.html) Installation Guides can be used for guidance. Note that the NVRTC component in the Toolkit can be obtained via PYPI, Conda or local installers.
10
+
```{note}
11
+
Only the NVRTC and nvJitLink redistributable components are required from the CUDA Toolkit, which can be obtained via PyPI, Conda, or local installers (as described in the CUDA Toolkit [Windows](https://docs.nvidia.com/cuda/cuda-installation-guide-microsoft-windows/index.html) and [Linux](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html) Installation Guides).
11
12
```
12
13
13
14
## Installing from PyPI
@@ -19,48 +20,33 @@ $ pip install cuda-python
19
20
## Installing from Conda
20
21
21
22
```console
22
-
$ conda install -c nvidia cuda-python
23
+
$ conda install -c conda-forge cuda-python
23
24
```
24
25
25
-
Conda packages have dependencies to CUDA Toolkit components:
26
-
27
-
* cuda-cudart (Provides CUDA headers to enable writing NVRTC kernels with CUDA types)
[^1]: User projects that `cimport` CUDA symbols in Cython must also use CUDA Toolkit (CTK) types as provided by the `cuda-python` major.minor version. This results in CTK headers becoming a transitive dependency of downstream projects through CUDA Python.
32
+
[^1]: User projects that `cimport` CUDA symbols in Cython must also use CUDA Toolkit (CTK) types as provided by the `cuda.bindings` major.minor version. This results in CTK headers becoming a transitive dependency of downstream projects through CUDA Python.
38
33
39
-
Source builds require that the provided CUDA headers are of the same major.minor version as the `cuda-python` bindings you're trying to build. Despite of this requirement, note that the minor version compatibility is still maintained. Use the `CUDA_HOME` (or `CUDA_PATH`) environment variable to specify the location of your headers. For example, if your headers are located in `/usr/local/cuda/include`, then you should set `CUDA_HOME` with:
34
+
Source builds require that the provided CUDA headers are of the same major.minor version as the `cuda.bindings`you're trying to build. Despite this requirement, note that the minor version compatibility is still maintained. Use the `CUDA_HOME` (or `CUDA_PATH`) environment variable to specify the location of your headers. For example, if your headers are located in `/usr/local/cuda/include`, then you should set `CUDA_HOME` with:
40
35
41
36
```console
42
37
$ export CUDA_HOME=/usr/local/cuda
43
38
```
44
39
45
-
```{note} Only `cydriver`, `cyruntime` and `cynvrtc` are impacted by the header requirement.
46
-
```
47
-
48
-
### In-place
49
-
50
-
To compile the extension in-place, run:
51
-
52
-
```console
53
-
$ python setup.py build_ext --inplace
40
+
```{note}
41
+
Only `cydriver`, `cyruntime` and `cynvrtc` are impacted by the header requirement.
54
42
```
55
43
56
-
To compile for debugging the extension modules with gdb, pass the `--debug` argument to setup.py.
57
-
58
-
### Develop
44
+
### Editable Install
59
45
60
46
You can use
61
47
62
48
```console
63
-
$ pip install -e .
49
+
$ pip install -v -e .
64
50
```
65
51
66
52
to install the module as editable in your current Python environment (e.g. for testing of porting other libraries to use the binding).
0 commit comments