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

docs update

Browse Source
This commit is contained in:
Awni Hannun
2024-08-23 12:14:53 -07:00
committed by CircleCI Docs
parent f5dcb1c2b9
commit 9da49a07a4
697 changed files with 15867 additions and 8594 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/build/html/defines_8h_source.html vendored
View File

@@ -94,26 +94,28 @@ $(function() { codefold.init(0); });
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#endif</span></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="defines_8h.html#a15629f1b81a2b6f1cca26d07a2734623"> 11</a></span><span class="keyword">static</span> <a class="code hl_define" href="defines_8h.html#a767ed9f2604de22b259cee02c4ce1d22">MTL_CONST</a> <span class="keyword">constexpr</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="defines_8h.html#a15629f1b81a2b6f1cca26d07a2734623">MAX_REDUCE_SPECIALIZED_DIMS</a> = 4;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="defines_8h.html#a2ad505864a2ab786147766900bc18c21"> 12</a></span><span class="keyword">static</span> <a class="code hl_define" href="defines_8h.html#a767ed9f2604de22b259cee02c4ce1d22">MTL_CONST</a> <span class="keyword">constexpr</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="defines_8h.html#a2ad505864a2ab786147766900bc18c21">REDUCE_N_READS</a> = 16;</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="defines_8h.html#a722995df24286b27b7da3d74b73f768d"> 13</a></span><span class="keyword">static</span> <a class="code hl_define" href="defines_8h.html#a767ed9f2604de22b259cee02c4ce1d22">MTL_CONST</a> <span class="keyword">constexpr</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="defines_8h.html#a722995df24286b27b7da3d74b73f768d">SOFTMAX_N_READS</a> = 4;</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="defines_8h.html#a89c0a33ba39a881ad3458ffdde62a24f"> 14</a></span><span class="keyword">static</span> <a class="code hl_define" href="defines_8h.html#a767ed9f2604de22b259cee02c4ce1d22">MTL_CONST</a> <span class="keyword">constexpr</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="defines_8h.html#a89c0a33ba39a881ad3458ffdde62a24f">RMS_N_READS</a> = 4;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="defines_8h.html#a717a175676c3f96d74adfde7e751a541"> 15</a></span><span class="keyword">static</span> <a class="code hl_define" href="defines_8h.html#a767ed9f2604de22b259cee02c4ce1d22">MTL_CONST</a> <span class="keyword">constexpr</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="defines_8h.html#a717a175676c3f96d74adfde7e751a541">RMS_LOOPED_LIMIT</a> = 4096;</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">// Instantiate a templated kernel.</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">// Extra args are used as template parameters:</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment">// e.g. instantiate_kernel(binary_int, binary, a, b) -&gt;</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment">// [[host_name(binary_int)]] [kernel] binary&lt;a, b&gt;</span></div>
<div class="foldopen" id="foldopen00021" data-start="" data-end="">
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="defines_8h.html#a0cc4a821c1090d4183ff3a31da7e9f7b"> 21</a></span><span class="preprocessor">#define instantiate_kernel(name, func, ...) \</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor"> template [[host_name( \</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor"> name)]] [[kernel]] decltype(func&lt;__VA_ARGS__&gt;) func&lt;__VA_ARGS__&gt;;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="defines_8h.html#a2ad505864a2ab786147766900bc18c21"> 12</a></span><span class="keyword">static</span> <a class="code hl_define" href="defines_8h.html#a767ed9f2604de22b259cee02c4ce1d22">MTL_CONST</a> <span class="keyword">constexpr</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="defines_8h.html#a2ad505864a2ab786147766900bc18c21">REDUCE_N_READS</a> = 4;</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="defines_8h.html#a68c33274e15a2f163f7631a36280d82f"> 13</a></span><span class="keyword">static</span> <a class="code hl_define" href="defines_8h.html#a767ed9f2604de22b259cee02c4ce1d22">MTL_CONST</a> <span class="keyword">constexpr</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="defines_8h.html#a68c33274e15a2f163f7631a36280d82f">REDUCE_N_WRITES</a> = 4;</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="defines_8h.html#a722995df24286b27b7da3d74b73f768d"> 14</a></span><span class="keyword">static</span> <a class="code hl_define" href="defines_8h.html#a767ed9f2604de22b259cee02c4ce1d22">MTL_CONST</a> <span class="keyword">constexpr</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="defines_8h.html#a722995df24286b27b7da3d74b73f768d">SOFTMAX_N_READS</a> = 4;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="defines_8h.html#a89c0a33ba39a881ad3458ffdde62a24f"> 15</a></span><span class="keyword">static</span> <a class="code hl_define" href="defines_8h.html#a767ed9f2604de22b259cee02c4ce1d22">MTL_CONST</a> <span class="keyword">constexpr</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="defines_8h.html#a89c0a33ba39a881ad3458ffdde62a24f">RMS_N_READS</a> = 4;</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="defines_8h.html#a717a175676c3f96d74adfde7e751a541"> 16</a></span><span class="keyword">static</span> <a class="code hl_define" href="defines_8h.html#a767ed9f2604de22b259cee02c4ce1d22">MTL_CONST</a> <span class="keyword">constexpr</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="defines_8h.html#a717a175676c3f96d74adfde7e751a541">RMS_LOOPED_LIMIT</a> = 4096;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">// Instantiate a templated kernel.</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment">// Extra args are used as template parameters:</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment">// e.g. instantiate_kernel(binary_int, binary, a, b) -&gt;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment">// [[host_name(binary_int)]] [kernel] binary&lt;a, b&gt;</span></div>
<div class="foldopen" id="foldopen00022" data-start="" data-end="">
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="defines_8h.html#a0cc4a821c1090d4183ff3a31da7e9f7b"> 22</a></span><span class="preprocessor">#define instantiate_kernel(name, func, ...) \</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor"> template [[host_name( \</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor"> name)]] [[kernel]] decltype(func&lt;__VA_ARGS__&gt;) func&lt;__VA_ARGS__&gt;;</span></div>
</div>
<div class="ttc" id="adefines_8h_html_a15629f1b81a2b6f1cca26d07a2734623"><div class="ttname"><a href="defines_8h.html#a15629f1b81a2b6f1cca26d07a2734623">MAX_REDUCE_SPECIALIZED_DIMS</a></div><div class="ttdeci">static constexpr int MAX_REDUCE_SPECIALIZED_DIMS</div><div class="ttdef"><b>Definition</b> defines.h:11</div></div>
<div class="ttc" id="adefines_8h_html_a2ad505864a2ab786147766900bc18c21"><div class="ttname"><a href="defines_8h.html#a2ad505864a2ab786147766900bc18c21">REDUCE_N_READS</a></div><div class="ttdeci">static constexpr int REDUCE_N_READS</div><div class="ttdef"><b>Definition</b> defines.h:12</div></div>
<div class="ttc" id="adefines_8h_html_a717a175676c3f96d74adfde7e751a541"><div class="ttname"><a href="defines_8h.html#a717a175676c3f96d74adfde7e751a541">RMS_LOOPED_LIMIT</a></div><div class="ttdeci">static constexpr int RMS_LOOPED_LIMIT</div><div class="ttdef"><b>Definition</b> defines.h:15</div></div>
<div class="ttc" id="adefines_8h_html_a722995df24286b27b7da3d74b73f768d"><div class="ttname"><a href="defines_8h.html#a722995df24286b27b7da3d74b73f768d">SOFTMAX_N_READS</a></div><div class="ttdeci">static constexpr int SOFTMAX_N_READS</div><div class="ttdef"><b>Definition</b> defines.h:13</div></div>
<div class="ttc" id="adefines_8h_html_a68c33274e15a2f163f7631a36280d82f"><div class="ttname"><a href="defines_8h.html#a68c33274e15a2f163f7631a36280d82f">REDUCE_N_WRITES</a></div><div class="ttdeci">static constexpr int REDUCE_N_WRITES</div><div class="ttdef"><b>Definition</b> defines.h:13</div></div>
<div class="ttc" id="adefines_8h_html_a717a175676c3f96d74adfde7e751a541"><div class="ttname"><a href="defines_8h.html#a717a175676c3f96d74adfde7e751a541">RMS_LOOPED_LIMIT</a></div><div class="ttdeci">static constexpr int RMS_LOOPED_LIMIT</div><div class="ttdef"><b>Definition</b> defines.h:16</div></div>
<div class="ttc" id="adefines_8h_html_a722995df24286b27b7da3d74b73f768d"><div class="ttname"><a href="defines_8h.html#a722995df24286b27b7da3d74b73f768d">SOFTMAX_N_READS</a></div><div class="ttdeci">static constexpr int SOFTMAX_N_READS</div><div class="ttdef"><b>Definition</b> defines.h:14</div></div>
<div class="ttc" id="adefines_8h_html_a767ed9f2604de22b259cee02c4ce1d22"><div class="ttname"><a href="defines_8h.html#a767ed9f2604de22b259cee02c4ce1d22">MTL_CONST</a></div><div class="ttdeci">#define MTL_CONST</div><div class="ttdef"><b>Definition</b> defines.h:8</div></div>
<div class="ttc" id="adefines_8h_html_a89c0a33ba39a881ad3458ffdde62a24f"><div class="ttname"><a href="defines_8h.html#a89c0a33ba39a881ad3458ffdde62a24f">RMS_N_READS</a></div><div class="ttdeci">static constexpr int RMS_N_READS</div><div class="ttdef"><b>Definition</b> defines.h:14</div></div>
<div class="ttc" id="adefines_8h_html_a89c0a33ba39a881ad3458ffdde62a24f"><div class="ttname"><a href="defines_8h.html#a89c0a33ba39a881ad3458ffdde62a24f">RMS_N_READS</a></div><div class="ttdeci">static constexpr int RMS_N_READS</div><div class="ttdef"><b>Definition</b> defines.h:15</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>