Skip to content

Commit 7c2526d

Browse files
author
cuda-python-bot
committed
Deploy doc preview for PR 1316 (f5dc2db)
1 parent 409a6cc commit 7c2526d

90 files changed

Lines changed: 3989 additions & 264 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.
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: 720f850aee4da49e33627498755e4bb9
3+
config: 8dc718944e33f87188ab5dbb11ff09aa
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,10 @@ CUDA system information and NVIDIA Management Library (NVML)
7979
:template: autosummary/cyclass.rst
8080

8181
system.Device
82+
system.DeviceArchitecture
83+
system.MemoryInfo
84+
system.BAR1MemoryInfo
85+
system.PciInfo
8286

8387

8488
.. module:: cuda.core.utils
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
.. SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
.. SPDX-License-Identifier: Apache-2.0
3+
4+
cuda.core.system.BAR1MemoryInfo
5+
===============================
6+
7+
.. currentmodule:: cuda.core.system
8+
9+
.. autoclass:: BAR1MemoryInfo
10+
11+
12+
13+
14+
.. autoattribute:: free
15+
.. autoattribute:: reserved
16+
.. autoattribute:: total
17+
.. autoattribute:: used
18+
19+
20+
21+
22+
23+
.. rubric:: Methods
24+
25+
26+
.. automethod:: __init__
27+
28+
29+
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
.. SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
.. SPDX-License-Identifier: Apache-2.0
3+
4+
cuda.core.system.DeviceArchitecture
5+
===================================
6+
7+
.. currentmodule:: cuda.core.system
8+
9+
.. autoclass:: DeviceArchitecture
10+
11+
12+
13+
14+
.. autoattribute:: id
15+
.. autoattribute:: name
16+
17+
18+
19+
20+
21+
.. rubric:: Methods
22+
23+
24+
.. automethod:: __init__
25+
26+
27+
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
.. SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
.. SPDX-License-Identifier: Apache-2.0
3+
4+
cuda.core.system.MemoryInfo
5+
===========================
6+
7+
.. currentmodule:: cuda.core.system
8+
9+
.. autoclass:: MemoryInfo
10+
11+
12+
13+
14+
.. autoattribute:: free
15+
.. autoattribute:: reserved
16+
.. autoattribute:: total
17+
.. autoattribute:: used
18+
19+
20+
21+
22+
23+
.. rubric:: Methods
24+
25+
26+
.. automethod:: __init__
27+
28+
29+
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
.. SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
.. SPDX-License-Identifier: Apache-2.0
3+
4+
cuda.core.system.PciInfo
5+
========================
6+
7+
.. currentmodule:: cuda.core.system
8+
9+
.. autoclass:: PciInfo
10+
11+
12+
13+
14+
.. autoattribute:: bus
15+
.. autoattribute:: bus_id
16+
.. autoattribute:: device
17+
.. autoattribute:: device_id
18+
.. autoattribute:: domain
19+
.. autoattribute:: vendor_id
20+
21+
22+
23+
24+
25+
.. rubric:: Methods
26+
27+
28+
.. automethod:: __init__
29+
30+
31+

docs/pr-preview/pr-1316/cuda-core/latest/_sources/index.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ Welcome to the documentation for ``cuda.core``.
1515
interoperability
1616
api
1717
contribute
18-
developer-guide
1918

2019
.. toctree::
2120
:maxdepth: 1
2221

22+
developer-guide
2323
conduct
2424
license
2525

docs/pr-preview/pr-1316/cuda-core/latest/_static/documentation_options.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const DOCUMENTATION_OPTIONS = {
2-
VERSION: '0.5.1.dev34',
2+
VERSION: '0.5.1.dev38',
33
LANGUAGE: 'en',
44
COLLAPSE_INDEX: false,
55
BUILDER: 'html',

docs/pr-preview/pr-1316/cuda-core/latest/api.html

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444

4545

4646

47-
<script src="_static/documentation_options.js?v=32893bd5"></script>
47+
<script src="_static/documentation_options.js?v=ed6b127d"></script>
4848
<script src="_static/doctools.js?v=9bcbadda"></script>
4949
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
5050
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
@@ -53,7 +53,7 @@
5353
<script>
5454
DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
5555
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://nvidia.github.io/cuda-python/cuda-core/nv-versions.json';
56-
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev34';
56+
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev38';
5757
DOCUMENTATION_OPTIONS.show_version_warning_banner =
5858
false;
5959
</script>
@@ -512,14 +512,18 @@
512512
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.get_nvml_version.html">cuda.core.system.get_nvml_version</a></li>
513513
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.get_process_name.html">cuda.core.system.get_process_name</a></li>
514514
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.Device.html">cuda.core.system.Device</a></li>
515+
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.DeviceArchitecture.html">cuda.core.system.DeviceArchitecture</a></li>
516+
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.MemoryInfo.html">cuda.core.system.MemoryInfo</a></li>
517+
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.BAR1MemoryInfo.html">cuda.core.system.BAR1MemoryInfo</a></li>
518+
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.PciInfo.html">cuda.core.system.PciInfo</a></li>
515519
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.utils.args_viewable_as_strided_memory.html">cuda.core.utils.args_viewable_as_strided_memory</a></li>
516520
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.utils.StridedMemoryView.html">cuda.core.utils.StridedMemoryView</a></li>
517521
</ul>
518522
</details></li>
519523
<li class="toctree-l1"><a class="reference internal" href="contribute.html">Contributing</a></li>
520-
<li class="toctree-l1"><a class="reference internal" href="developer-guide.html">CUDA Core Developer Guide</a></li>
521524
</ul>
522525
<ul class="nav bd-sidenav">
526+
<li class="toctree-l1"><a class="reference internal" href="developer-guide.html">CUDA Core Developer Guide</a></li>
523527
<li class="toctree-l1"><a class="reference internal" href="conduct.html">Code of Conduct</a></li>
524528
<li class="toctree-l1"><a class="reference internal" href="license.html">Software License Agreement</a></li>
525529
</ul>
@@ -720,6 +724,18 @@ <h2>CUDA system information and NVIDIA Management Library (NVML)<a class="header
720724
<tr class="row-even"><td><p><a class="reference internal" href="generated/cuda.core.system.Device.html#cuda.core.system.Device" title="cuda.core.system.Device"><code class="xref py py-obj docutils literal notranslate"><span class="pre">system.Device</span></code></a>(int index, uuid)</p></td>
721725
<td><p>Representation of a device.</p></td>
722726
</tr>
727+
<tr class="row-odd"><td><p><a class="reference internal" href="generated/cuda.core.system.DeviceArchitecture.html#cuda.core.system.DeviceArchitecture" title="cuda.core.system.DeviceArchitecture"><code class="xref py py-obj docutils literal notranslate"><span class="pre">system.DeviceArchitecture</span></code></a>(architecture)</p></td>
728+
<td><p>Device architecture enumeration.</p></td>
729+
</tr>
730+
<tr class="row-even"><td><p><a class="reference internal" href="generated/cuda.core.system.MemoryInfo.html#cuda.core.system.MemoryInfo" title="cuda.core.system.MemoryInfo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">system.MemoryInfo</span></code></a>(memory_info)</p></td>
731+
<td><p>Memory allocation information for a device.</p></td>
732+
</tr>
733+
<tr class="row-odd"><td><p><a class="reference internal" href="generated/cuda.core.system.BAR1MemoryInfo.html#cuda.core.system.BAR1MemoryInfo" title="cuda.core.system.BAR1MemoryInfo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">system.BAR1MemoryInfo</span></code></a>(memory_info)</p></td>
734+
<td><p>BAR1 Memory allocation information for a device.</p></td>
735+
</tr>
736+
<tr class="row-even"><td><p><a class="reference internal" href="generated/cuda.core.system.PciInfo.html#cuda.core.system.PciInfo" title="cuda.core.system.PciInfo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">system.PciInfo</span></code></a>(pci_info)</p></td>
737+
<td><p>PCI information about a GPU device.</p></td>
738+
</tr>
723739
</tbody>
724740
</table>
725741
</div>

docs/pr-preview/pr-1316/cuda-core/latest/api_private.html

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444

4545

4646

47-
<script src="_static/documentation_options.js?v=32893bd5"></script>
47+
<script src="_static/documentation_options.js?v=ed6b127d"></script>
4848
<script src="_static/doctools.js?v=9bcbadda"></script>
4949
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
5050
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
@@ -53,7 +53,7 @@
5353
<script>
5454
DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
5555
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://nvidia.github.io/cuda-python/cuda-core/nv-versions.json';
56-
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev34';
56+
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev38';
5757
DOCUMENTATION_OPTIONS.show_version_warning_banner =
5858
false;
5959
</script>
@@ -510,14 +510,18 @@
510510
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.get_nvml_version.html">cuda.core.system.get_nvml_version</a></li>
511511
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.get_process_name.html">cuda.core.system.get_process_name</a></li>
512512
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.Device.html">cuda.core.system.Device</a></li>
513+
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.DeviceArchitecture.html">cuda.core.system.DeviceArchitecture</a></li>
514+
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.MemoryInfo.html">cuda.core.system.MemoryInfo</a></li>
515+
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.BAR1MemoryInfo.html">cuda.core.system.BAR1MemoryInfo</a></li>
516+
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.PciInfo.html">cuda.core.system.PciInfo</a></li>
513517
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.utils.args_viewable_as_strided_memory.html">cuda.core.utils.args_viewable_as_strided_memory</a></li>
514518
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.utils.StridedMemoryView.html">cuda.core.utils.StridedMemoryView</a></li>
515519
</ul>
516520
</details></li>
517521
<li class="toctree-l1"><a class="reference internal" href="contribute.html">Contributing</a></li>
518-
<li class="toctree-l1"><a class="reference internal" href="developer-guide.html">CUDA Core Developer Guide</a></li>
519522
</ul>
520523
<ul class="nav bd-sidenav">
524+
<li class="toctree-l1"><a class="reference internal" href="developer-guide.html">CUDA Core Developer Guide</a></li>
521525
<li class="toctree-l1"><a class="reference internal" href="conduct.html">Code of Conduct</a></li>
522526
<li class="toctree-l1"><a class="reference internal" href="license.html">Software License Agreement</a></li>
523527
</ul>

0 commit comments

Comments
 (0)