zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-09-18 10:11:43 +08:00
Code Issues Actions 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 8f68182d95
commit d8f7b8cda6
724 changed files with 14529 additions and 11046 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/build/html/linalg_8h_source.html vendored
View File

@@ -147,9 +147,13 @@ $(function() { codefold.init(0); });
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1linalg.html#ad966a0b6bff176c9f933534ed62389a2"> 67</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_1_1linalg.html#ad966a0b6bff176c9f933534ed62389a2">inv</a>(<span class="keyword">const</span> <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>&amp; a, <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1linalg.html#a46c8a4f806f0a97a4323e91189aa512b"> 69</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_1_1linalg.html#a46c8a4f806f0a97a4323e91189aa512b">cholesky</a>(<span class="keyword">const</span> <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>&amp; a, <span class="keywordtype">bool</span> upper = <span class="keyword">false</span>, <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1linalg.html#aba1994571326326717b5b5e38c2e0661"> 69</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_1_1linalg.html#aba1994571326326717b5b5e38c2e0661">tri_inv</a>(<span class="keyword">const</span> <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>&amp; a, <span class="keywordtype">bool</span> upper = <span class="keyword">false</span>, <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span>} <span class="comment">// namespace mlx::core::linalg</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1linalg.html#a46c8a4f806f0a97a4323e91189aa512b"> 71</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_1_1linalg.html#a46c8a4f806f0a97a4323e91189aa512b">cholesky</a>(<span class="keyword">const</span> <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>&amp; a, <span class="keywordtype">bool</span> upper = <span class="keyword">false</span>, <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1linalg.html#aef0fe4894c5cf98792d59859c6d20511"> 73</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_1_1linalg.html#aef0fe4894c5cf98792d59859c6d20511">cholesky_inv</a>(<span class="keyword">const</span> <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>&amp; a, <span class="keywordtype">bool</span> upper = <span class="keyword">false</span>, <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span>} <span class="comment">// namespace mlx::core::linalg</span></div>
</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>
@@ -157,9 +161,11 @@ $(function() { codefold.init(0); });
<div class="ttc" id="anamespacemlx_1_1core_1_1linalg_html"><div class="ttname"><a href="namespacemlx_1_1core_1_1linalg.html">mlx::core::linalg</a></div><div class="ttdef"><b>Definition</b> linalg.h:12</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1linalg_html_a46c8a4f806f0a97a4323e91189aa512b"><div class="ttname"><a href="namespacemlx_1_1core_1_1linalg.html#a46c8a4f806f0a97a4323e91189aa512b">mlx::core::linalg::cholesky</a></div><div class="ttdeci">array cholesky(const array &amp;a, bool upper=false, StreamOrDevice s={})</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1linalg_html_a64364b880e99914cf47bf756fa8dbaf0"><div class="ttname"><a href="namespacemlx_1_1core_1_1linalg.html#a64364b880e99914cf47bf756fa8dbaf0">mlx::core::linalg::svd</a></div><div class="ttdeci">std::vector&lt; array &gt; svd(const array &amp;a, StreamOrDevice s={})</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1linalg_html_aba1994571326326717b5b5e38c2e0661"><div class="ttname"><a href="namespacemlx_1_1core_1_1linalg.html#aba1994571326326717b5b5e38c2e0661">mlx::core::linalg::tri_inv</a></div><div class="ttdeci">array tri_inv(const array &amp;a, bool upper=false, StreamOrDevice s={})</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1linalg_html_aba765b8e95e9a1d33d31f727a185919d"><div class="ttname"><a href="namespacemlx_1_1core_1_1linalg.html#aba765b8e95e9a1d33d31f727a185919d">mlx::core::linalg::norm</a></div><div class="ttdeci">array norm(const array &amp;a, const double ord, const std::optional&lt; std::vector&lt; int &gt; &gt; &amp;axis=std::nullopt, bool keepdims=false, StreamOrDevice s={})</div><div class="ttdoc">Compute vector or matrix norms.</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1linalg_html_ad966a0b6bff176c9f933534ed62389a2"><div class="ttname"><a href="namespacemlx_1_1core_1_1linalg.html#ad966a0b6bff176c9f933534ed62389a2">mlx::core::linalg::inv</a></div><div class="ttdeci">array inv(const array &amp;a, StreamOrDevice s={})</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1linalg_html_ae6d97829459353fe3b31c8a0867c0ca2"><div class="ttname"><a href="namespacemlx_1_1core_1_1linalg.html#ae6d97829459353fe3b31c8a0867c0ca2">mlx::core::linalg::qr</a></div><div class="ttdeci">std::pair&lt; array, array &gt; qr(const array &amp;a, StreamOrDevice s={})</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1linalg_html_aef0fe4894c5cf98792d59859c6d20511"><div class="ttname"><a href="namespacemlx_1_1core_1_1linalg.html#aef0fe4894c5cf98792d59859c6d20511">mlx::core::linalg::cholesky_inv</a></div><div class="ttdeci">array cholesky_inv(const array &amp;a, bool upper=false, StreamOrDevice s={})</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="aops_8h_html"><div class="ttname"><a href="ops_8h.html">ops.h</a></div></div>
<div class="ttc" id="astream_8h_html"><div class="ttname"><a href="stream_8h.html">stream.h</a></div></div>