zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-06-25 09:51:17 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
e1c8a49c45
mlx/docs/build/html/graph__utils_8h_source.html
CircleCI Docs 2992e564ea rebase
2025-06-04 01:01:55 +00:00

209 lines
21 KiB
HTML
Raw Blame History

<!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/graph_utils.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&amp;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()">&#160;</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&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;dn=expat.txt MIT */
$(function(){initNavTree('graph__utils_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">graph_utils.h</div></div>
</div><!--header-->
<div class="contents">
<a href="graph__utils_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">#include &lt;unordered_map&gt;</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="preprocessor">#include &quot;<a class="code" href="array_8h.html">mlx/array.h</a>&quot;</span></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"> 9</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="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="foldopen" id="foldopen00011" data-start="{" data-end="};">
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="structmlx_1_1core_1_1_node_namer.html"> 11</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structmlx_1_1core_1_1_node_namer.html">NodeNamer</a> {</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="structmlx_1_1core_1_1_node_namer.html#a57823f9a2cdc60b2f06f857b36019277"> 12</a></span> std::unordered_map&lt;std::uintptr_t, std::string&gt; <a class="code hl_variable" href="structmlx_1_1core_1_1_node_namer.html#a57823f9a2cdc60b2f06f857b36019277">names</a>;</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="structmlx_1_1core_1_1_node_namer.html#a1690dd38de288c0aee2bb53156eb770e"> 14</a></span> <span class="keyword">const</span> std::string&amp; <a class="code hl_function" href="structmlx_1_1core_1_1_node_namer.html#a1690dd38de288c0aee2bb53156eb770e">get_name</a>(<span class="keyword">const</span> <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>&amp; x);</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="structmlx_1_1core_1_1_node_namer.html#a57a574e48f8a9cd122616d80b138c768"> 15</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="structmlx_1_1core_1_1_node_namer.html#a57a574e48f8a9cd122616d80b138c768">set_name</a>(<span class="keyword">const</span> <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>&amp; x, std::string n);</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>};</div>
</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"><a class="line" href="namespacemlx_1_1core.html#a9b33065059fd68fed26da94603cfcce3"> 18</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a9b33065059fd68fed26da94603cfcce3">print_graph</a>(</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> std::ostream&amp; os,</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_struct" href="structmlx_1_1core_1_1_node_namer.html">NodeNamer</a> namer,</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">const</span> std::vector&lt;array&gt;&amp; outputs);</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="foldopen" id="foldopen00023" data-start="{" data-end="}">
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a8ac23fb7f4d4c52e592d6296e63b80d4"> 23</a></span><span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a9b33065059fd68fed26da94603cfcce3">print_graph</a>(std::ostream&amp; os, <span class="keyword">const</span> std::vector&lt;array&gt;&amp; outputs) {</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a9b33065059fd68fed26da94603cfcce3">print_graph</a>(os, <a class="code hl_struct" href="structmlx_1_1core_1_1_node_namer.html">NodeNamer</a>{}, outputs);</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span>}</div>
</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="keyword">template</span> &lt;<span class="keyword">typename</span>... Arrays, <span class="keyword">typename</span> = <a class="code hl_typedef" href="namespacemlx_1_1core.html#af89751d79339f3e4d9318ea97d64d114">enable_for_arrays_t</a>&lt;Arrays...&gt;&gt;</div>
<div class="foldopen" id="foldopen00028" data-start="{" data-end="}">
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a17505ed8064dcaddc011cb3d52da2523"> 28</a></span><span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a9b33065059fd68fed26da94603cfcce3">print_graph</a>(std::ostream&amp; os, Arrays&amp;&amp;... outputs) {</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a9b33065059fd68fed26da94603cfcce3">print_graph</a>(</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> os, <a class="code hl_struct" href="structmlx_1_1core_1_1_node_namer.html">NodeNamer</a>{}, std::vector&lt;array&gt;{std::forward&lt;Arrays&gt;(outputs)...});</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span>}</div>
</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span>... Arrays, <span class="keyword">typename</span> = <a class="code hl_typedef" href="namespacemlx_1_1core.html#af89751d79339f3e4d9318ea97d64d114">enable_for_arrays_t</a>&lt;Arrays...&gt;&gt;</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword">inline</span> <span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00035" data-start="{" data-end="}">
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a59e84542600e1a23464c100da3cfb7c4"> 35</a></span><a class="code hl_function" href="namespacemlx_1_1core.html#a9b33065059fd68fed26da94603cfcce3">print_graph</a>(std::ostream&amp; os, <a class="code hl_struct" href="structmlx_1_1core_1_1_node_namer.html">NodeNamer</a> namer, Arrays&amp;&amp;... outputs) {</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a9b33065059fd68fed26da94603cfcce3">print_graph</a>(</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> os,</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> std::move(namer),</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> std::vector&lt;array&gt;{std::forward&lt;Arrays&gt;(outputs)...});</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span>}</div>
</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a30338cb7d259334e46dc7a4819716fa6"> 42</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a30338cb7d259334e46dc7a4819716fa6">export_to_dot</a>(</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> std::ostream&amp; os,</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_struct" href="structmlx_1_1core_1_1_node_namer.html">NodeNamer</a> namer,</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">const</span> std::vector&lt;array&gt;&amp; outputs);</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="foldopen" id="foldopen00047" data-start="{" data-end="}">
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a57395bdf43d9c5c134e610c169222cca"> 47</a></span><span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a30338cb7d259334e46dc7a4819716fa6">export_to_dot</a>(std::ostream&amp; os, <span class="keyword">const</span> std::vector&lt;array&gt;&amp; outputs) {</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a30338cb7d259334e46dc7a4819716fa6">export_to_dot</a>(os, <a class="code hl_struct" href="structmlx_1_1core_1_1_node_namer.html">NodeNamer</a>{}, outputs);</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span>}</div>
</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span>... Arrays, <span class="keyword">typename</span> = <a class="code hl_typedef" href="namespacemlx_1_1core.html#af89751d79339f3e4d9318ea97d64d114">enable_for_arrays_t</a>&lt;Arrays...&gt;&gt;</div>
<div class="foldopen" id="foldopen00052" data-start="{" data-end="}">
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a839f94dbad44f0d37333006fc876b42e"> 52</a></span><span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a30338cb7d259334e46dc7a4819716fa6">export_to_dot</a>(std::ostream&amp; os, Arrays&amp;&amp;... outputs) {</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a30338cb7d259334e46dc7a4819716fa6">export_to_dot</a>(</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> os, <a class="code hl_struct" href="structmlx_1_1core_1_1_node_namer.html">NodeNamer</a>{}, std::vector&lt;array&gt;{std::forward&lt;Arrays&gt;(outputs)...});</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span>}</div>
</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span>... Arrays, <span class="keyword">typename</span> = <a class="code hl_typedef" href="namespacemlx_1_1core.html#af89751d79339f3e4d9318ea97d64d114">enable_for_arrays_t</a>&lt;Arrays...&gt;&gt;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="keyword">inline</span> <span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00059" data-start="{" data-end="}">
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a12faa564e0d85a1daa77c08babb75261"> 59</a></span><a class="code hl_function" href="namespacemlx_1_1core.html#a30338cb7d259334e46dc7a4819716fa6">export_to_dot</a>(std::ostream&amp; os, <a class="code hl_struct" href="structmlx_1_1core_1_1_node_namer.html">NodeNamer</a> namer, Arrays&amp;&amp;... outputs) {</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a30338cb7d259334e46dc7a4819716fa6">export_to_dot</a>(</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> os,</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> std::move(namer),</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> std::vector&lt;array&gt;{std::forward&lt;Arrays&gt;(outputs)...});</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span>}</div>
</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</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="aclassmlx_1_1core_1_1array_html"><div class="ttname"><a href="classmlx_1_1core_1_1array.html">mlx::core::array</a></div><div class="ttdef"><b>Definition</b> array.h:24</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_a30338cb7d259334e46dc7a4819716fa6"><div class="ttname"><a href="namespacemlx_1_1core.html#a30338cb7d259334e46dc7a4819716fa6">mlx::core::export_to_dot</a></div><div class="ttdeci">void export_to_dot(std::ostream &amp;os, NodeNamer namer, const std::vector&lt; array &gt; &amp;outputs)</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a9b33065059fd68fed26da94603cfcce3"><div class="ttname"><a href="namespacemlx_1_1core.html#a9b33065059fd68fed26da94603cfcce3">mlx::core::print_graph</a></div><div class="ttdeci">void print_graph(std::ostream &amp;os, NodeNamer namer, const std::vector&lt; array &gt; &amp;outputs)</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_af89751d79339f3e4d9318ea97d64d114"><div class="ttname"><a href="namespacemlx_1_1core.html#af89751d79339f3e4d9318ea97d64d114">mlx::core::enable_for_arrays_t</a></div><div class="ttdeci">typename std::enable_if_t&lt; is_arrays_v&lt; T... &gt; &gt; enable_for_arrays_t</div><div class="ttdef"><b>Definition</b> array.h:630</div></div>
<div class="ttc" id="astructmlx_1_1core_1_1_node_namer_html"><div class="ttname"><a href="structmlx_1_1core_1_1_node_namer.html">mlx::core::NodeNamer</a></div><div class="ttdef"><b>Definition</b> graph_utils.h:11</div></div>
<div class="ttc" id="astructmlx_1_1core_1_1_node_namer_html_a1690dd38de288c0aee2bb53156eb770e"><div class="ttname"><a href="structmlx_1_1core_1_1_node_namer.html#a1690dd38de288c0aee2bb53156eb770e">mlx::core::NodeNamer::get_name</a></div><div class="ttdeci">const std::string &amp; get_name(const array &amp;x)</div></div>
<div class="ttc" id="astructmlx_1_1core_1_1_node_namer_html_a57823f9a2cdc60b2f06f857b36019277"><div class="ttname"><a href="structmlx_1_1core_1_1_node_namer.html#a57823f9a2cdc60b2f06f857b36019277">mlx::core::NodeNamer::names</a></div><div class="ttdeci">std::unordered_map&lt; std::uintptr_t, std::string &gt; names</div><div class="ttdef"><b>Definition</b> graph_utils.h:12</div></div>
<div class="ttc" id="astructmlx_1_1core_1_1_node_namer_html_a57a574e48f8a9cd122616d80b138c768"><div class="ttname"><a href="structmlx_1_1core_1_1_node_namer.html#a57a574e48f8a9cd122616d80b138c768">mlx::core::NodeNamer::set_name</a></div><div class="ttdeci">void set_name(const array &amp;x, std::string n)</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="graph__utils_8h.html">graph_utils.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>
Reference in New Issue View Git Blame Copy Permalink