Skip to content

Commit bf68160

Browse files
committed
Add project description
1 parent 291ed64 commit bf68160

File tree

6 files changed

+43
-18
lines changed

6 files changed

+43
-18
lines changed

.github/workflows/build-and-test.yml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -158,10 +158,9 @@ jobs:
158158
$CHOWN -R $(whoami) ${{ env.CUDA_BINDINGS_ARTIFACTS_DIR }}
159159
ls -lahR ${{ env.CUDA_BINDINGS_ARTIFACTS_DIR }}
160160
161-
# TODO: enable this after NVIDIA/cuda-python#297 is resolved
162-
# - name: Check cuda.bindings wheel
163-
# run: |
164-
# twine check ${{ env.CUDA_BINDINGS_ARTIFACTS_DIR }}/*.whl
161+
- name: Check cuda.bindings wheel
162+
run: |
163+
twine check ${{ env.CUDA_BINDINGS_ARTIFACTS_DIR }}/*.whl
165164
166165
- name: Upload cuda.bindings build artifacts
167166
uses: actions/upload-artifact@v4

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,9 @@ The list of available interfaces are:
3737
* CUDA Runtime
3838
* NVRTC
3939
* nvJitLink
40+
41+
## Supported Python Versions
42+
43+
All `cuda-bindings` subpackages follows [NEP 29](https://numpy.org/neps/nep-0029-deprecation_policy.html) for supported Python version guarantee.
44+
45+
Before dropping support, an issue will be raised for an advanced notice.

cuda_bindings/DESCRIPTION.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
*******************************************************
2+
cuda.bindings: Low-level CUDA interfaces
3+
*******************************************************
4+
5+
`cuda.bindings` is a standard set of low-level interfaces, providing full coverage of and access to the CUDA host APIs from Python. Checkout the [Overview](https://nvidia.github.io/cuda-python/cuda-bindings/latest/overview.html) for the workflow and performance results.
6+
7+
Installation
8+
============
9+
10+
`cuda.bindings` can be installed from:
11+
12+
* PyPI
13+
* Conda (conda-forge/nvidia channels)
14+
* Source builds
15+
16+
Differences between these options are described in [Installation](https://nvidia.github.io/cuda-python/cuda-bindings/latest/install.html) documentation. Each package guarantees minor version compatibility.
17+
18+
Runtime Dependencies
19+
====================
20+
21+
`cuda.bindings` is supported on all the same platforms as CUDA. Specific dependencies are as follows:
22+
23+
* Driver: Linux (450.80.02 or later) Windows (456.38 or later)
24+
* CUDA Toolkit 12.x
25+
26+
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).

cuda_bindings/README.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## Installing
88

9-
CUDA Python can be installed from:
9+
`cuda.bindings` can be installed from:
1010

1111
* PyPI
1212
* Conda (conda-forge/nvidia channels)
@@ -16,23 +16,13 @@ Differences between these options are described in [Installation](https://nvidia
1616

1717
## Runtime Dependencies
1818

19-
CUDA Python is supported on all platforms that CUDA is supported. Specific dependencies are as follows:
19+
`cuda.bindings` is supported on all the same platforms as CUDA. Specific dependencies are as follows:
2020

2121
* Driver: Linux (450.80.02 or later) Windows (456.38 or later)
2222
* CUDA Toolkit 12.x
2323

2424
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

26-
### Supported Python Versions
27-
28-
CUDA Python follows [NEP 29](https://numpy.org/neps/nep-0029-deprecation_policy.html) for supported Python version guarantee.
29-
30-
Before dropping support, an issue will be raised to look for feedback.
31-
32-
Source builds work for multiple Python versions, however pre-build PyPI and Conda packages are only provided for a subset:
33-
34-
* Python 3.9 to 3.12
35-
3626
## Developing
3727

3828
We use `pre-commit` to manage various tools to help development and ensure consistency.

cuda_bindings/pyproject.toml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,10 @@ classifiers = [
2727
"Programming Language :: Python :: 3.12",
2828
"Environment :: GPU :: NVIDIA CUDA",
2929
]
30-
dynamic = ["version"]
30+
dynamic = [
31+
"version",
32+
"readme",
33+
]
3134
dependencies = [
3235
"pywin32; sys_platform == 'win32'",
3336
]
@@ -47,6 +50,7 @@ include = ["cuda*"]
4750

4851
[tool.setuptools.dynamic]
4952
version = { attr = "cuda.bindings._version.__version__" }
53+
readme = { file = ["DESCRIPTION.rst"], content-type = "text/x-rst" }
5054

5155
[tool.ruff]
5256
line-length = 120

cuda_core/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Currently under active development; see [the documentation](https://nvidia.githu
44

55
## Installing
66

7-
TO build from source, just do:
7+
To build from source, just do:
88
```shell
99
$ git clone https://github.com/NVIDIA/cuda-python
1010
$ cd cuda-python/cuda_core # move to the directory where this README locates

0 commit comments

Comments
 (0)