mlx/docs/build/html/jit_2softmax_8h.html

142 lines
7.0 KiB
HTML
Raw Normal View History

2024-06-07 11:28:06 +08:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: mlx/backend/metal/jit/softmax.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">MLX
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_938ab0ecf10b8b860ff766c820f665fd.html">mlx</a></li><li class="navelem"><a class="el" href="dir_1d446c9bd3c99228254c9484e0bc5c06.html">backend</a></li><li class="navelem"><a class="el" href="dir_d0c977ea65824390717cdb7efc36c157.html">metal</a></li><li class="navelem"><a class="el" href="dir_4336740ec0075891704443b417fef6cb.html">jit</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">softmax.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a href="jit_2softmax_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a1cbfb210a9a765c6620e9f1247ccef12" id="r_a1cbfb210a9a765c6620e9f1247ccef12"><td class="memItemLeft" align="right" valign="top">constexpr std::string_view&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1cbfb210a9a765c6620e9f1247ccef12">softmax_kernels</a></td></tr>
<tr class="separator:a1cbfb210a9a765c6620e9f1247ccef12"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a1cbfb210a9a765c6620e9f1247ccef12" name="a1cbfb210a9a765c6620e9f1247ccef12"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1cbfb210a9a765c6620e9f1247ccef12">&#9670;&#160;</a></span>softmax_kernels</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr std::string_view softmax_kernels</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= R<span class="stringliteral">&quot;(</span></div>
<div class="line"><span class="stringliteral">template [[host_name(&quot;block_{0}&quot;)]] [[kernel]] void</span></div>
<div class="line"><span class="stringliteral">softmax_single_row&lt;{1}, {2}&gt;(</span></div>
<div class="line"><span class="stringliteral"> const device {1}* in,</span></div>
<div class="line"><span class="stringliteral"> device {1}* out,</span></div>
<div class="line"><span class="stringliteral"> constant int&amp; axis_size,</span></div>
<div class="line"><span class="stringliteral"> uint gid [[thread_position_in_grid]],</span></div>
<div class="line"><span class="stringliteral"> uint _lid [[thread_position_in_threadgroup]],</span></div>
<div class="line"><span class="stringliteral"> uint simd_lane_id [[thread_index_in_simdgroup]],</span></div>
<div class="line"><span class="stringliteral"> uint simd_group_id [[simdgroup_index_in_threadgroup]]);</span></div>
<div class="line"><span class="stringliteral">template [[host_name(&quot;looped_{0}&quot;)]] [[kernel]] void</span></div>
<div class="line"><span class="stringliteral">softmax_looped&lt;{1}, {2}&gt;(</span></div>
<div class="line"><span class="stringliteral"> const device {1}* in,</span></div>
<div class="line"><span class="stringliteral"> device {1}* out,</span></div>
<div class="line"><span class="stringliteral"> constant int&amp; axis_size,</span></div>
<div class="line"><span class="stringliteral"> uint gid [[threadgroup_position_in_grid]],</span></div>
<div class="line"><span class="stringliteral"> uint lid [[thread_position_in_threadgroup]],</span></div>
<div class="line"><span class="stringliteral"> uint lsize [[threads_per_threadgroup]],</span></div>
<div class="line"><span class="stringliteral"> uint simd_lane_id [[thread_index_in_simdgroup]],</span></div>
<div class="line"><span class="stringliteral"> uint simd_group_id [[simdgroup_index_in_threadgroup]]);</span></div>
<div class="line"><span class="stringliteral">)&quot;</span></div>
</div><!-- fragment -->
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>