Skip to content

Address remaining OSRB requests + document known installation issues #626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 12, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Thank you for your interest in contributing to CUDA Python! Based on the type of
- [`cuda.core`](https://nvidia.github.io/cuda-python/cuda-core/latest/contribute.html)
- [`cuda.bindings`](https://nvidia.github.io/cuda-python/cuda-bindings/latest/contribute.html)


## Pre-commit
This project uses [pre-commit.ci](https://pre-commit.ci/) with GitHub Actions. All pull requests are automatically checked for pre-commit compliance, and any pre-commit failures will block merging until resolved.

Expand All @@ -35,6 +36,45 @@ Some contributors prefer to commit intermediate or work-in-progress changes that

Choose the setup that best fits your workflow and development style.


## Code signing

This repository implements a security check to prevent the CI system from running untrusted code. A part of the security check consists of checking if the git commits are signed. Please ensure that your commits are signed [following GitHub’s instruction](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification).


## Developer Certificate of Origin (DCO)
```
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or

(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or

(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.

(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
```
6 changes: 3 additions & 3 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This repository is structured in a way that files are licensed differently
- [`cuda.python`](./cuda_python/): NVIDIA Software License
- [`cuda.bindings`](./cuda_bindings/): NVIDIA Software License
- [`cuda.core`](./cuda_core/) and everything else in this repository: Apache 2.0
- [`cuda.python`](./cuda_python/LICENSE): NVIDIA Software License
- [`cuda.bindings`](./cuda_bindings/LICENSE): NVIDIA Software License
- [`cuda.core`](./cuda_core/LICENSE) and everything else in this repository: Apache 2.0
1 change: 1 addition & 0 deletions cuda_bindings/docs/source/release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Release Notes
.. toctree::
:maxdepth: 3

12.X.Y <release/12.X.Y-notes.rst>
12.9.0 <release/12.9.0-notes.rst>
12.8.0 <release/12.8.0-notes.md>
12.6.2 <release/12.6.2-notes.md>
Expand Down
5 changes: 5 additions & 0 deletions cuda_bindings/docs/source/release/12.8.0-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,8 @@ Same applies to `cuda-bindings`.
## Discovery and loading of shared library dependencies from wheels

Shared library search paths for wheel builds are now extended to check site-packages. This allows `cuda-python`/`cuda-bindings` to seamlessly use the aforementioned CUDA Toolkit wheels installed in the user's Python environment.


## Known issues

- Updating from older versions (v12.6.2.post1 and below) via `pip install -U cuda-python` might not work. Please do a clean re-installation by uninstalling `pip uninstall -y cuda-python` followed by installing `pip install cuda-python`.
6 changes: 6 additions & 0 deletions cuda_bindings/docs/source/release/12.9.0-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,9 @@ Miscellaneous
* Improvements in the introductory code samples
* Fix performance hint warnings raised by Cython 3
* Improvements in the Overview page


Known issues
------------

* Updating from older versions (v12.6.2.post1 and below) via ``pip install -U cuda-python`` might not work. Please do a clean re-installation by uninstalling ``pip uninstall -y cuda-python`` followed by installing ``pip install cuda-python``.
24 changes: 24 additions & 0 deletions cuda_bindings/docs/source/release/12.X.Y-notes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.. SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE

``cuda-bindings`` 12.X.Y Release notes
======================================

Released on MM DD, 2025


Highlights
----------


Bug fixes
---------


Miscellaneous
-------------


Known issues
------------

* Updating from older versions (v12.6.2.post1 and below) via ``pip install -U cuda-python`` might not work. Please do a clean re-installation by uninstalling ``pip uninstall -y cuda-python`` followed by installing ``pip install cuda-python``.
1 change: 1 addition & 0 deletions cuda_python/docs/source/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
maxdepth: 3
---

12.X.Y <release/12.X.Y-notes>
12.9.0 <release/12.9.0-notes>
12.8.0 <release/12.8.0-notes>
12.6.2 <release/12.6.2-notes>
Expand Down
5 changes: 5 additions & 0 deletions cuda_python/docs/source/release/12.8.0-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,8 @@ Released on January 24, 2025.
- Add optional dependencies on CUDA NVRTC and nvJitLink wheels
- Enable discovery and loading of shared libraries from CUDA wheels
- `cuda-python` is now a meta package, currently depending only on `cuda-bindings` ([see RFC](https://github.com/NVIDIA/cuda-python/issues/105))


## Known issues

- Updating from older versions (v12.6.2.post1 and below) via `pip install -U cuda-python` might not work. Please do a clean re-installation by uninstalling `pip uninstall -y cuda-python` followed by installing `pip install cuda-python`.
6 changes: 6 additions & 0 deletions cuda_python/docs/source/release/12.9.0-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,9 @@ Highlights
----------

* Add bindings for libNVVM


Known issues
------------

* Updating from older versions (v12.6.2.post1 and below) via ``pip install -U cuda-python`` might not work. Please do a clean re-installation by uninstalling ``pip uninstall -y cuda-python`` followed by installing ``pip install cuda-python``.
20 changes: 20 additions & 0 deletions cuda_python/docs/source/release/12.X.Y-notes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
.. SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE

CUDA Python 12.X.Y Release notes
================================

Released on MM DD, 2025.


Included components
-------------------


Highlights
----------


Known issues
------------

* Updating from older versions (v12.6.2.post1 and below) via ``pip install -U cuda-python`` might not work. Please do a clean re-installation by uninstalling ``pip uninstall -y cuda-python`` followed by installing ``pip install cuda-python``.
Loading