CINXE.COM
Welcome to the cuDF documentation! — cudf 24.10.00 documentation
<!DOCTYPE html> <html data-content_root lang="en"><head> <meta charset="utf-8"> <meta content="width=device-width, initial-scale=1.0" name="viewport"><meta content="width=device-width, initial-scale=1" name="viewport"> <title>Welcome to the cuDF documentation! — cudf 24.10.00 documentation</title> <script data-cfasync="false"> document.documentElement.dataset.mode = localStorage.getItem("mode") || ""; document.documentElement.dataset.theme = localStorage.getItem("theme") || ""; </script> <!-- Loaded before other Sphinx assets --> <link href="_static/styles/theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet"> <link href="_static/styles/bootstrap.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet"> <link href="_static/styles/pydata-sphinx-theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet"> <link href="_static/vendor/fontawesome/6.5.2/css/all.min.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet"> <link as="font" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2" rel="preload" type="font/woff2"> <link as="font" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" rel="preload" type="font/woff2"> <link as="font" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" rel="preload" type="font/woff2"> <link href="_static/pygments.css?v=fa44fd50" rel="stylesheet" type="text/css"> <link href="_static/copybutton.css?v=76b2166b" rel="stylesheet" type="text/css"> <link href="_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" rel="stylesheet" type="text/css"> <link href="https://docs.rapids.ai/assets/css/custom.css" rel="stylesheet" type="text/css"> <!-- Pre-loaded scripts that we'll load fully later --> <link as="script" href="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b" rel="preload"> <link as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" rel="preload"> <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script> <script data-url_root="#" id="documentation_options" src="_static/documentation_options.js?v=5f784b28"></script> <script src="_static/doctools.js?v=888ff710"></script> <script src="_static/sphinx_highlight.js?v=4825356b"></script> <script src="_static/clipboard.min.js?v=a7894cd8"></script> <script src="_static/copybutton.js?v=4ea706d9"></script> <script defer="defer" src="https://docs.rapids.ai/assets/js/custom.js"></script> <script>DOCUMENTATION_OPTIONS.pagename = 'index';</script> <link href="genindex/" rel="index" title="Index"> <link href="search/" rel="search" title="Search"> <link href="user_guide/" rel="next" title="cuDF User Guide"> <meta content="width=device-width, initial-scale=1" name="viewport"> <meta content="en" name="docsearch:language"> <script id="rapids-selector-pixel-src" src="https://assets.adobedtm.com/5d4962a43b79/814eb6e9b4e1/launch-4bc07f1e0b0b.min.js"></script><link href="/assets/css/custom.css" id="rapids-selector-css" rel="stylesheet"></head> <body data-bs-root-margin="0px 0px -60%" data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-default-mode data-offset="180"> <div class="skip-link d-print-none" id="pst-skip-link"><a href="#main-content">Skip to main content</a></div> <div id="pst-scroll-pixel-helper"></div> <button class="btn rounded-pill" id="pst-back-to-top" type="button"> <i class="fa-solid fa-arrow-up"></i>Back to top</button> <input class="sidebar-toggle" id="pst-primary-sidebar-checkbox" type="checkbox"> <label class="overlay overlay-primary" for="pst-primary-sidebar-checkbox"></label> <input class="sidebar-toggle" id="pst-secondary-sidebar-checkbox" type="checkbox"> <label class="overlay overlay-secondary" for="pst-secondary-sidebar-checkbox"></label> <div class="search-button__wrapper"> <div class="search-button__overlay"></div> <div class="search-button__search-container"> <form action="search/" class="bd-search d-flex align-items-center" method="get"> <i class="fa-solid fa-magnifying-glass"></i> <input aria-label="Search the docs ..." autocapitalize="off" autocomplete="off" autocorrect="off" class="form-control" id="search-input" name="q" placeholder="Search the docs ..." spellcheck="false" type="search"> <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span> </form></div> </div> <div class="pst-async-banner-revealer d-none"> <aside aria-label="Version warning" class="d-none d-print-none" id="bd-header-version-warning"></aside> </div> <header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none"> <div class="bd-header__inner bd-page-width"> <button aria-label="Site navigation" class="pst-navbar-icon sidebar-toggle primary-toggle"> <span class="fa-solid fa-bars"></span> </button> <div class="navbar-header-items__start"> <div class="navbar-item"> <a class="navbar-brand logo" href="#"> <img alt="cudf 24.10.00 documentation - Home" class="logo__image only-light" src="_static/RAPIDS-logo-purple.png"> <script>document.write(`<img src="_static/RAPIDS-logo-purple.png" class="logo__image only-dark" alt="cudf 24.10.00 documentation - Home"/>`);</script> </a></div> </div> <div class="navbar-header-items"> <div class="ms-auto navbar-header-items__center"> <div class="navbar-item"> <nav> <ul class="bd-navbar-elements navbar-nav"> <li class="nav-item"> <a class="nav-link nav-internal" href="user_guide/"> cuDF User Guide </a> </li> <li class="nav-item"> <a class="nav-link nav-internal" href="cudf_pandas/"> cudf.pandas </a> </li> <li class="nav-item"> <a class="nav-link nav-internal" href="cudf_polars/"> Polars GPU engine </a> </li> <li class="nav-item"> <a class="nav-link nav-internal" href="libcudf_docs/"> libcudf documentation </a> </li> <li class="nav-item"> <a class="nav-link nav-internal" href="developer_guide/"> Developer Guide </a> </li> </ul> </nav></div> </div> <div class="navbar-header-items__end"> <div class="navbar-item navbar-persistent--container"> <script> document.write(` <button class="btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> <i class="fa-solid fa-magnifying-glass"></i> <span class="search-button__default-text">Search</span> <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> </button> `); </script> </div> <div class="navbar-item"> <script> document.write(` <button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip"> <i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i> <i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i> <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i> </button> `); </script></div> <div class="navbar-item"><ul aria-label="Icon Links" class="navbar-icon-links"> <li class="nav-item"> <a class="nav-link pst-navbar-icon" data-bs-placement="bottom" data-bs-toggle="tooltip" href="https://github.com/rapidsai/cudf" rel="noopener" target="_blank" title="GitHub"><i aria-hidden="true" class="fa-brands fa-square-github fa-lg"></i> <span class="sr-only">GitHub</span></a> </li> <li class="nav-item"> <a class="nav-link pst-navbar-icon" data-bs-placement="bottom" data-bs-toggle="tooltip" href="https://twitter.com/rapidsai" rel="noopener" target="_blank" title="Twitter"><i aria-hidden="true" class="fa-brands fa-square-twitter fa-lg"></i> <span class="sr-only">Twitter</span></a> </li> </ul></div> </div> </div> <div class="navbar-persistent--mobile"> <script> document.write(` <button class="btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> <i class="fa-solid fa-magnifying-glass"></i> <span class="search-button__default-text">Search</span> <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> </button> `); </script> </div> <button aria-label="On this page" class="pst-navbar-icon sidebar-toggle secondary-toggle"> <span class="fa-solid fa-outdent"></span> </button> </div> </header> <div class="bd-container"> <div class="bd-container__inner bd-page-width"> <div class="bd-sidebar-primary bd-sidebar hide-on-wide"><div id="rapids-pydata-container"><div class="rapids-home-container"><a class="rapids-home-container__home-btn" href="/api">Home</a></div><div class="rapids-selector__container rapids-selector--hidden"><div class="rapids-selector__selected">cudf</div><div class="rapids-selector__menu"><a class="rapids-selector__menu-item" href="/api/cucim/stable">cucim</a><a class="rapids-selector__menu-item" href="/api/cudf-java/stable">cudf-java</a><a class="rapids-selector__menu-item rapids-selector__menu-item--selected" href="/api/cudf/stable/">cudf</a><a class="rapids-selector__menu-item" href="/api/cugraph/stable">cugraph</a><a class="rapids-selector__menu-item" href="/api/cuml/stable">cuml</a><a class="rapids-selector__menu-item" href="/api/cuproj/stable">cuproj</a><a class="rapids-selector__menu-item" href="/api/cuspatial/stable">cuspatial</a><a class="rapids-selector__menu-item" href="/api/cuvs/stable">cuvs</a><a class="rapids-selector__menu-item" href="/api/cuxfilter/stable">cuxfilter</a><a class="rapids-selector__menu-item" href="/api/dask-cuda/stable">dask-cuda</a><a class="rapids-selector__menu-item" href="/api/dask-cudf/stable">dask-cudf</a><a class="rapids-selector__menu-item" href="/api/kvikio/stable">kvikio</a><a class="rapids-selector__menu-item" href="/api/libcudf/stable/namespacecudf/">libcudf</a><a class="rapids-selector__menu-item" href="/api/libcuml/stable">libcuml</a><a class="rapids-selector__menu-item" href="/api/libcuproj/stable">libcuproj</a><a class="rapids-selector__menu-item" href="/api/libcuspatial/stable">libcuspatial</a><a class="rapids-selector__menu-item" href="/api/libkvikio/stable">libkvikio</a><a class="rapids-selector__menu-item" href="/api/libucxx/stable">libucxx</a><a class="rapids-selector__menu-item" href="/api/raft/stable">raft</a><a class="rapids-selector__menu-item" href="/api/rapids-cmake/stable">rapids-cmake</a><a class="rapids-selector__menu-item" href="/api/rmm/stable">rmm</a></div></div><div class="rapids-selector__container rapids-selector--hidden"><div class="rapids-selector__selected">stable (24.10)</div><div class="rapids-selector__menu"><a class="rapids-selector__menu-item" href="/api/cudf/nightly/">nightly (24.12)</a><a class="rapids-selector__menu-item rapids-selector__menu-item--selected" href="/api/cudf/stable/">stable (24.10)</a><a class="rapids-selector__menu-item" href="/api/cudf/legacy/">legacy (24.08)</a></div></div></div> <div class="sidebar-header-items sidebar-primary__section"> <div class="sidebar-header-items__center"> <div class="navbar-item"> <nav> <ul class="bd-navbar-elements navbar-nav"> <li class="nav-item"> <a class="nav-link nav-internal" href="user_guide/"> cuDF User Guide </a> </li> <li class="nav-item"> <a class="nav-link nav-internal" href="cudf_pandas/"> cudf.pandas </a> </li> <li class="nav-item"> <a class="nav-link nav-internal" href="cudf_polars/"> Polars GPU engine </a> </li> <li class="nav-item"> <a class="nav-link nav-internal" href="libcudf_docs/"> libcudf documentation </a> </li> <li class="nav-item"> <a class="nav-link nav-internal" href="developer_guide/"> Developer Guide </a> </li> </ul> </nav></div> </div> <div class="sidebar-header-items__end"> <div class="navbar-item"> <script> document.write(` <button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip"> <i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i> <i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i> <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i> </button> `); </script></div> <div class="navbar-item"><ul aria-label="Icon Links" class="navbar-icon-links"> <li class="nav-item"> <a class="nav-link pst-navbar-icon" data-bs-placement="bottom" data-bs-toggle="tooltip" href="https://github.com/rapidsai/cudf" rel="noopener" target="_blank" title="GitHub"><i aria-hidden="true" class="fa-brands fa-square-github fa-lg"></i> <span class="sr-only">GitHub</span></a> </li> <li class="nav-item"> <a class="nav-link pst-navbar-icon" data-bs-placement="bottom" data-bs-toggle="tooltip" href="https://twitter.com/rapidsai" rel="noopener" target="_blank" title="Twitter"><i aria-hidden="true" class="fa-brands fa-square-twitter fa-lg"></i> <span class="sr-only">Twitter</span></a> </li> </ul></div> </div> </div> <div class="sidebar-primary-items__end sidebar-primary__section"> </div> <div id="rtd-footer-container"></div> </div> <main class="bd-main" id="main-content" role="main"> <div class="bd-content"> <div class="bd-article-container"> <div class="bd-header-article d-print-none"></div> <div id="searchbox"></div> <article class="bd-article"> <section id="welcome-to-the-cudf-documentation"> <h1>Welcome to the cuDF documentation!<a class="headerlink" href="#welcome-to-the-cudf-documentation" title="Permalink to this heading">#</a></h1> <figure class="align-center"> <a class="reference internal image-reference" href="_images/RAPIDS-logo-purple.png"><img alt="_images/RAPIDS-logo-purple.png" src="_images/RAPIDS-logo-purple.png" style="width: 300px;"></a> </figure> <p><strong>cuDF</strong> (pronounced “KOO-dee-eff”) is a Python GPU DataFrame library (built on the <a class="reference external" href="https://arrow.apache.org/">Apache Arrow</a> columnar memory format) for loading, joining, aggregating, filtering, and otherwise manipulating data. cuDF also provides a pandas-like API that will be familiar to data engineers & data scientists, so they can use it to easily accelerate their workflows without going into the details of CUDA programming.</p> <p><code class="docutils literal notranslate"><span class="pre">cudf.pandas</span></code> is built on cuDF and accelerates pandas code on the GPU. It supports 100% of the pandas API, using the GPU for supported operations, and automatically falling back to pandas for other operations.</p> <figure class="align-center" id="id1"> <a class="reference internal image-reference" href="_images/duckdb-benchmark-groupby-join.png"><img alt="_images/duckdb-benchmark-groupby-join.png" src="_images/duckdb-benchmark-groupby-join.png" style="width: 750px;"></a> <figcaption> <p><span class="caption-text">Results of the <a class="reference external" href="https://duckdblabs.github.io/db-benchmark/">Database-like ops benchmark</a> including <cite>cudf.pandas</cite>. See details <a class="reference external" href="cudf_pandas/benchmarks.html">here</a>.</span><a class="headerlink" href="#id1" title="Permalink to this image">#</a></p> </figcaption> </figure> <div class="toctree-wrapper compound"> <p aria-level="2" class="caption" role="heading"><span class="caption-text">Contents:</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="user_guide/">cuDF User Guide</a></li> <li class="toctree-l1"><a class="reference internal" href="cudf_pandas/">cudf.pandas</a></li> <li class="toctree-l1"><a class="reference internal" href="cudf_polars/">Polars GPU engine</a></li> <li class="toctree-l1"><a class="reference internal" href="libcudf_docs/">libcudf documentation</a></li> <li class="toctree-l1"><a class="reference internal" href="libcudf_docs/#indices-and-tables">Indices and tables</a></li> <li class="toctree-l1"><a class="reference internal" href="developer_guide/">Developer Guide</a></li> </ul> </div> </section> </article> <footer class="prev-next-footer d-print-none"> <div class="prev-next-area"> <a class="right-next" href="user_guide/" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">cuDF User Guide</p> </div> <i class="fa-solid fa-angle-right"></i> </a> </div> </footer> </div> <div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner"> <div class="sidebar-secondary-item"> <div class="tocsection sourcelink"> <a href="_sources/index.rst.txt"> <i class="fa-solid fa-file-lines"></i> Show Source </a> </div> </div> </div></div> </div> <footer class="bd-footer-content"> </footer> </main> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b"></script> <script src="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b"></script> <footer class="bd-footer"> <div class="bd-footer__inner bd-page-width"> <div class="footer-items__start"> <div class="footer-item"> <p class="copyright"> © Copyright 2018-2024, NVIDIA Corporation. <br> </p> </div> <div class="footer-item"> <p class="sphinx-version"> Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.1.2. <br> </p> </div> </div> <div class="footer-items__end"> <div class="footer-item"> <p class="theme-version"> Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.15.4. </p></div> </div> </div> </footer> <script defer id="rapids-selector-js" src="/assets/js/custom.js"></script><script id="rapids-selector-pixel-invocation" type="text/javascript">_satellite.pageBottom();</script></body></html>