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

docs update

Browse Source
This commit is contained in:
Awni Hannun
2024-08-10 09:24:35 -07:00
committed by CircleCI Docs
parent ee4f4e3816
commit 44a49282c9
724 changed files with 14529 additions and 11046 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
docs/build/html/group__ops.html vendored
View File

@@ -241,16 +241,16 @@ Functions</h2></td></tr>
<tr class="memitem:ga24067d10a842db2c9d509ea48135a2c3" id="r_ga24067d10a842db2c9d509ea48135a2c3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmlx_1_1core_1_1array.html">array</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga24067d10a842db2c9d509ea48135a2c3">mlx::core::moveaxis</a> (const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;a, int source, int destination, <a class="el" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s={})</td></tr>
<tr class="memdesc:ga24067d10a842db2c9d509ea48135a2c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move an axis of an array. <br /></td></tr>
<tr class="separator:ga24067d10a842db2c9d509ea48135a2c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4fd04d6472ae7cdb94a174edfe338ea3" id="r_ga4fd04d6472ae7cdb94a174edfe338ea3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmlx_1_1core_1_1array.html">array</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4fd04d6472ae7cdb94a174edfe338ea3">mlx::core::pad</a> (const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;a, const std::vector&lt; int &gt; &amp;axes, const std::vector&lt; int &gt; &amp;low_pad_size, const std::vector&lt; int &gt; &amp;high_pad_size, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;pad_value=<a class="el" href="classmlx_1_1core_1_1array.html">array</a>(0), <a class="el" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s={})</td></tr>
<tr class="memdesc:ga4fd04d6472ae7cdb94a174edfe338ea3"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classmlx_1_1core_1_1_pad.html">Pad</a> an array with a constant value. <br /></td></tr>
<tr class="separator:ga4fd04d6472ae7cdb94a174edfe338ea3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaca4e00d5e4ed9e9f29d56a17f19c2e31" id="r_gaca4e00d5e4ed9e9f29d56a17f19c2e31"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmlx_1_1core_1_1array.html">array</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaca4e00d5e4ed9e9f29d56a17f19c2e31">mlx::core::pad</a> (const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;a, const std::vector&lt; std::pair&lt; int, int &gt; &gt; &amp;pad_width, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;pad_value=<a class="el" href="classmlx_1_1core_1_1array.html">array</a>(0), <a class="el" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s={})</td></tr>
<tr class="memdesc:gaca4e00d5e4ed9e9f29d56a17f19c2e31"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classmlx_1_1core_1_1_pad.html">Pad</a> an array with a constant value along all axes. <br /></td></tr>
<tr class="separator:gaca4e00d5e4ed9e9f29d56a17f19c2e31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga608164c4f5b4ac2fba374219285d90bc" id="r_ga608164c4f5b4ac2fba374219285d90bc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmlx_1_1core_1_1array.html">array</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga608164c4f5b4ac2fba374219285d90bc">mlx::core::pad</a> (const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;a, const std::pair&lt; int, int &gt; &amp;pad_width, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;pad_value=<a class="el" href="classmlx_1_1core_1_1array.html">array</a>(0), <a class="el" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s={})</td></tr>
<tr class="separator:ga608164c4f5b4ac2fba374219285d90bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2e57e26c4d7f3d18802c164656cf915c" id="r_ga2e57e26c4d7f3d18802c164656cf915c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmlx_1_1core_1_1array.html">array</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga2e57e26c4d7f3d18802c164656cf915c">mlx::core::pad</a> (const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;a, int pad_width, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;pad_value=<a class="el" href="classmlx_1_1core_1_1array.html">array</a>(0), <a class="el" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s={})</td></tr>
<tr class="separator:ga2e57e26c4d7f3d18802c164656cf915c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga81c2f138ea81d78affd42e9a646cacbc" id="r_ga81c2f138ea81d78affd42e9a646cacbc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmlx_1_1core_1_1array.html">array</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga81c2f138ea81d78affd42e9a646cacbc">mlx::core::pad</a> (const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;a, const std::vector&lt; int &gt; &amp;axes, const std::vector&lt; int &gt; &amp;low_pad_size, const std::vector&lt; int &gt; &amp;high_pad_size, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;pad_value=<a class="el" href="classmlx_1_1core_1_1array.html">array</a>(0), const std::string mode=&quot;constant&quot;, <a class="el" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s={})</td></tr>
<tr class="memdesc:ga81c2f138ea81d78affd42e9a646cacbc"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classmlx_1_1core_1_1_pad.html">Pad</a> an array with a constant value. <br /></td></tr>
<tr class="separator:ga81c2f138ea81d78affd42e9a646cacbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8495c9902b0a67f288918cb528d5abeb" id="r_ga8495c9902b0a67f288918cb528d5abeb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmlx_1_1core_1_1array.html">array</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8495c9902b0a67f288918cb528d5abeb">mlx::core::pad</a> (const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;a, const std::vector&lt; std::pair&lt; int, int &gt; &gt; &amp;pad_width, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;pad_value=<a class="el" href="classmlx_1_1core_1_1array.html">array</a>(0), const std::string mode=&quot;constant&quot;, <a class="el" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s={})</td></tr>
<tr class="memdesc:ga8495c9902b0a67f288918cb528d5abeb"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classmlx_1_1core_1_1_pad.html">Pad</a> an array with a constant value along all axes. <br /></td></tr>
<tr class="separator:ga8495c9902b0a67f288918cb528d5abeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaeaae2f9637b0b3e2b4c6c0517e285935" id="r_gaeaae2f9637b0b3e2b4c6c0517e285935"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmlx_1_1core_1_1array.html">array</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaeaae2f9637b0b3e2b4c6c0517e285935">mlx::core::pad</a> (const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;a, const std::pair&lt; int, int &gt; &amp;pad_width, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;pad_value=<a class="el" href="classmlx_1_1core_1_1array.html">array</a>(0), const std::string mode=&quot;constant&quot;, <a class="el" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s={})</td></tr>
<tr class="separator:gaeaae2f9637b0b3e2b4c6c0517e285935"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5b8684361f57cbfd5e6eedf82a62ded0" id="r_ga5b8684361f57cbfd5e6eedf82a62ded0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmlx_1_1core_1_1array.html">array</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5b8684361f57cbfd5e6eedf82a62ded0">mlx::core::pad</a> (const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;a, int pad_width, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;pad_value=<a class="el" href="classmlx_1_1core_1_1array.html">array</a>(0), const std::string mode=&quot;constant&quot;, <a class="el" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s={})</td></tr>
<tr class="separator:ga5b8684361f57cbfd5e6eedf82a62ded0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga68da0176fefbe0c0096783c6fd926c6a" id="r_ga68da0176fefbe0c0096783c6fd926c6a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmlx_1_1core_1_1array.html">array</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga68da0176fefbe0c0096783c6fd926c6a">mlx::core::transpose</a> (const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;a, <a class="el" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s={})</td></tr>
<tr class="memdesc:ga68da0176fefbe0c0096783c6fd926c6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Permutes the dimensions in reverse order. <br /></td></tr>
<tr class="separator:ga68da0176fefbe0c0096783c6fd926c6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -6473,8 +6473,8 @@ template&lt;typename T &gt; </div>
</div>
</div>
<a id="ga608164c4f5b4ac2fba374219285d90bc" name="ga608164c4f5b4ac2fba374219285d90bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga608164c4f5b4ac2fba374219285d90bc">&#9670;&#160;</a></span>pad() <span class="overload">[1/4]</span></h2>
<a id="gaeaae2f9637b0b3e2b4c6c0517e285935" name="gaeaae2f9637b0b3e2b4c6c0517e285935"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaeaae2f9637b0b3e2b4c6c0517e285935">&#9670;&#160;</a></span>pad() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -6494,6 +6494,11 @@ template&lt;typename T &gt; </div>
<td></td>
<td class="paramtype">const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;</td> <td class="paramname"><span class="paramname"><em>pad_value</em><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="classmlx_1_1core_1_1array.html">array</a>(0)</span>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string</td> <td class="paramname"><span class="paramname"><em>mode</em><span class="paramdefsep"> = </span><span class="paramdefval">&quot;constant&quot;</span>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
@@ -6504,8 +6509,8 @@ template&lt;typename T &gt; </div>
</div>
</div>
<a id="ga4fd04d6472ae7cdb94a174edfe338ea3" name="ga4fd04d6472ae7cdb94a174edfe338ea3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4fd04d6472ae7cdb94a174edfe338ea3">&#9670;&#160;</a></span>pad() <span class="overload">[2/4]</span></h2>
<a id="ga81c2f138ea81d78affd42e9a646cacbc" name="ga81c2f138ea81d78affd42e9a646cacbc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga81c2f138ea81d78affd42e9a646cacbc">&#9670;&#160;</a></span>pad() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -6535,6 +6540,11 @@ template&lt;typename T &gt; </div>
<td></td>
<td class="paramtype">const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;</td> <td class="paramname"><span class="paramname"><em>pad_value</em><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="classmlx_1_1core_1_1array.html">array</a>(0)</span>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string</td> <td class="paramname"><span class="paramname"><em>mode</em><span class="paramdefsep"> = </span><span class="paramdefval">&quot;constant&quot;</span>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
@@ -6547,8 +6557,8 @@ template&lt;typename T &gt; </div>
</div>
</div>
<a id="gaca4e00d5e4ed9e9f29d56a17f19c2e31" name="gaca4e00d5e4ed9e9f29d56a17f19c2e31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaca4e00d5e4ed9e9f29d56a17f19c2e31">&#9670;&#160;</a></span>pad() <span class="overload">[3/4]</span></h2>
<a id="ga8495c9902b0a67f288918cb528d5abeb" name="ga8495c9902b0a67f288918cb528d5abeb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8495c9902b0a67f288918cb528d5abeb">&#9670;&#160;</a></span>pad() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -6568,6 +6578,11 @@ template&lt;typename T &gt; </div>
<td></td>
<td class="paramtype">const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;</td> <td class="paramname"><span class="paramname"><em>pad_value</em><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="classmlx_1_1core_1_1array.html">array</a>(0)</span>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string</td> <td class="paramname"><span class="paramname"><em>mode</em><span class="paramdefsep"> = </span><span class="paramdefval">&quot;constant&quot;</span>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
@@ -6580,8 +6595,8 @@ template&lt;typename T &gt; </div>
</div>
</div>
<a id="ga2e57e26c4d7f3d18802c164656cf915c" name="ga2e57e26c4d7f3d18802c164656cf915c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2e57e26c4d7f3d18802c164656cf915c">&#9670;&#160;</a></span>pad() <span class="overload">[4/4]</span></h2>
<a id="ga5b8684361f57cbfd5e6eedf82a62ded0" name="ga5b8684361f57cbfd5e6eedf82a62ded0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5b8684361f57cbfd5e6eedf82a62ded0">&#9670;&#160;</a></span>pad() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -6601,6 +6616,11 @@ template&lt;typename T &gt; </div>
<td></td>
<td class="paramtype">const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;</td> <td class="paramname"><span class="paramname"><em>pad_value</em><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="classmlx_1_1core_1_1array.html">array</a>(0)</span>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string</td> <td class="paramname"><span class="paramname"><em>mode</em><span class="paramdefsep"> = </span><span class="paramdefval">&quot;constant&quot;</span>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
@@ -7270,7 +7290,7 @@ template&lt;typename T &gt; </div>
<div class="ttc" id="agroup__ops_html_ga7b0e3d46a39d99b1628b422049790082"><div class="ttname"><a href="#ga7b0e3d46a39d99b1628b422049790082">mlx::core::reshape</a></div><div class="ttdeci">array reshape(const array &amp;a, std::vector&lt; int &gt; shape, StreamOrDevice s={})</div><div class="ttdoc">Reshape an array to the given shape.</div></div>
<div class="ttc" id="agroup__ops_html_gad438be8f90bae9d37c6853b8f4225d61"><div class="ttname"><a href="#gad438be8f90bae9d37c6853b8f4225d61">mlx::core::scatter</a></div><div class="ttdeci">array scatter(const array &amp;a, const std::vector&lt; array &gt; &amp;indices, const array &amp;updates, const std::vector&lt; int &gt; &amp;axes, StreamOrDevice s={})</div><div class="ttdoc">Scatter updates to the given indices.</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a369aa886219b83cf219e7a7862ce260b"><div class="ttname"><a href="namespacemlx_1_1core.html#a369aa886219b83cf219e7a7862ce260b">mlx::core::arange</a></div><div class="ttdeci">void arange(const std::vector&lt; array &gt; &amp;inputs, array &amp;out, double start, double step)</div><div class="ttdef"><b>Definition</b> arange.h:24</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a6894543b340321193dfb8052c438a319"><div class="ttname"><a href="namespacemlx_1_1core.html#a6894543b340321193dfb8052c438a319">mlx::core::float32</a></div><div class="ttdeci">constexpr Dtype float32</div><div class="ttdef"><b>Definition</b> dtype.h:73</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a6894543b340321193dfb8052c438a319"><div class="ttname"><a href="namespacemlx_1_1core.html#a6894543b340321193dfb8052c438a319">mlx::core::float32</a></div><div class="ttdeci">constexpr Dtype float32</div><div class="ttdef"><b>Definition</b> dtype.h:71</div></div>
</div><!-- fragment --><p>will produce:</p>
<div class="fragment"><div class="line"><a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>([[0, 0, 0, 0],</div>
<div class="line"> [0, 0, 0, 0],</div>