From 437ab85ab7ee3b693e7471475b75e2fd2b8f7c82 Mon Sep 17 00:00:00 2001 From: Leo Fang Date: Tue, 9 Jun 2026 21:18:55 +0000 Subject: [PATCH 1/2] [doc-only] cuda.{bindings,pathfinder}: document how to install nightly (top-of-tree) builds Extends the cuda.core change in #2175 to the remaining cuda-python components named in #2166 (which also covers cuda.bindings and cuda.pathfinder). cuda_bindings: - Add a new "Development environment" section to install.rst with a "Installing the latest nightly (top-of-tree builds)" subsection, matching the cuda.core layout. Artifact pattern includes the CUDA major (cuda13*) since cuda-bindings wheels are CUDA-versioned. cuda_pathfinder: - Add a new install.rst (PyPI / Conda / Development environment with nightly subsection / Source). cuda.pathfinder previously had no standalone install page. Nightly uses the single pure-Python cuda-pathfinder-wheel artifact (no python/platform/CUDA selection needed). - Wire install.rst into the toctree in index.rst. --- cuda_bindings/docs/source/install.rst | 32 +++++++++++ cuda_pathfinder/docs/source/index.rst | 1 + cuda_pathfinder/docs/source/install.rst | 70 +++++++++++++++++++++++++ 3 files changed, 103 insertions(+) create mode 100644 cuda_pathfinder/docs/source/install.rst diff --git a/cuda_bindings/docs/source/install.rst b/cuda_bindings/docs/source/install.rst index ce99255c133..da8e42a1b57 100644 --- a/cuda_bindings/docs/source/install.rst +++ b/cuda_bindings/docs/source/install.rst @@ -80,6 +80,38 @@ For example: Tegra users can install the cuDLA conda package from conda-forge through ``conda install -c conda-forge libcudla cuda-version=13``, if it does not already exist on the system. +Development environment +----------------------- + +The sections above cover end-user installation. The section below focuses on +a repeatable *development* workflow (editable installs and running tests). + +Installing the latest nightly (top-of-tree builds) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +These are useful for users looking to test new features or bug fixes prior to +their inclusion in a release. + +CI publishes wheels as GitHub Actions artifacts on every push to ``main``. To +obtain the most recent build, use the following commands: + +.. code-block:: console + + $ # Find the latest successful CI run on main: + $ RUN_ID=$(gh run list -R NVIDIA/cuda-python -w ci.yml -b main -s success -L1 --json databaseId -q '.[0].databaseId') + + $ # Download the wheel (pick your Python version and platform): + $ gh run download "$RUN_ID" -R NVIDIA/cuda-python -p "cuda-bindings-python312-cuda13*-linux-64-*" + + $ # Install the downloaded wheel: + $ pip install cuda-bindings-python312-cuda13*-linux-64-*/cuda_bindings*.whl[all] + +Replace ``python312`` with your Python version (e.g. ``python310``, ``python311``, +``python313``, ``python314``, ``python314t``). For aarch64, replace ``linux-64`` +with ``linux-aarch64``; for Windows, use ``win-64``. Only the current CUDA +major version is built on ``main``; wheels for the prior CUDA major are +published from the corresponding backport branch. + Installing from Source ---------------------- diff --git a/cuda_pathfinder/docs/source/index.rst b/cuda_pathfinder/docs/source/index.rst index b569d07b476..aaddb5cd6ab 100644 --- a/cuda_pathfinder/docs/source/index.rst +++ b/cuda_pathfinder/docs/source/index.rst @@ -8,6 +8,7 @@ :maxdepth: 2 :caption: Contents: + install api contribute license diff --git a/cuda_pathfinder/docs/source/install.rst b/cuda_pathfinder/docs/source/install.rst new file mode 100644 index 00000000000..c400655a2ab --- /dev/null +++ b/cuda_pathfinder/docs/source/install.rst @@ -0,0 +1,70 @@ +.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved. +.. SPDX-License-Identifier: Apache-2.0 + +Installation +============ + +Runtime Requirements +-------------------- + +``cuda.pathfinder`` is a pure-Python package with no runtime dependencies: + +* Linux (x86-64, arm64) and Windows (x86-64) +* Python 3.10 - 3.14 + +Installing from PyPI +-------------------- + +.. code-block:: console + + $ pip install -U cuda-pathfinder + +Installing from Conda (conda-forge) +----------------------------------- + +.. code-block:: console + + $ conda install -c conda-forge cuda-pathfinder + +Development environment +----------------------- + +The sections above cover end-user installation. The section below focuses on +a repeatable *development* workflow (editable installs and running tests). + +Installing the latest nightly (top-of-tree builds) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +These are useful for users looking to test new features or bug fixes prior to +their inclusion in a release. + +CI publishes the wheel as a GitHub Actions artifact on every push to ``main``. +Because ``cuda.pathfinder`` is pure Python, a single wheel covers every +supported Python version and platform. To obtain the most recent build, use +the following commands: + +.. code-block:: console + + $ # Find the latest successful CI run on main: + $ RUN_ID=$(gh run list -R NVIDIA/cuda-python -w ci.yml -b main -s success -L1 --json databaseId -q '.[0].databaseId') + + $ # Download the wheel: + $ gh run download "$RUN_ID" -R NVIDIA/cuda-python -p "cuda-pathfinder-wheel" + + $ # Install the downloaded wheel: + $ pip install cuda-pathfinder-wheel/*.whl + +Installing from Source +---------------------- + +.. code-block:: console + + $ git clone https://github.com/NVIDIA/cuda-python + $ cd cuda-python/cuda_pathfinder + $ pip install . + +For an editable install (e.g. when developing ``cuda.pathfinder`` itself): + +.. code-block:: console + + $ pip install -v -e . From c3e158c850e5ca402875f2c32f371a2f3e3700f8 Mon Sep 17 00:00:00 2001 From: Leo Fang Date: Tue, 9 Jun 2026 21:26:18 +0000 Subject: [PATCH 2/2] [doc-only] cuda.{core,bindings,pathfinder}: nest "Installing from Source" under "Development environment" Make "Installing from Source" consistently a subsection of "Development environment" across all three components instead of a top-level sibling, matching the intent of the developer-workflow group introduced in #2175. - cuda.core: drop "Installing from Source" from --- to ~~~ (now under Development environment, as a sibling of nightly / uv / pixi). - cuda.bindings: drop "Installing from Source" from --- to ~~~, and drop its "Requirements" and "Editable Install" subsections from ~~~ to ^^^ accordingly. - cuda.pathfinder: drop "Installing from Source" from --- to ~~~ in the new install.rst added earlier in this branch. Also bump SPDX copyright headers on touched existing files to 2025-2026; the new cuda_pathfinder install.rst uses 2026. --- cuda_bindings/docs/source/install.rst | 6 +++--- cuda_core/docs/source/install.rst | 4 ++-- cuda_pathfinder/docs/source/index.rst | 2 +- cuda_pathfinder/docs/source/install.rst | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/cuda_bindings/docs/source/install.rst b/cuda_bindings/docs/source/install.rst index da8e42a1b57..4b90f68ef52 100644 --- a/cuda_bindings/docs/source/install.rst +++ b/cuda_bindings/docs/source/install.rst @@ -113,10 +113,10 @@ major version is built on ``main``; wheels for the prior CUDA major are published from the corresponding backport branch. Installing from Source ----------------------- +~~~~~~~~~~~~~~~~~~~~~~ Requirements -~~~~~~~~~~~~ +^^^^^^^^^^^^ * CUDA Toolkit headers[^1] * CUDA Runtime static library[^2] @@ -138,7 +138,7 @@ See :doc:`Environment Variables ` for a description of ot Only ``cydriver``, ``cyruntime`` and ``cynvrtc`` are impacted by the header requirement. Editable Install -~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^ You can use: diff --git a/cuda_core/docs/source/install.rst b/cuda_core/docs/source/install.rst index 0aa0faf58e9..a49aab7c966 100644 --- a/cuda_core/docs/source/install.rst +++ b/cuda_core/docs/source/install.rst @@ -1,4 +1,4 @@ -.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved. +.. SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. .. SPDX-License-Identifier: Apache-2.0 Installation @@ -147,7 +147,7 @@ Use ``-e cu12`` to test against CUDA 12 instead. .. _pixi: https://pixi.sh/ Installing from Source ----------------------- +~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console diff --git a/cuda_pathfinder/docs/source/index.rst b/cuda_pathfinder/docs/source/index.rst index aaddb5cd6ab..30dc426e195 100644 --- a/cuda_pathfinder/docs/source/index.rst +++ b/cuda_pathfinder/docs/source/index.rst @@ -1,4 +1,4 @@ -.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved. +.. SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. .. SPDX-License-Identifier: Apache-2.0 ``cuda.pathfinder``: Utilities for locating CUDA components diff --git a/cuda_pathfinder/docs/source/install.rst b/cuda_pathfinder/docs/source/install.rst index c400655a2ab..abc8fbb9d50 100644 --- a/cuda_pathfinder/docs/source/install.rst +++ b/cuda_pathfinder/docs/source/install.rst @@ -1,4 +1,4 @@ -.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved. +.. SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. .. SPDX-License-Identifier: Apache-2.0 Installation @@ -55,7 +55,7 @@ the following commands: $ pip install cuda-pathfinder-wheel/*.whl Installing from Source ----------------------- +~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console