mirror of
https://github.com/ml-explore/mlx.git
synced 2025-06-25 09:51:17 +08:00
162 lines
19 KiB
HTML
162 lines
19 KiB
HTML
<!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.10.0"/>
|
|
<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"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<script type="text/javascript" src="clipboard.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.10.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" 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');
|
|
$(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() { codefold.init(0); });
|
|
/* @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> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">io.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="io_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><span class="preprocessor">#include "<a class="code" href="load_8h.html">mlx/io/load.h</a>"</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include "<a class="code" href="stream_8h.html">mlx/stream.h</a>"</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include "<a class="code" href="utils_8h.html">mlx/utils.h</a>"</span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</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="l00013" name="l00013"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a8c2c1b9a37aadfb48f4c3a7e806e32e3"> 13</a></span><span class="keyword">using </span><a class="code hl_typedef" href="namespacemlx_1_1core.html#a8c2c1b9a37aadfb48f4c3a7e806e32e3">GGUFMetaData</a> =</div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> std::variant<std::monostate, array, std::string, std::vector<std::string>>;</div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#aa5b0f7f13a941e1f41c411194e9033c7"> 15</a></span><span class="keyword">using </span><a class="code hl_typedef" href="namespacemlx_1_1core.html#aa5b0f7f13a941e1f41c411194e9033c7">GGUFLoad</a> = std::pair<</div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> std::unordered_map<std::string, array>,</div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> std::unordered_map<std::string, GGUFMetaData>>;</div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a688cd7917b1365065e8059e9964c3d45"> 18</a></span><span class="keyword">using </span><a class="code hl_typedef" href="namespacemlx_1_1core.html#a688cd7917b1365065e8059e9964c3d45">SafetensorsLoad</a> = std::pair<</div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> std::unordered_map<std::string, array>,</div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> std::unordered_map<std::string, std::string>>;</div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#ad4c2cebe9e54582295f98c5a448a1f32"> 23</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespacemlx_1_1core.html#ad4c2cebe9e54582295f98c5a448a1f32">save</a>(std::shared_ptr<io::Writer> out_stream, <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a> a);</div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a22a37f3e33e0658680f6227bdd2d0b91"> 26</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="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#abada9bfa834d7423959362386720f3db"> 29</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#abada9bfa834d7423959362386720f3db">load</a>(std::shared_ptr<io::Reader> in_stream, <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#ac71a08bf4c052ae3c77e9e89cbea071d"> 32</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#abada9bfa834d7423959362386720f3db">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="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a96cc40e1af8c4626c813ce4859f70a5c"> 35</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="l00036" name="l00036"></a><span class="lineno"> 36</span> std::shared_ptr<io::Reader> in_stream,</div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#af7eea1682a38d363c56a066321e6d526"> 38</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="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">const</span> std::string& file,</div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</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#a9f158db20c2405557f3ebc397e876de8"> 42</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a9f158db20c2405557f3ebc397e876de8">save_safetensors</a>(</div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> std::shared_ptr<io::Writer> in_stream,</div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> std::unordered_map<std::string, array>,</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> std::unordered_map<std::string, std::string> metadata = {});</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a21e256d852d587bcdc0827831b2c5c16"> 46</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a9f158db20c2405557f3ebc397e876de8">save_safetensors</a>(</div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> std::string file,</div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> std::unordered_map<std::string, array>,</div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> std::unordered_map<std::string, std::string> metadata = {});</div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a2aa12b351ce559deb14cda0a5292c2ce"> 53</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& file, <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a8bcc29ca8846ec99dce333df4a34dc5f"> 55</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a8bcc29ca8846ec99dce333df4a34dc5f">save_gguf</a>(</div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> std::string file,</div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> std::unordered_map<std::string, array> array_map,</div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> std::unordered_map<std::string, GGUFMetaData> meta_data = {});</div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</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:20</div></div>
|
|
<div class="ttc" id="aload_8h_html"><div class="ttname"><a href="load_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 &file, StreamOrDevice s={})</div><div class="ttdoc">Load array map and metadata from .gguf file format.</div></div>
|
|
<div class="ttc" id="anamespacemlx_1_1core_html_a688cd7917b1365065e8059e9964c3d45"><div class="ttname"><a href="namespacemlx_1_1core.html#a688cd7917b1365065e8059e9964c3d45">mlx::core::SafetensorsLoad</a></div><div class="ttdeci">std::pair< std::unordered_map< std::string, array >, std::unordered_map< std::string, std::string > > SafetensorsLoad</div><div class="ttdef"><b>Definition</b> io.h:18</div></div>
|
|
<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< std::string, array > array_map, std::unordered_map< std::string, GGUFMetaData > 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< std::monostate, array, std::string, std::vector< std::string > > GGUFMetaData</div><div class="ttdef"><b>Definition</b> io.h:13</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< std::monostate, Stream, Device > StreamOrDevice</div><div class="ttdef"><b>Definition</b> utils.h:14</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< io::Reader > 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< io::Writer > in_stream, std::unordered_map< std::string, array >, std::unordered_map< std::string, std::string > 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< std::unordered_map< std::string, array >, std::unordered_map< std::string, GGUFMetaData > > GGUFLoad</div><div class="ttdef"><b>Definition</b> io.h:15</div></div>
|
|
<div class="ttc" id="anamespacemlx_1_1core_html_abada9bfa834d7423959362386720f3db"><div class="ttname"><a href="namespacemlx_1_1core.html#abada9bfa834d7423959362386720f3db">mlx::core::load</a></div><div class="ttdeci">array load(std::shared_ptr< io::Reader > in_stream, StreamOrDevice s={})</div><div class="ttdoc">Load array from reader in .npy format.</div></div>
|
|
<div class="ttc" id="anamespacemlx_1_1core_html_ad4c2cebe9e54582295f98c5a448a1f32"><div class="ttname"><a href="namespacemlx_1_1core.html#ad4c2cebe9e54582295f98c5a448a1f32">mlx::core::save</a></div><div class="ttdeci">void save(std::shared_ptr< io::Writer > out_stream, array a)</div><div class="ttdoc">Save array to out stream in .npy format.</div></div>
|
|
<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 <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
|
|
</small></address>
|
|
</body>
|
|
</html>
|