This commit is contained in:
CircleCI Docs
2025-03-05 21:30:09 +00:00
parent 75441e48ef
commit a943912d4c
733 changed files with 41418 additions and 30412 deletions

View File

@@ -116,9 +116,9 @@ $(function(){initNavTree('fast_8h_source.html',''); initResizable(true); });
<div class="foldopen" id="foldopen00009" data-start="{" data-end="}">
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1fast.html"> 9</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacemlx_1_1core_1_1fast.html">mlx::core::fast</a> {</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1fast.html#ac7b620275c6386f822b7aacc6b312e62"> 11</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_1fast.html#ac7b620275c6386f822b7aacc6b312e62">rms_norm</a>(</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1fast.html#a85ec3abc6b9d968c58275f5eef916f01"> 11</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_1fast.html#a85ec3abc6b9d968c58275f5eef916f01">rms_norm</a>(</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <span class="keyword">const</span> <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>&amp; x,</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">const</span> <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>&amp; weight,</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">const</span> std::optional&lt;array&gt;&amp; weight,</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <span class="keywordtype">float</span> eps,</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
@@ -203,11 +203,11 @@ $(function(){initNavTree('fast_8h_source.html',''); initResizable(true); });
<div class="ttc" id="anamespacemlx_1_1core_1_1fast_html_a12c7ef41409d6fb378008e67b6fab328"><div class="ttname"><a href="namespacemlx_1_1core_1_1fast.html#a12c7ef41409d6fb378008e67b6fab328">mlx::core::fast::affine_dequantize</a></div><div class="ttdeci">array affine_dequantize(const array &amp;w, const array &amp;scales, const array &amp;biases, int group_size=64, int bits=4, StreamOrDevice s={})</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1fast_html_a3663b50265b0a9c0cca2b5376852e059"><div class="ttname"><a href="namespacemlx_1_1core_1_1fast.html#a3663b50265b0a9c0cca2b5376852e059">mlx::core::fast::scaled_dot_product_attention</a></div><div class="ttdeci">array scaled_dot_product_attention(const array &amp;queries, const array &amp;keys, const array &amp;values, const float scale, const std::optional&lt; array &gt; &amp;mask=std::nullopt, const std::optional&lt; int &gt; memory_efficient_threshold=std::nullopt, StreamOrDevice s={})</div><div class="ttdoc">Computes: O = softmax(Q @ K.T) @ V.</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1fast_html_a534ef357eae24892684a6ecd866d3fab"><div class="ttname"><a href="namespacemlx_1_1core_1_1fast.html#a534ef357eae24892684a6ecd866d3fab">mlx::core::fast::rope</a></div><div class="ttdeci">array rope(const array &amp;x, int dims, bool traditional, std::optional&lt; float &gt; base, float scale, int offset, const std::optional&lt; array &gt; &amp;freqs=std::nullopt, StreamOrDevice s={})</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1fast_html_a85ec3abc6b9d968c58275f5eef916f01"><div class="ttname"><a href="namespacemlx_1_1core_1_1fast.html#a85ec3abc6b9d968c58275f5eef916f01">mlx::core::fast::rms_norm</a></div><div class="ttdeci">array rms_norm(const array &amp;x, const std::optional&lt; array &gt; &amp;weight, float eps, StreamOrDevice s={})</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1fast_html_a9390693ff7be931f3ef3428e2ea4c3f9"><div class="ttname"><a href="namespacemlx_1_1core_1_1fast.html#a9390693ff7be931f3ef3428e2ea4c3f9">mlx::core::fast::TemplateArg</a></div><div class="ttdeci">std::variant&lt; int, bool, Dtype &gt; TemplateArg</div><div class="ttdef"><b>Definition</b> fast.h:68</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1fast_html_aa45bf61e7a5c4ad0114b82ed80ae0dbd"><div class="ttname"><a href="namespacemlx_1_1core_1_1fast.html#aa45bf61e7a5c4ad0114b82ed80ae0dbd">mlx::core::fast::MetalKernelFunction</a></div><div class="ttdeci">std::function&lt; std::vector&lt; array &gt;(const std::vector&lt; array &gt; &amp;, const std::vector&lt; Shape &gt; &amp;, const std::vector&lt; Dtype &gt; &amp;, std::tuple&lt; int, int, int &gt;, std::tuple&lt; int, int, int &gt;, std::vector&lt; std::pair&lt; std::string, TemplateArg &gt; &gt;, std::optional&lt; float &gt;, bool, StreamOrDevice)&gt; MetalKernelFunction</div><div class="ttdef"><b>Definition</b> fast.h:80</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1fast_html_aa4b5f6886b2288cb6dfdd8598579f080"><div class="ttname"><a href="namespacemlx_1_1core_1_1fast.html#aa4b5f6886b2288cb6dfdd8598579f080">mlx::core::fast::affine_quantize</a></div><div class="ttdeci">std::tuple&lt; array, array, array &gt; affine_quantize(const array &amp;w, int group_size=64, int bits=4, StreamOrDevice s={})</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1fast_html_ab16436b465dc10ce472193d541d8426e"><div class="ttname"><a href="namespacemlx_1_1core_1_1fast.html#ab16436b465dc10ce472193d541d8426e">mlx::core::fast::metal_kernel</a></div><div class="ttdeci">MetalKernelFunction metal_kernel(const std::string &amp;name, const std::vector&lt; std::string &gt; &amp;input_names, const std::vector&lt; std::string &gt; &amp;output_names, const std::string &amp;source, const std::string &amp;header=&quot;&quot;, bool ensure_row_contiguous=true, bool atomic_outputs=false)</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1fast_html_ac7b620275c6386f822b7aacc6b312e62"><div class="ttname"><a href="namespacemlx_1_1core_1_1fast.html#ac7b620275c6386f822b7aacc6b312e62">mlx::core::fast::rms_norm</a></div><div class="ttdeci">array rms_norm(const array &amp;x, const array &amp;weight, float eps, 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:15</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 -->