Skip to content

Commit d7a354d

Browse files
committed
Update docs to CTK 11.5
1 parent bef50a4 commit d7a354d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+70086
-28
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,6 @@ instance/
7777
.scrapy
7878

7979
# Sphinx documentation
80-
docs/_build/
8180
docs_src/_build/
8281

8382
# PyBuilder

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ argument to setup.py.
2828
You can use
2929

3030
```
31-
python setup.py develop
31+
pip install -e .
3232
```
3333

34-
to use the module in-place in your current Python environment (e.g. for testing
35-
of porting other libraries to use the binding).
34+
to install the module as editible in your current Python environment (e.g. for
35+
testing of porting other libraries to use the binding).
3636

3737

3838
### Build the Docs

docs/.buildinfo

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 77fb703d8f26e7cf3b0ab2a9bf1616cd
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/.nojekyll

Whitespace-only changes.
332 KB
Loading

docs/_sources/api.rst.txt

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
-------------------------
2+
CUDA Python API Reference
3+
-------------------------
4+
5+
cuda
6+
----
7+
.. automodule:: cuda.cuda
8+
:members:
9+
10+
cudart
11+
------
12+
.. automodule:: cuda.cudart
13+
:members:
14+
15+
nvrtc
16+
-----
17+
.. automodule:: cuda.nvrtc
18+
:members:

docs/_sources/conduct.md.txt

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Code of Conduct
2+
3+
## Overview
4+
5+
Define the code of conduct followed and enforced for the CUDA Python project.
6+
7+
## Our Pledge
8+
9+
In the interest of fostering an open and welcoming environment, we as
10+
contributors and maintainers pledge to making participation in our project and
11+
our community a harassment-free experience for everyone, regardless of age, body
12+
size, disability, ethnicity, sex characteristics, gender identity and expression,
13+
level of experience, education, socio-economic status, nationality, personal
14+
appearance, race, religion, or sexual identity and orientation.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to creating a positive environment
19+
include:
20+
21+
* Using welcoming and inclusive language
22+
* Being respectful of differing viewpoints and experiences
23+
* Gracefully accepting constructive criticism
24+
* Focusing on what is best for the community
25+
* Showing empathy towards other community members
26+
27+
Examples of unacceptable behavior by participants include:
28+
29+
* The use of sexualized language or imagery and unwelcome sexual attention or
30+
advances
31+
* Trolling, insulting/derogatory comments, and personal or political attacks
32+
* Public or private harassment
33+
* Publishing others' private information, such as a physical or electronic
34+
address, without explicit permission
35+
* Other conduct which could reasonably be considered inappropriate in a
36+
professional setting
37+
38+
## Our Responsibilities
39+
40+
Project maintainers are responsible for clarifying the standards of acceptable
41+
behavior and are expected to take appropriate and fair corrective action in
42+
response to any instances of unacceptable behavior.
43+
44+
Project maintainers have the right and responsibility to remove, edit, or
45+
reject comments, commits, code, wiki edits, issues, and other contributions
46+
that are not aligned to this Code of Conduct, or to ban temporarily or
47+
permanently any contributor for other behaviors that they deem inappropriate,
48+
threatening, offensive, or harmful.
49+
50+
## Scope
51+
52+
This Code of Conduct applies both within project spaces and in public spaces
53+
when an individual is representing the project or its community. Examples of
54+
representing a project or community include using an official project e-mail
55+
address, posting via an official social media account, or acting as an appointed
56+
representative at an online or offline event. Representation of a project may be
57+
further defined and clarified by project maintainers.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported by contacting the project team at
63+
64+
complaints will be reviewed and investigated and will result in a response that
65+
is deemed necessary and appropriate to the circumstances. The project team is
66+
obligated to maintain confidentiality with regard to the reporter of an
67+
incident. Further details of specific enforcement policies may be posted
68+
separately.
69+
70+
Project maintainers who do not follow or enforce the Code of Conduct in good
71+
faith may face temporary or permanent repercussions as determined by other
72+
members of the project's leadership.
73+
74+
## Attribution
75+
76+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
77+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
78+
79+
[homepage]: https://www.contributor-covenant.org
80+
81+
For answers to common questions about this code of conduct, see
82+
https://www.contributor-covenant.org/faq

docs/_sources/contribute.md.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing to CUDA Python! Based on the type of contribution, it will fall into two categories:
4+
5+
1. You want to report a bug, feature request, or documentation issue
6+
- File an [issue](https://github.com/NVIDIA/cuda-python/issues/new)
7+
describing what you encountered or what you want to see changed.
8+
- The NVIDIA team will evaluate the issues and triage them, scheduling
9+
them for a release. If you believe the issue needs priority attention
10+
comment on the issue to notify the team.
11+
2. You want to implement a feature or bug-fix
12+
- At this time we do not accept code contributions.

docs/_sources/index.rst.txt

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
.. CUDA Python documentation master file, created by
2+
sphinx-quickstart on Wed Jul 7 12:14:05 2021.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
CUDA Python Manual
7+
=======================================
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
:caption: Contents:
12+
13+
install.md
14+
overview.md
15+
motivation.md
16+
conduct.md
17+
contribute.md
18+
release.md
19+
api.rst
20+
21+
22+
23+
Indices and tables
24+
==================
25+
26+
* :ref:`genindex`
27+
* :ref:`modindex`
28+
* :ref:`search`

docs/_sources/install.md.txt

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Installation
2+
3+
## Requirements
4+
5+
CUDA Python is supported on all platforms that CUDA is supported. Specific
6+
dependencies are as follows:
7+
8+
* Driver: Linux (450.80.02 or later) Windows(456.38 or later)
9+
* CUDA Toolkit 11.0 to 11.5
10+
11+
```{note} Only the NVRTC redistributable component is required from the CUDA Toolkit. [CUDA Toolkit Documentation](https://docs.nvidia.com/cuda/index.html) Installation Guides can be used for guidance. Note that the NVRTC component in the Toolkit can be obtained via PiPy, Conda or Local Installer.
12+
```
13+
14+
## Installing from PyPI
15+
16+
```{code-block} shell
17+
pip install cuda-python
18+
```
19+
20+
## Installing from Conda
21+
22+
```{code-block} shell
23+
conda install cuda-python
24+
```
25+
26+
## Installing from Source
27+
28+
### Requirements
29+
30+
Building dependencies:
31+
* cython>=0.29.24
32+
33+
Unit-test dependencies:
34+
* pytest>=6.2.4
35+
* pytest-benchmark>=3.4.1
36+
* numpy>=1.21.1
37+
38+
Latest list of dependencies can be found at [requirements.txt](https://github.com/NVIDIA/cuda-python/blob/main/requirements.txt)
39+
40+
### In-place
41+
42+
To compile the extension in-place, run:
43+
44+
```{code-block} shell
45+
python setup.py build_ext --inplace
46+
```
47+
48+
To compile for debugging the extension modules with gdb, pass the `--debug`
49+
argument to setup.py.
50+
51+
### Develop
52+
53+
You can use
54+
55+
```{code-block} shell
56+
pip install -e .
57+
```
58+
59+
to install the module as editible in your current Python environment (e.g. for
60+
testing of porting other libraries to use the binding).
61+
62+
## Build the Docs
63+
64+
```{code-block} shell
65+
conda env create -f docs_src/environment-docs.yml
66+
conda activate cuda-python-docs
67+
```
68+
Then compile and install `cuda-python` following the steps above.
69+
70+
```{code-block} shell
71+
cd docs_src
72+
make html
73+
open build/html/index.html
74+
```
75+
76+
### Publish the Docs
77+
78+
```{code-block} shell
79+
git checkout gh-pages
80+
cd docs_src
81+
make html
82+
cp -a build/html/. ../docs/
83+
```

docs/_sources/motivation.md.txt

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Motivation
2+
## What is CUDA Python?
3+
4+
NVIDIA’s CUDA Python provides [Cython](https://cython.org/) bindings and Python
5+
wrappers for the driver and runtime API for existing toolkits and libraries to
6+
simplify GPU-based accelerated processing. Python is one of the most popular
7+
programming languages for science, engineering, data analytics, and deep
8+
learning applications. The goal of CUDA Python is to unify
9+
the Python ecosystem with a single set of interfaces that provide full coverage
10+
of and access to the CUDA host APIs from Python.
11+
12+
## Why CUDA Python?
13+
14+
CUDA Python provides uniform APIs and bindings for inclusion into existing
15+
toolkits and libraries to simplify GPU-based parallel processing for HPC, data
16+
science, and AI.
17+
18+
[Numba](https://numpy.org/), a Python compiler from
19+
[Anaconda](https://www.anaconda.com/) that can compile Python code for execution
20+
on CUDA-capable GPUs, provides Python developers with an easy entry into
21+
GPU-accelerated computing and a path for using increasingly sophisticated CUDA
22+
code with a minimum of new syntax and jargon. Numba has its own CUDA driver API
23+
bindings that can now be replaced with CUDA Python. With CUDA Python and Numba,
24+
you get the best of both worlds: rapid iterative development with Python and the
25+
speed of a compiled language targeting both CPUs and NVIDIA GPUs.
26+
27+
[CuPy](https://cupy.dev/) is a
28+
[NumPy](https://numpy.org/)/[SciPy](https://www.scipy.org/) compatible Array
29+
library, from [Preferred Networks](https://www.preferred.jp/en/), for
30+
GPU-accelerated computing with Python. CUDA Python simplifies the CuPy build
31+
and allows for a faster and smaller memory footprint when importing the CuPy
32+
Python module. In the future, when more CUDA Toolkit libraries are supported,
33+
CuPy will have a lighter maintenance overhead and have fewer wheels to
34+
release. Users benefit from a faster CUDA runtime!
35+
36+
Our goal is to help unify the Python CUDA ecosystem with a single standard set
37+
of interfaces, providing full coverage of, and access to, the CUDA host APIs
38+
from Python. We want to provide a foundation for the ecosystem to build on top
39+
of in unison to allow composing different accelerated libraries together to
40+
solve the problems at hand. We also want to lower the barrier to entry for
41+
Python developers to utilize NVIDIA GPUs.

0 commit comments

Comments
 (0)