mirror of
https://github.com/ml-explore/mlx.git
synced 2025-06-26 02:33:21 +08:00
152 lines
13 KiB
HTML
152 lines
13 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 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="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_source.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="headertitle"><div class="title">defines.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="defines_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 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="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#if defined __METAL__ || defined MLX_METAL_JIT</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#define MTL_CONST constant</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#else</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"><a class="line" href="defines_8h.html#a767ed9f2604de22b259cee02c4ce1d22"> 8</a></span><span class="preprocessor">#define MTL_CONST</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="defines_8h.html#a15629f1b81a2b6f1cca26d07a2734623"> 11</a></span><span class="keyword">static</span> <a class="code hl_define" href="defines_8h.html#a767ed9f2604de22b259cee02c4ce1d22">MTL_CONST</a> <span class="keyword">constexpr</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="defines_8h.html#a15629f1b81a2b6f1cca26d07a2734623">MAX_REDUCE_SPECIALIZED_DIMS</a> = 4;</div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="defines_8h.html#a2ad505864a2ab786147766900bc18c21"> 12</a></span><span class="keyword">static</span> <a class="code hl_define" href="defines_8h.html#a767ed9f2604de22b259cee02c4ce1d22">MTL_CONST</a> <span class="keyword">constexpr</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="defines_8h.html#a2ad505864a2ab786147766900bc18c21">REDUCE_N_READS</a> = 4;</div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="defines_8h.html#a68c33274e15a2f163f7631a36280d82f"> 13</a></span><span class="keyword">static</span> <a class="code hl_define" href="defines_8h.html#a767ed9f2604de22b259cee02c4ce1d22">MTL_CONST</a> <span class="keyword">constexpr</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="defines_8h.html#a68c33274e15a2f163f7631a36280d82f">REDUCE_N_WRITES</a> = 4;</div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="defines_8h.html#a722995df24286b27b7da3d74b73f768d"> 14</a></span><span class="keyword">static</span> <a class="code hl_define" href="defines_8h.html#a767ed9f2604de22b259cee02c4ce1d22">MTL_CONST</a> <span class="keyword">constexpr</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="defines_8h.html#a722995df24286b27b7da3d74b73f768d">SOFTMAX_N_READS</a> = 4;</div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="defines_8h.html#a89c0a33ba39a881ad3458ffdde62a24f"> 15</a></span><span class="keyword">static</span> <a class="code hl_define" href="defines_8h.html#a767ed9f2604de22b259cee02c4ce1d22">MTL_CONST</a> <span class="keyword">constexpr</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="defines_8h.html#a89c0a33ba39a881ad3458ffdde62a24f">RMS_N_READS</a> = 4;</div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="defines_8h.html#a717a175676c3f96d74adfde7e751a541"> 16</a></span><span class="keyword">static</span> <a class="code hl_define" href="defines_8h.html#a767ed9f2604de22b259cee02c4ce1d22">MTL_CONST</a> <span class="keyword">constexpr</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="defines_8h.html#a717a175676c3f96d74adfde7e751a541">RMS_LOOPED_LIMIT</a> = 4096;</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><span class="comment">// Instantiate a templated kernel.</span></div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment">// Extra args are used as template parameters:</span></div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment">// e.g. instantiate_kernel(binary_int, binary, a, b) -></span></div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment">// [[host_name(binary_int)]] [kernel] binary<a, b></span></div>
|
|
<div class="foldopen" id="foldopen00022" data-start="" data-end="">
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="defines_8h.html#a0cc4a821c1090d4183ff3a31da7e9f7b"> 22</a></span><span class="preprocessor">#define instantiate_kernel(name, func, ...) \</span></div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor"> template [[host_name( \</span></div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor"> name)]] [[kernel]] decltype(func<__VA_ARGS__>) func<__VA_ARGS__>;</span></div>
|
|
</div>
|
|
<div class="ttc" id="adefines_8h_html_a15629f1b81a2b6f1cca26d07a2734623"><div class="ttname"><a href="defines_8h.html#a15629f1b81a2b6f1cca26d07a2734623">MAX_REDUCE_SPECIALIZED_DIMS</a></div><div class="ttdeci">static constexpr int MAX_REDUCE_SPECIALIZED_DIMS</div><div class="ttdef"><b>Definition</b> defines.h:11</div></div>
|
|
<div class="ttc" id="adefines_8h_html_a2ad505864a2ab786147766900bc18c21"><div class="ttname"><a href="defines_8h.html#a2ad505864a2ab786147766900bc18c21">REDUCE_N_READS</a></div><div class="ttdeci">static constexpr int REDUCE_N_READS</div><div class="ttdef"><b>Definition</b> defines.h:12</div></div>
|
|
<div class="ttc" id="adefines_8h_html_a68c33274e15a2f163f7631a36280d82f"><div class="ttname"><a href="defines_8h.html#a68c33274e15a2f163f7631a36280d82f">REDUCE_N_WRITES</a></div><div class="ttdeci">static constexpr int REDUCE_N_WRITES</div><div class="ttdef"><b>Definition</b> defines.h:13</div></div>
|
|
<div class="ttc" id="adefines_8h_html_a717a175676c3f96d74adfde7e751a541"><div class="ttname"><a href="defines_8h.html#a717a175676c3f96d74adfde7e751a541">RMS_LOOPED_LIMIT</a></div><div class="ttdeci">static constexpr int RMS_LOOPED_LIMIT</div><div class="ttdef"><b>Definition</b> defines.h:16</div></div>
|
|
<div class="ttc" id="adefines_8h_html_a722995df24286b27b7da3d74b73f768d"><div class="ttname"><a href="defines_8h.html#a722995df24286b27b7da3d74b73f768d">SOFTMAX_N_READS</a></div><div class="ttdeci">static constexpr int SOFTMAX_N_READS</div><div class="ttdef"><b>Definition</b> defines.h:14</div></div>
|
|
<div class="ttc" id="adefines_8h_html_a767ed9f2604de22b259cee02c4ce1d22"><div class="ttname"><a href="defines_8h.html#a767ed9f2604de22b259cee02c4ce1d22">MTL_CONST</a></div><div class="ttdeci">#define MTL_CONST</div><div class="ttdef"><b>Definition</b> defines.h:8</div></div>
|
|
<div class="ttc" id="adefines_8h_html_a89c0a33ba39a881ad3458ffdde62a24f"><div class="ttname"><a href="defines_8h.html#a89c0a33ba39a881ad3458ffdde62a24f">RMS_N_READS</a></div><div class="ttdeci">static constexpr int RMS_N_READS</div><div class="ttdef"><b>Definition</b> defines.h:15</div></div>
|
|
</div><!-- fragment --></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>
|