Skip to content

Commit e4f8509

Browse files
committed
Apply feedback
1 parent f33051a commit e4f8509

File tree

3 files changed

+19
-33
lines changed

3 files changed

+19
-33
lines changed

cuda_bindings/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ Differences between these options are described in [Installation](https://nvidia
1919
CUDA Python is supported on all platforms that CUDA is supported. Specific dependencies are as follows:
2020

2121
* 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
2323

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).
2525

2626
### Supported Python Versions
2727

@@ -73,18 +73,18 @@ Multiple testing options are available:
7373
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.
7474

7575
To run these tests:
76-
* `python -m pytest tests/` against local builds
76+
* `python -m pytest tests/` against editable installations
7777
* `pytest tests/` against installed packages
7878

7979
### Cython Unit Tests
8080

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:
8282

8383
1. Setup environment variable `CUDA_HOME` with the path to the CUDA Toolkit installation.
8484
2. Run `build_tests` script located in `test/cython` appropriate to your platform. This will both cythonize the tests and build them.
8585

8686
To run these tests:
87-
* `python -m pytest tests/cython/` against local builds
87+
* `python -m pytest tests/cython/` against editable installations
8888
* `pytest tests/cython/` against installed packages
8989

9090
### Samples
@@ -102,13 +102,13 @@ In addition, extra examples are included:
102102
wrappers of the driver API.
103103

104104
To run these samples:
105-
* `python -m pytest tests/cython/` against local builds
105+
* `python -m pytest tests/cython/` against editable installations
106106
* `pytest tests/cython/` against installed packages
107107

108108
### Benchmark (WIP)
109109

110110
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.
111111

112112
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
114114
* `pytest --benchmark-only benchmark/` against installed packages

cuda_bindings/docs/source/install.md

Lines changed: 11 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@
22

33
## Runtime Requirements
44

5-
`cuda-python` supports the same platforms as CUDA. Runtime dependencies are:
5+
`cuda.bindings` supports the same platforms as CUDA. Runtime dependencies are:
66

77
* 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
99

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).
1112
```
1213

1314
## Installing from PyPI
@@ -19,48 +20,33 @@ $ pip install cuda-python
1920
## Installing from Conda
2021

2122
```console
22-
$ conda install -c nvidia cuda-python
23+
$ conda install -c conda-forge cuda-python
2324
```
2425

25-
Conda packages have dependencies to CUDA Toolkit components:
26-
27-
* cuda-cudart (Provides CUDA headers to enable writing NVRTC kernels with CUDA types)
28-
* cuda-nvrtc (Provides NVRTC shared library)
29-
3026
## Installing from Source
3127

3228
### Requirements
3329

3430
* CUDA Toolkit headers[^1]
35-
* [requirements.txt](https://github.com/NVIDIA/cuda-python/blob/main/cuda_bindings/requirements.txt)
3631

37-
[^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.
3833

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:
4035

4136
```console
4237
$ export CUDA_HOME=/usr/local/cuda
4338
```
4439

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.
5442
```
5543

56-
To compile for debugging the extension modules with gdb, pass the `--debug` argument to setup.py.
57-
58-
### Develop
44+
### Editable Install
5945

6046
You can use
6147

6248
```console
63-
$ pip install -e .
49+
$ pip install -v -e .
6450
```
6551

6652
to install the module as editable in your current Python environment (e.g. for testing of porting other libraries to use the binding).

cuda_core/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,5 +39,5 @@ for more details, including how to sign your commits.
3939
## Testing
4040

4141
To run these tests:
42-
* `python -m pytest tests/` against local builds
42+
* `python -m pytest tests/` against editable installations
4343
* `pytest tests/` against installed packages

0 commit comments

Comments
 (0)