zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-11-06 03:58:12 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

rebase

Browse Source
This commit is contained in:
CircleCI Docs
2024-12-06 21:22:39 +00:00
parent fdbf300746
commit 830f99716d
896 changed files with 12293 additions and 11212 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/build/html/compile_8h_source.html vendored
View File

@@ -101,27 +101,45 @@ $(function(){ initResizable(false); });
<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#a3ac798e65e59fe10b7fb5c522efce782"> 12</a></span>std::function&lt;std::vector&lt;array&gt;(<span class="keyword">const</span> std::vector&lt;array&gt;&amp;)&gt; <a class="code hl_function" href="namespacemlx_1_1core.html#a3ac798e65e59fe10b7fb5c522efce782">compile</a>(</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">const</span> std::function&lt;std::vector&lt;array&gt;(<span class="keyword">const</span> std::vector&lt;array&gt;&amp;)&gt;&amp; fun,</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&lt;std::vector&lt;array&gt;(<span class="keyword">const</span> std::vector&lt;array&gt;&amp;)&gt; <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&lt;std::vector&lt;array&gt;(<span class="keyword">const</span> std::vector&lt;array&gt;&amp;)&gt; 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="l00020" name="l00020"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a5f5fea955057bb3842b271b037909e66"> 20</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="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a1983a2466bff3bae4d23cf34bd0946c9"> 25</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="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a49445a55f976c4397f25ea18e1e92bef"> 28</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="l00029" name="l00029"></a><span class="lineno"> 29</span>} <span class="comment">// namespace mlx::core</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&lt;std::vector&lt;array&gt;(<span class="keyword">const</span> std::vector&lt;array&gt;&amp;)&gt; <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&lt;array&gt;(fun)(<span class="keyword">const</span> std::vector&lt;array&gt;&amp;),</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> &lt;</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&lt;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> std::is_convertible_v&lt;F, decltype(+std::declval&lt;F&gt;())&gt;&gt;&gt;</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&lt;std::vector&lt;array&gt;(<span class="keyword">const</span> std::vector&lt;array&gt;&amp;)&gt; <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&amp;&amp; <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_a3ac798e65e59fe10b7fb5c522efce782"><div class="ttname"><a href="namespacemlx_1_1core.html#a3ac798e65e59fe10b7fb5c522efce782">mlx::core::compile</a></div><div class="ttdeci">std::function&lt; std::vector&lt; array &gt;(const std::vector&lt; array &gt; &amp;)&gt; compile(const std::function&lt; std::vector&lt; array &gt;(const std::vector&lt; array &gt; &amp;)&gt; &amp;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_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&lt; std::vector&lt; array &gt;(const std::vector&lt; array &gt; &amp;)&gt; compile(std::function&lt; std::vector&lt; array &gt;(const std::vector&lt; array &gt; &amp;)&gt; 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>