Skip to content

Commit e67fcd9

Browse files
author
cuda-python-bot
committed
Deploy doc preview for PR 1461 (a4dcee1)
1 parent 03ea689 commit e67fcd9

94 files changed

Lines changed: 3109 additions & 306 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: ed356455f39504386cccf0da29db052b
3+
config: d6a1d4f8d65a8aad4ea00d7a50261cda
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,22 +75,24 @@ CUDA system information and NVIDIA Management Library (NVML)
7575

7676
system.get_driver_version
7777
system.get_driver_version_full
78+
system.get_driver_branch
7879
system.get_num_devices
7980
system.get_nvml_version
8081
system.get_process_name
8182

8283
:template: autosummary/cyclass.rst
8384

8485
system.Device
86+
system.BAR1MemoryInfo
87+
system.BrandType
8588
system.DeviceArchitecture
89+
system.DeviceAttributes
8690
system.FieldId
8791
system.FieldValue
8892
system.FieldValues
8993
system.MemoryInfo
90-
system.BAR1MemoryInfo
9194
system.PciInfo
9295

93-
9496
.. module:: cuda.core.utils
9597

9698
Utility functions
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
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.BrandType
5+
==========================
6+
7+
.. currentmodule:: cuda.core.system
8+
9+
.. autoclass:: BrandType
10+
11+
12+
13+
14+
15+
16+
17+

docs/pr-preview/pr-1461/cuda-core/latest/_sources/generated/cuda.core.system.Device.rst.txt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,17 @@ cuda.core.system.Device
2727

2828

2929
.. autoattribute:: architecture
30+
.. autoattribute:: attributes
3031
.. autoattribute:: bar1_memory_info
32+
.. autoattribute:: brand
3133
.. autoattribute:: cpu_affinity
3234
.. autoattribute:: cuda_compute_capability
33-
.. autoattribute:: handle
35+
.. autoattribute:: index
36+
.. autoattribute:: is_c2c_mode_enabled
3437
.. autoattribute:: memory_info
3538
.. autoattribute:: name
3639
.. autoattribute:: pci_info
40+
.. autoattribute:: persistence_mode_enabled
3741
.. autoattribute:: serial
3842
.. autoattribute:: uuid
3943

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
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.DeviceAttributes
5+
=================================
6+
7+
.. currentmodule:: cuda.core.system
8+
9+
.. autoclass:: DeviceAttributes
10+
11+
12+
13+
.. rubric:: Methods
14+
15+
16+
.. automethod:: __init__
17+
18+
19+
20+
21+
22+
23+
.. rubric:: Attributes
24+
25+
26+
.. autoattribute:: compute_instance_slice_count
27+
.. autoattribute:: gpu_instance_slice_count
28+
.. autoattribute:: memory_size_mb
29+
.. autoattribute:: multiprocessor_count
30+
.. autoattribute:: shared_copy_engine_count
31+
.. autoattribute:: shared_decoder_count
32+
.. autoattribute:: shared_encoder_count
33+
.. autoattribute:: shared_jpeg_count
34+
.. autoattribute:: shared_ofa_count
35+
36+
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
cuda.core.system.get\_driver\_branch
2+
====================================
3+
4+
.. currentmodule:: cuda.core.system
5+
6+
.. autofunction:: get_driver_branch

docs/pr-preview/pr-1461/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.dev26',
2+
VERSION: '0.5.1.dev28',
33
LANGUAGE: 'en',
44
COLLAPSE_INDEX: false,
55
BUILDER: 'html',

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

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

4545

4646

47-
<script src="_static/documentation_options.js?v=c5c6e5e2"></script>
47+
<script src="_static/documentation_options.js?v=89a4c239"></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.dev26';
56+
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev28';
5757
DOCUMENTATION_OPTIONS.show_version_warning_banner =
5858
false;
5959
</script>
@@ -494,16 +494,19 @@
494494
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.LinkerOptions.html">cuda.core.LinkerOptions</a></li>
495495
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.get_driver_version.html">cuda.core.system.get_driver_version</a></li>
496496
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.get_driver_version_full.html">cuda.core.system.get_driver_version_full</a></li>
497+
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.get_driver_branch.html">cuda.core.system.get_driver_branch</a></li>
497498
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.get_num_devices.html">cuda.core.system.get_num_devices</a></li>
498499
<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>
499500
<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>
500501
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.Device.html">cuda.core.system.Device</a></li>
502+
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.BAR1MemoryInfo.html">cuda.core.system.BAR1MemoryInfo</a></li>
503+
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.BrandType.html">cuda.core.system.BrandType</a></li>
501504
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.DeviceArchitecture.html">cuda.core.system.DeviceArchitecture</a></li>
505+
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.DeviceAttributes.html">cuda.core.system.DeviceAttributes</a></li>
502506
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.FieldId.html">cuda.core.system.FieldId</a></li>
503507
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.FieldValue.html">cuda.core.system.FieldValue</a></li>
504508
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.FieldValues.html">cuda.core.system.FieldValues</a></li>
505509
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.MemoryInfo.html">cuda.core.system.MemoryInfo</a></li>
506-
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.BAR1MemoryInfo.html">cuda.core.system.BAR1MemoryInfo</a></li>
507510
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.PciInfo.html">cuda.core.system.PciInfo</a></li>
508511
<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>
509512
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.utils.StridedMemoryView.html">cuda.core.utils.StridedMemoryView</a></li>
@@ -700,21 +703,33 @@ <h2>CUDA system information and NVIDIA Management Library (NVML)<a class="header
700703
<tr class="row-even"><td><p><a class="reference internal" href="generated/cuda.core.system.get_driver_version_full.html#cuda.core.system.get_driver_version_full" title="cuda.core.system.get_driver_version_full"><code class="xref py py-obj docutils literal notranslate"><span class="pre">system.get_driver_version_full</span></code></a>(bool kernel_mode)</p></td>
701704
<td><p>Get the full driver version.</p></td>
702705
</tr>
703-
<tr class="row-odd"><td><p><a class="reference internal" href="generated/cuda.core.system.get_num_devices.html#cuda.core.system.get_num_devices" title="cuda.core.system.get_num_devices"><code class="xref py py-obj docutils literal notranslate"><span class="pre">system.get_num_devices</span></code></a>()</p></td>
706+
<tr class="row-odd"><td><p><a class="reference internal" href="generated/cuda.core.system.get_driver_branch.html#cuda.core.system.get_driver_branch" title="cuda.core.system.get_driver_branch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">system.get_driver_branch</span></code></a>()</p></td>
707+
<td><p>Retrieves the driver branch of the NVIDIA driver installed on the system.</p></td>
708+
</tr>
709+
<tr class="row-even"><td><p><a class="reference internal" href="generated/cuda.core.system.get_num_devices.html#cuda.core.system.get_num_devices" title="cuda.core.system.get_num_devices"><code class="xref py py-obj docutils literal notranslate"><span class="pre">system.get_num_devices</span></code></a>()</p></td>
704710
<td><p>Return the number of devices in the system.</p></td>
705711
</tr>
706-
<tr class="row-even"><td><p><a class="reference internal" href="generated/cuda.core.system.get_nvml_version.html#cuda.core.system.get_nvml_version" title="cuda.core.system.get_nvml_version"><code class="xref py py-obj docutils literal notranslate"><span class="pre">system.get_nvml_version</span></code></a>()</p></td>
712+
<tr class="row-odd"><td><p><a class="reference internal" href="generated/cuda.core.system.get_nvml_version.html#cuda.core.system.get_nvml_version" title="cuda.core.system.get_nvml_version"><code class="xref py py-obj docutils literal notranslate"><span class="pre">system.get_nvml_version</span></code></a>()</p></td>
707713
<td><p>The version of the NVML library.</p></td>
708714
</tr>
709-
<tr class="row-odd"><td><p><a class="reference internal" href="generated/cuda.core.system.get_process_name.html#cuda.core.system.get_process_name" title="cuda.core.system.get_process_name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">system.get_process_name</span></code></a>(int pid)</p></td>
715+
<tr class="row-even"><td><p><a class="reference internal" href="generated/cuda.core.system.get_process_name.html#cuda.core.system.get_process_name" title="cuda.core.system.get_process_name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">system.get_process_name</span></code></a>(int pid)</p></td>
710716
<td><p>The name of process with given PID.</p></td>
711717
</tr>
712-
<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>
718+
<tr class="row-odd"><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, pci_bus_id)</p></td>
713719
<td><p>Representation of a device.</p></td>
714720
</tr>
715-
<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>
721+
<tr class="row-even"><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>
722+
<td><p>BAR1 Memory allocation information for a device.</p></td>
723+
</tr>
724+
<tr class="row-odd"><td><p><a class="reference internal" href="generated/cuda.core.system.BrandType.html#cuda.core.system.BrandType" title="cuda.core.system.BrandType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">system.BrandType</span></code></a>(value[, names, module, ...])</p></td>
725+
<td><p>See <cite>nvmlBrandType_t</cite>.</p></td>
726+
</tr>
727+
<tr class="row-even"><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>
716728
<td><p>Device architecture enumeration.</p></td>
717729
</tr>
730+
<tr class="row-odd"><td><p><a class="reference internal" href="generated/cuda.core.system.DeviceAttributes.html#cuda.core.system.DeviceAttributes" title="cuda.core.system.DeviceAttributes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">system.DeviceAttributes</span></code></a>(attributes)</p></td>
731+
<td><p>Various device attributes.</p></td>
732+
</tr>
718733
<tr class="row-even"><td><p><a class="reference internal" href="generated/cuda.core.system.FieldId.html#cuda.core.system.FieldId" title="cuda.core.system.FieldId"><code class="xref py py-obj docutils literal notranslate"><span class="pre">system.FieldId</span></code></a>(value[, names, module, ...])</p></td>
719734
<td><p></p></td>
720735
</tr>
@@ -727,10 +742,7 @@ <h2>CUDA system information and NVIDIA Management Library (NVML)<a class="header
727742
<tr class="row-odd"><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>
728743
<td><p>Memory allocation information for a device.</p></td>
729744
</tr>
730-
<tr class="row-even"><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>
731-
<td><p>BAR1 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.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>
745+
<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>
734746
<td><p>PCI information about a GPU device.</p></td>
735747
</tr>
736748
</tbody>

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

Lines changed: 6 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=c5c6e5e2"></script>
47+
<script src="_static/documentation_options.js?v=89a4c239"></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.dev26';
56+
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev28';
5757
DOCUMENTATION_OPTIONS.show_version_warning_banner =
5858
false;
5959
</script>
@@ -492,16 +492,19 @@
492492
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.LinkerOptions.html">cuda.core.LinkerOptions</a></li>
493493
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.get_driver_version.html">cuda.core.system.get_driver_version</a></li>
494494
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.get_driver_version_full.html">cuda.core.system.get_driver_version_full</a></li>
495+
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.get_driver_branch.html">cuda.core.system.get_driver_branch</a></li>
495496
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.get_num_devices.html">cuda.core.system.get_num_devices</a></li>
496497
<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>
497498
<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>
498499
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.Device.html">cuda.core.system.Device</a></li>
500+
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.BAR1MemoryInfo.html">cuda.core.system.BAR1MemoryInfo</a></li>
501+
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.BrandType.html">cuda.core.system.BrandType</a></li>
499502
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.DeviceArchitecture.html">cuda.core.system.DeviceArchitecture</a></li>
503+
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.DeviceAttributes.html">cuda.core.system.DeviceAttributes</a></li>
500504
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.FieldId.html">cuda.core.system.FieldId</a></li>
501505
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.FieldValue.html">cuda.core.system.FieldValue</a></li>
502506
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.FieldValues.html">cuda.core.system.FieldValues</a></li>
503507
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.MemoryInfo.html">cuda.core.system.MemoryInfo</a></li>
504-
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.BAR1MemoryInfo.html">cuda.core.system.BAR1MemoryInfo</a></li>
505508
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.system.PciInfo.html">cuda.core.system.PciInfo</a></li>
506509
<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>
507510
<li class="toctree-l2"><a class="reference internal" href="generated/cuda.core.utils.StridedMemoryView.html">cuda.core.utils.StridedMemoryView</a></li>

0 commit comments

Comments
 (0)