Skip to content

Commit 7974ea2

Browse files
author
cuda-python-bot
committed
Deploy doc preview for PR 1860 (849b1b9)
1 parent bfcaf9e commit 7974ea2

184 files changed

Lines changed: 30991 additions & 1722 deletions

File tree

Some content is hidden

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

‎docs/pr-preview/pr-1860/cuda-core/latest/.buildinfo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 051c14860673727f0e2dcce11e6c40fd
3+
config: a655255173f52cc20ad4d609e06a8d43
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/pr-preview/pr-1860/cuda-core/latest/_sources/api.rst.txt‎

Lines changed: 85 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,48 @@ be considered stable and will follow semantic versioning with appropriate
1313
deprecation periods for breaking changes.
1414

1515

16-
CUDA runtime
17-
------------
16+
Devices and execution
17+
---------------------
1818

1919
.. autosummary::
2020
:toctree: generated/
2121

2222
Device
23-
Graph
24-
GraphBuilder
2523
launch
2624

2725
:template: autosummary/cyclass.rst
2826

29-
Buffer
3027
Stream
3128
Event
29+
30+
:template: dataclass.rst
31+
32+
StreamOptions
33+
EventOptions
34+
LaunchConfig
35+
36+
.. data:: LEGACY_DEFAULT_STREAM
37+
38+
The legacy default CUDA stream. All devices share the same legacy default
39+
stream, and work launched on it is not concurrent with work on any other
40+
stream.
41+
42+
.. data:: PER_THREAD_DEFAULT_STREAM
43+
44+
The per-thread default CUDA stream. Each host thread has its own per-thread
45+
default stream, and work launched on it can execute concurrently with work
46+
on other non-blocking streams.
47+
48+
49+
Memory management
50+
-----------------
51+
52+
.. autosummary::
53+
:toctree: generated/
54+
55+
:template: autosummary/cyclass.rst
56+
57+
Buffer
3258
MemoryResource
3359
DeviceMemoryResource
3460
GraphMemoryResource
@@ -42,24 +68,65 @@ CUDA runtime
4268
DeviceMemoryResourceOptions
4369
PinnedMemoryResourceOptions
4470
ManagedMemoryResourceOptions
45-
EventOptions
46-
GraphCompleteOptions
47-
GraphDebugPrintOptions
48-
StreamOptions
49-
LaunchConfig
5071
VirtualMemoryResourceOptions
5172

52-
.. data:: LEGACY_DEFAULT_STREAM
5373

54-
The legacy default CUDA stream. All devices share the same legacy default
55-
stream, and work launched on it is not concurrent with work on any other
56-
stream.
74+
CUDA graphs
75+
-----------
5776

58-
.. data:: PER_THREAD_DEFAULT_STREAM
77+
A CUDA graph captures a set of GPU operations and their dependencies,
78+
allowing them to be defined once and launched repeatedly with minimal
79+
CPU overhead. Graphs can be constructed in two ways:
80+
:class:`~graph.GraphBuilder` captures operations from a stream, while
81+
:class:`~graph.GraphDef` builds a graph explicitly by adding nodes and
82+
edges. Both produce an executable :class:`~graph.Graph` that can be
83+
launched on a :class:`Stream`.
5984

60-
The per-thread default CUDA stream. Each host thread has its own per-thread
61-
default stream, and work launched on it can execute concurrently with work
62-
on other non-blocking streams.
85+
.. autosummary::
86+
:toctree: generated/
87+
88+
graph.Graph
89+
graph.GraphBuilder
90+
graph.GraphDef
91+
92+
:template: autosummary/cyclass.rst
93+
94+
graph.GraphNode
95+
graph.Condition
96+
97+
:template: dataclass.rst
98+
99+
graph.GraphAllocOptions
100+
graph.GraphCompleteOptions
101+
graph.GraphDebugPrintOptions
102+
103+
Node types
104+
``````````
105+
106+
Every graph node is a subclass of :class:`~graph.GraphNode`, which
107+
provides the common interface (dependencies, successors, destruction).
108+
Each subclass exposes attributes unique to its operation type.
109+
110+
.. autosummary::
111+
:toctree: generated/
112+
113+
:template: autosummary/cyclass.rst
114+
115+
graph.EmptyNode
116+
graph.KernelNode
117+
graph.AllocNode
118+
graph.FreeNode
119+
graph.MemsetNode
120+
graph.MemcpyNode
121+
graph.ChildGraphNode
122+
graph.EventRecordNode
123+
graph.EventWaitNode
124+
graph.HostCallbackNode
125+
graph.ConditionalNode
126+
graph.IfNode
127+
graph.IfElseNode
128+
graph.WhileNode
129+
graph.SwitchNode
63130

64131

65132
CUDA compilation toolchain

‎docs/pr-preview/pr-1860/cuda-core/latest/_sources/api_private.rst.txt‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,15 @@ CUDA runtime
3434
_memory._ipc.IPCBufferDescriptor
3535

3636

37+
CUDA graphs
38+
-----------
39+
40+
.. autosummary::
41+
:toctree: generated/
42+
43+
graph._adjacency_set_proxy.AdjacencySetProxy
44+
45+
3746
CUDA protocols
3847
--------------
3948

‎docs/pr-preview/pr-1860/cuda-core/latest/_sources/generated/cuda.core.GraphCompleteOptions.rst.txt‎

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎docs/pr-preview/pr-1860/cuda-core/latest/_sources/generated/cuda.core.GraphDebugPrintOptions.rst.txt‎

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎docs/pr-preview/pr-1860/cuda-core/latest/_sources/generated/cuda.core.graph.AllocNode.rst.txt‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
.. SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
.. SPDX-License-Identifier: Apache-2.0
3+
4+
cuda.core.graph.AllocNode
5+
=========================
6+
7+
.. currentmodule:: cuda.core.graph
8+
9+
.. autoclass:: AllocNode
10+
11+
12+
13+
.. rubric:: Methods
14+
15+
16+
.. automethod:: __init__
17+
.. automethod:: alloc
18+
.. automethod:: callback
19+
.. automethod:: destroy
20+
.. automethod:: embed
21+
.. automethod:: free
22+
.. automethod:: if_cond
23+
.. automethod:: if_else
24+
.. automethod:: join
25+
.. automethod:: launch
26+
.. automethod:: memcpy
27+
.. automethod:: memset
28+
.. automethod:: record_event
29+
.. automethod:: switch
30+
.. automethod:: wait_event
31+
.. automethod:: while_loop
32+
33+
34+
35+
36+
37+
38+
.. rubric:: Attributes
39+
40+
41+
.. autoattribute:: bytesize
42+
.. autoattribute:: device_id
43+
.. autoattribute:: dptr
44+
.. autoattribute:: graph
45+
.. autoattribute:: handle
46+
.. autoattribute:: is_valid
47+
.. autoattribute:: memory_type
48+
.. autoattribute:: options
49+
.. autoattribute:: peer_access
50+
.. autoattribute:: pred
51+
.. autoattribute:: succ
52+
.. autoattribute:: type
53+
54+

‎docs/pr-preview/pr-1860/cuda-core/latest/_sources/generated/cuda.core.graph.ChildGraphNode.rst.txt‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
.. SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
.. SPDX-License-Identifier: Apache-2.0
3+
4+
cuda.core.graph.ChildGraphNode
5+
==============================
6+
7+
.. currentmodule:: cuda.core.graph
8+
9+
.. autoclass:: ChildGraphNode
10+
11+
12+
13+
.. rubric:: Methods
14+
15+
16+
.. automethod:: __init__
17+
.. automethod:: alloc
18+
.. automethod:: callback
19+
.. automethod:: destroy
20+
.. automethod:: embed
21+
.. automethod:: free
22+
.. automethod:: if_cond
23+
.. automethod:: if_else
24+
.. automethod:: join
25+
.. automethod:: launch
26+
.. automethod:: memcpy
27+
.. automethod:: memset
28+
.. automethod:: record_event
29+
.. automethod:: switch
30+
.. automethod:: wait_event
31+
.. automethod:: while_loop
32+
33+
34+
35+
36+
37+
38+
.. rubric:: Attributes
39+
40+
41+
.. autoattribute:: child_graph
42+
.. autoattribute:: graph
43+
.. autoattribute:: handle
44+
.. autoattribute:: is_valid
45+
.. autoattribute:: pred
46+
.. autoattribute:: succ
47+
.. autoattribute:: type
48+
49+

‎docs/pr-preview/pr-1860/cuda-core/latest/_sources/generated/cuda.core.graph.Condition.rst.txt‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
.. SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
.. SPDX-License-Identifier: Apache-2.0
3+
4+
cuda.core.graph.Condition
5+
=========================
6+
7+
.. currentmodule:: cuda.core.graph
8+
9+
.. autoclass:: Condition
10+
11+
12+
13+
.. rubric:: Methods
14+
15+
16+
.. automethod:: __init__
17+
18+
19+
20+
21+
22+
23+
.. rubric:: Attributes
24+
25+
26+
.. autoattribute:: handle
27+
28+

‎docs/pr-preview/pr-1860/cuda-core/latest/_sources/generated/cuda.core.graph.ConditionalNode.rst.txt‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
.. SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
.. SPDX-License-Identifier: Apache-2.0
3+
4+
cuda.core.graph.ConditionalNode
5+
===============================
6+
7+
.. currentmodule:: cuda.core.graph
8+
9+
.. autoclass:: ConditionalNode
10+
11+
12+
13+
.. rubric:: Methods
14+
15+
16+
.. automethod:: __init__
17+
.. automethod:: alloc
18+
.. automethod:: callback
19+
.. automethod:: destroy
20+
.. automethod:: embed
21+
.. automethod:: free
22+
.. automethod:: if_cond
23+
.. automethod:: if_else
24+
.. automethod:: join
25+
.. automethod:: launch
26+
.. automethod:: memcpy
27+
.. automethod:: memset
28+
.. automethod:: record_event
29+
.. automethod:: switch
30+
.. automethod:: wait_event
31+
.. automethod:: while_loop
32+
33+
34+
35+
36+
37+
38+
.. rubric:: Attributes
39+
40+
41+
.. autoattribute:: branches
42+
.. autoattribute:: cond_type
43+
.. autoattribute:: condition
44+
.. autoattribute:: graph
45+
.. autoattribute:: handle
46+
.. autoattribute:: is_valid
47+
.. autoattribute:: pred
48+
.. autoattribute:: succ
49+
.. autoattribute:: type
50+
51+

0 commit comments

Comments
 (0)