zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-09-18 01:50:16 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

rebase

Browse Source
This commit is contained in:
CircleCI Docs
2024-10-25 20:23:45 +00:00
parent 57e53f85ee
commit 73830de153
717 changed files with 33254 additions and 34561 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/build/html/metal_8h_source.html vendored
View File

@@ -156,17 +156,31 @@ $(function(){ initResizable(false); });
<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>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1metal.html#aa47cb5651bf3b65c46ab216b7e504d77"> 67</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">&quot;&quot;</span>);</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1metal.html#ac90714424e36fb01e04550de69b8314f"> 68</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="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span>std::unordered_map&lt;std::string, std::variant&lt;std::string, size_t&gt;&gt;</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1metal.html#a6ad19c44efabb7423f973407926ead61"> 72</a></span><a class="code hl_function" href="namespacemlx_1_1core_1_1metal.html#a6ad19c44efabb7423f973407926ead61">device_info</a>();</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span>} <span class="comment">// namespace mlx::core::metal</span></div>
<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">&quot;&quot;</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&lt;std::string, std::variant&lt;std::string, size_t&gt;&gt;</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>
<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_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:12</div></div>
<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>
<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>
<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>
<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>