2024-10-15 23:12:17 +08:00
<!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 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 > < 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 = "headertitle" > < div class = "title" > metal.h< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< a href = "metal_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 < variant> < / 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 " < a class = "code" href = "array_8h.html" > mlx/array.h< / a > " < / 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_1_1metal.html" > mlx::core::metal< / a > {< / div >
< div class = "line" > < a id = "l00010" name = "l00010" > < / a > < span class = "lineno" > 10< / span > < / div >
< div class = "line" > < a id = "l00011" name = "l00011" > < / a > < span class = "lineno" > 11< / span > < span class = "comment" > /* Check if the Metal backend is available. */< / span > < / div >
< div class = "line" > < a id = "l00012" name = "l00012" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core_1_1metal.html#a0cdf2c08c7bc0927a86070adc206987f" > 12< / a > < / span > < span class = "keywordtype" > bool< / span > < a class = "code hl_function" href = "namespacemlx_1_1core_1_1metal.html#a0cdf2c08c7bc0927a86070adc206987f" > is_available< / 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" > 14< / span > < span class = "comment" > /* Get the actively used memory in bytes.< / span > < / div >
< div class = "line" > < a id = "l00015" name = "l00015" > < / a > < span class = "lineno" > 15< / span > < span class = "comment" > *< / span > < / div >
< div class = "line" > < a id = "l00016" name = "l00016" > < / a > < span class = "lineno" > 16< / span > < span class = "comment" > * Note, this will not always match memory use reported by the system because< / span > < / div >
< div class = "line" > < a id = "l00017" name = "l00017" > < / a > < span class = "lineno" > 17< / span > < span class = "comment" > * it does not include cached memory buffers.< / span > < / div >
< div class = "line" > < a id = "l00018" name = "l00018" > < / a > < span class = "lineno" > 18< / span > < span class = "comment" > * */< / span > < / div >
< div class = "line" > < a id = "l00019" name = "l00019" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core_1_1metal.html#a7b75c2639016ac4d350fa6c9da386667" > 19< / a > < / span > < span class = "keywordtype" > size_t< / span > < a class = "code hl_function" href = "namespacemlx_1_1core_1_1metal.html#a7b75c2639016ac4d350fa6c9da386667" > get_active_memory< / a > ();< / div >
< div class = "line" > < a id = "l00020" name = "l00020" > < / a > < span class = "lineno" > 20< / span > < / div >
< div class = "line" > < a id = "l00021" name = "l00021" > < / a > < span class = "lineno" > 21< / span > < span class = "comment" > /* Get the peak amount of used memory in bytes.< / span > < / div >
< div class = "line" > < a id = "l00022" name = "l00022" > < / a > < span class = "lineno" > 22< / span > < span class = "comment" > *< / span > < / div >
< div class = "line" > < a id = "l00023" name = "l00023" > < / a > < span class = "lineno" > 23< / span > < span class = "comment" > * The maximum memory used recorded from the beginning of the program< / span > < / div >
< div class = "line" > < a id = "l00024" name = "l00024" > < / a > < span class = "lineno" > 24< / span > < span class = "comment" > * execution or since the last call to reset_peak_memory.< / span > < / div >
< div class = "line" > < a id = "l00025" name = "l00025" > < / a > < span class = "lineno" > 25< / span > < span class = "comment" > * */< / span > < / div >
< div class = "line" > < a id = "l00026" name = "l00026" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core_1_1metal.html#a4b67d680cefa95f0ed5801f0e14e48ce" > 26< / a > < / span > < span class = "keywordtype" > size_t< / span > < a class = "code hl_function" href = "namespacemlx_1_1core_1_1metal.html#a4b67d680cefa95f0ed5801f0e14e48ce" > get_peak_memory< / a > ();< / div >
< div class = "line" > < a id = "l00027" name = "l00027" > < / a > < span class = "lineno" > 27< / span > < / div >
< div class = "line" > < a id = "l00028" name = "l00028" > < / a > < span class = "lineno" > 28< / span > < span class = "comment" > /* Reset the peak memory to zero.< / span > < / div >
< div class = "line" > < a id = "l00029" name = "l00029" > < / a > < span class = "lineno" > 29< / span > < span class = "comment" > * */< / span > < / div >
< div class = "line" > < a id = "l00030" name = "l00030" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core_1_1metal.html#adec8bb375da6c9dd5ff625a3a8434122" > 30< / a > < / span > < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "namespacemlx_1_1core_1_1metal.html#adec8bb375da6c9dd5ff625a3a8434122" > reset_peak_memory< / a > ();< / div >
< div class = "line" > < a id = "l00031" name = "l00031" > < / a > < span class = "lineno" > 31< / span > < / div >
< div class = "line" > < a id = "l00032" name = "l00032" > < / a > < span class = "lineno" > 32< / span > < span class = "comment" > /* Get the cache size in bytes.< / span > < / div >
< div class = "line" > < a id = "l00033" name = "l00033" > < / a > < span class = "lineno" > 33< / span > < span class = "comment" > *< / span > < / div >
< div class = "line" > < a id = "l00034" name = "l00034" > < / a > < span class = "lineno" > 34< / span > < span class = "comment" > * The cache includes memory not currently used that has not been returned< / span > < / div >
< div class = "line" > < a id = "l00035" name = "l00035" > < / a > < span class = "lineno" > 35< / span > < span class = "comment" > * to the system allocator.< / span > < / div >
< div class = "line" > < a id = "l00036" name = "l00036" > < / a > < span class = "lineno" > 36< / span > < span class = "comment" > * */< / span > < / div >
< div class = "line" > < a id = "l00037" name = "l00037" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core_1_1metal.html#a43307654f62ed7c58e014be7fb03909c" > 37< / a > < / span > < span class = "keywordtype" > size_t< / span > < a class = "code hl_function" href = "namespacemlx_1_1core_1_1metal.html#a43307654f62ed7c58e014be7fb03909c" > get_cache_memory< / a > ();< / div >
< div class = "line" > < a id = "l00038" name = "l00038" > < / a > < span class = "lineno" > 38< / span > < / div >
< div class = "line" > < a id = "l00039" name = "l00039" > < / a > < span class = "lineno" > 39< / span > < span class = "comment" > /* Set the memory limit.< / span > < / div >
< div class = "line" > < a id = "l00040" name = "l00040" > < / a > < span class = "lineno" > 40< / span > < span class = "comment" > * Calls to malloc will wait on scheduled tasks if the limit is exceeded. If< / span > < / div >
< div class = "line" > < a id = "l00041" name = "l00041" > < / a > < span class = "lineno" > 41< / span > < span class = "comment" > * there are no more scheduled tasks an error will be raised if relaxed< / span > < / div >
< div class = "line" > < a id = "l00042" name = "l00042" > < / a > < span class = "lineno" > 42< / span > < span class = "comment" > * is false or memory will be allocated (including the potential for< / span > < / div >
< div class = "line" > < a id = "l00043" name = "l00043" > < / a > < span class = "lineno" > 43< / span > < span class = "comment" > * swap) if relaxed is true.< / span > < / div >
< div class = "line" > < a id = "l00044" name = "l00044" > < / a > < span class = "lineno" > 44< / span > < span class = "comment" > *< / span > < / div >
< div class = "line" > < a id = "l00045" name = "l00045" > < / a > < span class = "lineno" > 45< / span > < span class = "comment" > * The memory limit defaults to 1.5 times the maximum recommended working set< / span > < / div >
< div class = "line" > < a id = "l00046" name = "l00046" > < / a > < span class = "lineno" > 46< / span > < span class = "comment" > * size reported by the device.< / span > < / div >
< div class = "line" > < a id = "l00047" name = "l00047" > < / a > < span class = "lineno" > 47< / span > < span class = "comment" > *< / span > < / div >
< div class = "line" > < a id = "l00048" name = "l00048" > < / a > < span class = "lineno" > 48< / span > < span class = "comment" > * Returns the previous memory limit.< / span > < / div >
< div class = "line" > < a id = "l00049" name = "l00049" > < / a > < span class = "lineno" > 49< / span > < span class = "comment" > * */< / span > < / div >
< div class = "line" > < a id = "l00050" name = "l00050" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core_1_1metal.html#a3fb2c4a237fa4bfdff798156146c4937" > 50< / a > < / span > < span class = "keywordtype" > size_t< / span > < a class = "code hl_function" href = "namespacemlx_1_1core_1_1metal.html#a3fb2c4a237fa4bfdff798156146c4937" > set_memory_limit< / a > (< span class = "keywordtype" > size_t< / span > limit, < span class = "keywordtype" > bool< / span > relaxed = < span class = "keyword" > true< / span > );< / div >
< div class = "line" > < a id = "l00051" name = "l00051" > < / a > < span class = "lineno" > 51< / span > < / div >
< div class = "line" > < a id = "l00052" name = "l00052" > < / a > < span class = "lineno" > 52< / span > < span class = "comment" > /* Set the free cache limit.< / span > < / div >
< div class = "line" > < a id = "l00053" name = "l00053" > < / a > < span class = "lineno" > 53< / span > < span class = "comment" > * If using more than the given limit, free memory will be reclaimed< / span > < / div >
< div class = "line" > < a id = "l00054" name = "l00054" > < / a > < span class = "lineno" > 54< / span > < span class = "comment" > * from the cache on the next allocation. To disable the cache,< / span > < / div >
< div class = "line" > < a id = "l00055" name = "l00055" > < / a > < span class = "lineno" > 55< / span > < span class = "comment" > * set the limit to 0.< / span > < / div >
< div class = "line" > < a id = "l00056" name = "l00056" > < / a > < span class = "lineno" > 56< / span > < span class = "comment" > *< / span > < / div >
< div class = "line" > < a id = "l00057" name = "l00057" > < / a > < span class = "lineno" > 57< / span > < span class = "comment" > * The cache limit defaults to the memory limit.< / span > < / div >
< div class = "line" > < a id = "l00058" name = "l00058" > < / a > < span class = "lineno" > 58< / span > < span class = "comment" > *< / span > < / div >
< div class = "line" > < a id = "l00059" name = "l00059" > < / a > < span class = "lineno" > 59< / span > < span class = "comment" > * Returns the previous cache limit.< / span > < / div >
< div class = "line" > < a id = "l00060" name = "l00060" > < / a > < span class = "lineno" > 60< / span > < span class = "comment" > * */< / span > < / div >
< div class = "line" > < a id = "l00061" name = "l00061" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core_1_1metal.html#ab09c9b60f1e886ab859e6a066c9a5b9d" > 61< / a > < / span > < span class = "keywordtype" > size_t< / span > < a class = "code hl_function" href = "namespacemlx_1_1core_1_1metal.html#ab09c9b60f1e886ab859e6a066c9a5b9d" > set_cache_limit< / a > (< span class = "keywordtype" > size_t< / span > limit);< / div >
< div class = "line" > < a id = "l00062" name = "l00062" > < / a > < span class = "lineno" > 62< / span > < / div >
< div class = "line" > < a id = "l00063" name = "l00063" > < / a > < span class = "lineno" > 63< / span > < span class = "comment" > /* Clear the memory cache. */< / span > < / div >
< div class = "line" > < a id = "l00064" name = "l00064" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core_1_1metal.html#a22b3384ebd17f2fca198f81b9f1b6dc3" > 64< / a > < / span > < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "namespacemlx_1_1core_1_1metal.html#a22b3384ebd17f2fca198f81b9f1b6dc3" > clear_cache< / a > ();< / div >
< div class = "line" > < a id = "l00065" name = "l00065" > < / a > < span class = "lineno" > 65< / span > < / div >
2024-10-26 04:23:45 +08:00
< div class = "line" > < a id = "l00066" name = "l00066" > < / a > < span class = "lineno" > 66< / span > < span class = "comment" > /* Set the wired size limit.< / span > < / div >
< div class = "line" > < a id = "l00067" name = "l00067" > < / a > < span class = "lineno" > 67< / span > < span class = "comment" > *< / span > < / div >
< div class = "line" > < a id = "l00068" name = "l00068" > < / a > < span class = "lineno" > 68< / span > < span class = "comment" > * Note, this function is only useful for macOS 15.0 or higher.< / span > < / div >
< div class = "line" > < a id = "l00069" name = "l00069" > < / a > < span class = "lineno" > 69< / span > < span class = "comment" > *< / span > < / div >
< div class = "line" > < a id = "l00070" name = "l00070" > < / a > < span class = "lineno" > 70< / span > < span class = "comment" > * The wired limit is the total size in bytes of memory that will be kept< / span > < / div >
< div class = "line" > < a id = "l00071" name = "l00071" > < / a > < span class = "lineno" > 71< / span > < span class = "comment" > * resident. The default value is ``0``.< / span > < / div >
< div class = "line" > < a id = "l00072" name = "l00072" > < / a > < span class = "lineno" > 72< / span > < span class = "comment" > *< / span > < / div >
< div class = "line" > < a id = "l00073" name = "l00073" > < / a > < span class = "lineno" > 73< / span > < span class = "comment" > * Setting a wired limit larger than system wired limit is an error.< / span > < / div >
< div class = "line" > < a id = "l00074" name = "l00074" > < / a > < span class = "lineno" > 74< / span > < span class = "comment" > *< / span > < / div >
< div class = "line" > < a id = "l00075" name = "l00075" > < / a > < span class = "lineno" > 75< / span > < span class = "comment" > * Returns the previous wired limit.< / span > < / div >
< div class = "line" > < a id = "l00076" name = "l00076" > < / a > < span class = "lineno" > 76< / span > < span class = "comment" > * */< / span > < / div >
< div class = "line" > < a id = "l00077" name = "l00077" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core_1_1metal.html#a31eab4828d31d292bc84e07b0d961e1e" > 77< / a > < / span > < span class = "keywordtype" > size_t< / span > < a class = "code hl_function" href = "namespacemlx_1_1core_1_1metal.html#a31eab4828d31d292bc84e07b0d961e1e" > set_wired_limit< / a > (< span class = "keywordtype" > size_t< / span > limit);< / div >
< div class = "line" > < a id = "l00078" name = "l00078" > < / a > < span class = "lineno" > 78< / span > < / div >
< div class = "line" > < a id = "l00080" name = "l00080" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core_1_1metal.html#aa47cb5651bf3b65c46ab216b7e504d77" > 80< / a > < / span > < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "namespacemlx_1_1core_1_1metal.html#aa47cb5651bf3b65c46ab216b7e504d77" > start_capture< / a > (std::string path = < span class = "stringliteral" > " " < / span > );< / div >
< div class = "line" > < a id = "l00081" name = "l00081" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core_1_1metal.html#ac90714424e36fb01e04550de69b8314f" > 81< / a > < / span > < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "namespacemlx_1_1core_1_1metal.html#ac90714424e36fb01e04550de69b8314f" > stop_capture< / a > ();< / div >
< div class = "line" > < a id = "l00082" name = "l00082" > < / a > < span class = "lineno" > 82< / span > < / div >
< div class = "line" > < a id = "l00084" name = "l00084" > < / a > < span class = "lineno" > 84< / span > std::unordered_map< std::string, std::variant< std::string, size_t> > < / div >
< div class = "line" > < a id = "l00085" name = "l00085" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core_1_1metal.html#a6ad19c44efabb7423f973407926ead61" > 85< / a > < / span > < a class = "code hl_function" href = "namespacemlx_1_1core_1_1metal.html#a6ad19c44efabb7423f973407926ead61" > device_info< / a > ();< / div >
< div class = "line" > < a id = "l00086" name = "l00086" > < / a > < span class = "lineno" > 86< / span > < / div >
< div class = "line" > < a id = "l00087" name = "l00087" > < / a > < span class = "lineno" > 87< / span > } < span class = "comment" > // namespace mlx::core::metal< / span > < / div >
2024-10-15 23:12:17 +08:00
< div class = "ttc" id = "aarray_8h_html" > < div class = "ttname" > < a href = "array_8h.html" > array.h< / a > < / div > < / div >
2024-10-26 04:23:45 +08:00
< div class = "ttc" id = "anamespacemlx_1_1core_1_1metal_html" > < div class = "ttname" > < a href = "namespacemlx_1_1core_1_1metal.html" > mlx::core::metal< / a > < / div > < div class = "ttdef" > < b > Definition< / b > allocator.h:13< / div > < / div >
2024-10-15 23:12:17 +08:00
< div class = "ttc" id = "anamespacemlx_1_1core_1_1metal_html_a0cdf2c08c7bc0927a86070adc206987f" > < div class = "ttname" > < a href = "namespacemlx_1_1core_1_1metal.html#a0cdf2c08c7bc0927a86070adc206987f" > mlx::core::metal::is_available< / a > < / div > < div class = "ttdeci" > bool is_available()< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_1_1metal_html_a22b3384ebd17f2fca198f81b9f1b6dc3" > < div class = "ttname" > < a href = "namespacemlx_1_1core_1_1metal.html#a22b3384ebd17f2fca198f81b9f1b6dc3" > mlx::core::metal::clear_cache< / a > < / div > < div class = "ttdeci" > void clear_cache()< / div > < / div >
2024-10-26 04:23:45 +08:00
< div class = "ttc" id = "anamespacemlx_1_1core_1_1metal_html_a31eab4828d31d292bc84e07b0d961e1e" > < div class = "ttname" > < a href = "namespacemlx_1_1core_1_1metal.html#a31eab4828d31d292bc84e07b0d961e1e" > mlx::core::metal::set_wired_limit< / a > < / div > < div class = "ttdeci" > size_t set_wired_limit(size_t limit)< / div > < / div >
2024-10-15 23:12:17 +08:00
< div class = "ttc" id = "anamespacemlx_1_1core_1_1metal_html_a3fb2c4a237fa4bfdff798156146c4937" > < div class = "ttname" > < a href = "namespacemlx_1_1core_1_1metal.html#a3fb2c4a237fa4bfdff798156146c4937" > mlx::core::metal::set_memory_limit< / a > < / div > < div class = "ttdeci" > size_t set_memory_limit(size_t limit, bool relaxed=true)< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_1_1metal_html_a43307654f62ed7c58e014be7fb03909c" > < div class = "ttname" > < a href = "namespacemlx_1_1core_1_1metal.html#a43307654f62ed7c58e014be7fb03909c" > mlx::core::metal::get_cache_memory< / a > < / div > < div class = "ttdeci" > size_t get_cache_memory()< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_1_1metal_html_a4b67d680cefa95f0ed5801f0e14e48ce" > < div class = "ttname" > < a href = "namespacemlx_1_1core_1_1metal.html#a4b67d680cefa95f0ed5801f0e14e48ce" > mlx::core::metal::get_peak_memory< / a > < / div > < div class = "ttdeci" > size_t get_peak_memory()< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_1_1metal_html_a6ad19c44efabb7423f973407926ead61" > < div class = "ttname" > < a href = "namespacemlx_1_1core_1_1metal.html#a6ad19c44efabb7423f973407926ead61" > mlx::core::metal::device_info< / a > < / div > < div class = "ttdeci" > std::unordered_map< std::string, std::variant< std::string, size_t > > device_info()< / div > < div class = "ttdoc" > Get information about the GPU and system settings.< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_1_1metal_html_a7b75c2639016ac4d350fa6c9da386667" > < div class = "ttname" > < a href = "namespacemlx_1_1core_1_1metal.html#a7b75c2639016ac4d350fa6c9da386667" > mlx::core::metal::get_active_memory< / a > < / div > < div class = "ttdeci" > size_t get_active_memory()< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_1_1metal_html_aa47cb5651bf3b65c46ab216b7e504d77" > < div class = "ttname" > < a href = "namespacemlx_1_1core_1_1metal.html#aa47cb5651bf3b65c46ab216b7e504d77" > mlx::core::metal::start_capture< / a > < / div > < div class = "ttdeci" > void start_capture(std::string path=" " )< / div > < div class = "ttdoc" > Capture a GPU trace, saving it to an absolute file path< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_1_1metal_html_ab09c9b60f1e886ab859e6a066c9a5b9d" > < div class = "ttname" > < a href = "namespacemlx_1_1core_1_1metal.html#ab09c9b60f1e886ab859e6a066c9a5b9d" > mlx::core::metal::set_cache_limit< / a > < / div > < div class = "ttdeci" > size_t set_cache_limit(size_t limit)< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_1_1metal_html_ac90714424e36fb01e04550de69b8314f" > < div class = "ttname" > < a href = "namespacemlx_1_1core_1_1metal.html#ac90714424e36fb01e04550de69b8314f" > mlx::core::metal::stop_capture< / a > < / div > < div class = "ttdeci" > void stop_capture()< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_1_1metal_html_adec8bb375da6c9dd5ff625a3a8434122" > < div class = "ttname" > < a href = "namespacemlx_1_1core_1_1metal.html#adec8bb375da6c9dd5ff625a3a8434122" > mlx::core::metal::reset_peak_memory< / a > < / div > < div class = "ttdeci" > void reset_peak_memory()< / 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 >
