2024-10-15 23:12:17 +08:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "en-US" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=11" / >
2025-02-07 04:16:29 +08:00
< meta name = "generator" content = "Doxygen 1.13.2" / >
2024-10-15 23:12:17 +08:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > MLX: mlx/transforms.h Source File< / title >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< 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" / >
2025-01-10 05:56:20 +08:00
< script type = "text/javascript" src = "navtreedata.js" > < / script >
< script type = "text/javascript" src = "navtree.js" > < / script >
2024-10-15 23:12:17 +08:00
< 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 >
2025-01-10 05:56:20 +08:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
< / script >
2024-10-15 23:12:17 +08:00
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr id = "projectrow" >
< td id = "projectalign" >
< div id = "projectname" > MLX
< / div >
< / td >
2025-01-10 05:56:20 +08:00
< td > < div id = "MSearchBox" class = "MSearchBoxInactive" >
< span class = "left" >
< span id = "MSearchSelect" onmouseover = "return searchBox.OnSearchSelectShow()" onmouseout = "return searchBox.OnSearchSelectHide()" >   < / 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 >
2024-10-15 23:12:17 +08:00
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2025-02-07 04:16:29 +08:00
<!-- Generated by Doxygen 1.13.2 -->
2024-10-15 23:12:17 +08:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
< / script >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
< / script >
2025-01-10 05:56:20 +08:00
< / div > <!-- top -->
< 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 >
2024-10-15 23:12:17 +08:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
2025-01-10 05:56:20 +08:00
$(function(){initNavTree('transforms_8h_source.html',''); initResizable(true); });
2024-10-15 23:12:17 +08:00
/* @license-end */
< / script >
2025-01-10 05:56:20 +08:00
< div id = "doc-content" >
2024-10-15 23:12:17 +08:00
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< / div >
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
< div id = "MSearchResults" >
< div class = "SRPage" >
< div id = "SRIndex" >
< div id = "SRResults" > < / div >
< div class = "SRStatus" id = "Loading" > Loading...< / div >
< div class = "SRStatus" id = "Searching" > Searching...< / div >
< div class = "SRStatus" id = "NoMatches" > No Matches< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "header" >
< div class = "headertitle" > < div class = "title" > transforms.h< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< a href = "transforms_8h.html" > Go to the documentation of this file.< / a > < div class = "fragment" > < div class = "line" > < a id = "l00001" name = "l00001" > < / a > < span class = "lineno" > 1< / span > < span class = "comment" > // Copyright © 2023-2024 Apple Inc.< / span > < / div >
< div class = "line" > < a id = "l00002" name = "l00002" > < / a > < span class = "lineno" > 2< / span > < / div >
< div class = "line" > < a id = "l00003" name = "l00003" > < / a > < span class = "lineno" > 3< / span > < span class = "preprocessor" > #pragma once< / span > < / div >
< div class = "line" > < a id = "l00004" name = "l00004" > < / a > < span class = "lineno" > 4< / span > < / div >
< div class = "line" > < a id = "l00005" name = "l00005" > < / a > < span class = "lineno" > 5< / span > < span class = "preprocessor" > #include < optional> < / span > < / div >
< div class = "line" > < a id = "l00006" name = "l00006" > < / a > < span class = "lineno" > 6< / span > < / div >
< div class = "line" > < a id = "l00007" name = "l00007" > < / a > < span class = "lineno" > 7< / span > < span class = "preprocessor" > #include " < a class = "code" href = "array_8h.html" > mlx/array.h< / a > " < / span > < / div >
< div class = "line" > < a id = "l00008" name = "l00008" > < / a > < span class = "lineno" > 8< / span > < / div >
< div class = "line" > < a id = "l00009" name = "l00009" > < / a > < span class = "lineno" > 9< / span > < span class = "keyword" > namespace < / span > < a class = "code hl_namespace" href = "namespacemlx_1_1core.html" > mlx::core< / a > {< / 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 = "namespacemlx_1_1core.html#a15dda19aa7fa1fc5fca35df5cf963297" > 11< / a > < / span > < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#a15dda19aa7fa1fc5fca35df5cf963297" > async_eval< / a > (std::vector< array> outputs);< / div >
< div class = "line" > < a id = "l00012" name = "l00012" > < / a > < span class = "lineno" > 12< / span > < / div >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00013" name = "l00013" > < / a > < span class = "lineno" > 13< / span > < span class = "keyword" > template< / span > < < span class = "keyword" > typename< / span > ... Arrays, < span class = "keyword" > typename< / span > = < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#af89751d79339f3e4d9318ea97d64d114" > enable_for_arrays_t< / a > < Arrays...> > < / div >
< div class = "foldopen" id = "foldopen00014" data-start = "{" data-end = "}" >
< div class = "line" > < a id = "l00014" name = "l00014" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#abf8dae3b87a03a409711691cd9c097b6" > 14< / a > < / span > < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#a15dda19aa7fa1fc5fca35df5cf963297" > async_eval< / a > (Arrays& & ... outputs) {< / div >
< div class = "line" > < a id = "l00015" name = "l00015" > < / a > < span class = "lineno" > 15< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#a15dda19aa7fa1fc5fca35df5cf963297" > async_eval< / a > (std::vector< array> {std::forward< Arrays> (outputs)...});< / div >
< div class = "line" > < a id = "l00016" name = "l00016" > < / a > < span class = "lineno" > 16< / span > }< / div >
2024-10-15 23:12:17 +08:00
< / div >
2025-01-10 05:56:20 +08:00
< 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" > < a class = "line" href = "namespacemlx_1_1core.html#a7d6e097d8effed52f4713672e471f299" > 18< / a > < / span > < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#a7d6e097d8effed52f4713672e471f299" > eval< / a > (std::vector< array> outputs);< / div >
2024-10-15 23:12:17 +08:00
< div class = "line" > < a id = "l00019" name = "l00019" > < / a > < span class = "lineno" > 19< / span > < / div >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00020" name = "l00020" > < / a > < span class = "lineno" > 20< / span > < span class = "keyword" > template< / span > < < span class = "keyword" > typename< / span > ... Arrays, < span class = "keyword" > typename< / span > = < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#af89751d79339f3e4d9318ea97d64d114" > enable_for_arrays_t< / a > < Arrays...> > < / 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 = "namespacemlx_1_1core.html#adb14f689c9f75f7901edb196c2bfb971" > 21< / a > < / span > < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#a7d6e097d8effed52f4713672e471f299" > eval< / a > (Arrays& & ... outputs) {< / div >
< div class = "line" > < a id = "l00022" name = "l00022" > < / a > < span class = "lineno" > 22< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#a7d6e097d8effed52f4713672e471f299" > eval< / a > (std::vector< array> {std::forward< Arrays> (outputs)...});< / div >
< div class = "line" > < a id = "l00023" name = "l00023" > < / a > < span class = "lineno" > 23< / span > }< / div >
2024-10-15 23:12:17 +08:00
< / div >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00024" name = "l00024" > < / a > < span class = "lineno" > 24< / span > < / div >
< div class = "line" > < a id = "l00032" name = "l00032" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#a1b33e2c2e3471420490cf0be2de6de18" > 32< / a > < / span > std::pair< std::vector< array> , std::vector< array> > < a class = "code hl_function" href = "namespacemlx_1_1core.html#a1b33e2c2e3471420490cf0be2de6de18" > vjp< / a > (< / div >
< div class = "line" > < a id = "l00033" name = "l00033" > < / a > < span class = "lineno" > 33< / span > < span class = "keyword" > const< / span > std::function< std::vector< array> (< span class = "keyword" > const< / span > std::vector< array> & )> & fun,< / div >
< div class = "line" > < a id = "l00034" name = "l00034" > < / a > < span class = "lineno" > 34< / span > < span class = "keyword" > const< / span > std::vector< array> & primals,< / div >
< div class = "line" > < a id = "l00035" name = "l00035" > < / a > < span class = "lineno" > 35< / span > < span class = "keyword" > const< / span > std::vector< array> & cotangents);< / div >
< div class = "line" > < a id = "l00036" name = "l00036" > < / a > < span class = "lineno" > 36< / span > < / div >
< div class = "line" > < a id = "l00040" name = "l00040" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#a2065a11249c3f4356ffd69b7a8c487ff" > 40< / a > < / span > std::pair< array, array> < a class = "code hl_function" href = "namespacemlx_1_1core.html#a1b33e2c2e3471420490cf0be2de6de18" > vjp< / a > (< / div >
< div class = "line" > < a id = "l00041" name = "l00041" > < / a > < span class = "lineno" > 41< / span > < span class = "keyword" > const< / span > std::function< < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > (< span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & )> & fun,< / div >
< div class = "line" > < a id = "l00042" name = "l00042" > < / a > < span class = "lineno" > 42< / span > < span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & primal,< / div >
< div class = "line" > < a id = "l00043" name = "l00043" > < / a > < span class = "lineno" > 43< / span > < span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & cotangent);< / div >
< div class = "line" > < a id = "l00044" name = "l00044" > < / a > < span class = "lineno" > 44< / span > < / div >
< div class = "line" > < a id = "l00052" name = "l00052" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#a179a632200366c223d6ab56d3e032592" > 52< / a > < / span > std::pair< std::vector< array> , std::vector< array> > < a class = "code hl_function" href = "namespacemlx_1_1core.html#a179a632200366c223d6ab56d3e032592" > jvp< / a > (< / div >
< div class = "line" > < a id = "l00053" name = "l00053" > < / a > < span class = "lineno" > 53< / span > < span class = "keyword" > const< / span > std::function< std::vector< array> (< span class = "keyword" > const< / span > std::vector< array> & )> & fun,< / div >
< div class = "line" > < a id = "l00054" name = "l00054" > < / a > < span class = "lineno" > 54< / span > < span class = "keyword" > const< / span > std::vector< array> & primals,< / div >
< div class = "line" > < a id = "l00055" name = "l00055" > < / a > < span class = "lineno" > 55< / span > < span class = "keyword" > const< / span > std::vector< array> & tangents);< / div >
< div class = "line" > < a id = "l00056" name = "l00056" > < / a > < span class = "lineno" > 56< / span > < / div >
< div class = "line" > < a id = "l00060" name = "l00060" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#af38e7582db29519bb39326f6fa531d20" > 60< / a > < / span > std::pair< array, array> < a class = "code hl_function" href = "namespacemlx_1_1core.html#a179a632200366c223d6ab56d3e032592" > jvp< / a > (< / div >
< div class = "line" > < a id = "l00061" name = "l00061" > < / a > < span class = "lineno" > 61< / span > < span class = "keyword" > const< / span > std::function< < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > (< span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & )> & fun,< / div >
< div class = "line" > < a id = "l00062" name = "l00062" > < / a > < span class = "lineno" > 62< / span > < span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & primal,< / div >
< div class = "line" > < a id = "l00063" name = "l00063" > < / a > < span class = "lineno" > 63< / span > < span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & tangent);< / div >
< div class = "line" > < a id = "l00064" name = "l00064" > < / a > < span class = "lineno" > 64< / span > < / div >
< div class = "line" > < a id = "l00065" name = "l00065" > < / a > < span class = "lineno" > 65< / span > < span class = "comment" > // Return type of general value_and_grad: a function which takes an input< / span > < / div >
< div class = "line" > < a id = "l00066" name = "l00066" > < / a > < span class = "lineno" > 66< / span > < span class = "comment" > // vector of arrays and returns a pair of vectors of arrays one for the< / span > < / div >
< div class = "line" > < a id = "l00067" name = "l00067" > < / a > < span class = "lineno" > 67< / span > < span class = "comment" > // values and one for the gradients wrt the first value.< / span > < / div >
< div class = "line" > < a id = "l00068" name = "l00068" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#ab79d66ddf1ec38b2f2c01234892a2230" > 68< / a > < / span > < span class = "keyword" > using < / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#ab79d66ddf1ec38b2f2c01234892a2230" > ValueAndGradFn< / a > =< / div >
< div class = "line" > < a id = "l00069" name = "l00069" > < / a > < span class = "lineno" > 69< / span > std::function< std::pair< std::vector< array> , std::vector< array> > (< / div >
< div class = "line" > < a id = "l00070" name = "l00070" > < / a > < span class = "lineno" > 70< / span > < span class = "keyword" > const< / span > std::vector< array> & )> ;< / div >
< div class = "line" > < a id = "l00071" name = "l00071" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#a2689b8f1181648cb1685204fea9f3066" > 71< / a > < / span > < span class = "keyword" > using < / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#a2689b8f1181648cb1685204fea9f3066" > SimpleValueAndGradFn< / a > = std::function< std::pair< array, std::vector< array> > (< / div >
< div class = "line" > < a id = "l00072" name = "l00072" > < / a > < span class = "lineno" > 72< / span > < span class = "keyword" > const< / span > std::vector< array> & )> ;< / div >
< div class = "line" > < a id = "l00073" name = "l00073" > < / a > < span class = "lineno" > 73< / span > < / div >
< div class = "line" > < a id = "l00078" name = "l00078" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#abf49b337a00997231c0f7fd389efa8f3" > 78< / a > < / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#ab79d66ddf1ec38b2f2c01234892a2230" > ValueAndGradFn< / a > < a class = "code hl_function" href = "namespacemlx_1_1core.html#abf49b337a00997231c0f7fd389efa8f3" > value_and_grad< / a > (< / div >
< div class = "line" > < a id = "l00079" name = "l00079" > < / a > < span class = "lineno" > 79< / span > < span class = "keyword" > const< / span > std::function< std::vector< array> (< span class = "keyword" > const< / span > std::vector< array> & )> & fun,< / div >
< div class = "line" > < a id = "l00080" name = "l00080" > < / a > < span class = "lineno" > 80< / span > < span class = "keyword" > const< / span > std::vector< int> & argnums);< / div >
< div class = "line" > < a id = "l00081" name = "l00081" > < / a > < span class = "lineno" > 81< / span > < / div >
< div class = "foldopen" id = "foldopen00086" data-start = "{" data-end = "}" >
< div class = "line" > < a id = "l00086" name = "l00086" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#a7b987f404b8699de00f9e0099ab6b1b0" > 86< / a > < / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#ab79d66ddf1ec38b2f2c01234892a2230" > ValueAndGradFn< / a > < span class = "keyword" > inline< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#abf49b337a00997231c0f7fd389efa8f3" > value_and_grad< / a > (< / div >
< div class = "line" > < a id = "l00087" name = "l00087" > < / a > < span class = "lineno" > 87< / span > < span class = "keyword" > const< / span > std::function< std::vector< array> (< span class = "keyword" > const< / span > std::vector< array> & )> & fun,< / div >
< div class = "line" > < a id = "l00088" name = "l00088" > < / a > < span class = "lineno" > 88< / span > < span class = "keywordtype" > int< / span > argnum = 0) {< / div >
< div class = "line" > < a id = "l00089" name = "l00089" > < / a > < span class = "lineno" > 89< / span > < span class = "keywordflow" > return< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#abf49b337a00997231c0f7fd389efa8f3" > value_and_grad< / a > (fun, std::vector< int> {argnum});< / div >
< div class = "line" > < a id = "l00090" name = "l00090" > < / a > < span class = "lineno" > 90< / span > }< / div >
2024-10-15 23:12:17 +08:00
< / div >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00091" name = "l00091" > < / a > < span class = "lineno" > 91< / span > < / div >
2024-10-15 23:12:17 +08:00
< div class = "foldopen" id = "foldopen00096" data-start = "{" data-end = "}" >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00096" name = "l00096" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#a5a64dc878b29403d27e50bd7a288cc04" > 96< / a > < / span > std::function< std::pair< array, array> (< span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & )> < span class = "keyword" > inline< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#abf49b337a00997231c0f7fd389efa8f3" > value_and_grad< / a > (< / div >
< div class = "line" > < a id = "l00097" name = "l00097" > < / a > < span class = "lineno" > 97< / span > < span class = "keyword" > const< / span > std::function< < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > (< span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & )> & fun) {< / div >
< div class = "line" > < a id = "l00098" name = "l00098" > < / a > < span class = "lineno" > 98< / span > < span class = "keywordflow" > return< / span > [fun](< span class = "keyword" > auto< / span > inputs) { < span class = "keywordflow" > return< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#a1b33e2c2e3471420490cf0be2de6de18" > vjp< / a > (fun, inputs, < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > (1.0f)); };< / div >
< div class = "line" > < a id = "l00099" name = "l00099" > < / a > < span class = "lineno" > 99< / span > }< / div >
2024-10-15 23:12:17 +08:00
< / div >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00100" name = "l00100" > < / a > < span class = "lineno" > 100< / span > < / div >
< div class = "foldopen" id = "foldopen00101" data-start = "{" data-end = "}" >
< div class = "line" > < a id = "l00101" name = "l00101" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#a7620f1ae298127cb6181db9162f012a7" > 101< / a > < / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#a2689b8f1181648cb1685204fea9f3066" > SimpleValueAndGradFn< / a > < span class = "keyword" > inline< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#abf49b337a00997231c0f7fd389efa8f3" > value_and_grad< / a > (< / div >
< div class = "line" > < a id = "l00102" name = "l00102" > < / a > < span class = "lineno" > 102< / span > < span class = "keyword" > const< / span > std::function< < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > (< span class = "keyword" > const< / span > std::vector< array> & )> & fun,< / div >
< div class = "line" > < a id = "l00103" name = "l00103" > < / a > < span class = "lineno" > 103< / span > < span class = "keyword" > const< / span > std::vector< int> & argnums) {< / div >
< div class = "line" > < a id = "l00104" name = "l00104" > < / a > < span class = "lineno" > 104< / span > < span class = "keywordflow" > return< / span > [fun, argnums](< span class = "keyword" > auto< / span > inputs) {< / div >
< div class = "line" > < a id = "l00105" name = "l00105" > < / a > < span class = "lineno" > 105< / span > < span class = "keyword" > auto< / span > result = < a class = "code hl_function" href = "namespacemlx_1_1core.html#abf49b337a00997231c0f7fd389efa8f3" > value_and_grad< / a > (< / div >
< div class = "line" > < a id = "l00106" name = "l00106" > < / a > < span class = "lineno" > 106< / span > [fun](< span class = "keyword" > auto< / span > inputs) { < span class = "keywordflow" > return< / span > std::vector< array> {fun(inputs)}; },< / div >
< div class = "line" > < a id = "l00107" name = "l00107" > < / a > < span class = "lineno" > 107< / span > argnums)(inputs);< / div >
< div class = "line" > < a id = "l00108" name = "l00108" > < / a > < span class = "lineno" > 108< / span > < / div >
< div class = "line" > < a id = "l00109" name = "l00109" > < / a > < span class = "lineno" > 109< / span > < span class = "keywordflow" > return< / span > std::make_pair(result.first[0], result.second);< / div >
< div class = "line" > < a id = "l00110" name = "l00110" > < / a > < span class = "lineno" > 110< / span > };< / div >
< div class = "line" > < a id = "l00111" name = "l00111" > < / a > < span class = "lineno" > 111< / span > }< / div >
2024-10-15 23:12:17 +08:00
< / div >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00112" name = "l00112" > < / a > < span class = "lineno" > 112< / span > < / div >
< div class = "foldopen" id = "foldopen00113" data-start = "{" data-end = "}" >
< div class = "line" > < a id = "l00113" name = "l00113" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#a2f69ffc30d66b1fca8f24b65be161a51" > 113< / a > < / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#a2689b8f1181648cb1685204fea9f3066" > SimpleValueAndGradFn< / a > < span class = "keyword" > inline< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#abf49b337a00997231c0f7fd389efa8f3" > value_and_grad< / a > (< / div >
< div class = "line" > < a id = "l00114" name = "l00114" > < / a > < span class = "lineno" > 114< / span > < span class = "keyword" > const< / span > std::function< < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > (< span class = "keyword" > const< / span > std::vector< array> & )> & fun,< / div >
< div class = "line" > < a id = "l00115" name = "l00115" > < / a > < span class = "lineno" > 115< / span > < span class = "keywordtype" > int< / span > argnum = 0) {< / div >
< div class = "line" > < a id = "l00116" name = "l00116" > < / a > < span class = "lineno" > 116< / span > < span class = "keywordflow" > return< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#abf49b337a00997231c0f7fd389efa8f3" > value_and_grad< / a > (fun, std::vector< int> {argnum});< / div >
< div class = "line" > < a id = "l00117" name = "l00117" > < / a > < span class = "lineno" > 117< / span > }< / div >
2024-10-15 23:12:17 +08:00
< / div >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00118" name = "l00118" > < / a > < span class = "lineno" > 118< / span > < / div >
< div class = "foldopen" id = "foldopen00127" data-start = "{" data-end = "}" >
< div class = "line" > < a id = "l00127" name = "l00127" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#a3d2b2929ed4636e9e2b86e125b2e57d9" > 127< / a > < / span > std::function< std::vector< array> (< span class = "keyword" > const< / span > std::vector< array> & )> < span class = "keyword" > inline< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#a3d2b2929ed4636e9e2b86e125b2e57d9" > grad< / a > (< / div >
< div class = "line" > < a id = "l00128" name = "l00128" > < / a > < span class = "lineno" > 128< / span > < span class = "keyword" > const< / span > std::function< < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > (< span class = "keyword" > const< / span > std::vector< array> & )> & fun,< / div >
< div class = "line" > < a id = "l00129" name = "l00129" > < / a > < span class = "lineno" > 129< / span > < span class = "keyword" > const< / span > std::vector< int> & argnums) {< / div >
< div class = "line" > < a id = "l00130" name = "l00130" > < / a > < span class = "lineno" > 130< / span > < span class = "keyword" > auto< / span > fn = < a class = "code hl_function" href = "namespacemlx_1_1core.html#abf49b337a00997231c0f7fd389efa8f3" > value_and_grad< / a > (fun, argnums);< / div >
< div class = "line" > < a id = "l00131" name = "l00131" > < / a > < span class = "lineno" > 131< / span > < span class = "keywordflow" > return< / span > [fn](< span class = "keyword" > const< / span > std::vector< array> & inputs) { < span class = "keywordflow" > return< / span > fn(inputs).second; };< / div >
< div class = "line" > < a id = "l00132" name = "l00132" > < / a > < span class = "lineno" > 132< / span > }< / div >
2024-10-15 23:12:17 +08:00
< / div >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00133" name = "l00133" > < / a > < span class = "lineno" > 133< / span > < / div >
< div class = "foldopen" id = "foldopen00142" data-start = "{" data-end = "}" >
< div class = "line" > < a id = "l00142" name = "l00142" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#af482f6c64acd77c57ef5bb4b7be9726c" > 142< / a > < / span > std::function< std::vector< array> (< span class = "keyword" > const< / span > std::vector< array> & )> < span class = "keyword" > inline< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#a3d2b2929ed4636e9e2b86e125b2e57d9" > grad< / a > (< / div >
< div class = "line" > < a id = "l00143" name = "l00143" > < / a > < span class = "lineno" > 143< / span > < span class = "keyword" > const< / span > std::function< < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > (< span class = "keyword" > const< / span > std::vector< array> & )> & fun,< / div >
< div class = "line" > < a id = "l00144" name = "l00144" > < / a > < span class = "lineno" > 144< / span > < span class = "keywordtype" > int< / span > argnum = 0) {< / div >
< div class = "line" > < a id = "l00145" name = "l00145" > < / a > < span class = "lineno" > 145< / span > < span class = "keywordflow" > return< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#a3d2b2929ed4636e9e2b86e125b2e57d9" > grad< / a > (fun, std::vector< int> {argnum});< / div >
< div class = "line" > < a id = "l00146" name = "l00146" > < / a > < span class = "lineno" > 146< / span > }< / div >
2024-10-15 23:12:17 +08:00
< / div >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00147" name = "l00147" > < / a > < span class = "lineno" > 147< / span > < / div >
< div class = "foldopen" id = "foldopen00151" data-start = "{" data-end = "}" >
< div class = "line" > < a id = "l00151" name = "l00151" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#a64bc619876b0f8cc81a2637ca81c99f7" > 151< / a > < / span > std::function< < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > (< span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & )> < span class = "keyword" > inline< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#a3d2b2929ed4636e9e2b86e125b2e57d9" > grad< / a > (< / div >
< div class = "line" > < a id = "l00152" name = "l00152" > < / a > < span class = "lineno" > 152< / span > < span class = "keyword" > const< / span > std::function< < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > (< span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & )> & fun) {< / div >
< div class = "line" > < a id = "l00153" name = "l00153" > < / a > < span class = "lineno" > 153< / span > < span class = "keyword" > auto< / span > fn = < a class = "code hl_function" href = "namespacemlx_1_1core.html#abf49b337a00997231c0f7fd389efa8f3" > value_and_grad< / a > (fun);< / div >
< div class = "line" > < a id = "l00154" name = "l00154" > < / a > < span class = "lineno" > 154< / span > < span class = "keywordflow" > return< / span > [fn](< span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & input) { < span class = "keywordflow" > return< / span > fn(input).second; };< / div >
< div class = "line" > < a id = "l00155" name = "l00155" > < / a > < span class = "lineno" > 155< / span > }< / div >
< / div >
< div class = "line" > < a id = "l00156" name = "l00156" > < / a > < span class = "lineno" > 156< / span > < / div >
< div class = "line" > < a id = "l00160" name = "l00160" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#ac3caec2fa65375ed4c3bf1206177b84c" > 160< / a > < / span > std::function< < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > (< span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & )> < a class = "code hl_function" href = "namespacemlx_1_1core.html#ac3caec2fa65375ed4c3bf1206177b84c" > vmap< / a > (< / div >
< div class = "line" > < a id = "l00161" name = "l00161" > < / a > < span class = "lineno" > 161< / span > < span class = "keyword" > const< / span > std::function< < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > (< span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & )> & fun,< / div >
< div class = "line" > < a id = "l00162" name = "l00162" > < / a > < span class = "lineno" > 162< / span > < span class = "keywordtype" > int< / span > in_axis = 0,< / div >
< div class = "line" > < a id = "l00163" name = "l00163" > < / a > < span class = "lineno" > 163< / span > < span class = "keywordtype" > int< / span > out_axis = 0);< / div >
< div class = "line" > < a id = "l00164" name = "l00164" > < / a > < span class = "lineno" > 164< / span > < / div >
< div class = "line" > < a id = "l00168" name = "l00168" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#a8481a3bb4c12c2b7dc6ba576c2be3d0d" > 168< / a > < / span > std::function< < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > (< span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & , < span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & )> < a class = "code hl_function" href = "namespacemlx_1_1core.html#ac3caec2fa65375ed4c3bf1206177b84c" > vmap< / a > (< / div >
< div class = "line" > < a id = "l00169" name = "l00169" > < / a > < span class = "lineno" > 169< / span > < span class = "keyword" > const< / span > std::function< < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > (< span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & , < span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & )> & fun,< / div >
< div class = "line" > < a id = "l00170" name = "l00170" > < / a > < span class = "lineno" > 170< / span > < span class = "keywordtype" > int< / span > in_axis_a = 0,< / div >
< div class = "line" > < a id = "l00171" name = "l00171" > < / a > < span class = "lineno" > 171< / span > < span class = "keywordtype" > int< / span > in_axis_b = 0,< / div >
< div class = "line" > < a id = "l00172" name = "l00172" > < / a > < span class = "lineno" > 172< / span > < span class = "keywordtype" > int< / span > out_axis = 0);< / div >
< div class = "line" > < a id = "l00173" name = "l00173" > < / a > < span class = "lineno" > 173< / span > < / div >
< div class = "line" > < a id = "l00183" name = "l00183" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#a95a7757e8d18fced38acfc6a3e8d686a" > 183< / a > < / span > std::function< std::vector< array> (< span class = "keyword" > const< / span > std::vector< array> & )> < a class = "code hl_function" href = "namespacemlx_1_1core.html#ac3caec2fa65375ed4c3bf1206177b84c" > vmap< / a > (< / div >
< div class = "line" > < a id = "l00184" name = "l00184" > < / a > < span class = "lineno" > 184< / span > < span class = "keyword" > const< / span > std::function< std::vector< array> (< span class = "keyword" > const< / span > std::vector< array> & )> & fun,< / div >
< div class = "line" > < a id = "l00185" name = "l00185" > < / a > < span class = "lineno" > 185< / span > < span class = "keyword" > const< / span > std::vector< int> & in_axes = {},< / div >
< div class = "line" > < a id = "l00186" name = "l00186" > < / a > < span class = "lineno" > 186< / span > < span class = "keyword" > const< / span > std::vector< int> & out_axes = {});< / div >
< div class = "line" > < a id = "l00187" name = "l00187" > < / a > < span class = "lineno" > 187< / span > < / div >
< div class = "line" > < a id = "l00197" name = "l00197" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#a8d3ca5fbaecdb995660c24cde5aeebaf" > 197< / a > < / span > std::function< std::vector< array> (< span class = "keyword" > const< / span > std::vector< array> & )> < a class = "code hl_function" href = "namespacemlx_1_1core.html#a8d3ca5fbaecdb995660c24cde5aeebaf" > custom_function< / a > (< / div >
< div class = "line" > < a id = "l00198" name = "l00198" > < / a > < span class = "lineno" > 198< / span > std::function< std::vector< array> (< span class = "keyword" > const< / span > std::vector< array> & )> fun,< / div >
< div class = "line" > < a id = "l00199" name = "l00199" > < / a > < span class = "lineno" > 199< / span > std::optional< std::function< std::vector< array> (< / div >
2024-10-15 23:12:17 +08:00
< div class = "line" > < a id = "l00200" name = "l00200" > < / a > < span class = "lineno" > 200< / span > < span class = "keyword" > const< / span > std::vector< array> & ,< / div >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00201" name = "l00201" > < / a > < span class = "lineno" > 201< / span > < span class = "keyword" > const< / span > std::vector< array> & ,< / div >
< div class = "line" > < a id = "l00202" name = "l00202" > < / a > < span class = "lineno" > 202< / span > < span class = "keyword" > const< / span > std::vector< array> & )> > fun_vjp = std::nullopt,< / div >
< div class = "line" > < a id = "l00203" name = "l00203" > < / a > < span class = "lineno" > 203< / span > std::optional< std::function< std::vector< array> (< / div >
< div class = "line" > < a id = "l00204" name = "l00204" > < / a > < span class = "lineno" > 204< / span > < span class = "keyword" > const< / span > std::vector< array> & ,< / div >
< div class = "line" > < a id = "l00205" name = "l00205" > < / a > < span class = "lineno" > 205< / span > < span class = "keyword" > const< / span > std::vector< array> & ,< / div >
< div class = "line" > < a id = "l00206" name = "l00206" > < / a > < span class = "lineno" > 206< / span > < span class = "keyword" > const< / span > std::vector< int> & )> > fun_jvp = std::nullopt,< / div >
< div class = "line" > < a id = "l00207" name = "l00207" > < / a > < span class = "lineno" > 207< / span > std::optional< std::function< std::pair< std::vector< array> , std::vector< int> > (< / div >
< div class = "line" > < a id = "l00208" name = "l00208" > < / a > < span class = "lineno" > 208< / span > < span class = "keyword" > const< / span > std::vector< array> & ,< / div >
< div class = "line" > < a id = "l00209" name = "l00209" > < / a > < span class = "lineno" > 209< / span > < span class = "keyword" > const< / span > std::vector< int> & )> > fun_vmap = std::nullopt);< / div >
< div class = "line" > < a id = "l00210" name = "l00210" > < / a > < span class = "lineno" > 210< / span > < / div >
< div class = "line" > < a id = "l00215" name = "l00215" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#a9290596250fa308df4c69b44483bb8aa" > 215< / a > < / span > std::function< std::vector< array> (< span class = "keyword" > const< / span > std::vector< array> & )> < a class = "code hl_function" href = "namespacemlx_1_1core.html#a9290596250fa308df4c69b44483bb8aa" > custom_vjp< / a > (< / div >
< div class = "line" > < a id = "l00216" name = "l00216" > < / a > < span class = "lineno" > 216< / span > std::function< std::vector< array> (< span class = "keyword" > const< / span > std::vector< array> & )> fun,< / div >
< div class = "line" > < a id = "l00217" name = "l00217" > < / a > < span class = "lineno" > 217< / span > std::function< std::vector< array> (< / div >
< div class = "line" > < a id = "l00218" name = "l00218" > < / a > < span class = "lineno" > 218< / span > < span class = "keyword" > const< / span > std::vector< array> & ,< / div >
< div class = "line" > < a id = "l00219" name = "l00219" > < / a > < span class = "lineno" > 219< / span > < span class = "keyword" > const< / span > std::vector< array> & ,< / div >
< div class = "line" > < a id = "l00220" name = "l00220" > < / a > < span class = "lineno" > 220< / span > < span class = "keyword" > const< / span > std::vector< array> & )> fun_vjp);< / div >
< div class = "line" > < a id = "l00221" name = "l00221" > < / a > < span class = "lineno" > 221< / span > < / div >
< div class = "line" > < a id = "l00226" name = "l00226" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#a42fa813d72c15132f76ef5fd1213ed71" > 226< / a > < / span > std::function< std::vector< array> (< span class = "keyword" > const< / span > std::vector< array> & )> < a class = "code hl_function" href = "namespacemlx_1_1core.html#a42fa813d72c15132f76ef5fd1213ed71" > checkpoint< / a > (< / div >
< div class = "line" > < a id = "l00227" name = "l00227" > < / a > < span class = "lineno" > 227< / span > std::function< std::vector< array> (< span class = "keyword" > const< / span > std::vector< array> & )> fun);< / div >
< div class = "line" > < a id = "l00228" name = "l00228" > < / a > < span class = "lineno" > 228< / span > < / div >
< div class = "line" > < a id = "l00229" name = "l00229" > < / a > < span class = "lineno" > 229< / span > } < span class = "comment" > // namespace mlx::core< / span > < / div >
2024-10-15 23:12:17 +08:00
< div class = "ttc" id = "aarray_8h_html" > < div class = "ttname" > < a href = "array_8h.html" > array.h< / a > < / div > < / div >
2025-01-10 05:56:20 +08:00
< div class = "ttc" id = "aclassmlx_1_1core_1_1array_html" > < div class = "ttname" > < a href = "classmlx_1_1core_1_1array.html" > mlx::core::array< / a > < / div > < div class = "ttdef" > < b > Definition< / b > array.h:24< / div > < / div >
2024-10-15 23:12:17 +08:00
< div class = "ttc" id = "anamespacemlx_1_1core_html" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html" > mlx::core< / a > < / div > < div class = "ttdef" > < b > Definition< / b > allocator.h:7< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_html_a15dda19aa7fa1fc5fca35df5cf963297" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#a15dda19aa7fa1fc5fca35df5cf963297" > mlx::core::async_eval< / a > < / div > < div class = "ttdeci" > void async_eval(std::vector< array > outputs)< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_html_a179a632200366c223d6ab56d3e032592" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#a179a632200366c223d6ab56d3e032592" > mlx::core::jvp< / a > < / div > < div class = "ttdeci" > std::pair< std::vector< array > , std::vector< array > > jvp(const std::function< std::vector< array > (const std::vector< array > & )> & fun, const std::vector< array > & primals, const std::vector< array > & tangents)< / div > < div class = "ttdoc" > Computes the output and Jacobian-vector product (JVP) of a function.< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_html_a1b33e2c2e3471420490cf0be2de6de18" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#a1b33e2c2e3471420490cf0be2de6de18" > mlx::core::vjp< / a > < / div > < div class = "ttdeci" > std::pair< std::vector< array > , std::vector< array > > vjp(const std::function< std::vector< array > (const std::vector< array > & )> & fun, const std::vector< array > & primals, const std::vector< array > & cotangents)< / div > < div class = "ttdoc" > Computes the output and vector-Jacobian product (VJP) of a function.< / div > < / div >
2025-01-10 05:56:20 +08:00
< div class = "ttc" id = "anamespacemlx_1_1core_html_a2689b8f1181648cb1685204fea9f3066" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#a2689b8f1181648cb1685204fea9f3066" > mlx::core::SimpleValueAndGradFn< / a > < / div > < div class = "ttdeci" > std::function< std::pair< array, std::vector< array > > ( const std::vector< array > & )> SimpleValueAndGradFn< / div > < div class = "ttdef" > < b > Definition< / b > transforms.h:71< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_html_a3d2b2929ed4636e9e2b86e125b2e57d9" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#a3d2b2929ed4636e9e2b86e125b2e57d9" > mlx::core::grad< / a > < / div > < div class = "ttdeci" > std::function< std::vector< array > (const std::vector< array > & )> grad(const std::function< array(const std::vector< array > & )> & fun, const std::vector< int > & argnums)< / div > < div class = "ttdoc" > Returns a function which computes the gradient of the input function with respect to a vector of inpu...< / div > < div class = "ttdef" > < b > Definition< / b > transforms.h:127< / div > < / div >
2024-10-15 23:12:17 +08:00
< div class = "ttc" id = "anamespacemlx_1_1core_html_a42fa813d72c15132f76ef5fd1213ed71" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#a42fa813d72c15132f76ef5fd1213ed71" > mlx::core::checkpoint< / a > < / div > < div class = "ttdeci" > std::function< std::vector< array > (const std::vector< array > & )> checkpoint(std::function< std::vector< array > (const std::vector< array > & )> fun)< / div > < div class = "ttdoc" > Checkpoint the gradient of a function.< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_html_a7d6e097d8effed52f4713672e471f299" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#a7d6e097d8effed52f4713672e471f299" > mlx::core::eval< / a > < / div > < div class = "ttdeci" > void eval(std::vector< array > outputs)< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_html_a8d3ca5fbaecdb995660c24cde5aeebaf" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#a8d3ca5fbaecdb995660c24cde5aeebaf" > mlx::core::custom_function< / a > < / div > < div class = "ttdeci" > std::function< std::vector< array > (const std::vector< array > & )> custom_function(std::function< std::vector< array > (const std::vector< array > & )> fun, std::optional< std::function< std::vector< array > (const std::vector< array > & , const std::vector< array > & , const std::vector< array > & )> > fun_vjp=std::nullopt, std::optional< std::function< std::vector< array > (const std::vector< array > & , const std::vector< array > & , const std::vector< int > & )> > fun_jvp=std::nullopt, std::optional< std::function< std::pair< std::vector< array > , std::vector< int > > (const std::vector< array > & , const std::vector< int > & )> > fun_vmap=std::nullopt)< / div > < div class = "ttdoc" > Redefine the transformations of fun according to the provided functions.< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_html_a9290596250fa308df4c69b44483bb8aa" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#a9290596250fa308df4c69b44483bb8aa" > mlx::core::custom_vjp< / a > < / div > < div class = "ttdeci" > std::function< std::vector< array > (const std::vector< array > & )> custom_vjp(std::function< std::vector< array > (const std::vector< array > & )> fun, std::function< std::vector< array > (const std::vector< array > & , const std::vector< array > & , const std::vector< array > & )> fun_vjp)< / div > < div class = "ttdoc" > Return a function that behaves exactly like fun but if the vjp of the results is computed fun_vjp wil...< / div > < / div >
2025-01-10 05:56:20 +08:00
< div class = "ttc" id = "anamespacemlx_1_1core_html_ab79d66ddf1ec38b2f2c01234892a2230" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#ab79d66ddf1ec38b2f2c01234892a2230" > mlx::core::ValueAndGradFn< / a > < / div > < div class = "ttdeci" > std::function< std::pair< std::vector< array > , std::vector< array > > ( const std::vector< array > & )> ValueAndGradFn< / div > < div class = "ttdef" > < b > Definition< / b > transforms.h:68< / div > < / div >
2024-10-15 23:12:17 +08:00
< div class = "ttc" id = "anamespacemlx_1_1core_html_abf49b337a00997231c0f7fd389efa8f3" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#abf49b337a00997231c0f7fd389efa8f3" > mlx::core::value_and_grad< / a > < / div > < div class = "ttdeci" > ValueAndGradFn value_and_grad(const std::function< std::vector< array > (const std::vector< array > & )> & fun, const std::vector< int > & argnums)< / div > < div class = "ttdoc" > Returns a function which computes the value and gradient of the input function with respect to a vect...< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_html_ac3caec2fa65375ed4c3bf1206177b84c" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#ac3caec2fa65375ed4c3bf1206177b84c" > mlx::core::vmap< / a > < / div > < div class = "ttdeci" > std::function< array(const array & )> vmap(const std::function< array(const array & )> & fun, int in_axis=0, int out_axis=0)< / div > < div class = "ttdoc" > Automatically vectorize a unary function over the requested axes.< / div > < / div >
2025-01-10 05:56:20 +08:00
< div class = "ttc" id = "anamespacemlx_1_1core_html_af89751d79339f3e4d9318ea97d64d114" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#af89751d79339f3e4d9318ea97d64d114" > mlx::core::enable_for_arrays_t< / a > < / div > < div class = "ttdeci" > typename std::enable_if_t< is_arrays_v< T... > > enable_for_arrays_t< / div > < div class = "ttdef" > < b > Definition< / b > array.h:615< / div > < / div >
2024-10-15 23:12:17 +08:00
< / div > <!-- fragment --> < / div > <!-- contents -->
< / div > <!-- doc - content -->
2025-01-10 05:56:20 +08:00
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
< li class = "navelem" > < a class = "el" href = "dir_938ab0ecf10b8b860ff766c820f665fd.html" > mlx< / a > < / li > < li class = "navelem" > < a class = "el" href = "transforms_8h.html" > transforms.h< / a > < / li >
2025-02-07 04:16:29 +08:00
< 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.2 < / li >
2025-01-10 05:56:20 +08:00
< / ul >
< / div >
2024-10-15 23:12:17 +08:00
< / body >
< / html >
