docs update

This commit is contained in:
Awni Hannun
2024-07-11 15:32:08 -07:00
committed by CircleCI Docs
parent 098d163a6e
commit bea7b91017
754 changed files with 24043 additions and 13535 deletions

View File

@@ -36,16 +36,16 @@ var searchData=
['generic_33',['generic',['../structmlx_1_1core_1_1_dtype.html#ac091c39cbd6686ef69aa1e5a2425aa2da3d517f8924ac7fd03699a29d97dc52d9',1,'mlx::core::Dtype::generic'],['../namespacemlx_1_1core.html#a34d69c4d46aa9b2a4a79dba7aba093d2',1,'mlx::core::generic']]],
['get_5factive_5fmemory_34',['get_active_memory',['../classmlx_1_1core_1_1metal_1_1_metal_allocator.html#a7a3ad4e33d57a47474c98e2f88e775d7',1,'mlx::core::metal::MetalAllocator::get_active_memory()'],['../namespacemlx_1_1core_1_1metal.html#a7b75c2639016ac4d350fa6c9da386667',1,'mlx::core::metal::get_active_memory()']]],
['get_5farange_5fkernel_35',['get_arange_kernel',['../namespacemlx_1_1core.html#a76f614e9956a6ca05a9be4db5a483446',1,'mlx::core']]],
['get_5fbinary_5fkernel_36',['get_binary_kernel',['../namespacemlx_1_1core.html#aec97852a7d8938407122d21e78d66f5f',1,'mlx::core']]],
['get_5fbinary_5ftwo_5fkernel_37',['get_binary_two_kernel',['../namespacemlx_1_1core.html#a0a5effc3e1cfd4123b9a63c08e947e45',1,'mlx::core']]],
['get_5fbinary_5fkernel_36',['get_binary_kernel',['../namespacemlx_1_1core.html#a4decd4a07d91487e6903f6e3c8b7513a',1,'mlx::core']]],
['get_5fbinary_5ftwo_5fkernel_37',['get_binary_two_kernel',['../namespacemlx_1_1core.html#a4e809746f48e5dcf7fa63215d3f5e33e',1,'mlx::core']]],
['get_5fcache_5fmemory_38',['get_cache_memory',['../classmlx_1_1core_1_1metal_1_1_metal_allocator.html#ad3cabbe638917ca4114eb74dcabe381f',1,'mlx::core::metal::MetalAllocator::get_cache_memory()'],['../namespacemlx_1_1core_1_1metal.html#a43307654f62ed7c58e014be7fb03909c',1,'mlx::core::metal::get_cache_memory()']]],
['get_5fcolocated_5fmtllib_5fpath_39',['get_colocated_mtllib_path',['../namespacemlx_1_1core_1_1metal.html#a5fd6ba2040e53a254b9d71ae7ebd315f',1,'mlx::core::metal']]],
['get_5fcommand_5fbuffer_40',['get_command_buffer',['../classmlx_1_1core_1_1metal_1_1_device.html#a5fe3970fbe92ccc55fce4241ffbe5210',1,'mlx::core::metal::Device']]],
['get_5fcommand_5fbuffer_5fops_41',['get_command_buffer_ops',['../classmlx_1_1core_1_1metal_1_1_device.html#a064e1cb6a16de7a0619f6447622350f8',1,'mlx::core::metal::Device']]],
['get_5fcommand_5fencoder_42',['get_command_encoder',['../classmlx_1_1core_1_1metal_1_1_device.html#affa682ef612def4890f5152f81ffb7e6',1,'mlx::core::metal::Device']]],
['get_5fcopy_5fkernel_43',['get_copy_kernel',['../namespacemlx_1_1core.html#a05a220cff45f12439fde775983c6df78',1,'mlx::core']]],
['get_5fdefault_5fstream_44',['get_default_stream',['../classmlx_1_1core_1_1scheduler_1_1_scheduler.html#af4e49f6271df08bfe7ed7ba7cd960213',1,'mlx::core::scheduler::Scheduler']]],
['get_5ffft_5fkernel_45',['get_fft_kernel',['../namespacemlx_1_1core.html#a4d8800bb9892b04684c78e3e5c760983',1,'mlx::core']]],
['get_5fdefault_5fstream_44',['get_default_stream',['../classmlx_1_1core_1_1scheduler_1_1_scheduler.html#a2366c7b888e433608e203752edc92282',1,'mlx::core::scheduler::Scheduler']]],
['get_5ffft_5fkernel_45',['get_fft_kernel',['../namespacemlx_1_1core.html#a1d4cffc3c78067b3d9a62d64f3fb686f',1,'mlx::core']]],
['get_5ffunction_46',['get_function',['../classmlx_1_1core_1_1metal_1_1_device.html#abf4ecf035e8be2ff00d2a7e95475d7ac',1,'mlx::core::metal::Device::get_function(const std::string &base_name, MTL::Library *mtl_lib, const std::string &specialized_name="", const MTLFCList &func_consts={})'],['../classmlx_1_1core_1_1metal_1_1_device.html#ac083535ead07161cb27ad31f8f64fb84',1,'mlx::core::metal::Device::get_function(const std::string &base_name, const std::string &lib_name="mlx", const std::string &specialized_name="", const MTLFCList &func_consts={})']]],
['get_5fkernel_47',['get_kernel',['../classmlx_1_1core_1_1metal_1_1_device.html#a6810c4dcbcfbf93fc51d42aa5ff0fc3a',1,'mlx::core::metal::Device::get_kernel(const std::string &base_name, MTL::Library *mtl_lib, const std::string &hash_name="", const MTLFCList &func_consts={}, const std::vector< MTL::Function * > &linked_functions={})'],['../classmlx_1_1core_1_1metal_1_1_device.html#afa0cac9d800c21a8a7f6cb224256abaf',1,'mlx::core::metal::Device::get_kernel(const std::string &base_name, const std::string &lib_name="mlx", const std::string &hash_name="", const MTLFCList &func_consts={}, const std::vector< MTL::Function * > &linked_functions={})']]],
['get_5fkernel_5fpreamble_48',['get_kernel_preamble',['../compiled__preamble_8h.html#a1dfa17a0369fb90ff615c7461f5013f3',1,'compiled_preamble.h']]],
@@ -55,41 +55,47 @@ var searchData=
['get_5fpeak_5fmemory_52',['get_peak_memory',['../classmlx_1_1core_1_1metal_1_1_metal_allocator.html#ac7972a3fe58e69489de775a0f152da17',1,'mlx::core::metal::MetalAllocator::get_peak_memory()'],['../namespacemlx_1_1core_1_1metal.html#a4b67d680cefa95f0ed5801f0e14e48ce',1,'mlx::core::metal::get_peak_memory()']]],
['get_5fplan_53',['get_plan',['../namespacepocketfft_1_1detail.html#ab24cdb6118901f4d3c8df06ef0f8390b',1,'pocketfft::detail']]],
['get_5fpool_54',['get_pool',['../namespacepocketfft_1_1detail_1_1threading.html#a7ec2b3f99232bd0f15f7b022c59d139a',1,'pocketfft::detail::threading']]],
['get_5freduce_5finit_5fkernel_55',['get_reduce_init_kernel',['../namespacemlx_1_1core.html#a51c4bb09230348bd0252e22bfdc9bc89',1,'mlx::core']]],
['get_5freduce_5fkernel_56',['get_reduce_kernel',['../namespacemlx_1_1core.html#a5d6843dcbdbd4d12851fc2edbafbc9e6',1,'mlx::core']]],
['get_5fscan_5fkernel_57',['get_scan_kernel',['../namespacemlx_1_1core.html#aeefaff208444d3fa61ecc0946fe1de5f',1,'mlx::core']]],
['get_5fshape_58',['get_shape',['../namespacemlx_1_1core.html#aab0d8a256957984acc1e3615c65c898e',1,'mlx::core']]],
['get_5fsoftmax_5fkernel_59',['get_softmax_kernel',['../namespacemlx_1_1core.html#a35a412f688d79eb47e42d20a7c8650ee',1,'mlx::core']]],
['get_5fsort_5fkernel_60',['get_sort_kernel',['../namespacemlx_1_1core.html#a84ebe6275218070f0ea320f126f64e22',1,'mlx::core']]],
['get_5fsteel_5fconv_5fgeneral_5fkernel_61',['get_steel_conv_general_kernel',['../namespacemlx_1_1core.html#abce2b67044ee06a7bbe7a91ec7c8c48d',1,'mlx::core']]],
['get_5fsteel_5fconv_5fkernel_62',['get_steel_conv_kernel',['../namespacemlx_1_1core.html#adce79d220672f5f3c65cc31d145ca9c4',1,'mlx::core']]],
['get_5fsteel_5fgemm_5ffused_5fkernel_63',['get_steel_gemm_fused_kernel',['../namespacemlx_1_1core.html#a84fa8e0aee321a9d614433a0b933103b',1,'mlx::core']]],
['get_5fsteel_5fgemm_5fmasked_5fkernel_64',['get_steel_gemm_masked_kernel',['../namespacemlx_1_1core.html#ab5f60614e965144b451930fdf935e08d',1,'mlx::core']]],
['get_5fsteel_5fgemm_5fsplitk_5faccum_5fkernel_65',['get_steel_gemm_splitk_accum_kernel',['../namespacemlx_1_1core.html#a195b86cad5bb99aa1bcd23952305af6b',1,'mlx::core']]],
['get_5fsteel_5fgemm_5fsplitk_5fkernel_66',['get_steel_gemm_splitk_kernel',['../namespacemlx_1_1core.html#af48c6f2f72b61dbd6766e4f5fea85df5',1,'mlx::core']]],
['get_5fternary_5fkernel_67',['get_ternary_kernel',['../namespacemlx_1_1core.html#a266558f20a72c439396ecd492a08d65f',1,'mlx::core']]],
['get_5ftwiddle_68',['get_twiddle',['../radix_8h.html#ac5cf950316b9445296ee9ecfc56a56bd',1,'radix.h']]],
['get_5ftype_5fstring_69',['get_type_string',['../namespacemlx_1_1core.html#af776fd91dd60594dcfebbafd17f19068',1,'mlx::core']]],
['get_5funary_5fkernel_70',['get_unary_kernel',['../namespacemlx_1_1core.html#accf153854ef650d6a6633775d8a70612',1,'mlx::core']]],
['gguf_2eh_71',['gguf.h',['../gguf_8h.html',1,'']]],
['gguf_5fload_5fquantized_72',['gguf_load_quantized',['../namespacemlx_1_1core.html#a65dd68163bdaef3631e3724327782498',1,'mlx::core']]],
['ggufload_73',['GGUFLoad',['../namespacemlx_1_1core.html#aa5b0f7f13a941e1f41c411194e9033c7',1,'mlx::core']]],
['ggufmetadata_74',['GGUFMetaData',['../namespacemlx_1_1core.html#a8c2c1b9a37aadfb48f4c3a7e806e32e3',1,'mlx::core']]],
['global_5fformatter_75',['global_formatter',['../namespacemlx_1_1core.html#af5a408a78cc934717dd711ddfda58ea6',1,'mlx::core']]],
['good_76',['good',['../classmlx_1_1core_1_1io_1_1_reader.html#a005d0b52c1f34866f7412b7f41dabec3',1,'mlx::core::io::Reader::good()'],['../classmlx_1_1core_1_1io_1_1_writer.html#a0b050c2c27487007e250e2e19560ffe4',1,'mlx::core::io::Writer::good()'],['../classmlx_1_1core_1_1io_1_1_file_reader.html#a4ecb046dfa7dab346d096adab3a1c318',1,'mlx::core::io::FileReader::good()'],['../classmlx_1_1core_1_1io_1_1_file_writer.html#a9ec4934b26fb358d699ddce1482b2d54',1,'mlx::core::io::FileWriter::good()']]],
['good_5fsize_5fcmplx_77',['good_size_cmplx',['../structpocketfft_1_1detail_1_1util.html#a758e00d242a1b7eda8f9f0c21f35c624',1,'pocketfft::detail::util']]],
['good_5fsize_5freal_78',['good_size_real',['../structpocketfft_1_1detail_1_1util.html#a173da7d5929ded86fffcebcfdc5086aa',1,'pocketfft::detail::util']]],
['gpu_79',['gpu',['../structmlx_1_1core_1_1_device.html#a45ed081b56ae5d4ddd39c83a5d8a1616',1,'mlx::core::Device::gpu'],['../structmlx_1_1core_1_1_device.html#ac45b3de9b3458d8f31005136cde20fdba0aa0be2a866411d9ff03515227454947',1,'mlx::core::Device::gpu']]],
['grad_80',['grad',['../namespacemlx_1_1core.html#a99994806f81e83f98746c9e5ba4c3673',1,'mlx::core::grad'],['../namespacemlx_1_1core.html#af482f6c64acd77c57ef5bb4b7be9726c',1,'mlx::core::grad(const std::function< array(const std::vector< array > &)> &fun, int argnum=0)'],['../namespacemlx_1_1core.html#a64bc619876b0f8cc81a2637ca81c99f7',1,'mlx::core::grad(const std::function< array(const array &)> &fun)']]],
['graph_5futils_2eh_81',['graph_utils.h',['../graph__utils_8h.html',1,'']]],
['greater_82',['Greater',['../struct_greater.html',1,'Greater'],['../structmlx_1_1core_1_1detail_1_1_greater.html',1,'mlx::core::detail::Greater'],['../classmlx_1_1core_1_1_greater.html',1,'mlx::core::Greater'],['../classmlx_1_1core_1_1_greater.html#a1d5992a66c020cd97a70e8e3d8cd1a1b',1,'mlx::core::Greater::Greater()']]],
['greater_83',['greater',['../group__ops.html#gaf4ec7bfc1ad13b891f1f3ef1772ef04d',1,'mlx::core']]],
['greater_5fequal_84',['greater_equal',['../group__ops.html#ga7153071bcfff6faad21332163fb9a430',1,'mlx::core']]],
['greaterequal_85',['GreaterEqual',['../struct_greater_equal.html',1,'GreaterEqual'],['../structmlx_1_1core_1_1detail_1_1_greater_equal.html',1,'mlx::core::detail::GreaterEqual'],['../classmlx_1_1core_1_1_greater_equal.html',1,'mlx::core::GreaterEqual'],['../classmlx_1_1core_1_1_greater_equal.html#a19a3c49d5a9b40e17da0e56ef6908527',1,'mlx::core::GreaterEqual::GreaterEqual()']]],
['grid_86',['grid',['../struct_read_writer.html#ac7a957f99873d3797081f5d620f3b2c8',1,'ReadWriter']]],
['group_87',['Group',['../structmlx_1_1core_1_1distributed_1_1_group.html',1,'mlx::core::distributed']]],
['group_88',['group',['../classmlx_1_1core_1_1distributed_1_1_dist_primitive.html#a8831cb61ac633431b78b5fb99c0ea9ff',1,'mlx::core::distributed::DistPrimitive']]],
['group_89',['Group',['../structmlx_1_1core_1_1distributed_1_1_group.html#a6f84accc8d6734989b2757bf6cdd0152',1,'mlx::core::distributed::Group']]],
['groups_90',['groups',['../struct_m_l_x_conv_params.html#af7a5590ac0974c7841c7f8b9fda0cbed',1,'MLXConvParams']]],
['gumbel_91',['gumbel',['../namespacemlx_1_1core_1_1random.html#aa849b765cd794306997bcbb9936d3d84',1,'mlx::core::random']]]
['get_5fquantized_5fkernel_55',['get_quantized_kernel',['../namespacemlx_1_1core.html#aa3faeae5378bfaafe3ce3432a051e43e',1,'mlx::core']]],
['get_5freduce_5finit_5fkernel_56',['get_reduce_init_kernel',['../namespacemlx_1_1core.html#a51c4bb09230348bd0252e22bfdc9bc89',1,'mlx::core']]],
['get_5freduce_5fkernel_57',['get_reduce_kernel',['../namespacemlx_1_1core.html#a5d6843dcbdbd4d12851fc2edbafbc9e6',1,'mlx::core']]],
['get_5freduction_5fplan_58',['get_reduction_plan',['../namespacemlx_1_1core.html#a1555dc378c5254e79199421761f26f2b',1,'mlx::core']]],
['get_5fscan_5fkernel_59',['get_scan_kernel',['../namespacemlx_1_1core.html#aeefaff208444d3fa61ecc0946fe1de5f',1,'mlx::core']]],
['get_5fshape_60',['get_shape',['../namespacemlx_1_1core.html#aab0d8a256957984acc1e3615c65c898e',1,'mlx::core']]],
['get_5fsoftmax_5fkernel_61',['get_softmax_kernel',['../namespacemlx_1_1core.html#a35a412f688d79eb47e42d20a7c8650ee',1,'mlx::core']]],
['get_5fsort_5fkernel_62',['get_sort_kernel',['../namespacemlx_1_1core.html#a84ebe6275218070f0ea320f126f64e22',1,'mlx::core']]],
['get_5fsteel_5fconv_5fgeneral_5fkernel_63',['get_steel_conv_general_kernel',['../namespacemlx_1_1core.html#abce2b67044ee06a7bbe7a91ec7c8c48d',1,'mlx::core']]],
['get_5fsteel_5fconv_5fkernel_64',['get_steel_conv_kernel',['../namespacemlx_1_1core.html#adce79d220672f5f3c65cc31d145ca9c4',1,'mlx::core']]],
['get_5fsteel_5fgemm_5ffused_5fkernel_65',['get_steel_gemm_fused_kernel',['../namespacemlx_1_1core.html#a84fa8e0aee321a9d614433a0b933103b',1,'mlx::core']]],
['get_5fsteel_5fgemm_5fmasked_5fkernel_66',['get_steel_gemm_masked_kernel',['../namespacemlx_1_1core.html#ab5f60614e965144b451930fdf935e08d',1,'mlx::core']]],
['get_5fsteel_5fgemm_5fsplitk_5faccum_5fkernel_67',['get_steel_gemm_splitk_accum_kernel',['../namespacemlx_1_1core.html#a195b86cad5bb99aa1bcd23952305af6b',1,'mlx::core']]],
['get_5fsteel_5fgemm_5fsplitk_5fkernel_68',['get_steel_gemm_splitk_kernel',['../namespacemlx_1_1core.html#af48c6f2f72b61dbd6766e4f5fea85df5',1,'mlx::core']]],
['get_5ftemplate_5fdefinition_69',['get_template_definition',['../namespacemlx_1_1core.html#aae0d19f0acdef2accd2428fb84c8a032',1,'mlx::core']]],
['get_5fternary_5fkernel_70',['get_ternary_kernel',['../namespacemlx_1_1core.html#a54eb3b65375022428aab5f810e40624b',1,'mlx::core']]],
['get_5ftwiddle_71',['get_twiddle',['../radix_8h.html#ac5cf950316b9445296ee9ecfc56a56bd',1,'radix.h']]],
['get_5ftype_5fstring_72',['get_type_string',['../namespacemlx_1_1core.html#af776fd91dd60594dcfebbafd17f19068',1,'mlx::core']]],
['get_5funary_5fkernel_73',['get_unary_kernel',['../namespacemlx_1_1core.html#a15175e8e2b1e26726c63393e4d68b628',1,'mlx::core']]],
['gguf_2eh_74',['gguf.h',['../gguf_8h.html',1,'']]],
['gguf_5fload_5fquantized_75',['gguf_load_quantized',['../namespacemlx_1_1core.html#a65dd68163bdaef3631e3724327782498',1,'mlx::core']]],
['ggufload_76',['GGUFLoad',['../namespacemlx_1_1core.html#aa5b0f7f13a941e1f41c411194e9033c7',1,'mlx::core']]],
['ggufmetadata_77',['GGUFMetaData',['../namespacemlx_1_1core.html#a8c2c1b9a37aadfb48f4c3a7e806e32e3',1,'mlx::core']]],
['global_5fformatter_78',['global_formatter',['../namespacemlx_1_1core.html#af5a408a78cc934717dd711ddfda58ea6',1,'mlx::core']]],
['good_79',['good',['../classmlx_1_1core_1_1io_1_1_reader.html#a005d0b52c1f34866f7412b7f41dabec3',1,'mlx::core::io::Reader::good()'],['../classmlx_1_1core_1_1io_1_1_writer.html#a0b050c2c27487007e250e2e19560ffe4',1,'mlx::core::io::Writer::good()'],['../classmlx_1_1core_1_1io_1_1_file_reader.html#a4ecb046dfa7dab346d096adab3a1c318',1,'mlx::core::io::FileReader::good()'],['../classmlx_1_1core_1_1io_1_1_file_writer.html#a9ec4934b26fb358d699ddce1482b2d54',1,'mlx::core::io::FileWriter::good()']]],
['good_5fsize_5fcmplx_80',['good_size_cmplx',['../structpocketfft_1_1detail_1_1util.html#a758e00d242a1b7eda8f9f0c21f35c624',1,'pocketfft::detail::util']]],
['good_5fsize_5freal_81',['good_size_real',['../structpocketfft_1_1detail_1_1util.html#a173da7d5929ded86fffcebcfdc5086aa',1,'pocketfft::detail::util']]],
['gpu_82',['gpu',['../structmlx_1_1core_1_1_device.html#a45ed081b56ae5d4ddd39c83a5d8a1616',1,'mlx::core::Device::gpu'],['../structmlx_1_1core_1_1_device.html#ac45b3de9b3458d8f31005136cde20fdba0aa0be2a866411d9ff03515227454947',1,'mlx::core::Device::gpu']]],
['grad_83',['grad',['../namespacemlx_1_1core.html#a99994806f81e83f98746c9e5ba4c3673',1,'mlx::core::grad'],['../namespacemlx_1_1core.html#af482f6c64acd77c57ef5bb4b7be9726c',1,'mlx::core::grad(const std::function< array(const std::vector< array > &)> &fun, int argnum=0)'],['../namespacemlx_1_1core.html#a64bc619876b0f8cc81a2637ca81c99f7',1,'mlx::core::grad(const std::function< array(const array &)> &fun)']]],
['graph_5futils_2eh_84',['graph_utils.h',['../graph__utils_8h.html',1,'']]],
['greater_85',['Greater',['../struct_greater.html',1,'Greater'],['../structmlx_1_1core_1_1detail_1_1_greater.html',1,'mlx::core::detail::Greater'],['../classmlx_1_1core_1_1_greater.html',1,'mlx::core::Greater'],['../classmlx_1_1core_1_1_greater.html#a1d5992a66c020cd97a70e8e3d8cd1a1b',1,'mlx::core::Greater::Greater()']]],
['greater_86',['greater',['../group__ops.html#gaf4ec7bfc1ad13b891f1f3ef1772ef04d',1,'mlx::core']]],
['greater_5fequal_87',['greater_equal',['../group__ops.html#ga7153071bcfff6faad21332163fb9a430',1,'mlx::core']]],
['greaterequal_88',['GreaterEqual',['../struct_greater_equal.html',1,'GreaterEqual'],['../structmlx_1_1core_1_1detail_1_1_greater_equal.html',1,'mlx::core::detail::GreaterEqual'],['../classmlx_1_1core_1_1_greater_equal.html',1,'mlx::core::GreaterEqual'],['../classmlx_1_1core_1_1_greater_equal.html#a19a3c49d5a9b40e17da0e56ef6908527',1,'mlx::core::GreaterEqual::GreaterEqual()']]],
['grid_89',['grid',['../struct_read_writer.html#ac7a957f99873d3797081f5d620f3b2c8',1,'ReadWriter']]],
['group_90',['Group',['../structmlx_1_1core_1_1distributed_1_1_group.html',1,'mlx::core::distributed']]],
['group_91',['group',['../classmlx_1_1core_1_1distributed_1_1_dist_primitive.html#a8831cb61ac633431b78b5fb99c0ea9ff',1,'mlx::core::distributed::DistPrimitive']]],
['group_92',['Group',['../structmlx_1_1core_1_1distributed_1_1_group.html#a6f84accc8d6734989b2757bf6cdd0152',1,'mlx::core::distributed::Group']]],
['group_5fstep_5fcnt_93',['group_step_cnt',['../struct_quantized_block_loader.html#a234feacde36a4afc0d740332a3769fb6',1,'QuantizedBlockLoader']]],
['group_5fsteps_94',['group_steps',['../struct_quantized_block_loader.html#a31e14175f3d4902d9fe5ab5a219f61ba',1,'QuantizedBlockLoader']]],
['group_5fstride_95',['group_stride',['../struct_quantized_block_loader.html#a0ace7e3762ecfa5a4106e7dee7e1b6ab',1,'QuantizedBlockLoader']]],
['groups_96',['groups',['../struct_m_l_x_conv_params.html#af7a5590ac0974c7841c7f8b9fda0cbed',1,'MLXConvParams']]],
['gumbel_97',['gumbel',['../namespacemlx_1_1core_1_1random.html#aa849b765cd794306997bcbb9936d3d84',1,'mlx::core::random']]]
];