zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-09-18 10:26:56 +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 d8f7b8cda6
commit 27e07888b0
697 changed files with 15867 additions and 8594 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/build/html/functions_s.html vendored
View File

@@ -96,7 +96,7 @@ $(function() {
<li>set_status()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#a63598018999b49f1340b183cb303f05c">mlx::core::array</a></li>
<li>set_tracer()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#af26e6be1a9e6239471a4c24310c0c7c8">mlx::core::array</a></li>
<li>set_value()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_event.html#a0d077b11f4b28f882b42440b7ac6d40d">mlx::core::Event</a></li>
<li>shape()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#a51ed0c45666264dc172d06fba159eb8f">mlx::core::array</a>, <a class="el" href="structmlx_1_1core_1_1_reduction_plan.html#a6cfa8771fa9caf6fdcc3d74c9fca83ae">mlx::core::ReductionPlan</a>, <a class="el" href="classpocketfft_1_1detail_1_1arr__info.html#ac601c660c64a4c252aa8be4ae7dfa7a8">pocketfft::detail::arr_info</a></li>
<li>shape()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#a4a2a2c8a4a5beafd723fc13f2055d55d">mlx::core::array</a>, <a class="el" href="structmlx_1_1core_1_1fast_1_1_custom_kernel_shape_info.html#a63db720fe0c2abc4b71e22a58a015f8a">mlx::core::fast::CustomKernelShapeInfo</a>, <a class="el" href="structmlx_1_1core_1_1_reduction_plan.html#a6cfa8771fa9caf6fdcc3d74c9fca83ae">mlx::core::ReductionPlan</a>, <a class="el" href="classpocketfft_1_1detail_1_1arr__info.html#accada8146cb8d3ab7facb4c1e3413ec0">pocketfft::detail::arr_info</a></li>
<li>shapes&#160;:&#160;<a class="el" href="struct_indices.html#a5ab170f1a77636180889ddfffd4f7d2f">Indices&lt; IdxT, NIDX &gt;</a></li>
<li>shp&#160;:&#160;<a class="el" href="classpocketfft_1_1detail_1_1arr__info.html#a2467e9e01de1ba4d7cd28c1af783da8d">pocketfft::detail::arr_info</a></li>
<li>shutdown()&#160;:&#160;<a class="el" href="classpocketfft_1_1detail_1_1threading_1_1thread__pool.html#a0c7c29290fde806031c497f24c4ad411">pocketfft::detail::threading::thread_pool</a></li>
@@ -106,7 +106,6 @@ $(function() {
<li>signal()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_event.html#a65a858445506a61be5889ae0e3651b89">mlx::core::Event</a></li>
<li>signaling_NaN()&#160;:&#160;<a class="el" href="structmetal_1_1__numeric__limits__impl_3_01bfloat16__t_01_4.html#ad1f76a43c7d51a3765174aa6e0dd9f80">metal::_numeric_limits_impl&lt; bfloat16_t &gt;</a></li>
<li>simd_exclusive_scan()&#160;:&#160;<a class="el" href="struct_cum_max.html#ae11b67aa6c998e9a01615b2a79af4403">CumMax&lt; U &gt;</a>, <a class="el" href="struct_cum_min.html#a83e65017ff33018b585c043fb803773b">CumMin&lt; U &gt;</a>, <a class="el" href="struct_cum_prod.html#a5b0577295853a48856b84fd4f935dff8">CumProd&lt; U &gt;</a>, <a class="el" href="struct_cum_prod_3_01bool_01_4.html#a1a86e9398bae24182b7be0a6577bf223">CumProd&lt; bool &gt;</a>, <a class="el" href="struct_cum_sum.html#a64d1933942de4df2d44dd90e9e5e4460">CumSum&lt; U &gt;</a></li>
<li>simd_reduce()&#160;:&#160;<a class="el" href="struct_and.html#ab4df5517e050cfa7257c34c6b0bd980b">And&lt; U &gt;</a>, <a class="el" href="struct_max.html#a4f74440c6f1ce8247d5a87c2a8882080">Max&lt; U &gt;</a>, <a class="el" href="struct_min.html#afe8d7cefac624fd4267c1b252ac38528">Min&lt; U &gt;</a>, <a class="el" href="struct_or.html#aef6b5abbbf3fd22981b8d27562022605">Or&lt; U &gt;</a>, <a class="el" href="struct_prod.html#ab0d7a38360b971b4d99c4ad2db310069">Prod&lt; U &gt;</a>, <a class="el" href="struct_sum.html#acf10e0604098391526da3b8271928b5c">Sum&lt; U &gt;</a></li>
<li>simd_scan()&#160;:&#160;<a class="el" href="struct_cum_max.html#adc9ec8bb09b4433d4c2f03022c43d781">CumMax&lt; U &gt;</a>, <a class="el" href="struct_cum_min.html#a0a1005d91b1c90e90e2c6dbd6c296649">CumMin&lt; U &gt;</a>, <a class="el" href="struct_cum_prod.html#a860dbf6146de088d07175bd165b74004">CumProd&lt; U &gt;</a>, <a class="el" href="struct_cum_prod_3_01bool_01_4.html#abeb5ec4237b330e7219f4e881cf10d7a">CumProd&lt; bool &gt;</a>, <a class="el" href="struct_cum_sum.html#a83342af06f6a700067e3b451636852d6">CumSum&lt; U &gt;</a></li>
<li>simd_stride_a&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_block_m_m_a.html#ab52d2644053c5bb28ab9b24fab8b194a">mlx::steel::BlockMMA&lt; T, U, BM, BN, BK, WM, WN, transpose_a, transpose_b, lda_tgp, ldb_tgp, AccumType, Epilogue &gt;</a></li>
<li>simd_stride_b&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_block_m_m_a.html#af5c60b04602f72b705192911ed8749da">mlx::steel::BlockMMA&lt; T, U, BM, BN, BK, WM, WN, transpose_a, transpose_b, lda_tgp, ldb_tgp, AccumType, Epilogue &gt;</a></li>
@@ -151,7 +150,7 @@ $(function() {
<li>stride_out()&#160;:&#160;<a class="el" href="classpocketfft_1_1detail_1_1multi__iter.html#a81d71a13bf0b85e556fbb9834167ecc7">pocketfft::detail::multi_iter&lt; N &gt;</a></li>
<li>strided_device_idx&#160;:&#160;<a class="el" href="struct_read_writer.html#a4c0b12484aac4fd6759d67c190391989">ReadWriter&lt; in_T, out_T, step, four_step_real &gt;</a></li>
<li>strided_shared_idx&#160;:&#160;<a class="el" href="struct_read_writer.html#ace40adb02cfb33d89c98353327c251fc">ReadWriter&lt; in_T, out_T, step, four_step_real &gt;</a></li>
<li>strides&#160;:&#160;<a class="el" href="struct_indices.html#a7f73d7652f0f751e6a06c2663e329a4a">Indices&lt; IdxT, NIDX &gt;</a>, <a class="el" href="classmlx_1_1core_1_1array.html#a186cf2648da92584d5c1c8b24e69629b">mlx::core::array</a>, <a class="el" href="structmlx_1_1core_1_1_reduction_plan.html#a9bf7cae845ab633247c1811613ece8bd">mlx::core::ReductionPlan</a></li>
<li>strides&#160;:&#160;<a class="el" href="struct_indices.html#a7f73d7652f0f751e6a06c2663e329a4a">Indices&lt; IdxT, NIDX &gt;</a>, <a class="el" href="classmlx_1_1core_1_1array.html#a186cf2648da92584d5c1c8b24e69629b">mlx::core::array</a>, <a class="el" href="structmlx_1_1core_1_1fast_1_1_custom_kernel_shape_info.html#a63954de7da62942ec69afcaaa19d46f2">mlx::core::fast::CustomKernelShapeInfo</a>, <a class="el" href="structmlx_1_1core_1_1_reduction_plan.html#a9bf7cae845ab633247c1811613ece8bd">mlx::core::ReductionPlan</a></li>
<li>submit()&#160;:&#160;<a class="el" href="classpocketfft_1_1detail_1_1threading_1_1thread__pool.html#a8698d49e8f406cdb88006aac6a91f9a4">pocketfft::detail::threading::thread_pool</a></li>
<li>Subtract()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_subtract.html#a834854757394f8de7082af65bf86ed9c">mlx::core::Subtract</a></li>
<li>Sum&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924a1fc7c1f09c80650ab0497e2d6781d65f">mlx::core::distributed::AllReduce</a>, <a class="el" href="classmlx_1_1core_1_1_reduce.html#a0848518b16ae6d4043d6be247bdf31c9a8582875544f1d3d396a1a376473ef1dd">mlx::core::Reduce</a>, <a class="el" href="classmlx_1_1core_1_1_scan.html#a47bf2ec54ead4b8f00f9f188518630f1ade23893033e4849f5596e7ce76a5fc36">mlx::core::Scan</a>, <a class="el" href="classmlx_1_1core_1_1_scatter.html#a614d19af11dc30644b2b4941033b613ca14abe2d8818efa71726be4e156813d6f">mlx::core::Scatter</a></li>