2021-04-21 01:40:29 -04:00
<!DOCTYPE html>
< html class = "writer-html5" lang = "en" >
< head >
< meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
< title > Python API — Triton documentation< / title >
< link rel = "stylesheet" href = "../../_static/css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "../../_static/pygments.css" type = "text/css" / >
< link rel = "stylesheet" href = "../../_static/gallery.css" type = "text/css" / >
< link rel = "stylesheet" href = "../../_static/gallery-binder.css" type = "text/css" / >
< link rel = "stylesheet" href = "../../_static/gallery-dataframe.css" type = "text/css" / >
< link rel = "stylesheet" href = "../../_static/gallery-rendered-html.css" type = "text/css" / >
< link rel = "stylesheet" href = "../../_static/css/custom.css" type = "text/css" / >
<!-- [if lt IE 9]>
< script src = "../../_static/js/html5shiv.min.js" > < / script >
<![endif]-->
< script type = "text/javascript" id = "documentation_options" data-url_root = "../../" src = "../../_static/documentation_options.js" > < / script >
< script src = "../../_static/jquery.js" > < / script >
< script src = "../../_static/underscore.js" > < / script >
< script src = "../../_static/doctools.js" > < / script >
< script type = "text/javascript" src = "../../_static/js/theme.js" > < / script >
< link rel = "index" title = "Index" href = "../../genindex.html" / >
< link rel = "search" title = "Search" href = "../../search.html" / >
2021-04-21 02:05:54 -04:00
< link rel = "next" title = "triton.program_id" href = "generated/triton.program_id.html" / >
2021-04-21 01:40:29 -04:00
< link rel = "prev" title = "Matrix Multiplication" href = "../../getting-started/tutorials/03-matrix-multiplication.html" / >
< / head >
< body class = "wy-body-for-nav" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
< a href = "../../index.html" class = "icon icon-home" > Triton
< / a >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "../../search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< p class = "caption" > < span class = "caption-text" > Getting Started< / span > < / p >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../getting-started/installation.html" > Installation< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../getting-started/tutorials/index.html" > Tutorials< / a > < / li >
< / ul >
< p class = "caption" > < span class = "caption-text" > Language Reference< / span > < / p >
< ul class = "current" >
< li class = "toctree-l1 current" > < a class = "current reference internal" href = "#" > Python API< / a > < ul >
2021-04-21 02:05:54 -04:00
< li class = "toctree-l2" > < a class = "reference internal" href = "#programming-model" > Programming Model< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "generated/triton.program_id.html" > triton.program_id< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "generated/triton.num_programs.html" > triton.num_programs< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#creation-ops" > Creation Ops< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "generated/triton.arange.html" > triton.arange< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "generated/triton.zeros.html" > triton.zeros< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#shape-manipulation-ops" > Shape Manipulation Ops< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "generated/triton.broadcast_to.html" > triton.broadcast_to< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "generated/triton.reshape.html" > triton.reshape< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "generated/triton.ravel.html" > triton.ravel< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#linear-algebra-ops" > Linear Algebra Ops< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "generated/triton.dot.html" > triton.dot< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#memory-ops" > Memory Ops< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "generated/triton.load.html" > triton.load< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "generated/triton.store.html" > triton.store< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "generated/triton.atomic_cas.html" > triton.atomic_cas< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "generated/triton.atomic_xchg.html" > triton.atomic_xchg< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#indexing-ops" > Indexing Ops< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "generated/triton.where.html" > triton.where< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#math-ops" > Math Ops< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "generated/triton.exp.html" > triton.exp< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "generated/triton.log.html" > triton.log< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "generated/triton.sigmoid.html" > triton.sigmoid< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "generated/triton.softmax.html" > triton.softmax< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#reduction-ops" > Reduction Ops< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "generated/triton.max.html" > triton.max< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "generated/triton.min.html" > triton.min< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "generated/triton.sum.html" > triton.sum< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#comparison-ops" > Comparison ops< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "generated/triton.minimum.html" > triton.minimum< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "generated/triton.maximum.html" > triton.maximum< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#compiler-hint-ops" > Compiler Hint Ops< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "generated/triton.multiple_of.html" > triton.multiple_of< / a > < / li >
< / ul >
< / li >
2021-04-21 01:40:29 -04:00
< / ul >
< / li >
< / ul >
< p class = "caption" > < span class = "caption-text" > Programming Guide< / span > < / p >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../programming-guide/chapter-1/introduction.html" > Introduction< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../programming-guide/chapter-2/related-work.html" > Related Work< / a > < / li >
< / ul >
< / div >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "../../index.html" > Triton< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "../../index.html" class = "icon icon-home" > < / a > » < / li >
< li > Python API< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "../../_sources/language-reference/python-api/index.rst.txt" rel = "nofollow" > View page source< / a >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
< div class = "section" id = "python-api" >
< h1 > Python API< a class = "headerlink" href = "#python-api" title = "Permalink to this headline" > ¶< / a > < / h1 >
< div class = "section" id = "programming-model" >
< h2 > Programming Model< a class = "headerlink" href = "#programming-model" title = "Permalink to this headline" > ¶< / a > < / h2 >
< table class = "longtable docutils align-default" >
< colgroup >
< col style = "width: 10%" / >
< col style = "width: 90%" / >
< / colgroup >
< tbody >
2021-04-21 02:05:54 -04:00
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "generated/triton.program_id.html#triton.program_id" title = "triton.program_id" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > program_id< / span > < / code > < / a > < / p > < / td >
< td > < p > Returns the id of the current program instance along the given < cite > axis< / cite > . Triton uses an SPMD model in which different @ triton.jit functions run in parallel with different < a href = "#id1" > < span class = "problematic" id = "id2" > `< / span > < / a > program_id`s.< / p > < / td >
< / tr >
< tr class = "row-even" > < td > < p > < a class = "reference internal" href = "generated/triton.num_programs.html#triton.num_programs" title = "triton.num_programs" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > num_programs< / span > < / code > < / a > < / p > < / td >
< td > < p > Returns the number of program instances launched along the given < cite > axis< / cite > .< / p > < / td >
< / tr >
2021-04-21 01:40:29 -04:00
< / tbody >
< / table >
< / div >
< div class = "section" id = "creation-ops" >
< h2 > Creation Ops< a class = "headerlink" href = "#creation-ops" title = "Permalink to this headline" > ¶< / a > < / h2 >
< table class = "longtable docutils align-default" >
< colgroup >
< col style = "width: 10%" / >
< col style = "width: 90%" / >
< / colgroup >
< tbody >
2021-04-21 02:05:54 -04:00
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "generated/triton.arange.html#triton.arange" title = "triton.arange" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > arange< / span > < / code > < / a > < / p > < / td >
< td > < p > Returns contiguous values within the open interval [start, end).< / p > < / td >
< / tr >
< tr class = "row-even" > < td > < p > < a class = "reference internal" href = "generated/triton.zeros.html#triton.zeros" title = "triton.zeros" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > zeros< / span > < / code > < / a > < / p > < / td >
< td > < p > Returns a block filled with the scalar value 0 and the given shape.< / p > < / td >
< / tr >
2021-04-21 01:40:29 -04:00
< / tbody >
< / table >
< / div >
< div class = "section" id = "shape-manipulation-ops" >
< h2 > Shape Manipulation Ops< a class = "headerlink" href = "#shape-manipulation-ops" title = "Permalink to this headline" > ¶< / a > < / h2 >
< table class = "longtable docutils align-default" >
< colgroup >
< col style = "width: 10%" / >
< col style = "width: 90%" / >
< / colgroup >
< tbody >
2021-04-21 02:05:54 -04:00
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "generated/triton.broadcast_to.html#triton.broadcast_to" title = "triton.broadcast_to" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > broadcast_to< / span > < / code > < / a > < / p > < / td >
< td > < p > Tries to broadcast a block to a new shape.< / p > < / td >
< / tr >
< tr class = "row-even" > < td > < p > < a class = "reference internal" href = "generated/triton.reshape.html#triton.reshape" title = "triton.reshape" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > reshape< / span > < / code > < / a > < / p > < / td >
< td > < p > Reshapes a block to a new shape.< / p > < / td >
< / tr >
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "generated/triton.ravel.html#triton.ravel" title = "triton.ravel" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > ravel< / span > < / code > < / a > < / p > < / td >
< td > < p > < / p > < / td >
< / tr >
2021-04-21 01:40:29 -04:00
< / tbody >
< / table >
< / div >
< div class = "section" id = "linear-algebra-ops" >
< h2 > Linear Algebra Ops< a class = "headerlink" href = "#linear-algebra-ops" title = "Permalink to this headline" > ¶< / a > < / h2 >
< table class = "longtable docutils align-default" >
< colgroup >
< col style = "width: 10%" / >
< col style = "width: 90%" / >
< / colgroup >
< tbody >
2021-04-21 02:05:54 -04:00
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "generated/triton.dot.html#triton.dot" title = "triton.dot" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > dot< / span > < / code > < / a > < / p > < / td >
< td > < p > Returns the matrix product of two blocks.< / p > < / td >
< / tr >
2021-04-21 01:40:29 -04:00
< / tbody >
< / table >
< / div >
< div class = "section" id = "memory-ops" >
< h2 > Memory Ops< a class = "headerlink" href = "#memory-ops" title = "Permalink to this headline" > ¶< / a > < / h2 >
< table class = "longtable docutils align-default" >
< colgroup >
< col style = "width: 10%" / >
< col style = "width: 90%" / >
< / colgroup >
< tbody >
2021-04-21 02:05:54 -04:00
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "generated/triton.load.html#triton.load" title = "triton.load" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > load< / span > < / code > < / a > < / p > < / td >
< td > < p > Return a block of data whose values are, elementwise, loaded from memory at location defined by < cite > pointer< / cite > .< / p > < / td >
< / tr >
< tr class = "row-even" > < td > < p > < a class = "reference internal" href = "generated/triton.store.html#triton.store" title = "triton.store" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > store< / span > < / code > < / a > < / p > < / td >
< td > < p > Stores < cite > value< / cite > block of elements in memory, element-wise, at the memory locations specified by < cite > pointer< / cite > .< / p > < / td >
< / tr >
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "generated/triton.atomic_cas.html#triton.atomic_cas" title = "triton.atomic_cas" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > atomic_cas< / span > < / code > < / a > < / p > < / td >
< td > < p > < / p > < / td >
< / tr >
< tr class = "row-even" > < td > < p > < a class = "reference internal" href = "generated/triton.atomic_xchg.html#triton.atomic_xchg" title = "triton.atomic_xchg" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > atomic_xchg< / span > < / code > < / a > < / p > < / td >
< td > < p > < / p > < / td >
< / tr >
2021-04-21 01:40:29 -04:00
< / tbody >
< / table >
< / div >
< div class = "section" id = "indexing-ops" >
< h2 > Indexing Ops< a class = "headerlink" href = "#indexing-ops" title = "Permalink to this headline" > ¶< / a > < / h2 >
< table class = "longtable docutils align-default" >
< colgroup >
< col style = "width: 10%" / >
< col style = "width: 90%" / >
< / colgroup >
< tbody >
2021-04-21 02:05:54 -04:00
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "generated/triton.where.html#triton.where" title = "triton.where" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > where< / span > < / code > < / a > < / p > < / td >
< td > < p > Returns a block of elements from either < cite > x< / cite > or < cite > y< / cite > , depending on < cite > condition< / cite > .< / p > < / td >
< / tr >
2021-04-21 01:40:29 -04:00
< / tbody >
< / table >
< / div >
< div class = "section" id = "math-ops" >
< h2 > Math Ops< a class = "headerlink" href = "#math-ops" title = "Permalink to this headline" > ¶< / a > < / h2 >
< table class = "longtable docutils align-default" >
< colgroup >
< col style = "width: 10%" / >
< col style = "width: 90%" / >
< / colgroup >
< tbody >
2021-04-21 02:05:54 -04:00
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "generated/triton.exp.html#triton.exp" title = "triton.exp" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > exp< / span > < / code > < / a > < / p > < / td >
< td > < p > < / p > < / td >
< / tr >
< tr class = "row-even" > < td > < p > < a class = "reference internal" href = "generated/triton.log.html#triton.log" title = "triton.log" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > log< / span > < / code > < / a > < / p > < / td >
< td > < p > < / p > < / td >
< / tr >
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "generated/triton.sigmoid.html#triton.sigmoid" title = "triton.sigmoid" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > sigmoid< / span > < / code > < / a > < / p > < / td >
< td > < p > < / p > < / td >
< / tr >
< tr class = "row-even" > < td > < p > < a class = "reference internal" href = "generated/triton.softmax.html#triton.softmax" title = "triton.softmax" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > softmax< / span > < / code > < / a > < / p > < / td >
< td > < p > < / p > < / td >
< / tr >
2021-04-21 01:40:29 -04:00
< / tbody >
< / table >
< / div >
< div class = "section" id = "reduction-ops" >
< h2 > Reduction Ops< a class = "headerlink" href = "#reduction-ops" title = "Permalink to this headline" > ¶< / a > < / h2 >
< table class = "longtable docutils align-default" >
< colgroup >
< col style = "width: 10%" / >
< col style = "width: 90%" / >
< / colgroup >
< tbody >
2021-04-21 02:05:54 -04:00
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "generated/triton.max.html#triton.max" title = "triton.max" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > max< / span > < / code > < / a > < / p > < / td >
< td > < p > < / p > < / td >
< / tr >
< tr class = "row-even" > < td > < p > < a class = "reference internal" href = "generated/triton.min.html#triton.min" title = "triton.min" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > min< / span > < / code > < / a > < / p > < / td >
< td > < p > < / p > < / td >
< / tr >
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "generated/triton.sum.html#triton.sum" title = "triton.sum" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > sum< / span > < / code > < / a > < / p > < / td >
< td > < p > < / p > < / td >
< / tr >
2021-04-21 01:40:29 -04:00
< / tbody >
< / table >
< / div >
< div class = "section" id = "comparison-ops" >
< h2 > Comparison ops< a class = "headerlink" href = "#comparison-ops" title = "Permalink to this headline" > ¶< / a > < / h2 >
< table class = "longtable docutils align-default" >
< colgroup >
< col style = "width: 10%" / >
< col style = "width: 90%" / >
< / colgroup >
< tbody >
2021-04-21 02:05:54 -04:00
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "generated/triton.minimum.html#triton.minimum" title = "triton.minimum" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > minimum< / span > < / code > < / a > < / p > < / td >
< td > < p > < / p > < / td >
< / tr >
< tr class = "row-even" > < td > < p > < a class = "reference internal" href = "generated/triton.maximum.html#triton.maximum" title = "triton.maximum" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > maximum< / span > < / code > < / a > < / p > < / td >
< td > < p > < / p > < / td >
< / tr >
2021-04-21 01:40:29 -04:00
< / tbody >
< / table >
< / div >
< div class = "section" id = "compiler-hint-ops" >
< h2 > Compiler Hint Ops< a class = "headerlink" href = "#compiler-hint-ops" title = "Permalink to this headline" > ¶< / a > < / h2 >
< table class = "longtable docutils align-default" >
< colgroup >
< col style = "width: 10%" / >
< col style = "width: 90%" / >
< / colgroup >
< tbody >
2021-04-21 02:05:54 -04:00
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "generated/triton.multiple_of.html#triton.multiple_of" title = "triton.multiple_of" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > multiple_of< / span > < / code > < / a > < / p > < / td >
< td > < p > < / p > < / td >
< / tr >
2021-04-21 01:40:29 -04:00
< / tbody >
< / table >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
2021-04-21 02:05:54 -04:00
< a href = "generated/triton.program_id.html" class = "btn btn-neutral float-right" title = "triton.program_id" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" aria-hidden = "true" > < / span > < / a >
2021-04-21 01:40:29 -04:00
< a href = "../../getting-started/tutorials/03-matrix-multiplication.html" class = "btn btn-neutral float-left" title = "Matrix Multiplication" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" aria-hidden = "true" > < / span > Previous< / a >
< / div >
< hr / >
< div role = "contentinfo" >
< p >
© Copyright 2020, Philippe Tillet.
< / p >
< / div >
Built with < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > using a
< a href = "https://github.com/readthedocs/sphinx_rtd_theme" > theme< / a >
provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
< / body >
< / html >
