mirror of
https://github.com/ml-explore/mlx.git
synced 2025-06-26 02:33:21 +08:00
151 lines
15 KiB
HTML
151 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.12.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>MLX: mlx/compile.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&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>
|
|
<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&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&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> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">compile.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="compile_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="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">#include "<a class="code" href="array_8h.html">mlx/array.h</a>"</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacemlx_1_1core.html">mlx::core</a> {</div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#adb15ff2b1ca5207fd4f6e631e2c3bcb4"> 9</a></span><span class="keyword">enum class</span> <a class="code hl_enumeration" href="namespacemlx_1_1core.html#adb15ff2b1ca5207fd4f6e631e2c3bcb4">CompileMode</a> { <a class="code hl_enumvalue" href="namespacemlx_1_1core.html#adb15ff2b1ca5207fd4f6e631e2c3bcb4a075ae3d2fc31640504f814f60e5ef713">disabled</a>, <a class="code hl_enumvalue" href="namespacemlx_1_1core.html#adb15ff2b1ca5207fd4f6e631e2c3bcb4a8e5611dfddbae6e68624c59aa3e4e3e2">no_simplify</a>, <a class="code hl_enumvalue" href="namespacemlx_1_1core.html#adb15ff2b1ca5207fd4f6e631e2c3bcb4ada8df7fd43da6073fec4fe5666b03dbb">no_fuse</a>, <a class="code hl_enumvalue" href="namespacemlx_1_1core.html#adb15ff2b1ca5207fd4f6e631e2c3bcb4aa10311459433adf322f2590a4987c423">enabled</a> };</div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a55933c6665de9f81059120d6b0de1c87"> 12</a></span>std::function<std::vector<array>(<span class="keyword">const</span> std::vector<array>&)> <a class="code hl_function" href="namespacemlx_1_1core.html#a55933c6665de9f81059120d6b0de1c87">compile</a>(</div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> std::function<std::vector<array>(<span class="keyword">const</span> std::vector<array>&)> fun,</div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <span class="keywordtype">bool</span> shapeless = <span class="keyword">false</span>);</div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a56de948c2dffbf35c88035bc1561db53"> 16</a></span>std::function<std::vector<array>(<span class="keyword">const</span> std::vector<array>&)> <a class="code hl_function" href="namespacemlx_1_1core.html#a55933c6665de9f81059120d6b0de1c87">compile</a>(</div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> std::vector<array>(fun)(<span class="keyword">const</span> std::vector<array>&),</div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="keywordtype">bool</span> shapeless = <span class="keyword">false</span>);</div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment">// Convert capture-less lambdas to function pointers.</span></div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="keyword">template</span> <</div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">typename</span> F,</div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">typename</span> = std::enable_if_t<</div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> std::is_convertible_v<F, decltype(+std::declval<F>())>>></div>
|
|
<div class="foldopen" id="foldopen00025" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#ace67713d269595f5f2265e46728a6f9c"> 25</a></span>std::function<std::vector<array>(<span class="keyword">const</span> std::vector<array>&)> <a class="code hl_function" href="namespacemlx_1_1core.html#a55933c6665de9f81059120d6b0de1c87">compile</a>(</div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> F&& <a class="code hl_variable" href="types_2bf16_8h.html#af900396d7b72ff2a7002e8befe8cf8f1">f</a>,</div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keywordtype">bool</span> shapeless = <span class="keyword">false</span>) {</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a55933c6665de9f81059120d6b0de1c87">compile</a>(+<a class="code hl_variable" href="types_2bf16_8h.html#af900396d7b72ff2a7002e8befe8cf8f1">f</a>, shapeless);</div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span>}</div>
|
|
</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a5f5fea955057bb3842b271b037909e66"> 35</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a5f5fea955057bb3842b271b037909e66">disable_compile</a>();</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a1983a2466bff3bae4d23cf34bd0946c9"> 40</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a1983a2466bff3bae4d23cf34bd0946c9">enable_compile</a>();</div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a49445a55f976c4397f25ea18e1e92bef"> 43</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a49445a55f976c4397f25ea18e1e92bef">set_compile_mode</a>(<a class="code hl_enumeration" href="namespacemlx_1_1core.html#adb15ff2b1ca5207fd4f6e631e2c3bcb4">CompileMode</a> mode);</div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span>} <span class="comment">// namespace mlx::core</span></div>
|
|
<div class="ttc" id="aarray_8h_html"><div class="ttname"><a href="array_8h.html">array.h</a></div></div>
|
|
<div class="ttc" id="anamespacemlx_1_1core_html"><div class="ttname"><a href="namespacemlx_1_1core.html">mlx::core</a></div><div class="ttdef"><b>Definition</b> allocator.h:7</div></div>
|
|
<div class="ttc" id="anamespacemlx_1_1core_html_a1983a2466bff3bae4d23cf34bd0946c9"><div class="ttname"><a href="namespacemlx_1_1core.html#a1983a2466bff3bae4d23cf34bd0946c9">mlx::core::enable_compile</a></div><div class="ttdeci">void enable_compile()</div><div class="ttdoc">Globally enable compilation.</div></div>
|
|
<div class="ttc" id="anamespacemlx_1_1core_html_a49445a55f976c4397f25ea18e1e92bef"><div class="ttname"><a href="namespacemlx_1_1core.html#a49445a55f976c4397f25ea18e1e92bef">mlx::core::set_compile_mode</a></div><div class="ttdeci">void set_compile_mode(CompileMode mode)</div><div class="ttdoc">Set the compiler mode to the given value.</div></div>
|
|
<div class="ttc" id="anamespacemlx_1_1core_html_a55933c6665de9f81059120d6b0de1c87"><div class="ttname"><a href="namespacemlx_1_1core.html#a55933c6665de9f81059120d6b0de1c87">mlx::core::compile</a></div><div class="ttdeci">std::function< std::vector< array >(const std::vector< array > &)> compile(std::function< std::vector< array >(const std::vector< array > &)> fun, bool shapeless=false)</div><div class="ttdoc">Compile takes a function and returns a compiled function.</div></div>
|
|
<div class="ttc" id="anamespacemlx_1_1core_html_a5f5fea955057bb3842b271b037909e66"><div class="ttname"><a href="namespacemlx_1_1core.html#a5f5fea955057bb3842b271b037909e66">mlx::core::disable_compile</a></div><div class="ttdeci">void disable_compile()</div><div class="ttdoc">Globally disable compilation.</div></div>
|
|
<div class="ttc" id="anamespacemlx_1_1core_html_adb15ff2b1ca5207fd4f6e631e2c3bcb4"><div class="ttname"><a href="namespacemlx_1_1core.html#adb15ff2b1ca5207fd4f6e631e2c3bcb4">mlx::core::CompileMode</a></div><div class="ttdeci">CompileMode</div><div class="ttdef"><b>Definition</b> compile.h:9</div></div>
|
|
<div class="ttc" id="anamespacemlx_1_1core_html_adb15ff2b1ca5207fd4f6e631e2c3bcb4a075ae3d2fc31640504f814f60e5ef713"><div class="ttname"><a href="namespacemlx_1_1core.html#adb15ff2b1ca5207fd4f6e631e2c3bcb4a075ae3d2fc31640504f814f60e5ef713">mlx::core::CompileMode::disabled</a></div><div class="ttdeci">@ disabled</div></div>
|
|
<div class="ttc" id="anamespacemlx_1_1core_html_adb15ff2b1ca5207fd4f6e631e2c3bcb4a8e5611dfddbae6e68624c59aa3e4e3e2"><div class="ttname"><a href="namespacemlx_1_1core.html#adb15ff2b1ca5207fd4f6e631e2c3bcb4a8e5611dfddbae6e68624c59aa3e4e3e2">mlx::core::CompileMode::no_simplify</a></div><div class="ttdeci">@ no_simplify</div></div>
|
|
<div class="ttc" id="anamespacemlx_1_1core_html_adb15ff2b1ca5207fd4f6e631e2c3bcb4aa10311459433adf322f2590a4987c423"><div class="ttname"><a href="namespacemlx_1_1core.html#adb15ff2b1ca5207fd4f6e631e2c3bcb4aa10311459433adf322f2590a4987c423">mlx::core::CompileMode::enabled</a></div><div class="ttdeci">@ enabled</div></div>
|
|
<div class="ttc" id="anamespacemlx_1_1core_html_adb15ff2b1ca5207fd4f6e631e2c3bcb4ada8df7fd43da6073fec4fe5666b03dbb"><div class="ttname"><a href="namespacemlx_1_1core.html#adb15ff2b1ca5207fd4f6e631e2c3bcb4ada8df7fd43da6073fec4fe5666b03dbb">mlx::core::CompileMode::no_fuse</a></div><div class="ttdeci">@ no_fuse</div></div>
|
|
<div class="ttc" id="atypes_2bf16_8h_html_af900396d7b72ff2a7002e8befe8cf8f1"><div class="ttname"><a href="types_2bf16_8h.html#af900396d7b72ff2a7002e8befe8cf8f1">f</a></div><div class="ttdeci">float f</div><div class="ttdef"><b>Definition</b> bf16.h:16</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <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>
|