zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-11-04 02:28:13 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
Awni Hannun
2024-05-23 21:11:24 -07:00
committed by CircleCI Docs
parent a7d2c589b2
commit 4f6d88f179
1837 changed files with 6038 additions and 255894 deletions
Download Patch File Download Diff File Expand all files Collapse all files

119
docs/build/html/defines_8h_source.html vendored
View File

@@ -1,119 +0,0 @@
<!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.10.0"/>
<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>
<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.10.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" 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');
$(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() { codefold.init(0); });
/* @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> </ul>
</div>
</div><!-- top -->
<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">#ifdef __METAL__</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#ac96c48525d1351dc3e5f2abcdf283bf3"> 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#ac96c48525d1351dc3e5f2abcdf283bf3">MAX_BINARY_SPECIALIZED_DIMS</a> = 5;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="defines_8h.html#a1334e8a0b44129f40d5545b47b3b8d7a"> 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#a1334e8a0b44129f40d5545b47b3b8d7a">MAX_COPY_SPECIALIZED_DIMS</a> = 5;</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="defines_8h.html#a15629f1b81a2b6f1cca26d07a2734623"> 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#a15629f1b81a2b6f1cca26d07a2734623">MAX_REDUCE_SPECIALIZED_DIMS</a> = 4;</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="defines_8h.html#a2ad505864a2ab786147766900bc18c21"> 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#a2ad505864a2ab786147766900bc18c21">REDUCE_N_READS</a> = 16;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="defines_8h.html#a722995df24286b27b7da3d74b73f768d"> 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#a722995df24286b27b7da3d74b73f768d">SOFTMAX_N_READS</a> = 4;</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="defines_8h.html#a8c399de34cae1d5071505d7c61d0e0f3"> 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#a8c399de34cae1d5071505d7c61d0e0f3">SOFTMAX_LOOPED_LIMIT</a> = 4096;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="defines_8h.html#a89c0a33ba39a881ad3458ffdde62a24f"> 17</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="l00018" name="l00018"></a><span class="lineno"><a class="line" href="defines_8h.html#a717a175676c3f96d74adfde7e751a541"> 18</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="ttc" id="adefines_8h_html_a1334e8a0b44129f40d5545b47b3b8d7a"><div class="ttname"><a href="defines_8h.html#a1334e8a0b44129f40d5545b47b3b8d7a">MAX_COPY_SPECIALIZED_DIMS</a></div><div class="ttdeci">static constexpr int MAX_COPY_SPECIALIZED_DIMS</div><div class="ttdef"><b>Definition</b> defines.h:12</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:13</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:14</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:18</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:15</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:17</div></div>
<div class="ttc" id="adefines_8h_html_a8c399de34cae1d5071505d7c61d0e0f3"><div class="ttname"><a href="defines_8h.html#a8c399de34cae1d5071505d7c61d0e0f3">SOFTMAX_LOOPED_LIMIT</a></div><div class="ttdeci">static constexpr int SOFTMAX_LOOPED_LIMIT</div><div class="ttdef"><b>Definition</b> defines.h:16</div></div>
<div class="ttc" id="adefines_8h_html_ac96c48525d1351dc3e5f2abcdf283bf3"><div class="ttname"><a href="defines_8h.html#ac96c48525d1351dc3e5f2abcdf283bf3">MAX_BINARY_SPECIALIZED_DIMS</a></div><div class="ttdeci">static constexpr int MAX_BINARY_SPECIALIZED_DIMS</div><div class="ttdef"><b>Definition</b> defines.h:11</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.10.0
</small></address>
</body>
</html>