Spaces:
Sleeping
Sleeping
| <html class="no-js" lang="en"> | |
| <head><meta charset="utf-8"/> | |
| <meta name="viewport" content="width=device-width,initial-scale=1"/> | |
| <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> | |
| <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Basic example of using the CUTLASS Python interface" href="externals/00_basic_gemm.html" /><link rel="prev" title="CUTLASS Python Interface" href="index.html" /> | |
| <link rel="canonical" href="docs/install.html" /> | |
| <!-- Generated with Sphinx 6.1.3 and Furo 2023.03.27 --> | |
| <title>Installation - CUTLASS Python</title> | |
| <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> | |
| <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=fad236701ea90a88636c2a8c73b44ae642ed2a53" /> | |
| <link rel="stylesheet" type="text/css" href="_static/copybutton.css" /> | |
| <link rel="stylesheet" type="text/css" href="_static/tabs.css" /> | |
| <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> | |
| <style> | |
| body { | |
| --color-code-background: #eeffcc; | |
| --color-code-foreground: black; | |
| --color-brand-primary: #76B900; | |
| --color-brand-content: #76B900; | |
| } | |
| @media not print { | |
| body[data-theme="dark"] { | |
| --color-code-background: #272822; | |
| --color-code-foreground: #f8f8f2; | |
| --color-brand-primary: #76B900; | |
| --color-brand-content: #76B900; | |
| } | |
| @media (prefers-color-scheme: dark) { | |
| body:not([data-theme="light"]) { | |
| --color-code-background: #272822; | |
| --color-code-foreground: #f8f8f2; | |
| --color-brand-primary: #76B900; | |
| --color-brand-content: #76B900; | |
| } | |
| } | |
| } | |
| </style></head> | |
| <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 stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024"> | |
| <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/> | |
| </svg> | |
| </symbol> | |
| <symbol id="svg-menu" viewBox="0 0 24 24"> | |
| <title>Menu</title> | |
| <svg xmlns="http://www.w3.org/2000/svg" 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" 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" 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" 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" 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> | |
| </svg> | |
| <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> | |
| <label class="overlay toc-overlay" for="__toc"> | |
| <div class="visually-hidden">Hide table of contents sidebar</div> | |
| </label> | |
| <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">CUTLASS Python</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" 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/cutlass-logo-small.png" alt="Light Logo"/> | |
| <img class="sidebar-logo only-dark" src="_static/cutlass-logo-small.png" alt="Dark Logo"/> | |
| </div> | |
| <span class="sidebar-brand-text">CUTLASS Python</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"> | |
| </form> | |
| <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree"> | |
| <ul> | |
| <li class="toctree-l1"><a class="reference internal" href="index.html">Home</a></li> | |
| </ul> | |
| <p class="caption" role="heading"><span class="caption-text">Getting Started:</span></p> | |
| <ul class="current"> | |
| <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Installation</a></li> | |
| <li class="toctree-l1"><a class="reference internal" href="externals/00_basic_gemm.html">Getting Started</a></li> | |
| <li class="toctree-l1"><a class="reference internal" href="contribute.html">Contributing</a></li> | |
| </ul> | |
| <p class="caption" role="heading"><span class="caption-text">Python Documentation:</span></p> | |
| <ul> | |
| <li class="toctree-l1 has-children"><a class="reference internal" href="modules.html">CUTLASS Python API</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 has-children"><a class="reference internal" href="cutlass.html">CUTLASS</a><input 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-l3"><a class="reference internal" href="cutlass.emit.html">Emitters</a></li> | |
| <li class="toctree-l3"><a class="reference internal" href="cutlass.op.html">Operations</a></li> | |
| <li class="toctree-l3"><a class="reference internal" href="cutlass.utils.html">Utilities</a></li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <p class="caption" role="heading"><span class="caption-text">Examples and Tutorials:</span></p> | |
| <ul> | |
| <li class="toctree-l1 has-children"><a class="reference internal" href="examples.html">Examples</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><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="externals/00_basic_gemm.html">Basic GEMM</a></li> | |
| <li class="toctree-l2"><a class="reference internal" href="externals/01_epilogue.html">Epilogue</a></li> | |
| <li class="toctree-l2"><a class="reference internal" href="externals/02_pytorch_extension_grouped_gemm.html">PyTorch Extension</a></li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <p class="caption" role="heading"><span class="caption-text">Reference:</span></p> | |
| <ul> | |
| <li class="toctree-l1"><a class="reference external" href="https://github.com/NVIDIA/cutlass">Github</a></li> | |
| </ul> | |
| </div> | |
| </div> | |
| </div> | |
| </div> | |
| </aside> | |
| <div class="main"> | |
| <div class="content"> | |
| <div class="article-container"> | |
| <a href="#" class="back-to-top muted-link"> | |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"> | |
| <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path> | |
| </svg> | |
| <span>Back to top</span> | |
| </a> | |
| <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" 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"> | |
| <section id="installation"> | |
| <h1>Installation<a class="headerlink" href="#installation" title="Permalink to this heading">#</a></h1> | |
| <section id="installing-from-source"> | |
| <h2>Installing from source<a class="headerlink" href="#installing-from-source" title="Permalink to this heading">#</a></h2> | |
| <p>Installing from source requires the latest CUDA Toolkit that matches the major.minor of CUDA Python installed.</p> | |
| <p>Prior to installing the CUTLASS Python interface, one may optionally set the following environment variables:</p> | |
| <ul class="simple"> | |
| <li><p><code class="docutils literal notranslate"><span class="pre">CUTLASS_PATH</span></code>: the path to the cloned CUTLASS repository</p></li> | |
| <li><p><code class="docutils literal notranslate"><span class="pre">CUDA_INSTALL_PATH</span></code>: the path to the installation of CUDA</p></li> | |
| </ul> | |
| <p>If these environment variables are not set, the installation process will infer them to be the following:</p> | |
| <ul class="simple"> | |
| <li><p><code class="docutils literal notranslate"><span class="pre">CUTLASS_PATH</span></code>: one directory level above the current directory (i.e., <code class="docutils literal notranslate"><span class="pre">$(pwd)/..</span></code>)</p></li> | |
| <li><p><code class="docutils literal notranslate"><span class="pre">CUDA_INSTALL_PATH</span></code>: the directory holding <code class="docutils literal notranslate"><span class="pre">/bin/nvcc</span></code> for the first version of <code class="docutils literal notranslate"><span class="pre">nvcc</span></code> on <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> (i.e., <code class="docutils literal notranslate"><span class="pre">which</span> <span class="pre">nvcc</span> <span class="pre">|</span> <span class="pre">awk</span> <span class="pre">-F'/bin/nvcc'</span> <span class="pre">'{print</span> <span class="pre">$1}'</span></code>)</p></li> | |
| </ul> | |
| <p><strong>NOTE:</strong> The version of <code class="docutils literal notranslate"><span class="pre">cuda-python</span></code> installed must match the CUDA version in <code class="docutils literal notranslate"><span class="pre">CUDA_INSTALL_PATH</span></code>.</p> | |
| <section id="installing-a-developer-mode-package"> | |
| <h3>Installing a developer-mode package<a class="headerlink" href="#installing-a-developer-mode-package" title="Permalink to this heading">#</a></h3> | |
| <p>The CUTLASS Python interface can currently be installed via:</p> | |
| <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>setup.py<span class="w"> </span>develop<span class="w"> </span>--user | |
| </pre></div> | |
| </div> | |
| <p>This will allow changes to the Python interface source to be reflected when using the Python interface.</p> | |
| <p>We plan to add support for installing via <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">setup.py</span> <span class="pre">install</span></code> in a future release.</p> | |
| </section> | |
| </section> | |
| <section id="docker"> | |
| <h2>Docker<a class="headerlink" href="#docker" title="Permalink to this heading">#</a></h2> | |
| <p>To ensure that you have all of the necessary Python modules for running the examples using the | |
| CUTLASS Python interface, we recommend using one of the Docker images located in the docker directory.</p> | |
| <p>For example, to build and launch a container that uses CUDA 12.1 via an NGC PyTorch container, run:</p> | |
| <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>docker<span class="w"> </span>build<span class="w"> </span>-t<span class="w"> </span>cutlass-cuda12.1:latest<span class="w"> </span>-f<span class="w"> </span>docker/Dockerfile-cuda12.1-pytorch<span class="w"> </span>. | |
| docker<span class="w"> </span>run<span class="w"> </span>--gpus<span class="w"> </span>all<span class="w"> </span>-it<span class="w"> </span>--rm<span class="w"> </span>cutlass-cuda12.1:latest | |
| </pre></div> | |
| </div> | |
| <p>The CUTLASS Python interface has been tested with CUDA 11.8, 12.0, and 12.1 on Python 3.8.10 and 3.9.7.</p> | |
| </section> | |
| </section> | |
| </article> | |
| </div> | |
| <footer> | |
| <div class="related-pages"> | |
| <a class="next-page" href="externals/00_basic_gemm.html"> | |
| <div class="page-info"> | |
| <div class="context"> | |
| <span>Next</span> | |
| </div> | |
| <div class="title">Basic example of using the CUTLASS Python interface</div> | |
| </div> | |
| <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> | |
| </a> | |
| <a class="prev-page" href="index.html"> | |
| <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> | |
| <div class="page-info"> | |
| <div class="context"> | |
| <span>Previous</span> | |
| </div> | |
| <div class="title">Home</div> | |
| </div> | |
| </a> | |
| </div> | |
| <div class="bottom-of-page"> | |
| <div class="left-details"> | |
| <div class="copyright"> | |
| Copyright © 2023, NVIDIA | |
| </div> | |
| Made 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</a> | |
| </div> | |
| <div class="right-details"> | |
| <div class="icons"> | |
| <a class="muted-link " href="https://github.com/NVIDIA/cutlass" aria-label="GitHub"> | |
| <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16"> | |
| <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path> | |
| </svg> | |
| </a> | |
| </div> | |
| </div> | |
| </div> | |
| </footer> | |
| </div> | |
| <aside class="toc-drawer"> | |
| <div class="toc-sticky toc-scroll"> | |
| <div class="toc-title-container"> | |
| <span class="toc-title"> | |
| On this page | |
| </span> | |
| </div> | |
| <div class="toc-tree-container"> | |
| <div class="toc-tree"> | |
| <ul> | |
| <li><a class="reference internal" href="#">Installation</a><ul> | |
| <li><a class="reference internal" href="#installing-from-source">Installing from source</a><ul> | |
| <li><a class="reference internal" href="#installing-a-developer-mode-package">Installing a developer-mode package</a></li> | |
| </ul> | |
| </li> | |
| <li><a class="reference internal" href="#docker">Docker</a></li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </div> | |
| </div> | |
| </div> | |
| </aside> | |
| </div> | |
| </div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> | |
| <script src="_static/doctools.js"></script> | |
| <script src="_static/sphinx_highlight.js"></script> | |
| <script src="_static/scripts/furo.js"></script> | |
| <script src="_static/clipboard.min.js"></script> | |
| <script src="_static/copybutton.js"></script> | |
| <script src="_static/tabs.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> | |
| </body> | |
| </html> |