CINXE.COM
Welcome to cuML’s documentation! — cuml 25.02.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 cuML’s documentation! — cuml 25.02.00 documentation</title> <script data-cfasync="false"> document.documentElement.dataset.mode = localStorage.getItem("mode") || ""; document.documentElement.dataset.theme = localStorage.getItem("theme") || ""; </script> <!-- this give us a css class that will be invisible only if js is disabled --> <noscript> <style> .pst-js-only { display: none !important; } </style> </noscript> <!-- Loaded before other Sphinx assets --> <link href="_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet"> <link href="_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet"> <link href="_static/pygments.css?v=03e43079" rel="stylesheet" type="text/css"> <link href="_static/copybutton.css?v=76b2166b" rel="stylesheet" type="text/css"> <link href="_static/references.css?v=61e7cc0b" rel="stylesheet" type="text/css"> <link href="https://docs.rapids.ai/assets/css/custom.css" rel="stylesheet" type="text/css"> <!-- So that users can add custom icons --> <script src="_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script> <!-- Pre-loaded scripts that we'll load fully later --> <link as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" rel="preload"> <link as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" rel="preload"> <script src="_static/documentation_options.js?v=665464d6"></script> <script src="_static/doctools.js?v=9bcbadda"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <script src="_static/clipboard.min.js?v=a7894cd8"></script> <script src="_static/copybutton.js?v=f281be69"></script> <script defer="defer" src="https://docs.rapids.ai/assets/js/custom.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script>window.MathJax = {"tex": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true}, "options": {"ignoreHtmlClass": "tex2jax_ignore|mathjax_ignore|document", "processHtmlClass": "tex2jax_process|mathjax_process|math|output_area"}}</script> <script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script> <script>DOCUMENTATION_OPTIONS.pagename = 'index';</script> <link href="genindex/" rel="index" title="Index"> <link href="search/" rel="search" title="Search"> <link href="cuml_intro/" rel="next" title="Introduction"> <meta content="width=device-width, initial-scale=1" name="viewport"> <meta content="en" name="docsearch:language"> <meta content="25.02" name="docsearch:version"> <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> <dialog id="pst-search-dialog"> <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" 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> </dialog> <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="#"> <p class="title logo__title">cuml 25.02.00 documentation</p> </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="cuml_intro/"> Introduction </a> </li> <li class="nav-item"> <a class="nav-link nav-internal" href="api/"> API Reference </a> </li> <li class="nav-item"> <a class="nav-link nav-internal" href="user_guide/"> User Guide </a> </li> <li class="nav-item"> <a class="nav-link nav-internal" href="cuml_blogs/"> Blogs and other references </a> </li> </ul> </nav></div> </div> <div class="navbar-header-items__end"> <div class="navbar-item navbar-persistent--container"> <button aria-label="Search" class="btn search-button-field search-button__button pst-js-only" data-bs-placement="bottom" data-bs-toggle="tooltip" title="Search"> <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> </div> <div class="navbar-item"> <button aria-label="Color mode" class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" data-bs-placement="bottom" data-bs-title="Color mode" data-bs-toggle="tooltip"> <i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i> <i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i> <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i> </button></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/cuml" 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"> <button aria-label="Search" class="btn search-button-field search-button__button pst-js-only" data-bs-placement="bottom" data-bs-toggle="tooltip" title="Search"> <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> </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"> <dialog id="pst-primary-sidebar-modal"></dialog> <div class="bd-sidebar-primary bd-sidebar hide-on-wide" id="pst-primary-sidebar"><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">cuml</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" href="/api/cudf/stable/">cudf</a><a class="rapids-selector__menu-item" href="/api/cugraph/stable">cugraph</a><a class="rapids-selector__menu-item rapids-selector__menu-item--selected" 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/librmm/stable">librmm</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 (25.02)</div><div class="rapids-selector__menu"><a class="rapids-selector__menu-item" href="/api/cuml/nightly">nightly (25.04)</a><a class="rapids-selector__menu-item rapids-selector__menu-item--selected" href="/api/cuml/stable">stable (25.02)</a><a class="rapids-selector__menu-item" href="/api/cuml/legacy">legacy (24.12)</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="cuml_intro/"> Introduction </a> </li> <li class="nav-item"> <a class="nav-link nav-internal" href="api/"> API Reference </a> </li> <li class="nav-item"> <a class="nav-link nav-internal" href="user_guide/"> User Guide </a> </li> <li class="nav-item"> <a class="nav-link nav-internal" href="cuml_blogs/"> Blogs and other references </a> </li> </ul> </nav></div> </div> <div class="sidebar-header-items__end"> <div class="navbar-item"> <button aria-label="Color mode" class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" data-bs-placement="bottom" data-bs-title="Color mode" data-bs-toggle="tooltip"> <i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i> <i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i> <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i> </button></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/cuml" 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 class="sidebar-primary-item"> <div class="flat" data-ea-manual="true" data-ea-publisher="readthedocs" data-ea-type="readthedocs-sidebar" id="ethical-ad-placement"> </div></div> </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-cuml-s-documentation"> <h1>Welcome to cuML’s documentation!<a class="headerlink" href="#welcome-to-cuml-s-documentation" title="Link to this heading">#</a></h1> <p>cuML is a suite of fast, GPU-accelerated machine learning algorithms designed for data science and analytical tasks. Our API mirrors Sklearn’s, and we provide practitioners with the easy fit-predict-transform paradigm without ever having to program on a GPU.</p> <p>As data gets larger, algorithms running on a CPU becomes slow and cumbersome. RAPIDS provides users a streamlined approach where data is initially loaded in the GPU, and compute tasks can be performed on it directly.</p> <p>cuML is fully open source, and the RAPIDS team welcomes new and seasoned contributors, users and hobbyists! Thank you for your wonderful support!</p> <p>An installation requirement for cuML is that your system must be Linux-like. Support for Windows is possible in the near future.</p> <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="cuml_intro/">Introduction</a><ul> <li class="toctree-l2"><a class="reference internal" href="cuml_intro/#where-possible-match-the-scikit-learn-api">1. Where possible, match the scikit-learn API</a></li> <li class="toctree-l2"><a class="reference internal" href="cuml_intro/#accept-flexible-input-types-return-predictable-output-types">2. Accept flexible input types, return predictable output types</a></li> <li class="toctree-l2"><a class="reference internal" href="cuml_intro/#be-fast">3. Be fast!</a></li> <li class="toctree-l2"><a class="reference internal" href="cuml_intro/#learn-more">Learn more</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="api/">API Reference</a><ul> <li class="toctree-l2"><a class="reference internal" href="api/#module-configuration">Module Configuration</a></li> <li class="toctree-l2"><a class="reference internal" href="api/#preprocessing-metrics-and-utilities">Preprocessing, Metrics, and Utilities</a></li> <li class="toctree-l2"><a class="reference internal" href="api/#regression-and-classification">Regression and Classification</a></li> <li class="toctree-l2"><a class="reference internal" href="api/#clustering">Clustering</a></li> <li class="toctree-l2"><a class="reference internal" href="api/#dimensionality-reduction-and-manifold-learning">Dimensionality Reduction and Manifold Learning</a></li> <li class="toctree-l2"><a class="reference internal" href="api/#neighbors">Neighbors</a></li> <li class="toctree-l2"><a class="reference internal" href="api/#time-series">Time Series</a></li> <li class="toctree-l2"><a class="reference internal" href="api/#model-explainability">Model Explainability</a></li> <li class="toctree-l2"><a class="reference internal" href="api/#multi-node-multi-gpu-algorithms">Multi-Node, Multi-GPU Algorithms</a></li> <li class="toctree-l2"><a class="reference internal" href="api/#experimental">Experimental</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="user_guide/">User Guide</a><ul> <li class="toctree-l2"><a class="reference internal" href="estimator_intro/">Training and Evaluating Machine Learning Models</a></li> <li class="toctree-l2"><a class="reference internal" href="pickling_cuml_models/">Pickling Models for Persistence</a></li> <li class="toctree-l2"><a class="reference internal" href="execution_device_interoperability/">cuML on GPU and CPU</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="cuml_blogs/">Blogs and other references</a><ul> <li class="toctree-l2"><a class="reference internal" href="cuml_blogs/#integrations-applications-and-general-concepts">Integrations, applications, and general concepts</a></li> <li class="toctree-l2"><a class="reference internal" href="cuml_blogs/#tree-and-forest-models">Tree and forest models</a></li> <li class="toctree-l2"><a class="reference internal" href="cuml_blogs/#other-popular-models">Other popular models</a></li> <li class="toctree-l2"><a class="reference internal" href="cuml_blogs/#academic-papers">Academic Papers</a></li> </ul> </li> </ul> </div> </section> <section id="indices-and-tables"> <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading">#</a></h1> <ul class="simple"> <li><p><a class="reference internal" href="genindex/"><span class="std std-ref">Index</span></a></p></li> <li><p><a class="reference internal" href="py-modindex/"><span class="std std-ref">Module Index</span></a></p></li> <li><p><a class="reference internal" href="search/"><span class="std std-ref">Search Page</span></a></p></li> </ul> </section> </article> <footer class="prev-next-footer d-print-none"> <div class="prev-next-area"> <a class="right-next" href="cuml_intro/" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Introduction</p> </div> <i class="fa-solid fa-angle-right"></i> </a> </div> </footer> </div> <dialog id="pst-secondary-sidebar-modal"></dialog> <div class="bd-sidebar-secondary bd-toc" id="pst-secondary-sidebar"><div class="sidebar-secondary-items sidebar-secondary__inner"> <div class="sidebar-secondary-item"> <div class="page-toc tocsection onthispage" id="pst-page-navigation-heading-2"> <i class="fa-solid fa-list"></i> On this page </div> <nav aria-labelledby="pst-page-navigation-heading-2" class="bd-toc-nav page-toc"> <ul class="visible nav section-nav flex-column"> <li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#">Welcome to cuML’s documentation!</a></li> <li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#indices-and-tables">Indices and tables</a></li> </ul> </nav></div> <div class="sidebar-secondary-item"> <div aria-label="source link" role="note"> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="_sources/index.rst.txt" rel="nofollow">Show Source</a></li> </ul> </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 defer src="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script> <script defer src="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></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 2020-2023, NVIDIA Corporation. <br> </p> </div> <div class="footer-item"> <p class="sphinx-version"> Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3. <br> </p> </div> </div> <div class="footer-items__end"> <div class="footer-item"> <p class="theme-version"> <!-- # L10n: Setting the PST URL as an argument as this does not need to be localized --> Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.1. </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>