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

rebase

Browse Source
This commit is contained in:
CircleCI Docs
2025-01-09 21:56:20 +00:00
parent 04b749a588
commit d8d647015b
2642 changed files with 137687 additions and 70861 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
docs/build/html/io_8h_source.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.13.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: mlx/io.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -11,11 +11,18 @@
<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>
@@ -28,12 +35,24 @@
<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.12.0 -->
<!-- Generated by Doxygen 1.13.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -44,22 +63,23 @@ var searchBox = new SearchBox("searchBox", "search/",'.html');
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></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() {
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); });
$(function(){initNavTree('io_8h_source.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -81,12 +101,6 @@ $(function(){ initResizable(false); });
</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 id="doc-content">
<div class="header">
<div class="headertitle"><div class="title">io.h</div></div>
</div><!--header-->
@@ -112,15 +126,15 @@ $(function(){ initResizable(false); });
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a688cd7917b1365065e8059e9964c3d45"> 19</a></span><span class="keyword">using </span><a class="code hl_typedef" href="namespacemlx_1_1core.html#a688cd7917b1365065e8059e9964c3d45">SafetensorsLoad</a> = std::pair&lt;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> std::unordered_map&lt;std::string, array&gt;,</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> std::unordered_map&lt;std::string, std::string&gt;&gt;;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#ad4c2cebe9e54582295f98c5a448a1f32"> 24</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespacemlx_1_1core.html#ad4c2cebe9e54582295f98c5a448a1f32">save</a>(std::shared_ptr&lt;io::Writer&gt; out_stream, <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a> a);</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a22a37f3e33e0658680f6227bdd2d0b91"> 27</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespacemlx_1_1core.html#ad4c2cebe9e54582295f98c5a448a1f32">save</a>(std::string file, <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a> a);</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#abada9bfa834d7423959362386720f3db"> 30</a></span><a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a> <a class="code hl_function" href="namespacemlx_1_1core.html#a954de19249da7c1fa39b89bdc47368aa">load</a>(std::shared_ptr&lt;io::Reader&gt; in_stream, <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#ac71a08bf4c052ae3c77e9e89cbea071d"> 33</a></span><a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a> <a class="code hl_function" href="namespacemlx_1_1core.html#a954de19249da7c1fa39b89bdc47368aa">load</a>(std::string file, <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a96cc40e1af8c4626c813ce4859f70a5c"> 36</a></span><a class="code hl_typedef" href="namespacemlx_1_1core.html#a688cd7917b1365065e8059e9964c3d45">SafetensorsLoad</a> <a class="code hl_function" href="namespacemlx_1_1core.html#a96cc40e1af8c4626c813ce4859f70a5c">load_safetensors</a>(</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> std::shared_ptr&lt;io::Reader&gt; in_stream,</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
@@ -136,7 +150,8 @@ $(function(){ initResizable(false); });
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> std::string file,</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> std::unordered_map&lt;std::string, array&gt;,</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> std::unordered_map&lt;std::string, std::string&gt; metadata = {});</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a2aa12b351ce559deb14cda0a5292c2ce"> 54</a></span><a class="code hl_typedef" href="namespacemlx_1_1core.html#aa5b0f7f13a941e1f41c411194e9033c7">GGUFLoad</a> <a class="code hl_function" href="namespacemlx_1_1core.html#a2aa12b351ce559deb14cda0a5292c2ce">load_gguf</a>(<span class="keyword">const</span> std::string&amp; file, <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a8bcc29ca8846ec99dce333df4a34dc5f"> 56</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a8bcc29ca8846ec99dce333df4a34dc5f">save_gguf</a>(</div>
@@ -146,7 +161,7 @@ $(function(){ initResizable(false); });
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</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:23</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="aio_2load_8h_html"><div class="ttname"><a href="io_2load_8h.html">load.h</a></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_a2aa12b351ce559deb14cda0a5292c2ce"><div class="ttname"><a href="namespacemlx_1_1core.html#a2aa12b351ce559deb14cda0a5292c2ce">mlx::core::load_gguf</a></div><div class="ttdeci">GGUFLoad load_gguf(const std::string &amp;file, StreamOrDevice s={})</div><div class="ttdoc">Load array map and metadata from .gguf file format.</div></div>
@@ -154,7 +169,7 @@ $(function(){ initResizable(false); });
<div class="ttc" id="anamespacemlx_1_1core_html_a8bcc29ca8846ec99dce333df4a34dc5f"><div class="ttname"><a href="namespacemlx_1_1core.html#a8bcc29ca8846ec99dce333df4a34dc5f">mlx::core::save_gguf</a></div><div class="ttdeci">void save_gguf(std::string file, std::unordered_map&lt; std::string, array &gt; array_map, std::unordered_map&lt; std::string, GGUFMetaData &gt; meta_data={})</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a8c2c1b9a37aadfb48f4c3a7e806e32e3"><div class="ttname"><a href="namespacemlx_1_1core.html#a8c2c1b9a37aadfb48f4c3a7e806e32e3">mlx::core::GGUFMetaData</a></div><div class="ttdeci">std::variant&lt; std::monostate, array, std::string, std::vector&lt; std::string &gt; &gt; GGUFMetaData</div><div class="ttdef"><b>Definition</b> io.h:14</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a954de19249da7c1fa39b89bdc47368aa"><div class="ttname"><a href="namespacemlx_1_1core.html#a954de19249da7c1fa39b89bdc47368aa">mlx::core::load</a></div><div class="ttdeci">void load(array &amp;out, size_t offset, const std::shared_ptr&lt; io::Reader &gt; &amp;reader, bool swap_endianess)</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a95fc1013cc48fbfee0c54310711a5e58"><div class="ttname"><a href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">mlx::core::StreamOrDevice</a></div><div class="ttdeci">std::variant&lt; std::monostate, Stream, Device &gt; StreamOrDevice</div><div class="ttdef"><b>Definition</b> utils.h:14</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a95fc1013cc48fbfee0c54310711a5e58"><div class="ttname"><a href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">mlx::core::StreamOrDevice</a></div><div class="ttdeci">std::variant&lt; std::monostate, Stream, Device &gt; StreamOrDevice</div><div class="ttdef"><b>Definition</b> utils.h:15</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a96cc40e1af8c4626c813ce4859f70a5c"><div class="ttname"><a href="namespacemlx_1_1core.html#a96cc40e1af8c4626c813ce4859f70a5c">mlx::core::load_safetensors</a></div><div class="ttdeci">SafetensorsLoad load_safetensors(std::shared_ptr&lt; io::Reader &gt; in_stream, StreamOrDevice s={})</div><div class="ttdoc">Load array map from .safetensors file format.</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a9f158db20c2405557f3ebc397e876de8"><div class="ttname"><a href="namespacemlx_1_1core.html#a9f158db20c2405557f3ebc397e876de8">mlx::core::save_safetensors</a></div><div class="ttdeci">void save_safetensors(std::shared_ptr&lt; io::Writer &gt; in_stream, std::unordered_map&lt; std::string, array &gt;, std::unordered_map&lt; std::string, std::string &gt; metadata={})</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_aa5b0f7f13a941e1f41c411194e9033c7"><div class="ttname"><a href="namespacemlx_1_1core.html#aa5b0f7f13a941e1f41c411194e9033c7">mlx::core::GGUFLoad</a></div><div class="ttdeci">std::pair&lt; std::unordered_map&lt; std::string, array &gt;, std::unordered_map&lt; std::string, GGUFMetaData &gt; &gt; GGUFLoad</div><div class="ttdef"><b>Definition</b> io.h:16</div></div>
@@ -162,10 +177,13 @@ $(function(){ initResizable(false); });
<div class="ttc" id="astream_8h_html"><div class="ttname"><a href="stream_8h.html">stream.h</a></div></div>
<div class="ttc" id="autils_8h_html"><div class="ttname"><a href="utils_8h.html">utils.h</a></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.12.0
</small></address>
</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="io_8h.html">io.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.1 </li>
</ul>
</div>
</body>
</html>