mlx/docs/build/html/transforms__impl_8h_source.html
2025-06-04 01:01:50 +00:00

192 lines
21 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.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: mlx/transforms_impl.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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">transforms_impl.h</div></div>
</div><!--header-->
<div class="contents">
<a href="transforms__impl_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="keyword">namespace </span><a class="code hl_namespace" href="namespacemlx_1_1core_1_1detail.html">mlx::core::detail</a> {</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"><a class="line" href="namespacemlx_1_1core_1_1detail.html#a5ba794afe1a557e0505887cfb481c515"> 7</a></span>std::pair&lt;std::vector&lt;array&gt;, std::vector&lt;array&gt;&gt; <a class="code hl_function" href="namespacemlx_1_1core_1_1detail.html#a5ba794afe1a557e0505887cfb481c515">vmap_trace</a>(</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</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="l00009" name="l00009"></a><span class="lineno"> 9</span> <span class="keyword">const</span> std::vector&lt;array&gt;&amp; inputs,</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> <span class="keyword">const</span> std::vector&lt;int&gt;&amp; in_axes);</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1detail.html#a31a5582530faea230eb8acafc0f7e154"> 12</a></span>std::vector&lt;array&gt; <a class="code hl_function" href="namespacemlx_1_1core_1_1detail.html#a31a5582530faea230eb8acafc0f7e154">vmap_replace</a>(</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">const</span> std::vector&lt;array&gt;&amp; inputs,</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">const</span> std::vector&lt;array&gt;&amp; s_inputs,</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">const</span> std::vector&lt;array&gt;&amp; s_outputs,</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">const</span> std::vector&lt;int&gt;&amp; in_axes,</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">const</span> std::vector&lt;int&gt;&amp; out_axes);</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment">// This is not part of the general C++ API as calling with a bad id is a bad</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment">// idea.</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1detail.html#a4d14dee182dc9a8bea64efdaad310a1f"> 21</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_variable" href="namespacemlx_1_1core_1_1detail.html#a4d14dee182dc9a8bea64efdaad310a1f">compile</a>(</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</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="l00023" name="l00023"></a><span class="lineno"> 23</span> std::uintptr_t fun_id,</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keywordtype">bool</span> shapeless = <span class="keyword">false</span>,</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> std::vector&lt;uint64_t&gt; constants = {});</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment">// Erase cached compile functions</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1detail.html#a69eb76a14f845ca000f1ccb2edda0175"> 28</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespacemlx_1_1core_1_1detail.html#a69eb76a14f845ca000f1ccb2edda0175">compile_erase</a>(std::uintptr_t fun_id);</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment">// Clear the compiler cache causing a recompilation of all compiled functions</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment">// when called again.</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1detail.html#a3fb927c209b946aefebb195993fbe4cf"> 32</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespacemlx_1_1core_1_1detail.html#a3fb927c209b946aefebb195993fbe4cf">compile_clear_cache</a>();</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment">// Create an InTracing object during tracing operations to signify to the rest</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment">// of the codebase that we are during tracing so evals should not throw away</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment">// the graph.</span></div>
<div class="foldopen" id="foldopen00037" data-start="{" data-end="};">
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="structmlx_1_1core_1_1detail_1_1_in_tracing.html"> 37</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structmlx_1_1core_1_1detail_1_1_in_tracing.html">InTracing</a> {</div>
<div class="foldopen" id="foldopen00038" data-start="{" data-end="}">
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="structmlx_1_1core_1_1detail_1_1_in_tracing.html#a7a77f19391498afa5dcea3509d241a70"> 38</a></span> <a class="code hl_function" href="structmlx_1_1core_1_1detail_1_1_in_tracing.html#a7a77f19391498afa5dcea3509d241a70">InTracing</a>() {</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> tracing_counter++;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> }</div>
</div>
<div class="foldopen" id="foldopen00041" data-start="{" data-end="}">
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="structmlx_1_1core_1_1detail_1_1_in_tracing.html#a83d57d7fa63bcb0ff72080191d0f177a"> 41</a></span> <a class="code hl_function" href="structmlx_1_1core_1_1detail_1_1_in_tracing.html#a83d57d7fa63bcb0ff72080191d0f177a">~InTracing</a>() {</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> tracing_counter--;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> }</div>
</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="foldopen" id="foldopen00045" data-start="{" data-end="}">
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="structmlx_1_1core_1_1detail_1_1_in_tracing.html#ac52b8e2c3f808d3076c4e1ebaf9dc63d"> 45</a></span> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="structmlx_1_1core_1_1detail_1_1_in_tracing.html#ac52b8e2c3f808d3076c4e1ebaf9dc63d">in_tracing</a>() {</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keywordflow">return</span> tracing_counter &gt; 0;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> }</div>
</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">static</span> <span class="keywordtype">int</span> tracing_counter;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span>};</div>
</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="foldopen" id="foldopen00053" data-start="{" data-end="};">
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="structmlx_1_1core_1_1detail_1_1_retain_graph.html"> 53</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structmlx_1_1core_1_1detail_1_1_retain_graph.html">RetainGraph</a> {</div>
<div class="foldopen" id="foldopen00054" data-start="{" data-end="}">
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="structmlx_1_1core_1_1detail_1_1_retain_graph.html#a7fac0244c14cc9e8f580bc1298ff68da"> 54</a></span> <a class="code hl_function" href="structmlx_1_1core_1_1detail_1_1_retain_graph.html#a7fac0244c14cc9e8f580bc1298ff68da">RetainGraph</a>() {</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> tracing_counter++;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> }</div>
</div>
<div class="foldopen" id="foldopen00057" data-start="{" data-end="}">
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="structmlx_1_1core_1_1detail_1_1_retain_graph.html#a6bd6dc2e1caf2f764f39856a72ff6cbc"> 57</a></span> <a class="code hl_function" href="structmlx_1_1core_1_1detail_1_1_retain_graph.html#a6bd6dc2e1caf2f764f39856a72ff6cbc">~RetainGraph</a>() {</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> tracing_counter--;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> }</div>
</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="foldopen" id="foldopen00061" data-start="{" data-end="}">
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="structmlx_1_1core_1_1detail_1_1_retain_graph.html#a12ead93cb70ebab865c5e9ce7718f814"> 61</a></span> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="structmlx_1_1core_1_1detail_1_1_retain_graph.html#a12ead93cb70ebab865c5e9ce7718f814">retain_graph</a>() {</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keywordflow">return</span> tracing_counter &gt; 0;</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> }</div>
</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">static</span> <span class="keywordtype">int</span> tracing_counter;</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span>};</div>
</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span>} <span class="comment">// namespace mlx::core::detail</span></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1detail_html"><div class="ttname"><a href="namespacemlx_1_1core_1_1detail.html">mlx::core::detail</a></div><div class="ttdef"><b>Definition</b> ops.h:8</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1detail_html_a31a5582530faea230eb8acafc0f7e154"><div class="ttname"><a href="namespacemlx_1_1core_1_1detail.html#a31a5582530faea230eb8acafc0f7e154">mlx::core::detail::vmap_replace</a></div><div class="ttdeci">std::vector&lt; array &gt; vmap_replace(const std::vector&lt; array &gt; &amp;inputs, const std::vector&lt; array &gt; &amp;s_inputs, const std::vector&lt; array &gt; &amp;s_outputs, const std::vector&lt; int &gt; &amp;in_axes, const std::vector&lt; int &gt; &amp;out_axes)</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1detail_html_a3fb927c209b946aefebb195993fbe4cf"><div class="ttname"><a href="namespacemlx_1_1core_1_1detail.html#a3fb927c209b946aefebb195993fbe4cf">mlx::core::detail::compile_clear_cache</a></div><div class="ttdeci">void compile_clear_cache()</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1detail_html_a4d14dee182dc9a8bea64efdaad310a1f"><div class="ttname"><a href="namespacemlx_1_1core_1_1detail.html#a4d14dee182dc9a8bea64efdaad310a1f">mlx::core::detail::compile</a></div><div class="ttdeci">std::function&lt; std::vector&lt; array &gt;(const std::vector&lt; array &gt; &amp;) compile)(const std::function&lt; std::vector&lt; array &gt;(const std::vector&lt; array &gt; &amp;)&gt; &amp;fun, std::uintptr_t fun_id, bool shapeless=false, std::vector&lt; uint64_t &gt; constants={})</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1detail_html_a5ba794afe1a557e0505887cfb481c515"><div class="ttname"><a href="namespacemlx_1_1core_1_1detail.html#a5ba794afe1a557e0505887cfb481c515">mlx::core::detail::vmap_trace</a></div><div class="ttdeci">std::pair&lt; std::vector&lt; array &gt;, std::vector&lt; array &gt; &gt; vmap_trace(const std::function&lt; std::vector&lt; array &gt;(const std::vector&lt; array &gt; &amp;)&gt; &amp;fun, const std::vector&lt; array &gt; &amp;inputs, const std::vector&lt; int &gt; &amp;in_axes)</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1detail_html_a69eb76a14f845ca000f1ccb2edda0175"><div class="ttname"><a href="namespacemlx_1_1core_1_1detail.html#a69eb76a14f845ca000f1ccb2edda0175">mlx::core::detail::compile_erase</a></div><div class="ttdeci">void compile_erase(std::uintptr_t fun_id)</div></div>
<div class="ttc" id="astructmlx_1_1core_1_1detail_1_1_in_tracing_html"><div class="ttname"><a href="structmlx_1_1core_1_1detail_1_1_in_tracing.html">mlx::core::detail::InTracing</a></div><div class="ttdef"><b>Definition</b> transforms_impl.h:37</div></div>
<div class="ttc" id="astructmlx_1_1core_1_1detail_1_1_in_tracing_html_a7a77f19391498afa5dcea3509d241a70"><div class="ttname"><a href="structmlx_1_1core_1_1detail_1_1_in_tracing.html#a7a77f19391498afa5dcea3509d241a70">mlx::core::detail::InTracing::InTracing</a></div><div class="ttdeci">InTracing()</div><div class="ttdef"><b>Definition</b> transforms_impl.h:38</div></div>
<div class="ttc" id="astructmlx_1_1core_1_1detail_1_1_in_tracing_html_a83d57d7fa63bcb0ff72080191d0f177a"><div class="ttname"><a href="structmlx_1_1core_1_1detail_1_1_in_tracing.html#a83d57d7fa63bcb0ff72080191d0f177a">mlx::core::detail::InTracing::~InTracing</a></div><div class="ttdeci">~InTracing()</div><div class="ttdef"><b>Definition</b> transforms_impl.h:41</div></div>
<div class="ttc" id="astructmlx_1_1core_1_1detail_1_1_in_tracing_html_ac52b8e2c3f808d3076c4e1ebaf9dc63d"><div class="ttname"><a href="structmlx_1_1core_1_1detail_1_1_in_tracing.html#ac52b8e2c3f808d3076c4e1ebaf9dc63d">mlx::core::detail::InTracing::in_tracing</a></div><div class="ttdeci">static bool in_tracing()</div><div class="ttdef"><b>Definition</b> transforms_impl.h:45</div></div>
<div class="ttc" id="astructmlx_1_1core_1_1detail_1_1_retain_graph_html"><div class="ttname"><a href="structmlx_1_1core_1_1detail_1_1_retain_graph.html">mlx::core::detail::RetainGraph</a></div><div class="ttdef"><b>Definition</b> transforms_impl.h:53</div></div>
<div class="ttc" id="astructmlx_1_1core_1_1detail_1_1_retain_graph_html_a12ead93cb70ebab865c5e9ce7718f814"><div class="ttname"><a href="structmlx_1_1core_1_1detail_1_1_retain_graph.html#a12ead93cb70ebab865c5e9ce7718f814">mlx::core::detail::RetainGraph::retain_graph</a></div><div class="ttdeci">static bool retain_graph()</div><div class="ttdef"><b>Definition</b> transforms_impl.h:61</div></div>
<div class="ttc" id="astructmlx_1_1core_1_1detail_1_1_retain_graph_html_a6bd6dc2e1caf2f764f39856a72ff6cbc"><div class="ttname"><a href="structmlx_1_1core_1_1detail_1_1_retain_graph.html#a6bd6dc2e1caf2f764f39856a72ff6cbc">mlx::core::detail::RetainGraph::~RetainGraph</a></div><div class="ttdeci">~RetainGraph()</div><div class="ttdef"><b>Definition</b> transforms_impl.h:57</div></div>
<div class="ttc" id="astructmlx_1_1core_1_1detail_1_1_retain_graph_html_a7fac0244c14cc9e8f580bc1298ff68da"><div class="ttname"><a href="structmlx_1_1core_1_1detail_1_1_retain_graph.html#a7fac0244c14cc9e8f580bc1298ff68da">mlx::core::detail::RetainGraph::RetainGraph</a></div><div class="ttdeci">RetainGraph()</div><div class="ttdef"><b>Definition</b> transforms_impl.h:54</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>