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

rebase

Browse Source
This commit is contained in:
CircleCI Docs
2024-11-22 20:24:16 +00:00
parent 6433a22733
commit 8ba8a39e43
905 changed files with 30035 additions and 16934 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/build/html/ops_8h_source.html vendored
View File

@@ -294,11 +294,11 @@ $(function(){ initResizable(false); });
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno"> 218</span> <span class="keyword">const</span> std::optional&lt;array&gt;&amp; a_max = std::nullopt,</div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"> 219</span> <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span> </div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"><a class="line" href="group__ops.html#gabdc36fa65697d0361c8d67495de77129"> 222</a></span><a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a> <a class="code hl_function" href="group__ops.html#gabdc36fa65697d0361c8d67495de77129">concatenate</a>(</div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"><a class="line" href="group__ops.html#gabdc36fa65697d0361c8d67495de77129"> 222</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#a76a2e310857f60f5ea6f1388d45b964d">concatenate</a>(</div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span> <span class="keyword">const</span> std::vector&lt;array&gt;&amp; arrays,</div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span> <span class="keywordtype">int</span> axis,</div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span> <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"><a class="line" href="group__ops.html#gaa95c34ca3a8877f2c50cb60e7fa312b8"> 226</a></span><a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a> <a class="code hl_function" href="group__ops.html#gabdc36fa65697d0361c8d67495de77129">concatenate</a>(<span class="keyword">const</span> std::vector&lt;array&gt;&amp; arrays, <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"><a class="line" href="group__ops.html#gaa95c34ca3a8877f2c50cb60e7fa312b8"> 226</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#a76a2e310857f60f5ea6f1388d45b964d">concatenate</a>(<span class="keyword">const</span> std::vector&lt;array&gt;&amp; arrays, <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span> </div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno"><a class="line" href="group__ops.html#gaf8f2ec2b98a4b59eca73d7471df6e032"> 229</a></span><a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a> <a class="code hl_function" href="group__ops.html#gaf8f2ec2b98a4b59eca73d7471df6e032">stack</a>(<span class="keyword">const</span> std::vector&lt;array&gt;&amp; arrays, <span class="keywordtype">int</span> axis, <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno"><a class="line" href="group__ops.html#ga82216209dce901296fc737fe8efa5c94"> 230</a></span><a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a> <a class="code hl_function" href="group__ops.html#gaf8f2ec2b98a4b59eca73d7471df6e032">stack</a>(<span class="keyword">const</span> std::vector&lt;array&gt;&amp; arrays, <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
@@ -1364,7 +1364,13 @@ $(function(){ initResizable(false); });
<div class="line"><a id="l01486" name="l01486"></a><span class="lineno"> 1486</span><span class="comment">/* The imaginary part of a complex array. */</span></div>
<div class="line"><a id="l01487" name="l01487"></a><span class="lineno"><a class="line" href="group__ops.html#ga7ff592a64d528f0cf4f3d098465da029"> 1487</a></span><a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a> <a class="code hl_function" href="group__ops.html#ga7ff592a64d528f0cf4f3d098465da029">imag</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="l01488" name="l01488"></a><span class="lineno"> 1488</span> </div>
<div class="line"><a id="l01491" name="l01491"></a><span class="lineno"> 1491</span>} <span class="comment">// namespace mlx::core</span></div>
<div class="line"><a id="l01489" name="l01489"></a><span class="lineno"> 1489</span><span class="comment">/* Ensure the array&#39;s underlying memory is contiguous. */</span></div>
<div class="line"><a id="l01490" name="l01490"></a><span class="lineno"><a class="line" href="group__ops.html#ga8ab10aa6c41416d739791164a52b25d5"> 1490</a></span><a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a> <a class="code hl_function" href="group__ops.html#ga8ab10aa6c41416d739791164a52b25d5">contiguous</a>(</div>
<div class="line"><a id="l01491" name="l01491"></a><span class="lineno"> 1491</span> <span class="keyword">const</span> <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>&amp; a,</div>
<div class="line"><a id="l01492" name="l01492"></a><span class="lineno"> 1492</span> <span class="keywordtype">bool</span> allow_col_major = <span class="keyword">false</span>,</div>
<div class="line"><a id="l01493" name="l01493"></a><span class="lineno"> 1493</span> <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
<div class="line"><a id="l01494" name="l01494"></a><span class="lineno"> 1494</span> </div>
<div class="line"><a id="l01497" name="l01497"></a><span class="lineno"> 1497</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="adevice_8h_html"><div class="ttname"><a href="device_8h.html">device.h</a></div></div>
@@ -1474,6 +1480,7 @@ $(function(){ initResizable(false); });
<div class="ttc" id="agroup__ops_html_ga89682bf78491761e062d4ee7bef0c829"><div class="ttname"><a href="group__ops.html#ga89682bf78491761e062d4ee7bef0c829">mlx::core::left_shift</a></div><div class="ttdeci">array left_shift(const array &amp;a, const array &amp;b, StreamOrDevice s={})</div><div class="ttdoc">Shift bits to the left.</div></div>
<div class="ttc" id="agroup__ops_html_ga8a2056f8c9bb30914c40bcf509386491"><div class="ttname"><a href="group__ops.html#ga8a2056f8c9bb30914c40bcf509386491">mlx::core::where</a></div><div class="ttdeci">array where(const array &amp;condition, const array &amp;x, const array &amp;y, StreamOrDevice s={})</div><div class="ttdoc">Select from x or y depending on condition.</div></div>
<div class="ttc" id="agroup__ops_html_ga8a3b04e23e347d99ecf411fd6f4e5125"><div class="ttname"><a href="group__ops.html#ga8a3b04e23e347d99ecf411fd6f4e5125">mlx::core::exp</a></div><div class="ttdeci">array exp(const array &amp;a, StreamOrDevice s={})</div><div class="ttdoc">Exponential of the elements of an array.</div></div>
<div class="ttc" id="agroup__ops_html_ga8ab10aa6c41416d739791164a52b25d5"><div class="ttname"><a href="group__ops.html#ga8ab10aa6c41416d739791164a52b25d5">mlx::core::contiguous</a></div><div class="ttdeci">array contiguous(const array &amp;a, bool allow_col_major=false, StreamOrDevice s={})</div></div>
<div class="ttc" id="agroup__ops_html_ga8af4f22c08c11c4ffab7e3d45e0f3cd6"><div class="ttname"><a href="group__ops.html#ga8af4f22c08c11c4ffab7e3d45e0f3cd6">mlx::core::bitwise_or</a></div><div class="ttdeci">array bitwise_or(const array &amp;a, const array &amp;b, StreamOrDevice s={})</div><div class="ttdoc">Bitwise inclusive or.</div></div>
<div class="ttc" id="agroup__ops_html_ga8d50480266d258cac40ff51bcb0fc6a7"><div class="ttname"><a href="group__ops.html#ga8d50480266d258cac40ff51bcb0fc6a7">mlx::core::gather_mm</a></div><div class="ttdeci">array gather_mm(array a, array b, std::optional&lt; array &gt; lhs_indices=std::nullopt, std::optional&lt; array &gt; rhs_indices=std::nullopt, StreamOrDevice s={})</div><div class="ttdoc">Compute matrix product with matrix-level gather.</div></div>
<div class="ttc" id="agroup__ops_html_ga8d656904aa2690b60955ae745aecfc30"><div class="ttname"><a href="group__ops.html#ga8d656904aa2690b60955ae745aecfc30">mlx::core::floor</a></div><div class="ttdeci">array floor(const array &amp;a, StreamOrDevice s={})</div><div class="ttdoc">Floor the element of an array.</div></div>
@@ -1506,7 +1513,6 @@ $(function(){ initResizable(false); });
<div class="ttc" id="agroup__ops_html_gaba4d25e7a2bf87ba4feb7837ec7fa396"><div class="ttname"><a href="group__ops.html#gaba4d25e7a2bf87ba4feb7837ec7fa396">mlx::core::atleast_1d</a></div><div class="ttdeci">array atleast_1d(const array &amp;a, StreamOrDevice s={})</div><div class="ttdoc">convert an array to an atleast ndim array</div></div>
<div class="ttc" id="agroup__ops_html_gabc46eed81ab6c6247903e4ec0c4ec1fb"><div class="ttname"><a href="group__ops.html#gabc46eed81ab6c6247903e4ec0c4ec1fb">mlx::core::swapaxes</a></div><div class="ttdeci">array swapaxes(const array &amp;a, int axis1, int axis2, StreamOrDevice s={})</div><div class="ttdoc">Swap two axes of an array.</div></div>
<div class="ttc" id="agroup__ops_html_gabca78d34ce93f0de2814e62225bb2a53"><div class="ttname"><a href="group__ops.html#gabca78d34ce93f0de2814e62225bb2a53">mlx::core::logical_not</a></div><div class="ttdeci">array logical_not(const array &amp;a, StreamOrDevice s={})</div><div class="ttdoc">Logical not of an array.</div></div>
<div class="ttc" id="agroup__ops_html_gabdc36fa65697d0361c8d67495de77129"><div class="ttname"><a href="group__ops.html#gabdc36fa65697d0361c8d67495de77129">mlx::core::concatenate</a></div><div class="ttdeci">array concatenate(const std::vector&lt; array &gt; &amp;arrays, int axis, StreamOrDevice s={})</div><div class="ttdoc">Concatenate arrays along a given axis.</div></div>
<div class="ttc" id="agroup__ops_html_gabf786129c7660ed8d5acb5499bc6fefd"><div class="ttname"><a href="group__ops.html#gabf786129c7660ed8d5acb5499bc6fefd">mlx::core::trace</a></div><div class="ttdeci">array trace(const array &amp;a, int offset, int axis1, int axis2, Dtype dtype, StreamOrDevice s={})</div><div class="ttdoc">Return the sum along a specified diagonal in the given array.</div></div>
<div class="ttc" id="agroup__ops_html_gabfa4208fb1f9b1cdd0abc563b19175af"><div class="ttname"><a href="group__ops.html#gabfa4208fb1f9b1cdd0abc563b19175af">mlx::core::quantized_matmul</a></div><div class="ttdeci">array quantized_matmul(array x, array w, array scales, array biases, bool transpose=true, int group_size=64, int bits=4, StreamOrDevice s={})</div><div class="ttdoc">Quantized matmul multiplies x with a quantized matrix w.</div></div>
<div class="ttc" id="agroup__ops_html_gabff758a5c1ce32ad7e8b78aba0164077"><div class="ttname"><a href="group__ops.html#gabff758a5c1ce32ad7e8b78aba0164077">mlx::core::dequantize</a></div><div class="ttdeci">array dequantize(const array &amp;w, const array &amp;scales, const array &amp;biases, int group_size=64, int bits=4, StreamOrDevice s={})</div><div class="ttdoc">Dequantize a matrix produced by quantize()</div></div>
@@ -1555,6 +1561,7 @@ $(function(){ initResizable(false); });
<div class="ttc" id="anamespacemlx_1_1core_html_a479648542a2bea151b947b18f0e79dd2"><div class="ttname"><a href="namespacemlx_1_1core.html#a479648542a2bea151b947b18f0e79dd2">mlx::core::copy</a></div><div class="ttdeci">void copy(const array &amp;src, array &amp;dst, CopyType ctype)</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a5d6373aad1444edc9de1eb07bfe5cad3"><div class="ttname"><a href="namespacemlx_1_1core.html#a5d6373aad1444edc9de1eb07bfe5cad3">mlx::core::int32</a></div><div class="ttdeci">constexpr Dtype int32</div><div class="ttdef"><b>Definition</b> dtype.h:76</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:80</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a76a2e310857f60f5ea6f1388d45b964d"><div class="ttname"><a href="namespacemlx_1_1core.html#a76a2e310857f60f5ea6f1388d45b964d">mlx::core::concatenate</a></div><div class="ttdeci">void concatenate(std::string &amp;acc, T first)</div><div class="ttdef"><b>Definition</b> utils.h:66</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a937503d72b66c661bf3f5fdcd98ef97c"><div class="ttname"><a href="namespacemlx_1_1core.html#a937503d72b66c661bf3f5fdcd98ef97c">mlx::core::operator==</a></div><div class="ttdeci">bool operator==(const Device &amp;lhs, const Device &amp;rhs)</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a94d00a1b7f8a4717ab3f26f45e4da655"><div class="ttname"><a href="namespacemlx_1_1core.html#a94d00a1b7f8a4717ab3f26f45e4da655">mlx::core::operator!=</a></div><div class="ttdeci">bool operator!=(const Device &amp;lhs, const Device &amp;rhs)</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>