Skip to content

Commit 56a4d2a

Browse files
docs: update doc to highlight Pypi wheels (#235)
1 parent 5fa64ba commit 56a4d2a

File tree

3 files changed

+32
-6
lines changed

3 files changed

+32
-6
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,18 @@ Choose the installation method that meets your environment needs.
7979

8080
#### Python Wheel File Installation
8181

82-
Download the appropriate .whl file for your computer architecture, Python and CUDA version from the release assets of current CV-CUDA release. Release information of all CV-CUDA releases can be found [here][CV-CUDA GitHub Releases]. Once downloaded, execute the `pip install` command to install the Python wheel. For example:
82+
Check pypi.org projects for support for your platform of choice, [cvcuda-cu11][cvcuda-cu11] and [cvcuda-cu12][cvcuda-cu12] for CUDA 11 and CUDA 12, respectively.
83+
84+
Use the following command to install the latest available version:
85+
```shell
86+
pip install cvcuda_<cu_ver>
87+
```
88+
89+
where <cu_ver> is the desired CUDA version.
90+
91+
Alternatively, download the appropriate .whl file for your computer architecture, Python and CUDA version from the release assets of current CV-CUDA release. Release information of all CV-CUDA releases can be found [here][CV-CUDA GitHub Releases]. Once downloaded, execute the `pip install` command to install the Python wheel. For example:
8392
```shell
84-
pip install cvcuda_<cu_ver>-<x.x.x>-cp<py_ver>-cp<py_ver>-linux_<arch>.whl
93+
pip install ./cvcuda_<cu_ver>-<x.x.x>-cp<py_ver>-cp<py_ver>-linux_<arch>.whl
8594
```
8695

8796
where `<cu_ver>` is the desired CUDA version, `<x.x.x>` is the CV-CUDA release version, `<py_ver>` is the desired Python version and `<arch>` is the desired architecture.
@@ -249,7 +258,7 @@ The new Python wheels for PyPI compliance must be built within the ManyLinux 201
249258

250259
The built wheels can still be installed using `pip`. For example, to install the Python wheel built for CUDA 12.x, Python 3.10 and 3.11 on Linux x86_64 systems:
251260
```shell
252-
pip install cvcuda_cu12-<x.x.x>-cp310.cp311-cp310.cp311-linux_x86_64.whl
261+
pip install ./cvcuda_cu12-<x.x.x>-cp310.cp311-cp310.cp311-linux_x86_64.whl
253262
```
254263

255264
## Contributing
@@ -324,3 +333,5 @@ CV-CUDA is developed jointly by NVIDIA and ByteDance.
324333
[ByteDance]: https://www.bytedance.com/
325334
[CV-CUDA GitHub Releases]: https://github.com/CVCUDA/CV-CUDA/releases
326335
[CV-CUDA Samples]: https://github.com/CVCUDA/CV-CUDA/blob/main/samples/README.md
336+
[cvcuda-cu11]: https://pypi.org/project/cvcuda-cu11/
337+
[cvcuda-cu12]: https://pypi.org/project/cvcuda-cu12/

docs/sphinx/installation.rst

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
# SPDX-FileCopyrightText: Copyright (c) 2022-2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
# SPDX-FileCopyrightText: Copyright (c) 2022-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
33
# SPDX-License-Identifier: Apache-2.0
44
#
55
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -74,11 +74,19 @@ You can download the CV-CUDA tar, deb or wheel packages from `the asset section
7474

7575
* Python Wheel File Installation
7676

77-
Download the appropriate .whl file for your computer architecture, Python and CUDA version from `the asset section of the latest release <https://github.com/CVCUDA/CV-CUDA/releases>`_
77+
Check pypi.org projects for support for your platform of choice, `cvcuda-cu11 <https://pypi.org/project/cvcuda-cu11/>`_ and `cvcuda-cu12 <https://pypi.org/project/cvcuda-cu12/>`_ for CUDA 11 and CUDA 12, respectively.
78+
Use the following command to install the latest available version::
79+
80+
pip install cvcuda_<cu_ver>
81+
82+
where <cu_ver> is the desired CUDA version.
83+
84+
85+
Alternatively, download the appropriate .whl file for your computer architecture, Python and CUDA version from `the asset section of the latest release <https://github.com/CVCUDA/CV-CUDA/releases>`_
7886

7987
Execute the following command to install appropriate CV-CUDA Python wheel ::
8088

81-
pip install cvcuda_<cu_ver>-<x.x.x>-cp<py_ver>-cp<py_ver>-linux_<arch>.whl
89+
pip install ./cvcuda_<cu_ver>-<x.x.x>-cp<py_ver>-cp<py_ver>-linux_<arch>.whl
8290

8391
where <cu_ver> is the desired CUDA version, <x.x.x> the CV-CUDA release version, <py_ver> the desired Python version and <arch> the desired architecture.
8492

docs/sphinx/relnotes/v0.14.0-beta.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@ v0.14.0-beta
2222
Release Highlights
2323
------------------
2424

25+
Python x86_64 wheels are now available on PyPi, `cvcuda-cu11 <https://pypi.org/project/cvcuda-cu11/>`_ and `cvcuda-cu12 <https://pypi.org/project/cvcuda-cu12/>`_ for CUDA 11 and CUDA 12, respectively ::
26+
27+
pip install cvcuda-cu<CUDA_VERSION>
28+
29+
2530
CV-CUDA v0.14.0 includes the following changes:​
2631

2732
* **New Features**:​
@@ -52,6 +57,8 @@ Compatibility and Known Limitations
5257

5358
* We do not provide SBSA-compatible aarch64_cu11 packages yet, this will be addressed in an upcoming release.
5459

60+
* Only x86_64 wheels are available on PyPi as of 02/28/25. SBSA/Grace CUDA 12 wheels will be added shortly.
61+
5562
For the full list, see main README on `CV-CUDA GitHub <https://github.com/CVCUDA/CV-CUDA>`_.
5663

5764
License

0 commit comments

Comments
 (0)