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

rebase

Browse Source
This commit is contained in:
CircleCI Docs
2025-01-09 21:56:20 +00:00
parent 04b749a588
commit d8d647015b
2642 changed files with 137687 additions and 70861 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
docs/build/html/functions_r.html vendored
View File

@@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="generator" content="Doxygen 1.13.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: Class Members</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -11,11 +11,18 @@
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -28,12 +35,24 @@
<div id="projectname">MLX
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<!-- Generated by Doxygen 1.13.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -44,24 +63,23 @@ var searchBox = new SearchBox("searchBox", "search/",'.html');
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="doc-content">
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
$(function(){initNavTree('functions_r.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -91,10 +109,10 @@ $(function(){ initResizable(false); });
<li>r2h&#160;:&#160;<a class="el" href="structpocketfft_1_1detail_1_1_exec_r2_r.html#a925b398c8e1868614ce9eaf381d02b7e">pocketfft::detail::ExecR2R</a></li>
<li>radix&#160;:&#160;<a class="el" href="structmetal_1_1__numeric__limits__impl_3_01bfloat16__t_01_4.html#aaefa8c2cadd11ac7e22f7b2c5edbd1cd">metal::_numeric_limits_impl&lt; bfloat16_t &gt;</a></li>
<li>RandomBits()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_random_bits.html#acd79c5ea2d67132c98d00fa927f08e26">mlx::core::RandomBits</a></li>
<li>rank()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1distributed_1_1_group.html#ad4a5cdab8e2209ad4825f0c63a9cbec7">mlx::core::distributed::Group</a></li>
<li>rank()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1distributed_1_1detail_1_1_group_impl.html#ae0838a40ce58442cdc73d57d7969a702">mlx::core::distributed::detail::GroupImpl</a>, <a class="el" href="structmlx_1_1core_1_1distributed_1_1_group.html#a94b676c55c9a0f9d6e75ddf80644f18d">mlx::core::distributed::Group</a></li>
<li>raw_event()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_event.html#af408d30df17c4771e9e2aa550cb6e921">mlx::core::Event</a></li>
<li>raw_group()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1distributed_1_1_group.html#a3285b94851cf145a2a472f60b7f7ca36">mlx::core::distributed::Group</a></li>
<li>raw_ptr()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1allocator_1_1_buffer.html#a2dfe63e0b4bffeb965cdc50ad4228dbc">mlx::core::allocator::Buffer</a></li>
<li>raw_group()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1distributed_1_1_group.html#aea20bbd3a1c46a3d19da9923885720bf">mlx::core::distributed::Group</a></li>
<li>raw_ptr()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1allocator_1_1_buffer.html#a2dfe63e0b4bffeb965cdc50ad4228dbc">mlx::core::allocator::Buffer</a>, <a class="el" href="classmlx_1_1core_1_1metal_1_1_buffer.html#a2dfe63e0b4bffeb965cdc50ad4228dbc">mlx::core::metal::Buffer</a></li>
<li>read()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1io_1_1_parallel_file_reader.html#a6691826fc8d28f83792bfa2f92660a3b">mlx::core::io::ParallelFileReader</a>, <a class="el" href="classmlx_1_1core_1_1io_1_1_reader.html#ad8d74e2c62b579511089faa4cc6f50a1">mlx::core::io::Reader</a></li>
<li>read_ih&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_conv2_d_input_block_loader_general.html#a35a010c3819df6667339d37a5e8f5b43">mlx::steel::Conv2DInputBlockLoaderGeneral&lt; T, BM, BN, BK, tgp_size, tgp_padding &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_conv2_d_input_block_loader_large_filter.html#a82dd8230e1f37500f1a562177c3ad692">mlx::steel::Conv2DInputBlockLoaderLargeFilter&lt; T, BM, BN, BK, tgp_size, tgp_padding &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_conv2_d_input_block_loader_small_channels.html#a6623e33d946b41d01c69ec793706d789">mlx::steel::Conv2DInputBlockLoaderSmallChannels&lt; T, BM, BN, BK, tgp_size, n_channels, tgp_padding &gt;</a></li>
<li>read_iw&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_conv2_d_input_block_loader_general.html#a53a683adf280e4806363020754525261">mlx::steel::Conv2DInputBlockLoaderGeneral&lt; T, BM, BN, BK, tgp_size, tgp_padding &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_conv2_d_input_block_loader_large_filter.html#a17550360cae0a942a9552d7a67827512">mlx::steel::Conv2DInputBlockLoaderLargeFilter&lt; T, BM, BN, BK, tgp_size, tgp_padding &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_conv2_d_input_block_loader_small_channels.html#aa2a1a870ff51889975f6ffb2b8caa31c">mlx::steel::Conv2DInputBlockLoaderSmallChannels&lt; T, BM, BN, BK, tgp_size, n_channels, tgp_padding &gt;</a></li>
@@ -103,14 +121,15 @@ $(function(){ initResizable(false); });
<li>Real()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_real.html#acd4480e3f0834d70ff6b5f1ecef17892">mlx::core::Real</a></li>
<li>real&#160;:&#160;<a class="el" href="structcomplex64__t.html#abbd4a0092eca9f112c1c5ae1a133a27e">complex64_t</a></li>
<li>Recv()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1distributed_1_1_recv.html#a511dd4e0259da18a181a25579d9b55db">mlx::core::distributed::Recv</a></li>
<li>recv()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1distributed_1_1detail_1_1_group_impl.html#ac4af5fc16a82ba8c72df04d7694f8352">mlx::core::distributed::detail::GroupImpl</a></li>
<li>Reduce()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_reduce.html#a055368c1d036fb953a23ef230e33dcbf">mlx::core::Reduce</a></li>
<li>ReduceType&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_arg_reduce.html#a920ed48caaba76683be0d1f1ed4a8bd3">mlx::core::ArgReduce</a>, <a class="el" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924">mlx::core::distributed::AllReduce</a>, <a class="el" href="classmlx_1_1core_1_1_reduce.html#a0848518b16ae6d4043d6be247bdf31c9">mlx::core::Reduce</a>, <a class="el" href="classmlx_1_1core_1_1_scan.html#a47bf2ec54ead4b8f00f9f188518630f1">mlx::core::Scan</a>, <a class="el" href="classmlx_1_1core_1_1_scatter.html#a614d19af11dc30644b2b4941033b613c">mlx::core::Scatter</a></li>
<li>ReductionPlan()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1_reduction_plan.html#a3df6acc08ef92647aab19d68b0961610">mlx::core::ReductionPlan</a></li>
<li>ReductionPlan()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1_reduction_plan.html#a07d9eb40a259918ce23360416b3e9db8">mlx::core::ReductionPlan</a></li>
<li>reference&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1array_1_1_array_iterator.html#a44e2e1f29191c20ec4390de4fa0bd59f">mlx::core::array::ArrayIterator</a></li>
<li>register_library()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1metal_1_1_device.html#a45945f2efcd242d915ffa2171e92bf9d">mlx::core::metal::Device</a></li>
<li>Remainder()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_remainder.html#a4f3eada4a21898af4a77d1d27ce14641">mlx::core::Remainder</a></li>
<li>remaining()&#160;:&#160;<a class="el" href="classpocketfft_1_1detail_1_1multi__iter.html#a034d12f842df90e6471dffd3fa6ba4bd">pocketfft::detail::multi_iter&lt; N &gt;</a>, <a class="el" href="classpocketfft_1_1detail_1_1rev__iter.html#a143637135c441a4b9a2959c2370d8c63">pocketfft::detail::rev_iter</a>, <a class="el" href="classpocketfft_1_1detail_1_1simple__iter.html#a9267d37f51a9a5aecc69293c7ed1b1f6">pocketfft::detail::simple_iter</a></li>
<li>reset()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1_contiguous_iterator.html#a56336d55be846426e9522f375fc11297">mlx::core::ContiguousIterator&lt; StrideT &gt;</a></li>
<li>reset()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1_contiguous_iterator.html#afa2e2bde9bfa57ac759bc7f5b881262a">mlx::core::ContiguousIterator</a></li>
<li>reset_peak_memory()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1metal_1_1_metal_allocator.html#a26b9c8ac7ed56c3bb7ddc194009ec5a6">mlx::core::metal::MetalAllocator</a></li>
<li>Reshape()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_reshape.html#aa5a5d520b6ec6c8d9ba9d79808e36312">mlx::core::Reshape</a></li>
<li>ResidencySet()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1metal_1_1_residency_set.html#abb69d020da017a7e52e9e3903b877eec">mlx::core::metal::ResidencySet</a></li>
@@ -124,20 +143,22 @@ $(function(){ initResizable(false); });
<li>RightShift&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_bitwise_binary.html#a6f8b5d455d0c1770428a6bef1608f23da011e7b275a1f0edbd9345cfcf6501503">mlx::core::BitwiseBinary</a></li>
<li>RMSNorm()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1fast_1_1_r_m_s_norm.html#a22adaff0749711263388ec151fcfebe2">mlx::core::fast::RMSNorm</a></li>
<li>RMSNormVJP()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1fast_1_1_r_m_s_norm_v_j_p.html#aac060129b2e1af79bf388bfe705381ca">mlx::core::fast::RMSNormVJP</a></li>
<li>RoPE()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1fast_1_1_ro_p_e.html#a031fa27aeba94cfa5ccc633137a12163">mlx::core::fast::RoPE</a></li>
<li>RoPE()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1fast_1_1_ro_p_e.html#a60b399d7f38c0f5f50342a6b97f0eb1a">mlx::core::fast::RoPE</a></li>
<li>Round()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_round.html#a1327a359b2aed91f576145a0e70d1dde">mlx::core::Round</a></li>
<li>round_error()&#160;:&#160;<a class="el" href="structmetal_1_1__numeric__limits__impl_3_01bfloat16__t_01_4.html#afa223448fa4f04c1113a85345dd720c3">metal::_numeric_limits_impl&lt; bfloat16_t &gt;</a></li>
<li>row_bin_op()&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_base_m_m_a_frag_3_01_t_00_018_00_018_01_4.html#a318c4279bdc7b39b7919f108b1cd8010">mlx::steel::BaseMMAFrag&lt; T, 8, 8 &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_m_m_a_tile.html#a3d0d5b9c7962658cc6d5afbbbb2f19e2">mlx::steel::MMATile&lt; T, kTileRows_, kTileCols_, MMAFrag_ &gt;</a></li>
<li>row_bin_op()&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_base_m_m_a_frag.html#a318c4279bdc7b39b7919f108b1cd8010">mlx::steel::BaseMMAFrag&lt; T, 8, 8 &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_m_m_a_tile.html#a3d0d5b9c7962658cc6d5afbbbb2f19e2">mlx::steel::MMATile&lt; T, kTileRows_, kTileCols_, MMAFrag_ &gt;</a></li>
<li>row_contiguous&#160;:&#160;<a class="el" href="struct_indices.html#a255e340a39c6ac28ef2c232b106f85d1">Indices&lt; IdxT, NIDX &gt;</a>, <a class="el" href="structmlx_1_1core_1_1array_1_1_flags.html#a3170fa381dc7a90f6eabcc029bdf9bfd">mlx::core::array::Flags</a></li>
<li>row_frag_type&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_base_m_m_a_frag_3_01_t_00_018_00_018_01_4.html#a5ec2e40a8f5ad98c71b825544cdd878b">mlx::steel::BaseMMAFrag&lt; T, 8, 8 &gt;</a></li>
<li>row_reduce()&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_base_m_m_a_frag_3_01_t_00_018_00_018_01_4.html#a51d662e4cff88b5ad17d7c44bb6b6970">mlx::steel::BaseMMAFrag&lt; T, 8, 8 &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_m_m_a_tile.html#aa0ad5cb750ace934bf230385d8bd9f88">mlx::steel::MMATile&lt; T, kTileRows_, kTileCols_, MMAFrag_ &gt;</a></li>
<li>row_frag_type&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_base_m_m_a_frag.html#a3dcd4301390937f89ed1dde6d28e341f">mlx::steel::BaseMMAFrag&lt; T, 8, 8 &gt;</a></li>
<li>row_reduce()&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_base_m_m_a_frag.html#a51d662e4cff88b5ad17d7c44bb6b6970">mlx::steel::BaseMMAFrag&lt; T, 8, 8 &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_m_m_a_tile.html#aa0ad5cb750ace934bf230385d8bd9f88">mlx::steel::MMATile&lt; T, kTileRows_, kTileCols_, MMAFrag_ &gt;</a></li>
<li>run()&#160;:&#160;<a class="el" href="struct_g_e_m_v_kernel.html#ac4a7b5011a0ea938ab1949bb1767fc1a">GEMVKernel&lt; T, out_mask_t, op_mask_t, BM, BN, SM, SN, TM, TN &gt;</a>, <a class="el" href="struct_g_e_m_v_t_kernel.html#a5d68656832de892f33db939005713927">GEMVTKernel&lt; T, out_mask_t, op_mask_t, BM, BN, SM, SN, TM, TN &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_g_e_m_m_kernel.html#a00e55d4a161758350ed7310817d2d2a5">mlx::steel::GEMMKernel&lt; T, U, BM, BN, BK, WM, WN, transpose_a, transpose_b, MN_aligned, K_aligned, AccumType, Epilogue &gt;</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
</small></address>
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.1 </li>
</ul>
</div>
</body>
</html>