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

docs update

Browse Source
This commit is contained in:
Awni Hannun
2024-07-11 15:32:08 -07:00
committed by CircleCI Docs
parent 85f70be0e6
commit 0ec311dff3
754 changed files with 24043 additions and 13535 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/build/html/kernels_8h.html vendored
View File

@@ -81,7 +81,8 @@ $(function() {
<div class="headertitle"><div class="title">kernels.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="array_8h_source.html">mlx/array.h</a>&quot;</code><br />
<div class="textblock"><code>#include &lt;fmt/format.h&gt;</code><br />
<code>#include &quot;<a class="el" href="array_8h_source.html">mlx/array.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="backend_2metal_2device_8h_source.html">mlx/backend/metal/device.h</a>&quot;</code><br />
</div>
<p><a href="kernels_8h_source.html">Go to the source code of this file.</a></p>
@@ -97,14 +98,14 @@ Namespaces</h2></td></tr>
Functions</h2></td></tr>
<tr class="memitem:a76f614e9956a6ca05a9be4db5a483446" id="r_a76f614e9956a6ca05a9be4db5a483446"><td class="memItemLeft" align="right" valign="top">MTL::ComputePipelineState *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a76f614e9956a6ca05a9be4db5a483446">mlx::core::get_arange_kernel</a> (<a class="el" href="classmlx_1_1core_1_1metal_1_1_device.html">metal::Device</a> &amp;d, const std::string &amp;kernel_name, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;out)</td></tr>
<tr class="separator:a76f614e9956a6ca05a9be4db5a483446"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:accf153854ef650d6a6633775d8a70612" id="r_accf153854ef650d6a6633775d8a70612"><td class="memItemLeft" align="right" valign="top">MTL::ComputePipelineState *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#accf153854ef650d6a6633775d8a70612">mlx::core::get_unary_kernel</a> (<a class="el" href="classmlx_1_1core_1_1metal_1_1_device.html">metal::Device</a> &amp;d, const std::string &amp;kernel_name, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;out)</td></tr>
<tr class="separator:accf153854ef650d6a6633775d8a70612"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec97852a7d8938407122d21e78d66f5f" id="r_aec97852a7d8938407122d21e78d66f5f"><td class="memItemLeft" align="right" valign="top">MTL::ComputePipelineState *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#aec97852a7d8938407122d21e78d66f5f">mlx::core::get_binary_kernel</a> (<a class="el" href="classmlx_1_1core_1_1metal_1_1_device.html">metal::Device</a> &amp;d, const std::string &amp;kernel_name, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;in, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;out)</td></tr>
<tr class="separator:aec97852a7d8938407122d21e78d66f5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a5effc3e1cfd4123b9a63c08e947e45" id="r_a0a5effc3e1cfd4123b9a63c08e947e45"><td class="memItemLeft" align="right" valign="top">MTL::ComputePipelineState *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a0a5effc3e1cfd4123b9a63c08e947e45">mlx::core::get_binary_two_kernel</a> (<a class="el" href="classmlx_1_1core_1_1metal_1_1_device.html">metal::Device</a> &amp;d, const std::string &amp;kernel_name, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;in, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;out)</td></tr>
<tr class="separator:a0a5effc3e1cfd4123b9a63c08e947e45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a266558f20a72c439396ecd492a08d65f" id="r_a266558f20a72c439396ecd492a08d65f"><td class="memItemLeft" align="right" valign="top">MTL::ComputePipelineState *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a266558f20a72c439396ecd492a08d65f">mlx::core::get_ternary_kernel</a> (<a class="el" href="classmlx_1_1core_1_1metal_1_1_device.html">metal::Device</a> &amp;d, const std::string &amp;kernel_name, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;out)</td></tr>
<tr class="separator:a266558f20a72c439396ecd492a08d65f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15175e8e2b1e26726c63393e4d68b628" id="r_a15175e8e2b1e26726c63393e4d68b628"><td class="memItemLeft" align="right" valign="top">MTL::ComputePipelineState *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a15175e8e2b1e26726c63393e4d68b628">mlx::core::get_unary_kernel</a> (<a class="el" href="classmlx_1_1core_1_1metal_1_1_device.html">metal::Device</a> &amp;d, const std::string &amp;kernel_name, <a class="el" href="structmlx_1_1core_1_1_dtype.html">Dtype</a> out_type, const std::string <a class="el" href="common_2binary_8h.html#a70228731d29946574b238d21fb4b360c">op</a>)</td></tr>
<tr class="separator:a15175e8e2b1e26726c63393e4d68b628"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4decd4a07d91487e6903f6e3c8b7513a" id="r_a4decd4a07d91487e6903f6e3c8b7513a"><td class="memItemLeft" align="right" valign="top">MTL::ComputePipelineState *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a4decd4a07d91487e6903f6e3c8b7513a">mlx::core::get_binary_kernel</a> (<a class="el" href="classmlx_1_1core_1_1metal_1_1_device.html">metal::Device</a> &amp;d, const std::string &amp;kernel_name, <a class="el" href="structmlx_1_1core_1_1_dtype.html">Dtype</a> in_type, <a class="el" href="structmlx_1_1core_1_1_dtype.html">Dtype</a> out_type, const std::string <a class="el" href="common_2binary_8h.html#a70228731d29946574b238d21fb4b360c">op</a>)</td></tr>
<tr class="separator:a4decd4a07d91487e6903f6e3c8b7513a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e809746f48e5dcf7fa63215d3f5e33e" id="r_a4e809746f48e5dcf7fa63215d3f5e33e"><td class="memItemLeft" align="right" valign="top">MTL::ComputePipelineState *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a4e809746f48e5dcf7fa63215d3f5e33e">mlx::core::get_binary_two_kernel</a> (<a class="el" href="classmlx_1_1core_1_1metal_1_1_device.html">metal::Device</a> &amp;d, const std::string &amp;kernel_name, <a class="el" href="structmlx_1_1core_1_1_dtype.html">Dtype</a> in_type, <a class="el" href="structmlx_1_1core_1_1_dtype.html">Dtype</a> out_type, const std::string <a class="el" href="common_2binary_8h.html#a70228731d29946574b238d21fb4b360c">op</a>)</td></tr>
<tr class="separator:a4e809746f48e5dcf7fa63215d3f5e33e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54eb3b65375022428aab5f810e40624b" id="r_a54eb3b65375022428aab5f810e40624b"><td class="memItemLeft" align="right" valign="top">MTL::ComputePipelineState *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a54eb3b65375022428aab5f810e40624b">mlx::core::get_ternary_kernel</a> (<a class="el" href="classmlx_1_1core_1_1metal_1_1_device.html">metal::Device</a> &amp;d, const std::string &amp;kernel_name, <a class="el" href="structmlx_1_1core_1_1_dtype.html">Dtype</a> type, const std::string <a class="el" href="common_2binary_8h.html#a70228731d29946574b238d21fb4b360c">op</a>)</td></tr>
<tr class="separator:a54eb3b65375022428aab5f810e40624b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05a220cff45f12439fde775983c6df78" id="r_a05a220cff45f12439fde775983c6df78"><td class="memItemLeft" align="right" valign="top">MTL::ComputePipelineState *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a05a220cff45f12439fde775983c6df78">mlx::core::get_copy_kernel</a> (<a class="el" href="classmlx_1_1core_1_1metal_1_1_device.html">metal::Device</a> &amp;d, const std::string &amp;kernel_name, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;in, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;out)</td></tr>
<tr class="separator:a05a220cff45f12439fde775983c6df78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35a412f688d79eb47e42d20a7c8650ee" id="r_a35a412f688d79eb47e42d20a7c8650ee"><td class="memItemLeft" align="right" valign="top">MTL::ComputePipelineState *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a35a412f688d79eb47e42d20a7c8650ee">mlx::core::get_softmax_kernel</a> (<a class="el" href="classmlx_1_1core_1_1metal_1_1_device.html">metal::Device</a> &amp;d, const std::string &amp;kernel_name, bool precise, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;out)</td></tr>
@@ -131,8 +132,13 @@ Functions</h2></td></tr>
<tr class="separator:adce79d220672f5f3c65cc31d145ca9c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abce2b67044ee06a7bbe7a91ec7c8c48d" id="r_abce2b67044ee06a7bbe7a91ec7c8c48d"><td class="memItemLeft" align="right" valign="top">MTL::ComputePipelineState *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#abce2b67044ee06a7bbe7a91ec7c8c48d">mlx::core::get_steel_conv_general_kernel</a> (<a class="el" href="classmlx_1_1core_1_1metal_1_1_device.html">metal::Device</a> &amp;d, const std::string &amp;kernel_name, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;out, int bm, int bn, int bk, int wm, int wn)</td></tr>
<tr class="separator:abce2b67044ee06a7bbe7a91ec7c8c48d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d8800bb9892b04684c78e3e5c760983" id="r_a4d8800bb9892b04684c78e3e5c760983"><td class="memItemLeft" align="right" valign="top">MTL::ComputePipelineState *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a4d8800bb9892b04684c78e3e5c760983">mlx::core::get_fft_kernel</a> (<a class="el" href="classmlx_1_1core_1_1metal_1_1_device.html">metal::Device</a> &amp;d, const std::string &amp;kernel_name, const std::string &amp;hash_name, const int tg_mem_size, const std::string &amp;in_type, const std::string &amp;out_type, int step, bool real, const <a class="el" href="namespacemlx_1_1core_1_1metal.html#a616e09a1ef321d527770721cef264c54">metal::MTLFCList</a> &amp;func_consts)</td></tr>
<tr class="separator:a4d8800bb9892b04684c78e3e5c760983"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d4cffc3c78067b3d9a62d64f3fb686f" id="r_a1d4cffc3c78067b3d9a62d64f3fb686f"><td class="memItemLeft" align="right" valign="top">MTL::ComputePipelineState *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a1d4cffc3c78067b3d9a62d64f3fb686f">mlx::core::get_fft_kernel</a> (<a class="el" href="classmlx_1_1core_1_1metal_1_1_device.html">metal::Device</a> &amp;d, const std::string &amp;kernel_name, const std::string &amp;hash_name, const <a class="el" href="namespacemlx_1_1core_1_1metal.html#a616e09a1ef321d527770721cef264c54">metal::MTLFCList</a> &amp;func_consts, const std::string &amp;template_def)</td></tr>
<tr class="separator:a1d4cffc3c78067b3d9a62d64f3fb686f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3faeae5378bfaafe3ce3432a051e43e" id="r_aa3faeae5378bfaafe3ce3432a051e43e"><td class="memItemLeft" align="right" valign="top">MTL::ComputePipelineState *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#aa3faeae5378bfaafe3ce3432a051e43e">mlx::core::get_quantized_kernel</a> (<a class="el" href="classmlx_1_1core_1_1metal_1_1_device.html">metal::Device</a> &amp;d, const std::string &amp;kernel_name, const std::string &amp;template_def)</td></tr>
<tr class="separator:aa3faeae5378bfaafe3ce3432a051e43e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae0d19f0acdef2accd2428fb84c8a032" id="r_aae0d19f0acdef2accd2428fb84c8a032"><td class="memTemplParams" colspan="2">template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:aae0d19f0acdef2accd2428fb84c8a032"><td class="memTemplItemLeft" align="right" valign="top">std::string&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#aae0d19f0acdef2accd2428fb84c8a032">mlx::core::get_template_definition</a> (std::string name, std::string func, Args... args)</td></tr>
<tr class="separator:aae0d19f0acdef2accd2428fb84c8a032"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
<!-- start footer part -->