zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-11-04 10:38:10 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
Files
721548a7996c1f68541092ddf6593cd447ccf1d7
mlx/docs/build/html/reduce__all_8h_source.html
CircleCI Docs 2d528f6927 rebase
2025-10-17 19:14:58 +00:00

168 lines
14 KiB
HTML
Raw Blame History

<!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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: mlx/backend/metal/kernels/reduction/reduce_all.h Source File</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>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<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>
<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.12.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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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',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); });
/* @license-end */
</script>
<!-- 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_70a37effa88bcbd6b791977fa1e64356.html">kernels</a></li><li class="navelem"><a class="el" href="dir_f60cd69d27fd3faa641c79056fff0e2d.html">reduction</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="headertitle"><div class="title">reduce_all.h</div></div>
</div><!--header-->
<div class="contents">
<a href="reduce__all_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright © 2023-2024 Apple Inc.</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, <span class="keyword">typename</span> U, <span class="keyword">typename</span> Op, <span class="keywordtype">int</span> N_READS = REDUCE_N_READS&gt;</div>
<div class="foldopen" id="foldopen00004" data-start="{" data-end="}">
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"><a class="line" href="reduce__all_8h.html#a99ef48ae72b3e715c5f4d7ea07cd213d"> 4</a></span>[[kernel]] <span class="keywordtype">void</span> <a class="code hl_function" href="reduce__all_8h.html#a99ef48ae72b3e715c5f4d7ea07cd213d">all_reduce</a>(</div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> <span class="keyword">const</span> device T* in [[buffer(0)]],</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> device U* out [[buffer(1)]],</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> <span class="keyword">const</span> constant <span class="keywordtype">size_t</span>&amp; in_size [[buffer(2)]],</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> <span class="keyword">const</span> constant <span class="keywordtype">size_t</span>&amp; row_size [[buffer(3)]],</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> uint3 gid [[threadgroup_position_in_grid]],</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> uint3 lid [[thread_position_in_threadgroup]],</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> uint3 lsize [[threads_per_threadgroup]],</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> uint simd_per_group [[simdgroups_per_threadgroup]],</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> uint simd_lane_id [[thread_index_in_simdgroup]],</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> uint simd_group_id [[simdgroup_index_in_threadgroup]]) {</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> Op <a class="code hl_variable" href="common_2binary_8h.html#a70228731d29946574b238d21fb4b360c">op</a>;</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> threadgroup U shared_vals[<a class="code hl_variable" href="backend_2metal_2kernels_2reduction_2ops_8h.html#a515b75d563a93d3c09ee677948dc83e3">simd_size</a>];</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> U total = Op::init;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> int64_t start_idx = gid.y * row_size;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> int64_t actual_row =</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> (start_idx + row_size &lt;= in_size) ? row_size : in_size - start_idx;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> int64_t blocks = actual_row / (lsize.x * N_READS);</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keywordtype">int</span> extra = actual_row - blocks * (lsize.x * N_READS);</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> extra -= lid.x * N_READS;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> start_idx += lid.x * N_READS;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> in += start_idx;</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordflow">if</span> (extra &gt;= N_READS) {</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> blocks++;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> extra = 0;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> }</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordflow">for</span> (int64_t b = 0; b &lt; blocks; b++) {</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> total = <a class="code hl_variable" href="common_2binary_8h.html#a70228731d29946574b238d21fb4b360c">op</a>(<span class="keyword">static_cast&lt;</span>U<span class="keyword">&gt;</span>(in[i]), total);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> }</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> in += lsize.x * N_READS;</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> (extra &gt; 0) {</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; extra; i++) {</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> total = <a class="code hl_variable" href="common_2binary_8h.html#a70228731d29946574b238d21fb4b360c">op</a>(<span class="keyword">static_cast&lt;</span>U<span class="keyword">&gt;</span>(in[i]), total);</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> }</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">// Reduction within simd group</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> total = <a class="code hl_variable" href="common_2binary_8h.html#a70228731d29946574b238d21fb4b360c">op</a>.simd_reduce(total);</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keywordflow">if</span> (simd_per_group &gt; 1) {</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keywordflow">if</span> (simd_lane_id == 0) {</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> shared_vals[simd_group_id] = total;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> }</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// Reduction within thread group</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> threadgroup_barrier(mem_flags::mem_threadgroup);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> total = lid.x &lt; simd_per_group ? shared_vals[lid.x] : <a class="code hl_variable" href="common_2binary_8h.html#a70228731d29946574b238d21fb4b360c">op</a>.init;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> total = <a class="code hl_variable" href="common_2binary_8h.html#a70228731d29946574b238d21fb4b360c">op</a>.simd_reduce(total);</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> }</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keywordflow">if</span> (lid.x == 0) {</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> out[gid.y] = total;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> }</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span>}</div>
</div>
<div class="ttc" id="abackend_2metal_2kernels_2reduction_2ops_8h_html_a515b75d563a93d3c09ee677948dc83e3"><div class="ttname"><a href="backend_2metal_2kernels_2reduction_2ops_8h.html#a515b75d563a93d3c09ee677948dc83e3">simd_size</a></div><div class="ttdeci">static constant constexpr const uint8_t simd_size</div><div class="ttdef"><b>Definition</b> ops.h:22</div></div>
<div class="ttc" id="acommon_2binary_8h_html_a70228731d29946574b238d21fb4b360c"><div class="ttname"><a href="common_2binary_8h.html#a70228731d29946574b238d21fb4b360c">op</a></div><div class="ttdeci">Op op</div><div class="ttdef"><b>Definition</b> binary.h:129</div></div>
<div class="ttc" id="areduce__all_8h_html_a99ef48ae72b3e715c5f4d7ea07cd213d"><div class="ttname"><a href="reduce__all_8h.html#a99ef48ae72b3e715c5f4d7ea07cd213d">all_reduce</a></div><div class="ttdeci">void all_reduce(const device T *in, device U *out, const constant size_t &amp;in_size, const constant size_t &amp;row_size, uint3 gid, uint3 lid, uint3 lsize, uint simd_per_group, uint simd_lane_id, uint simd_group_id)</div><div class="ttdef"><b>Definition</b> reduce_all.h:4</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 -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink