mlx/docs/build/html/steel__gemm__fused_8h.html
CircleCI Docs c7080f89ca rebase
2025-06-04 01:01:55 +00:00

367 lines
19 KiB
HTML

<!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.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: mlx/backend/metal/kernels/steel/gemm/kernels/steel_gemm_fused.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>
<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>
<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>
<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.13.2 -->
<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>
</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(){initNavTree('steel__gemm__fused_8h.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">steel_gemm_fused.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a href="steel__gemm__fused_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="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a70d5b54bfae6471242d4e85675c929fd" id="r_a70d5b54bfae6471242d4e85675c929fd"><td class="memTemplParams" colspan="2">template&lt;typename T, int BM, int BN, int BK, int WM, int WN, bool transpose_a, bool transpose_b, typename AccumType = float&gt; </td></tr>
<tr class="memitem:a70d5b54bfae6471242d4e85675c929fd"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a70d5b54bfae6471242d4e85675c929fd">gemm</a> (const device T *A, const device T *B, const device T *C, device T *D, const constant <a class="el" href="structmlx_1_1steel_1_1_g_e_m_m_params.html">GEMMParams</a> *params, const constant <a class="el" href="structmlx_1_1steel_1_1_g_e_m_m_add_m_m_params.html">GEMMAddMMParams</a> *addmm_params, const constant int *batch_shape, const constant int64_t *batch_strides, const constant uint32_t *lhs_indices, const constant uint32_t *rhs_indices, const constant uint32_t *C_indices, const constant int *operand_shape, const constant int64_t *operand_strides, const constant packed_int3 &amp;operand_batch_ndim, uint simd_lane_id, uint simd_group_id, uint3 tid, uint3 lid)</td></tr>
<tr class="separator:a70d5b54bfae6471242d4e85675c929fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:adffcdc900c19ff97f1523e43f1a5a6cc" id="r_adffcdc900c19ff97f1523e43f1a5a6cc"><td class="memItemLeft" align="right" valign="top">constant bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adffcdc900c19ff97f1523e43f1a5a6cc">has_batch</a></td></tr>
<tr class="separator:adffcdc900c19ff97f1523e43f1a5a6cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3fe4e4382bda8a419557a5e6f77bc084" id="r_a3fe4e4382bda8a419557a5e6f77bc084"><td class="memItemLeft" align="right" valign="top">constant bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3fe4e4382bda8a419557a5e6f77bc084">use_out_source</a></td></tr>
<tr class="separator:a3fe4e4382bda8a419557a5e6f77bc084"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a703f06c849c89c37af7b1d27b0804a29" id="r_a703f06c849c89c37af7b1d27b0804a29"><td class="memItemLeft" align="right" valign="top">constant bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a703f06c849c89c37af7b1d27b0804a29">do_axpby</a></td></tr>
<tr class="separator:a703f06c849c89c37af7b1d27b0804a29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55af226dc74b0026b7d4b865142a6d21" id="r_a55af226dc74b0026b7d4b865142a6d21"><td class="memItemLeft" align="right" valign="top">constant bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a55af226dc74b0026b7d4b865142a6d21">align_M</a></td></tr>
<tr class="separator:a55af226dc74b0026b7d4b865142a6d21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3b267252df2dcbfdde8c5f174d27036" id="r_aa3b267252df2dcbfdde8c5f174d27036"><td class="memItemLeft" align="right" valign="top">constant bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa3b267252df2dcbfdde8c5f174d27036">align_N</a></td></tr>
<tr class="separator:aa3b267252df2dcbfdde8c5f174d27036"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8bdd2cecf97aa5b033152b1d0f0d2416" id="r_a8bdd2cecf97aa5b033152b1d0f0d2416"><td class="memItemLeft" align="right" valign="top">constant bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8bdd2cecf97aa5b033152b1d0f0d2416">align_K</a></td></tr>
<tr class="separator:a8bdd2cecf97aa5b033152b1d0f0d2416"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60efac3ac3b7cd64d096bbae38a3ac69" id="r_a60efac3ac3b7cd64d096bbae38a3ac69"><td class="memItemLeft" align="right" valign="top">constant bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a60efac3ac3b7cd64d096bbae38a3ac69">do_gather</a></td></tr>
<tr class="separator:a60efac3ac3b7cd64d096bbae38a3ac69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaaf17233201156be684f858bfd0f1b67" id="r_aaaf17233201156be684f858bfd0f1b67"><td class="memItemLeft" align="right" valign="top">constant bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaaf17233201156be684f858bfd0f1b67">gather_bias</a> = <a class="el" href="#a60efac3ac3b7cd64d096bbae38a3ac69">do_gather</a> &amp;&amp; <a class="el" href="#a3fe4e4382bda8a419557a5e6f77bc084">use_out_source</a></td></tr>
<tr class="separator:aaaf17233201156be684f858bfd0f1b67"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a70d5b54bfae6471242d4e85675c929fd" name="a70d5b54bfae6471242d4e85675c929fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70d5b54bfae6471242d4e85675c929fd">&#9670;&#160;</a></span>gemm()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T, int BM, int BN, int BK, int WM, int WN, bool transpose_a, bool transpose_b, typename AccumType = float&gt; </div>
<table class="memname">
<tr>
<td class="memname">void gemm </td>
<td>(</td>
<td class="paramtype">const device T *</td> <td class="paramname"><span class="paramname"><em>A</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const device T *</td> <td class="paramname"><span class="paramname"><em>B</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const device T *</td> <td class="paramname"><span class="paramname"><em>C</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device T *</td> <td class="paramname"><span class="paramname"><em>D</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const constant <a class="el" href="structmlx_1_1steel_1_1_g_e_m_m_params.html">GEMMParams</a> *</td> <td class="paramname"><span class="paramname"><em>params</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const constant <a class="el" href="structmlx_1_1steel_1_1_g_e_m_m_add_m_m_params.html">GEMMAddMMParams</a> *</td> <td class="paramname"><span class="paramname"><em>addmm_params</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const constant int *</td> <td class="paramname"><span class="paramname"><em>batch_shape</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const constant int64_t *</td> <td class="paramname"><span class="paramname"><em>batch_strides</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const constant uint32_t *</td> <td class="paramname"><span class="paramname"><em>lhs_indices</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const constant uint32_t *</td> <td class="paramname"><span class="paramname"><em>rhs_indices</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const constant uint32_t *</td> <td class="paramname"><span class="paramname"><em>C_indices</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const constant int *</td> <td class="paramname"><span class="paramname"><em>operand_shape</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const constant int64_t *</td> <td class="paramname"><span class="paramname"><em>operand_strides</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const constant packed_int3 &amp;</td> <td class="paramname"><span class="paramname"><em>operand_batch_ndim</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint</td> <td class="paramname"><span class="paramname"><em>simd_lane_id</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint</td> <td class="paramname"><span class="paramname"><em>simd_group_id</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint3</td> <td class="paramname"><span class="paramname"><em>tid</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint3</td> <td class="paramname"><span class="paramname"><em>lid</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a8bdd2cecf97aa5b033152b1d0f0d2416" name="a8bdd2cecf97aa5b033152b1d0f0d2416"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8bdd2cecf97aa5b033152b1d0f0d2416">&#9670;&#160;</a></span>align_K</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">constant bool align_K</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a55af226dc74b0026b7d4b865142a6d21" name="a55af226dc74b0026b7d4b865142a6d21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55af226dc74b0026b7d4b865142a6d21">&#9670;&#160;</a></span>align_M</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">constant bool align_M</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aa3b267252df2dcbfdde8c5f174d27036" name="aa3b267252df2dcbfdde8c5f174d27036"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3b267252df2dcbfdde8c5f174d27036">&#9670;&#160;</a></span>align_N</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">constant bool align_N</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a703f06c849c89c37af7b1d27b0804a29" name="a703f06c849c89c37af7b1d27b0804a29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a703f06c849c89c37af7b1d27b0804a29">&#9670;&#160;</a></span>do_axpby</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">constant bool do_axpby</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a60efac3ac3b7cd64d096bbae38a3ac69" name="a60efac3ac3b7cd64d096bbae38a3ac69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60efac3ac3b7cd64d096bbae38a3ac69">&#9670;&#160;</a></span>do_gather</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">constant bool do_gather</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aaaf17233201156be684f858bfd0f1b67" name="aaaf17233201156be684f858bfd0f1b67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaaf17233201156be684f858bfd0f1b67">&#9670;&#160;</a></span>gather_bias</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">constant bool gather_bias = <a class="el" href="#a60efac3ac3b7cd64d096bbae38a3ac69">do_gather</a> &amp;&amp; <a class="el" href="#a3fe4e4382bda8a419557a5e6f77bc084">use_out_source</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="adffcdc900c19ff97f1523e43f1a5a6cc" name="adffcdc900c19ff97f1523e43f1a5a6cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adffcdc900c19ff97f1523e43f1a5a6cc">&#9670;&#160;</a></span>has_batch</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">constant bool has_batch</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3fe4e4382bda8a419557a5e6f77bc084" name="a3fe4e4382bda8a419557a5e6f77bc084"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3fe4e4382bda8a419557a5e6f77bc084">&#9670;&#160;</a></span>use_out_source</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">constant bool use_out_source</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
</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="dir_76215a6c54e2b67053e723fc2395583c.html">steel</a></li><li class="navelem"><a class="el" href="dir_6768c99e6145fb9510ccdb40db8ede25.html">gemm</a></li><li class="navelem"><a class="el" href="dir_9c555e3d0f5b8c3fb3a7397c81fd5bf9.html">kernels</a></li><li class="navelem"><a class="el" href="steel__gemm__fused_8h.html">steel_gemm_fused.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.2 </li>
</ul>
</div>
</body>
</html>