This commit is contained in:
CircleCI Docs
2025-01-09 21:56:20 +00:00
parent 04b749a588
commit d8d647015b
2642 changed files with 137687 additions and 70861 deletions

View File

@@ -3,7 +3,7 @@
<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.12.0"/>
<meta name="generator" content="Doxygen 1.13.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: mlx/backend/metal/kernels/softmax.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -11,11 +11,18 @@
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -28,12 +35,24 @@
<div id="projectname">MLX
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<!-- Generated by Doxygen 1.13.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -44,22 +63,23 @@ var searchBox = new SearchBox("searchBox", "search/",'.html');
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
$(function(){initNavTree('kernels_2softmax_8h_source.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -81,12 +101,6 @@ $(function(){ initResizable(false); });
</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_70a37effa88bcbd6b791977fa1e64356.html">kernels</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="headertitle"><div class="title">softmax.h</div></div>
</div><!--header-->
@@ -129,17 +143,17 @@ $(function(){ initResizable(false); });
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> } <span class="keywordflow">else</span> {</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; N_READS; i++) {</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> ld[i] =</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> ((lid * N_READS + i) &lt; axis_size) ? AccT(in[i]) : <a class="code hl_struct" href="struct_limits.html">Limits&lt;AccT&gt;::min</a>;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> ((lid * N_READS + i) &lt; axis_size) ? AccT(in[i]) : <a class="code hl_variable" href="struct_limits.html#a6e81584ba65a4dc6ff9366b458e3a20e">Limits&lt;AccT&gt;::min</a>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> }</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> }</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keywordflow">if</span> (simd_group_id == 0) {</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> local_max[simd_lane_id] = <a class="code hl_struct" href="struct_limits.html">Limits&lt;AccT&gt;::min</a>;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> local_max[simd_lane_id] = <a class="code hl_variable" href="struct_limits.html#a6e81584ba65a4dc6ff9366b458e3a20e">Limits&lt;AccT&gt;::min</a>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> local_normalizer[simd_lane_id] = 0;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> }</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> threadgroup_barrier(mem_flags::mem_threadgroup);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="comment">// Get the max</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> AccT maxval = <a class="code hl_struct" href="struct_limits.html">Limits&lt;AccT&gt;::finite_min</a>;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> AccT maxval = <a class="code hl_variable" href="struct_limits.html#ae7469d21f2688797ca3e388d919ef05e">Limits&lt;AccT&gt;::finite_min</a>;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; N_READS; i++) {</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> maxval = (maxval &lt; ld[i]) ? ld[i] : maxval;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> }</div>
@@ -214,7 +228,7 @@ $(function(){ initResizable(false); });
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> </div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> <span class="comment">// Get the max and the normalizer in one go</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> AccT prevmax;</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> AccT maxval = <a class="code hl_struct" href="struct_limits.html">Limits&lt;AccT&gt;::finite_min</a>;</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> AccT maxval = <a class="code hl_variable" href="struct_limits.html#ae7469d21f2688797ca3e388d919ef05e">Limits&lt;AccT&gt;::finite_min</a>;</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> AccT normalizer = 0;</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> r = 0; r &lt; static_cast&lt;int&gt;(<a class="code hl_function" href="backend_2metal_2kernels_2utils_8h.html#a8e5a4b0fb5d018d7b078d147efe4f1e3">ceildiv</a>(axis_size, N_READS * lsize));</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> r++) {</div>
@@ -227,7 +241,7 @@ $(function(){ initResizable(false); });
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> } <span class="keywordflow">else</span> {</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; N_READS; i++) {</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> vals[i] = (offset + i &lt; axis_size) ? AccT(in[offset + i])</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> : <a class="code hl_struct" href="struct_limits.html">Limits&lt;AccT&gt;::finite_min</a>;</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> : <a class="code hl_variable" href="struct_limits.html#ae7469d21f2688797ca3e388d919ef05e">Limits&lt;AccT&gt;::finite_min</a>;</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> }</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> }</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> prevmax = maxval;</div>
@@ -287,17 +301,21 @@ $(function(){ initResizable(false); });
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span> }</div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno"> 190</span>}</div>
</div>
<div class="ttc" id="abackend_2metal_2kernels_2utils_8h_html_a8e5a4b0fb5d018d7b078d147efe4f1e3"><div class="ttname"><a href="backend_2metal_2kernels_2utils_8h.html#a8e5a4b0fb5d018d7b078d147efe4f1e3">ceildiv</a></div><div class="ttdeci">T ceildiv(T N, U M)</div><div class="ttdoc">Compute ceil((float)N/(float)M)</div><div class="ttdef"><b>Definition</b> utils.h:313</div></div>
<div class="ttc" id="abackend_2metal_2kernels_2utils_8h_html_a8e5a4b0fb5d018d7b078d147efe4f1e3"><div class="ttname"><a href="backend_2metal_2kernels_2utils_8h.html#a8e5a4b0fb5d018d7b078d147efe4f1e3">ceildiv</a></div><div class="ttdeci">T ceildiv(T N, U M)</div><div class="ttdoc">Compute ceil((float)N/(float)M)</div><div class="ttdef"><b>Definition</b> utils.h:302</div></div>
<div class="ttc" id="akernels_2softmax_8h_html_a440d4031ee5e86159a4dd715e44a438b"><div class="ttname"><a href="kernels_2softmax_8h.html#a440d4031ee5e86159a4dd715e44a438b">softmax_exp</a></div><div class="ttdeci">T softmax_exp(T x)</div><div class="ttdef"><b>Definition</b> softmax.h:4</div></div>
<div class="ttc" id="akernels_2softmax_8h_html_a815fe70f879f318e5d6e99acf043f52b"><div class="ttname"><a href="kernels_2softmax_8h.html#a815fe70f879f318e5d6e99acf043f52b">softmax_single_row</a></div><div class="ttdeci">void softmax_single_row(const device T *in, device T *out, constant int &amp;axis_size, uint gid, uint _lid, uint simd_lane_id, uint simd_group_id)</div><div class="ttdef"><b>Definition</b> softmax.h:11</div></div>
<div class="ttc" id="akernels_2softmax_8h_html_a8c47b0924ebfeebcca25f3dd17373276"><div class="ttname"><a href="kernels_2softmax_8h.html#a8c47b0924ebfeebcca25f3dd17373276">softmax_looped</a></div><div class="ttdeci">void softmax_looped(const device T *in, device T *out, constant int &amp;axis_size, uint gid, uint lid, uint lsize, uint simd_lane_id, uint simd_group_id)</div><div class="ttdef"><b>Definition</b> softmax.h:101</div></div>
<div class="ttc" id="aquantized_8h_html_a62969a218d93680f5e35d0c61b160b99"><div class="ttname"><a href="quantized_8h.html#a62969a218d93680f5e35d0c61b160b99">SIMD_SIZE</a></div><div class="ttdeci">static constant constexpr const int SIMD_SIZE</div><div class="ttdef"><b>Definition</b> quantized.h:10</div></div>
<div class="ttc" id="astruct_limits_html"><div class="ttname"><a href="struct_limits.html">Limits</a></div><div class="ttdef"><b>Definition</b> utils.h:23</div></div>
<div class="ttc" id="astruct_limits_html_a6e81584ba65a4dc6ff9366b458e3a20e"><div class="ttname"><a href="struct_limits.html#a6e81584ba65a4dc6ff9366b458e3a20e">Limits::min</a></div><div class="ttdeci">static const constant U min</div><div class="ttdef"><b>Definition</b> utils.h:25</div></div>
<div class="ttc" id="astruct_limits_html_ae7469d21f2688797ca3e388d919ef05e"><div class="ttname"><a href="struct_limits.html#ae7469d21f2688797ca3e388d919ef05e">Limits::finite_min</a></div><div class="ttdeci">static const constant U finite_min</div><div class="ttdef"><b>Definition</b> utils.h:27</div></div>
</div><!-- fragment --></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.12.0
</small></address>
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<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_70a37effa88bcbd6b791977fa1e64356.html">kernels</a></li><li class="navelem"><a class="el" href="kernels_2softmax_8h.html">softmax.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.1 </li>
</ul>
</div>
</body>
</html>