Files
triton/language-reference/python-api/generated/triton.program_id.html
2021-04-21 02:08:14 -04:00

257 lines
8.6 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>triton.program_id &mdash; 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" />
<link rel="next" title="triton.num_programs" href="triton.num_programs.html" />
<link rel="prev" title="Python API" href="../index.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="reference internal" href="../index.html">Python API</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="../index.html#programming-model">Programming Model</a><ul class="current">
<li class="toctree-l3 current"><a class="current reference internal" href="#">triton.program_id</a></li>
<li class="toctree-l3"><a class="reference internal" href="triton.num_programs.html">triton.num_programs</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../index.html#creation-ops">Creation Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../index.html#shape-manipulation-ops">Shape Manipulation Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../index.html#linear-algebra-ops">Linear Algebra Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../index.html#memory-ops">Memory Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../index.html#indexing-ops">Indexing Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../index.html#math-ops">Math Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../index.html#reduction-ops">Reduction Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../index.html#comparison-ops">Comparison ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../index.html#compiler-hint-ops">Compiler Hint Ops</a></li>
</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> &raquo;</li>
<li><a href="../index.html">Python API</a> &raquo;</li>
<li>triton.program_id</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/language-reference/python-api/generated/triton.program_id.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="triton-program-id">
<h1>triton.program_id<a class="headerlink" href="#triton-program-id" title="Permalink to this headline"></a></h1>
<dl class="py function">
<dt id="triton.program_id">
<code class="sig-prename descclassname"><span class="pre">triton.</span></code><code class="sig-name descname"><span class="pre">program_id</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">axis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">builder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#triton.program_id" title="Permalink to this definition"></a></dt>
<dd><p>Returns the id of the current program instance along the given <cite>axis</cite>.
Triton uses an SPMD model in which different &#64;triton.jit functions run in parallel with different <a href="#id1"><span class="problematic" id="id2">`</span></a>program_id`s.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>axis</strong> (<em>int</em>) The axis of the 3D launch grid. Has to be either 0, 1 or 2.</p></li>
<li><p><strong>builder</strong> (<em>triton.ir.builder</em>) IR builder to generate code into, optional from within &#64;triton.jit functions</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="triton.num_programs.html" class="btn btn-neutral float-right" title="triton.num_programs" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="../index.html" class="btn btn-neutral float-left" title="Python API" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; 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>