mirror of
https://github.com/ml-explore/mlx.git
synced 2025-06-25 18:11:15 +08:00
323 lines
15 KiB
HTML
323 lines
15 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/defines.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&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()"> </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&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&dn=expat.txt MIT */
|
|
$(function(){initNavTree('defines_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="#define-members">Macros</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle"><div class="title">defines.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a href="defines_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="define-members" name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:a767ed9f2604de22b259cee02c4ce1d22" id="r_a767ed9f2604de22b259cee02c4ce1d22"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a767ed9f2604de22b259cee02c4ce1d22">MTL_CONST</a></td></tr>
|
|
<tr class="separator:a767ed9f2604de22b259cee02c4ce1d22"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0cc4a821c1090d4183ff3a31da7e9f7b" id="r_a0cc4a821c1090d4183ff3a31da7e9f7b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0cc4a821c1090d4183ff3a31da7e9f7b">instantiate_kernel</a>(name, func, ...)</td></tr>
|
|
<tr class="separator:a0cc4a821c1090d4183ff3a31da7e9f7b"><td class="memSeparator" colspan="2"> </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:a15629f1b81a2b6f1cca26d07a2734623" id="r_a15629f1b81a2b6f1cca26d07a2734623"><td class="memItemLeft" align="right" valign="top">static constexpr int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a15629f1b81a2b6f1cca26d07a2734623">MAX_REDUCE_SPECIALIZED_DIMS</a> = 4</td></tr>
|
|
<tr class="separator:a15629f1b81a2b6f1cca26d07a2734623"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2ad505864a2ab786147766900bc18c21" id="r_a2ad505864a2ab786147766900bc18c21"><td class="memItemLeft" align="right" valign="top">static constexpr int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2ad505864a2ab786147766900bc18c21">REDUCE_N_READS</a> = 4</td></tr>
|
|
<tr class="separator:a2ad505864a2ab786147766900bc18c21"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a68c33274e15a2f163f7631a36280d82f" id="r_a68c33274e15a2f163f7631a36280d82f"><td class="memItemLeft" align="right" valign="top">static constexpr int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a68c33274e15a2f163f7631a36280d82f">REDUCE_N_WRITES</a> = 4</td></tr>
|
|
<tr class="separator:a68c33274e15a2f163f7631a36280d82f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a722995df24286b27b7da3d74b73f768d" id="r_a722995df24286b27b7da3d74b73f768d"><td class="memItemLeft" align="right" valign="top">static constexpr int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a722995df24286b27b7da3d74b73f768d">SOFTMAX_N_READS</a> = 4</td></tr>
|
|
<tr class="separator:a722995df24286b27b7da3d74b73f768d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a89c0a33ba39a881ad3458ffdde62a24f" id="r_a89c0a33ba39a881ad3458ffdde62a24f"><td class="memItemLeft" align="right" valign="top">static constexpr int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a89c0a33ba39a881ad3458ffdde62a24f">RMS_N_READS</a> = 4</td></tr>
|
|
<tr class="separator:a89c0a33ba39a881ad3458ffdde62a24f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a717a175676c3f96d74adfde7e751a541" id="r_a717a175676c3f96d74adfde7e751a541"><td class="memItemLeft" align="right" valign="top">static constexpr int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a717a175676c3f96d74adfde7e751a541">RMS_LOOPED_LIMIT</a> = 4096</td></tr>
|
|
<tr class="separator:a717a175676c3f96d74adfde7e751a541"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="a0cc4a821c1090d4183ff3a31da7e9f7b" name="a0cc4a821c1090d4183ff3a31da7e9f7b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0cc4a821c1090d4183ff3a31da7e9f7b">◆ </a></span>instantiate_kernel</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define instantiate_kernel</td>
|
|
<td>(</td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>func</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em></em></span>... )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"> <span class="keyword">template</span> [[host_name( \</div>
|
|
<div class="line"> name)]] [[kernel]] <span class="keyword">decltype</span>(func<__VA_ARGS__>) func<__VA_ARGS__>;</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a767ed9f2604de22b259cee02c4ce1d22" name="a767ed9f2604de22b259cee02c4ce1d22"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a767ed9f2604de22b259cee02c4ce1d22">◆ </a></span>MTL_CONST</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MTL_CONST</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
|
<a id="a15629f1b81a2b6f1cca26d07a2734623" name="a15629f1b81a2b6f1cca26d07a2734623"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a15629f1b81a2b6f1cca26d07a2734623">◆ </a></span>MAX_REDUCE_SPECIALIZED_DIMS</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int MAX_REDUCE_SPECIALIZED_DIMS = 4</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2ad505864a2ab786147766900bc18c21" name="a2ad505864a2ab786147766900bc18c21"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2ad505864a2ab786147766900bc18c21">◆ </a></span>REDUCE_N_READS</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int REDUCE_N_READS = 4</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a68c33274e15a2f163f7631a36280d82f" name="a68c33274e15a2f163f7631a36280d82f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a68c33274e15a2f163f7631a36280d82f">◆ </a></span>REDUCE_N_WRITES</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int REDUCE_N_WRITES = 4</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a717a175676c3f96d74adfde7e751a541" name="a717a175676c3f96d74adfde7e751a541"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a717a175676c3f96d74adfde7e751a541">◆ </a></span>RMS_LOOPED_LIMIT</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int RMS_LOOPED_LIMIT = 4096</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a89c0a33ba39a881ad3458ffdde62a24f" name="a89c0a33ba39a881ad3458ffdde62a24f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a89c0a33ba39a881ad3458ffdde62a24f">◆ </a></span>RMS_N_READS</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int RMS_N_READS = 4</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a722995df24286b27b7da3d74b73f768d" name="a722995df24286b27b7da3d74b73f768d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a722995df24286b27b7da3d74b73f768d">◆ </a></span>SOFTMAX_N_READS</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int SOFTMAX_N_READS = 4</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </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="defines_8h.html">defines.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>
|