re-run pre-commit; update docs to reflect recent changes

Author: leofang

README.md

@@ -1,4 +1,4 @@
-# CUDA-Python
+# cuda-python
 
 CUDA Python is the home for accessing NVIDIA’s CUDA platform from Python. It consists of multiple components:
 
@@ -7,21 +7,21 @@ CUDA Python is the home for accessing NVIDIA’s CUDA platform from Python. It c
 * [cuda.cooperative](https://nvidia.github.io/cccl/cuda_cooperative/): Pythonic exposure of CUB cooperative algorithms
 * [cuda.parallel](https://nvidia.github.io/cccl/cuda_parallel/): Pythonic exposure of Thrust parallel algorithms
 
-For access to NVIDIA Math Libraries, please refer to [nvmath-python](https://docs.nvidia.com/cuda/nvmath-python/latest).
+For access to NVIDIA CPU & GPU Math Libraries, please refer to [nvmath-python](https://docs.nvidia.com/cuda/nvmath-python/latest).
 
 CUDA Python is currently undergoing an overhaul to improve existing and bring up new components. All of the previously available functionalities from the cuda-python package will continue to be available, please refer to the [cuda.bindings](https://nvidia.github.io/cuda-python/cuda-bindings/latest) documentation for installation guide and further detail.
 
-## CUDA-Python as a metapackage
+## cuda-python as a metapackage
 
-CUDA-Python is structured to become a metapackage that contains a collection of subpackages. Each subpackage is versioned independently, allowing installation of each component as needed.
+`cuda-python` is being re-structured to become a metapackage that contains a collection of subpackages. Each subpackage is versioned independently, allowing installation of each component as needed.
 
 ### Subpackage: `cuda.core`
 
 The `cuda.core` package offers idiomatic, pythonic access to CUDA Runtime and other functionalities.
 
 The goals are to
 
-1. Provide **idiomatic (“pythonic”)** access to CUDA Driver/Runtime
+1. Provide **idiomatic ("pythonic")** access to CUDA Driver, Runtime, and JIT compiler toolchain
 2. Focus on **developer productivity** by ensuring end-to-end CUDA development can be performed quickly and entirely in Python
 3. **Avoid homegrown** Python abstractions for CUDA for new Python GPU libraries starting from scratch
 4. **Ease** developer **burden of maintaining** and catching up with latest CUDA features

cuda_bindings/README.md

@@ -1,13 +1,15 @@
 # `cuda.bindings`: Low-level CUDA interfaces
 
-CUDA Python 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.
+`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.
+
+`cuda.bindings` is a subpackage of `cuda-python`.
 
 ## Installing
 
 CUDA Python can be installed from:
 
-* PYPI
-* Conda (nvidia channel)
+* PyPI
+* Conda (conda-forge/nvidia channels)
 * Source builds
 
 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.
@@ -31,6 +33,30 @@ Source builds work for multiple Python versions, however pre-build PyPI and Cond
 
 * Python 3.9 to 3.12
 
+## Developing
+
+We use `pre-commit` to manage various tools to help development and ensure consistency.
+```shell
+pip install pre-commit
+```
+
+### Code linting
+
+Run this command before checking in the code changes
+```shell
+pre-commit run -a --show-diff-on-failure
+```
+to ensure the code formatting is in line of the requirements (as listed in [`pyproject.toml`](./pyproject.toml)).
+
+### 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. See
+[here](https://docs.gha-runners.nvidia.com/apps/copy-pr-bot/faqs/#why-did-i-receive-a-comment-that-my-pull-request-requires-additional-validation)
+and
+[here](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)
+for more details, including how to sign your commits.
+
 ## Testing
 
 Latest dependencies can be found in [requirements.txt](https://github.com/NVIDIA/cuda-python/blob/main/cuda_bindings/requirements.txt).

cuda_core/README.md

@@ -1,9 +1,43 @@
 # `cuda.core`: (experimental) pythonic CUDA module
 
-Currently under active development. To build from source, just do:
+Currently under active developmen; see [the documentation](https://nvidia.github.io/cuda-python/cuda-core/latest/) for more details.
+
+## Installing
+
+TO build from source, just do:
 ```shell
 $ git clone https://github.com/NVIDIA/cuda-python
 $ cd cuda-python/cuda_core  # move to the directory where this README locates
 $ pip install .
 ```
 For now `cuda-python` is a required dependency.
+
+## Developing
+
+We use `pre-commit` to manage various tools to help development and ensure consistency.
+```shell
+pip install pre-commit
+```
+
+### Code linting
+
+Run this command before checking in the code changes
+```shell
+pre-commit run -a --show-diff-on-failure
+```
+to ensure the code formatting is in line of the requirements (as listed in [`pyproject.toml`](./pyproject.toml)).
+
+### 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. See
+[here](https://docs.gha-runners.nvidia.com/apps/copy-pr-bot/faqs/#why-did-i-receive-a-comment-that-my-pull-request-requires-additional-validation)
+and
+[here](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)
+for more details, including how to sign your commits.
+
+## Testing
+
+To run these tests:
+* `python -m pytest tests/` against local builds
+* `pytest tests/` against installed packages

cuda_core/cuda/core/experimental/_stream.py

@@ -211,9 +211,7 @@ def wait(self, event_or_stream: Union[Event, Stream]):
                 try:
                     stream = Stream._init(event_or_stream)
                 except Exception as e:
-                    raise ValueError(
-                        "only an Event, Stream, or object supporting __cuda_stream__ can be waited"
-                    ) from e
+                    raise ValueError("only an Event, Stream, or object supporting __cuda_stream__ can be waited") from e
             else:
                 stream = event_or_stream
             event = handle_return(cuda.cuEventCreate(cuda.CUevent_flags.CU_EVENT_DISABLE_TIMING))

cuda_python/docs/source/index.rst

@@ -9,7 +9,7 @@ multiple components:
 - `cuda.cooperative`_: Pythonic exposure of CUB cooperative algorithms
 - `cuda.parallel`_: Pythonic exposure of Thrust parallel algorithms
 
-For access to NVIDIA Math Libraries, please refer to `nvmath-python`_.
+For access to NVIDIA CPU & GPU Math Libraries, please refer to `nvmath-python`_.
 
 .. _nvmath-python: https://docs.nvidia.com/cuda/nvmath-python/latest