Spaces:
Sleeping
Sleeping
File size: 43,321 Bytes
e45d058 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 |
<!doctype html>
<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="Emitters" href="cutlass.emit.html" /><link rel="prev" title="CUTLASS Python API" href="modules.html" />
<link rel="canonical" href="docs/cutlass.html" />
<!-- Generated with Sphinx 6.1.3 and Furo 2023.03.27 -->
<title>CUTLASS - 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>
<li class="toctree-l1"><a class="reference internal" href="install.html">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 class="current">
<li class="toctree-l1 current has-children"><a class="reference internal" href="modules.html">CUTLASS Python API</a><input checked="" 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 class="current">
<li class="toctree-l2 current has-children current-page"><a class="current reference internal" href="#">CUTLASS</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-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="cutlass">
<h1>CUTLASS<a class="headerlink" href="#cutlass" title="Permalink to this heading">#</a></h1>
<section id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this heading">#</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="cutlass.emit.html">Emitters</a></li>
<li class="toctree-l1"><a class="reference internal" href="cutlass.op.html">Operations</a></li>
<li class="toctree-l1"><a class="reference internal" href="cutlass.utils.html">Utilities</a></li>
</ul>
</div>
</section>
<section id="module-cutlass.epilogue">
<span id="epilogue"></span><h2>Epilogue<a class="headerlink" href="#module-cutlass.epilogue" title="Permalink to this heading">#</a></h2>
<p>Registry of elementwise epilogues</p>
<p>Elementwise epilogues can be added to many CUTLASS kernels in the CUTLAS Python interface via
code like the following for GEMM:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">plan</span> <span class="o">=</span> <span class="n">cutlass</span><span class="o">.</span><span class="n">op</span><span class="o">.</span><span class="n">Gemm</span><span class="p">(</span><span class="n">element</span><span class="o">=</span><span class="n">cutlass</span><span class="o">.</span><span class="n">DataType</span><span class="o">.</span><span class="n">f32</span><span class="p">,</span> <span class="n">layout</span><span class="o">=</span><span class="n">cutlass</span><span class="o">.</span><span class="n">LayoutType</span><span class="o">.</span><span class="n">RowMajor</span><span class="p">)</span>
<span class="n">plan</span><span class="o">.</span><span class="n">activation</span> <span class="o">=</span> <span class="n">cutlass</span><span class="o">.</span><span class="n">epilogue</span><span class="o">.</span><span class="n">relu</span>
</pre></div>
</div>
<dl class="py function">
<dt class="sig sig-object py" id="cutlass.epilogue.get_activation_epilogue">
<span class="sig-prename descclassname"><span class="pre">cutlass.epilogue.</span></span><span class="sig-name descname"><span class="pre">get_activation_epilogue</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">activation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">element_output</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">elements_per_access</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">element_accumulator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">element_compute</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cutlass/epilogue.html#get_activation_epilogue"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cutlass.epilogue.get_activation_epilogue" title="Permalink to this definition">#</a></dt>
<dd><p>Return an epilogue corresponding to the activation function, data types, and alignment
used in the kernel</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>activation</strong> – elementwise activation function to use</p></li>
<li><p><strong>element_output</strong> – data type of the output</p></li>
<li><p><strong>elements_per_access</strong> (<em>int</em>) – alignment of operand C of the kernel</p></li>
<li><p><strong>element_accumulator</strong> – data type of the accumulated output C</p></li>
<li><p><strong>element_compute</strong> – data type in which compute operations should be performed</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>epilogue functor</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cutlass.epilogue.get_activations">
<span class="sig-prename descclassname"><span class="pre">cutlass.epilogue.</span></span><span class="sig-name descname"><span class="pre">get_activations</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/cutlass/epilogue.html#get_activations"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cutlass.epilogue.get_activations" title="Permalink to this definition">#</a></dt>
<dd><p>Returns a list of available activation functions</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>list of available activation functions</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>list</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-cutlass.library_defaults">
<span id="library-defaults"></span><h2>Library Defaults<a class="headerlink" href="#module-cutlass.library_defaults" title="Permalink to this heading">#</a></h2>
<p>Classes containing valid operations for a given compute capability and data types.</p>
<dl class="py class">
<dt class="sig sig-object py" id="cutlass.library_defaults.ArchOptions">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cutlass.library_defaults.</span></span><span class="sig-name descname"><span class="pre">ArchOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">target_cc,</span> <span class="pre">kernel_cc,</span> <span class="pre">operation_kind,</span> <span class="pre">gemm_kinds,</span> <span class="pre">allowed_math_operations=[<MathOperation.multiply_add:</span> <span class="pre">1>,</span> <span class="pre"><MathOperation.multiply_add_saturate:</span> <span class="pre">2>]</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cutlass/library_defaults.html#ArchOptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cutlass.library_defaults.ArchOptions" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Structure for keeping track of kernels available on a given compute capability</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>target_cc</strong> (<em>int</em>) – compute capability of the device on which kernels will be run</p></li>
<li><p><strong>kernel_cc</strong> (<em>int</em>) – compute capability of the kernels to generate</p></li>
<li><p><strong>operation_kind</strong> (<em>cutlass.OperationKind</em>) – type of operation to register</p></li>
<li><p><strong>gemm_kinds</strong> (<em>list</em>) – types of GEMM operations that can be included</p></li>
<li><p><strong>allowed_math_operations</strong> (<em>list</em>) – types of primitive math operations allowed</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="cutlass.library_defaults.ArchOptions.opclass_supports_combination">
<span class="sig-name descname"><span class="pre">opclass_supports_combination</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">op_class</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datatype_comb</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layout_comb</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cutlass/library_defaults.html#ArchOptions.opclass_supports_combination"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cutlass.library_defaults.ArchOptions.opclass_supports_combination" title="Permalink to this definition">#</a></dt>
<dd><p>Returns whether the provided operation class supports the provided data type and layout combination</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>op_class</strong> (<em>cutlass.OpcodeClass</em>) – operation class to consider</p></li>
<li><p><strong>datatype_comb</strong> (<em>tuple</em><em>[</em><em>cutlass.DataType</em><em>]</em>) – tuple of data types for (element_A, element_B, element_accumulator)</p></li>
<li><p><strong>layout_comb</strong> (<em>tuple</em><em>[</em><em>cutlass.LayoutType</em><em>]</em>) – tuple of data types for (layout_A, layout_B)</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>set of operation classes that support the provided data type and layout combination</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>set</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cutlass.library_defaults.ArchOptions.operations">
<span class="sig-name descname"><span class="pre">operations</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">op_class</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">element_a</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">element_b</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">element_accumulator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layout_a</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layout_b</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cutlass/library_defaults.html#ArchOptions.operations"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cutlass.library_defaults.ArchOptions.operations" title="Permalink to this definition">#</a></dt>
<dd><p>Returns whether the provided operation class supports the provided data type combination</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>op_class</strong> (<em>cutlass.OpcodeClass</em>) – operation class to consider</p></li>
<li><p><strong>element_a</strong> (<em>cutlass.DataType</em>) – data type of operand A</p></li>
<li><p><strong>element_b</strong> (<em>cutlass.DataType</em>) – data type of operand B</p></li>
<li><p><strong>element_accumulator</strong> (<em>cutlass.DataType</em>) – data type of accumulator</p></li>
<li><p><strong>layout_a</strong> (<em>cutlass.LayoutType</em>) – layout of operand A</p></li>
<li><p><strong>layout_b</strong> (<em>cutlass.LayoutType</em>) – layout of operand B</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>container of kernels by alignment supported by the provided combination of parameters</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#cutlass.library_defaults.KernelsForDataType" title="cutlass.library_defaults.KernelsForDataType">KernelsForDataType</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cutlass.library_defaults.ArchOptions.supporting_opclasses">
<span class="sig-name descname"><span class="pre">supporting_opclasses</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">element_a</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">element_b</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">element_accumulator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layout_a</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layout_b</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cutlass/library_defaults.html#ArchOptions.supporting_opclasses"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cutlass.library_defaults.ArchOptions.supporting_opclasses" title="Permalink to this definition">#</a></dt>
<dd><p>Returns a set of operation classes that support the provided data type combination</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>element_a</strong> (<em>cutlass.DataType</em>) – data type of operand A</p></li>
<li><p><strong>element_b</strong> (<em>cutlass.DataType</em>) – data type of operand B</p></li>
<li><p><strong>element_accumulator</strong> (<em>cutlass.DataType</em>) – data type of accumulator</p></li>
<li><p><strong>layout_a</strong> (<em>cutlass.LayoutType</em>) – layout of operand A</p></li>
<li><p><strong>layout_b</strong> (<em>cutlass.LayoutType</em>) – layout of operand B</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>set of operation classes that support the provided data type combination</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>set</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="cutlass.library_defaults.KernelsForDataType">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cutlass.library_defaults.</span></span><span class="sig-name descname"><span class="pre">KernelsForDataType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datatype_comb</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layout_comb</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cutlass/library_defaults.html#KernelsForDataType"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cutlass.library_defaults.KernelsForDataType" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Container class for keeping track of kernels that correspond to a particular combination
of data types for operands A, B, and accumulator</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>datatype_comb</strong> (<em>tuple</em>) – </p></li>
<li><p><strong>layout_comb</strong> (<em>tuple</em>) – </p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="cutlass.library_defaults.KernelsForDataType.add">
<span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">operation</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cutlass/library_defaults.html#KernelsForDataType.add"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cutlass.library_defaults.KernelsForDataType.add" title="Permalink to this definition">#</a></dt>
<dd><p>Add an operation to the list of supported kernels</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cutlass.library_defaults.KernelsForDataType.alignments">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">alignments</span></span><a class="headerlink" href="#cutlass.library_defaults.KernelsForDataType.alignments" title="Permalink to this definition">#</a></dt>
<dd><p>Returns an unsorted list of alignments supported by this data type combination</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>unsorted list of alignments supported by this data type combination</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cutlass.library_defaults.KernelsForDataType.all_operations">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">all_operations</span></span><a class="headerlink" href="#cutlass.library_defaults.KernelsForDataType.all_operations" title="Permalink to this definition">#</a></dt>
<dd><p>Returns a list of all operations supported by this data type combination</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>list of all operations supported by this data type combination</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cutlass.library_defaults.KernelsForDataType.find_alignment">
<span class="sig-name descname"><span class="pre">find_alignment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">shape</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layout</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cutlass/library_defaults.html#KernelsForDataType.find_alignment"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cutlass.library_defaults.KernelsForDataType.find_alignment" title="Permalink to this definition">#</a></dt>
<dd><p>Returns the most preferable alignment for a given shape and layout</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>shape</strong> (<em>tuple</em>) – extent of each dimension of the tensor</p></li>
<li><p><strong>layout</strong> (<em>cutlass.LayoutType</em>) – layout of the tensor</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>maximum alignment supported by the data type combination and tensor size</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cutlass.library_defaults.KernelsForDataType.operations">
<span class="sig-name descname"><span class="pre">operations</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">alignment</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cutlass/library_defaults.html#KernelsForDataType.operations"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cutlass.library_defaults.KernelsForDataType.operations" title="Permalink to this definition">#</a></dt>
<dd><p>Returns operations satisfying the alignment constraint indicated by <cite>alignment</cite></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>alignment</strong> (<em>int</em>) – alignment constraint of operations to return</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>list of operations</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cutlass.library_defaults.KernelsForDataType.sort">
<span class="sig-name descname"><span class="pre">sort</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/cutlass/library_defaults.html#KernelsForDataType.sort"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cutlass.library_defaults.KernelsForDataType.sort" title="Permalink to this definition">#</a></dt>
<dd><p>Sorts each list of kernels in <cite>kernels_by_alignment</cite> in descending order of threadblock shape</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="cutlass.library_defaults.OptionRegistry">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cutlass.library_defaults.</span></span><span class="sig-name descname"><span class="pre">OptionRegistry</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target_cc</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cutlass/library_defaults.html#OptionRegistry"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cutlass.library_defaults.OptionRegistry" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Container of all architecture-specific options</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>target_cc</strong> (<em>int</em>) – compute capability of the device on which operations will be run</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="cutlass.library_defaults.OptionRegistry.options_for_cc">
<span class="sig-name descname"><span class="pre">options_for_cc</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cc</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cutlass/library_defaults.html#OptionRegistry.options_for_cc"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cutlass.library_defaults.OptionRegistry.options_for_cc" title="Permalink to this definition">#</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>cc</strong> (<em>int</em>) – </p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#cutlass.library_defaults.ArchOptions" title="cutlass.library_defaults.ArchOptions"><em>ArchOptions</em></a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<section id="module-cutlass.swizzle">
<span id="swizzle"></span><h2>Swizzle<a class="headerlink" href="#module-cutlass.swizzle" title="Permalink to this heading">#</a></h2>
<p>Registry of swizzling functions</p>
<dl class="py function">
<dt class="sig sig-object py" id="cutlass.swizzle.get_swizzling_functors">
<span class="sig-prename descclassname"><span class="pre">cutlass.swizzle.</span></span><span class="sig-name descname"><span class="pre">get_swizzling_functors</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/cutlass/swizzle.html#get_swizzling_functors"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cutlass.swizzle.get_swizzling_functors" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
</section>
</section>
</article>
</div>
<footer>
<div class="related-pages">
<a class="next-page" href="cutlass.emit.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">Emitters</div>
</div>
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
</a>
<a class="prev-page" href="modules.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">CUTLASS Python API</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="#">CUTLASS</a><ul>
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
<li><a class="reference internal" href="#module-cutlass.epilogue">Epilogue</a><ul>
<li><a class="reference internal" href="#cutlass.epilogue.get_activation_epilogue"><code class="docutils literal notranslate"><span class="pre">get_activation_epilogue()</span></code></a></li>
<li><a class="reference internal" href="#cutlass.epilogue.get_activations"><code class="docutils literal notranslate"><span class="pre">get_activations()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-cutlass.library_defaults">Library Defaults</a><ul>
<li><a class="reference internal" href="#cutlass.library_defaults.ArchOptions"><code class="docutils literal notranslate"><span class="pre">ArchOptions</span></code></a><ul>
<li><a class="reference internal" href="#cutlass.library_defaults.ArchOptions.opclass_supports_combination"><code class="docutils literal notranslate"><span class="pre">ArchOptions.opclass_supports_combination()</span></code></a></li>
<li><a class="reference internal" href="#cutlass.library_defaults.ArchOptions.operations"><code class="docutils literal notranslate"><span class="pre">ArchOptions.operations()</span></code></a></li>
<li><a class="reference internal" href="#cutlass.library_defaults.ArchOptions.supporting_opclasses"><code class="docutils literal notranslate"><span class="pre">ArchOptions.supporting_opclasses()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#cutlass.library_defaults.KernelsForDataType"><code class="docutils literal notranslate"><span class="pre">KernelsForDataType</span></code></a><ul>
<li><a class="reference internal" href="#cutlass.library_defaults.KernelsForDataType.add"><code class="docutils literal notranslate"><span class="pre">KernelsForDataType.add()</span></code></a></li>
<li><a class="reference internal" href="#cutlass.library_defaults.KernelsForDataType.alignments"><code class="docutils literal notranslate"><span class="pre">KernelsForDataType.alignments</span></code></a></li>
<li><a class="reference internal" href="#cutlass.library_defaults.KernelsForDataType.all_operations"><code class="docutils literal notranslate"><span class="pre">KernelsForDataType.all_operations</span></code></a></li>
<li><a class="reference internal" href="#cutlass.library_defaults.KernelsForDataType.find_alignment"><code class="docutils literal notranslate"><span class="pre">KernelsForDataType.find_alignment()</span></code></a></li>
<li><a class="reference internal" href="#cutlass.library_defaults.KernelsForDataType.operations"><code class="docutils literal notranslate"><span class="pre">KernelsForDataType.operations()</span></code></a></li>
<li><a class="reference internal" href="#cutlass.library_defaults.KernelsForDataType.sort"><code class="docutils literal notranslate"><span class="pre">KernelsForDataType.sort()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#cutlass.library_defaults.OptionRegistry"><code class="docutils literal notranslate"><span class="pre">OptionRegistry</span></code></a><ul>
<li><a class="reference internal" href="#cutlass.library_defaults.OptionRegistry.options_for_cc"><code class="docutils literal notranslate"><span class="pre">OptionRegistry.options_for_cc()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#module-cutlass.swizzle">Swizzle</a><ul>
<li><a class="reference internal" href="#cutlass.swizzle.get_swizzling_functors"><code class="docutils literal notranslate"><span class="pre">get_swizzling_functors()</span></code></a></li>
</ul>
</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> |