zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-06-26 02:33:21 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
e5e2ffe503
mlx/docs/build/html/metal_8h.html
CircleCI Docs c996fc9d45 rebase
2025-06-04 01:01:53 +00:00

148 lines
11 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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: mlx/backend/metal/metal.h File Reference</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&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>
<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',false);
$(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(){ 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><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> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">metal.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;variant&gt;</code><br />
<code>#include &quot;<a class="el" href="array_8h_source.html">mlx/array.h</a>&quot;</code><br />
</div>
<p><a href="metal_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx.html">mlx</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html">mlx::core</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core_1_1metal.html">mlx::core::metal</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a0cdf2c08c7bc0927a86070adc206987f" id="r_a0cdf2c08c7bc0927a86070adc206987f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core_1_1metal.html#a0cdf2c08c7bc0927a86070adc206987f">mlx::core::metal::is_available</a> ()</td></tr>
<tr class="separator:a0cdf2c08c7bc0927a86070adc206987f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b75c2639016ac4d350fa6c9da386667" id="r_a7b75c2639016ac4d350fa6c9da386667"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core_1_1metal.html#a7b75c2639016ac4d350fa6c9da386667">mlx::core::metal::get_active_memory</a> ()</td></tr>
<tr class="separator:a7b75c2639016ac4d350fa6c9da386667"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b67d680cefa95f0ed5801f0e14e48ce" id="r_a4b67d680cefa95f0ed5801f0e14e48ce"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core_1_1metal.html#a4b67d680cefa95f0ed5801f0e14e48ce">mlx::core::metal::get_peak_memory</a> ()</td></tr>
<tr class="separator:a4b67d680cefa95f0ed5801f0e14e48ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adec8bb375da6c9dd5ff625a3a8434122" id="r_adec8bb375da6c9dd5ff625a3a8434122"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core_1_1metal.html#adec8bb375da6c9dd5ff625a3a8434122">mlx::core::metal::reset_peak_memory</a> ()</td></tr>
<tr class="separator:adec8bb375da6c9dd5ff625a3a8434122"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43307654f62ed7c58e014be7fb03909c" id="r_a43307654f62ed7c58e014be7fb03909c"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core_1_1metal.html#a43307654f62ed7c58e014be7fb03909c">mlx::core::metal::get_cache_memory</a> ()</td></tr>
<tr class="separator:a43307654f62ed7c58e014be7fb03909c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3fb2c4a237fa4bfdff798156146c4937" id="r_a3fb2c4a237fa4bfdff798156146c4937"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core_1_1metal.html#a3fb2c4a237fa4bfdff798156146c4937">mlx::core::metal::set_memory_limit</a> (size_t limit, bool relaxed=true)</td></tr>
<tr class="separator:a3fb2c4a237fa4bfdff798156146c4937"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab09c9b60f1e886ab859e6a066c9a5b9d" id="r_ab09c9b60f1e886ab859e6a066c9a5b9d"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core_1_1metal.html#ab09c9b60f1e886ab859e6a066c9a5b9d">mlx::core::metal::set_cache_limit</a> (size_t limit)</td></tr>
<tr class="separator:ab09c9b60f1e886ab859e6a066c9a5b9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22b3384ebd17f2fca198f81b9f1b6dc3" id="r_a22b3384ebd17f2fca198f81b9f1b6dc3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core_1_1metal.html#a22b3384ebd17f2fca198f81b9f1b6dc3">mlx::core::metal::clear_cache</a> ()</td></tr>
<tr class="separator:a22b3384ebd17f2fca198f81b9f1b6dc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31eab4828d31d292bc84e07b0d961e1e" id="r_a31eab4828d31d292bc84e07b0d961e1e"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core_1_1metal.html#a31eab4828d31d292bc84e07b0d961e1e">mlx::core::metal::set_wired_limit</a> (size_t limit)</td></tr>
<tr class="separator:a31eab4828d31d292bc84e07b0d961e1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa47cb5651bf3b65c46ab216b7e504d77" id="r_aa47cb5651bf3b65c46ab216b7e504d77"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core_1_1metal.html#aa47cb5651bf3b65c46ab216b7e504d77">mlx::core::metal::start_capture</a> (std::string path=&quot;&quot;)</td></tr>
<tr class="memdesc:aa47cb5651bf3b65c46ab216b7e504d77"><td class="mdescLeft">&#160;</td><td class="mdescRight">Capture a GPU trace, saving it to an absolute file <code>path</code> <br /></td></tr>
<tr class="separator:aa47cb5651bf3b65c46ab216b7e504d77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac90714424e36fb01e04550de69b8314f" id="r_ac90714424e36fb01e04550de69b8314f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core_1_1metal.html#ac90714424e36fb01e04550de69b8314f">mlx::core::metal::stop_capture</a> ()</td></tr>
<tr class="separator:ac90714424e36fb01e04550de69b8314f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ad19c44efabb7423f973407926ead61" id="r_a6ad19c44efabb7423f973407926ead61"><td class="memItemLeft" align="right" valign="top">std::unordered_map&lt; std::string, std::variant&lt; std::string, size_t &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core_1_1metal.html#a6ad19c44efabb7423f973407926ead61">mlx::core::metal::device_info</a> ()</td></tr>
<tr class="memdesc:a6ad19c44efabb7423f973407926ead61"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get information about the GPU and system settings. <br /></td></tr>
<tr class="separator:a6ad19c44efabb7423f973407926ead61"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</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.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink