<html class="no-js">

<head><meta charset="utf-8"/>

<meta name="viewport" content="width=device-width,initial-scale=1"/>

<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="cuda" href="module/cuda.html" /><link rel="prev" title="CUDA Python 11.4.0 Release notes" href="release/11.4.0-notes.html" />

<meta name="generator" content="sphinx-4.2.0, furo 2021.10.09"/>

<title>CUDA Python API Reference - CUDA Python 11.6.0 documentation</title>

<link rel="stylesheet" type="text/css" href="_static/pygments.css" />

<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=0254c309f5cadf746f1a613e7677379ac9c8cdcd" />

<link rel="stylesheet" type="text/css" href="_static/togglebutton.css" />

<link rel="stylesheet" type="text/css" href="_static/mystnb.css" />

<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=16fb25fabf47304eee183a5e9af80b1ba98259b1" />

body {

--color-code-background: #f8f8f8;

--color-code-foreground: black;

}

body[data-theme="dark"] {

--color-code-background: #202020;

--color-code-foreground: #d0d0d0;

}

@media (prefers-color-scheme: dark) {

body:not([data-theme="light"]) {

--color-code-background: #202020;

--color-code-foreground: #d0d0d0;

}

}

<body>

<script>

document.body.dataset.theme = localStorage.getItem("theme") || "auto";

</script>

<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">

<symbol id="svg-toc" viewBox="0 0 24 24">

<title>Contents</title>

<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor"

stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round">

<path stroke="none" d="M0 0h24v24H0z" />

<line x1="4" y1="6" x2="20" y2="6" />

<line x1="10" y1="12" x2="20" y2="12" />

<line x1="6" y1="18" x2="20" y2="18" />

</svg>

</symbol>

<symbol id="svg-menu" viewBox="0 0 24 24">

<title>Menu</title>

<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor"

stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">

<line x1="3" y1="12" x2="21" y2="12"></line>

<line x1="3" y1="6" x2="21" y2="6"></line>

<line x1="3" y1="18" x2="21" y2="18"></line>

</svg>

</symbol>

<symbol id="svg-arrow-right" viewBox="0 0 24 24">

<title>Expand</title>

<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor"

stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">

<polyline points="9 18 15 12 9 6"></polyline>

</svg>

</symbol>

<symbol id="svg-sun" viewBox="0 0 24 24">

<title>Light mode</title>

<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor"

stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">

<circle cx="12" cy="12" r="5"></circle>

<line x1="12" y1="1" x2="12" y2="3"></line>

<line x1="12" y1="21" x2="12" y2="23"></line>

<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>

<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>

<line x1="1" y1="12" x2="3" y2="12"></line>

<line x1="21" y1="12" x2="23" y2="12"></line>

<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>

<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>

</svg>

</symbol>

<symbol id="svg-moon" viewBox="0 0 24 24">

<title>Dark mode</title>

<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor"

stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">

<path stroke="none" d="M0 0h24v24H0z" fill="none" />

<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />

</svg>

</symbol>

<symbol id="svg-sun-half" viewBox="0 0 24 24">

<title>Auto light/dark mode</title>

<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor"

stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">

<path stroke="none" d="M0 0h24v24H0z" fill="none"/>

<circle cx="12" cy="12" r="9" />

<path d="M13 12h5" />

<path d="M13 15h4" />

<path d="M13 18h1" />

<path d="M13 9h4" />

<path d="M13 6h1" />

</svg>

</symbol>

<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">

<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">

<label class="overlay sidebar-overlay" for="__navigation">

<div class="visually-hidden">Hide navigation sidebar</div>

<label class="overlay toc-overlay" for="__toc">

<div class="visually-hidden">Hide table of contents sidebar</div>

<div class="page">

<header class="mobile-header">

<div class="header-left">

<label class="nav-overlay-icon" for="__navigation">

<div class="visually-hidden">Toggle site navigation sidebar</div>

<i class="icon"><svg><use href="#svg-menu"></use></svg></i>

</label>

</div>

<div class="header-center">

<a href="index.html"><div class="brand">CUDA Python 11.6.0 documentation</div></a>

</div>

<div class="header-right">

<div class="theme-toggle-container theme-toggle-header">

<button class="theme-toggle">

<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>

<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>

<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>

<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>

</button>

</div>

<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">

<div class="visually-hidden">Toggle table of contents sidebar</div>

<i class="icon"><svg><use href="#svg-toc"></use></svg></i>

</label>

</div>

</header>

<aside class="sidebar-drawer">

<div class="sidebar-container">

<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">

<div class="sidebar-logo-container">

<img class="sidebar-logo only-light" src="_static/logo-light-mode.png" alt="Light Logo"/>

<img class="sidebar-logo only-dark" src="_static/logo-dark-mode.png" alt="Dark Logo"/>

</div>

<span class="sidebar-brand-text">CUDA Python 11.6.0 documentation</span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">

<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

<input type="hidden" name="check_keywords" value="yes">

<input type="hidden" name="area" value="default">

<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">

<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>

<ul class="current">

<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>

<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>

<li class="toctree-l1"><a class="reference internal" href="motivation.html">Motivation</a></li>

<li class="toctree-l1"><a class="reference internal" href="conduct.html">Code of Conduct</a></li>

<li class="toctree-l1"><a class="reference internal" href="contribute.html">Contributing</a></li>

<li class="toctree-l1 has-children"><a class="reference internal" href="release.html">Release Notes</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>

<li class="toctree-l2"><a class="reference internal" href="release/11.6.0-notes.html"> 11.6.0</a></li>

<li class="toctree-l2"><a class="reference internal" href="release/11.5.0-notes.html"> 11.5.0</a></li>

<li class="toctree-l2"><a class="reference internal" href="release/11.4.0-notes.html"> 11.4.0</a></li>

<li class="toctree-l1 current has-children current-page"><a class="current reference internal" href="#">CUDA Python API Reference</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html">cuda</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html">cudart</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/nvrtc.html">nvrtc</a></li>

</div>

</div>

</aside>

<div class="main">

<div class="content">

<div class="article-container">

<div class="content-icon-container">

<div class="theme-toggle-container theme-toggle-content">

<button class="theme-toggle">

<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>

<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>

<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>

<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>

</button>

</div>

<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">

<div class="visually-hidden">Toggle table of contents sidebar</div>

<i class="icon"><svg><use href="#svg-toc"></use></svg></i>

</label>

</div>

<article role="main">

<div class="section" id="cuda-python-api-reference">

<h1>CUDA Python API Reference<a class="headerlink" href="#cuda-python-api-reference" title="Permalink to this headline">¶</a></h1>

<div class="toctree-wrapper compound">

<p class="caption" role="heading"><span class="caption-text">CaptionHolder:</span></p>

<li class="toctree-l1"><a class="reference internal" href="module/cuda.html">cuda</a><ul>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#data-types-used-by-cuda-driver">Data types used by CUDA driver</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#error-handling">Error Handling</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#initialization">Initialization</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#version-management">Version Management</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#device-management">Device Management</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#primary-context-management">Primary Context Management</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#context-management">Context Management</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#module-management">Module Management</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#memory-management">Memory Management</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#virtual-memory-management">Virtual Memory Management</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#stream-ordered-memory-allocator">Stream Ordered Memory Allocator</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#unified-addressing">Unified Addressing</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#stream-management">Stream Management</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#event-management">Event Management</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#external-resource-interoperability">External Resource Interoperability</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#stream-memory-operations">Stream memory operations</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#execution-control">Execution Control</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#graph-management">Graph Management</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#occupancy">Occupancy</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#texture-object-management">Texture Object Management</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#surface-object-management">Surface Object Management</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#peer-context-memory-access">Peer Context Memory Access</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#graphics-interoperability">Graphics Interoperability</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#driver-entry-point-access">Driver Entry Point Access</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#egl-interoperability">EGL Interoperability</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#opengl-interoperability">OpenGL Interoperability</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#profiler-control">Profiler Control</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cuda.html#vdpau-interoperability">VDPAU Interoperability</a></li>

<li class="toctree-l1"><a class="reference internal" href="module/cudart.html">cudart</a><ul>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#profiler-control">Profiler Control</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#device-management">Device Management</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#error-handling">Error Handling</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#stream-management">Stream Management</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#event-management">Event Management</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#external-resource-interoperability">External Resource Interoperability</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#execution-control">Execution Control</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#occupancy">Occupancy</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#memory-management">Memory Management</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#stream-ordered-memory-allocator">Stream Ordered Memory Allocator</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#unified-addressing">Unified Addressing</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#peer-device-memory-access">Peer Device Memory Access</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#opengl-interoperability">OpenGL Interoperability</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#direct3d-9-interoperability">Direct3D 9 Interoperability</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#direct3d-10-interoperability">Direct3D 10 Interoperability</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#direct3d-11-interoperability">Direct3D 11 Interoperability</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#vdpau-interoperability">VDPAU Interoperability</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#egl-interoperability">EGL Interoperability</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#graphics-interoperability">Graphics Interoperability</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#texture-object-management">Texture Object Management</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#surface-object-management">Surface Object Management</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#version-management">Version Management</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#graph-management">Graph Management</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#driver-entry-point-access">Driver Entry Point Access</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#c-api-routines">C++ API Routines</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#interactions-with-the-cuda-driver-api">Interactions with the CUDA Driver API</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/cudart.html#data-types-used-by-cuda-runtime">Data types used by CUDA Runtime</a></li>

<li class="toctree-l1"><a class="reference internal" href="module/nvrtc.html">nvrtc</a><ul>

<li class="toctree-l2"><a class="reference internal" href="module/nvrtc.html#error-handling">Error Handling</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/nvrtc.html#general-information-query">General Information Query</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/nvrtc.html#compilation">Compilation</a></li>

<li class="toctree-l2"><a class="reference internal" href="module/nvrtc.html#supported-compile-options">Supported Compile Options</a></li>

</article>

</div>

<footer>

<div class="related-pages">

<a class="next-page" href="module/cuda.html">

<div class="page-info">

<div class="context">

<span>Next</span>

</div>

<div class="title">cuda</div>

</div>

<svg><use href="#svg-arrow-right"></use></svg>

</a>

<a class="prev-page" href="release/11.4.0-notes.html">

<svg><use href="#svg-arrow-right"></use></svg>

<div class="page-info">

<div class="context">

<span>Previous</span>

</div>

<div class="title">CUDA Python 11.4.0 Release notes</div>

</div>

</a>

</div>

<div class="related-information">

Copyright &#169; 2021-2022, NVIDIA |

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a>

and

<a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s

<a href="https://github.com/pradyunsg/furo">Furo theme</a>. |

<a class="muted-link" href="_sources/api.rst.txt"

rel="nofollow">

Show Source

</a>

</div>

</footer>

</div>

<aside class="toc-drawer no-toc">

</aside>

</div>

</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

<script src="_static/jquery.js"></script>

<script src="_static/underscore.js"></script>

<script src="_static/doctools.js"></script>

<script src="_static/scripts/main.js"></script>

<script src="_static/togglebutton.js"></script>

<script>var togglebuttonSelector = '.toggle, .admonition.dropdown, .tag_hide_input div.cell_input, .tag_hide-input div.cell_input, .tag_hide_output div.cell_output, .tag_hide-output div.cell_output, .tag_hide_cell.cell, .tag_hide-cell.cell';</script>

</body>