zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-06-26 02:33:21 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
1431bea8cb
mlx/docs/build/html/transforms_8h.html

207 lines
29 KiB
HTML
Raw Normal View History

rebase
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"/>
rebase
2025-01-10 05:56:20 +08:00
<meta name="generator" content="Doxygen 1.13.1"/>
rebase
2024-10-15 23:12:17 +08:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: mlx/transforms.h File Reference</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"/>
rebase
2025-01-10 05:56:20 +08:00
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
rebase
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>
rebase
2025-01-10 05:56:20 +08:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
rebase
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>
rebase
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()">&#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>
rebase
2024-10-15 23:12:17 +08:00
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
rebase
2025-01-10 05:56:20 +08:00
<!-- Generated by Doxygen 1.13.1 -->
rebase
2024-10-15 23:12:17 +08:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
rebase
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>
rebase
2024-10-15 23:12:17 +08:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
rebase
2025-01-10 05:56:20 +08:00
$(function(){initNavTree('transforms_8h.html',''); initResizable(true); });
rebase
2024-10-15 23:12:17 +08:00
/* @license-end */
</script>
rebase
2025-01-10 05:56:20 +08:00
<div id="doc-content">
rebase
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="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">transforms.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;optional&gt;</code><br />
<code>#include &quot;<a class="el" href="array_8h_source.html">mlx/array.h</a>&quot;</code><br />
</div>
<p><a href="transforms_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx.html">mlx</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html">mlx::core</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ab79d66ddf1ec38b2f2c01234892a2230" id="r_ab79d66ddf1ec38b2f2c01234892a2230"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#ab79d66ddf1ec38b2f2c01234892a2230">mlx::core::ValueAndGradFn</a></td></tr>
<tr class="separator:ab79d66ddf1ec38b2f2c01234892a2230"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2689b8f1181648cb1685204fea9f3066" id="r_a2689b8f1181648cb1685204fea9f3066"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a2689b8f1181648cb1685204fea9f3066">mlx::core::SimpleValueAndGradFn</a></td></tr>
<tr class="separator:a2689b8f1181648cb1685204fea9f3066"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a15dda19aa7fa1fc5fca35df5cf963297" id="r_a15dda19aa7fa1fc5fca35df5cf963297"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a15dda19aa7fa1fc5fca35df5cf963297">mlx::core::async_eval</a> (std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; outputs)</td></tr>
<tr class="separator:a15dda19aa7fa1fc5fca35df5cf963297"><td class="memSeparator" colspan="2">&#160;</td></tr>
rebase
2025-01-10 05:56:20 +08:00
<tr class="memitem:abf8dae3b87a03a409711691cd9c097b6" id="r_abf8dae3b87a03a409711691cd9c097b6"><td class="memTemplParams" colspan="2">template&lt;typename... Arrays, typename = enable_for_arrays_t&lt;Arrays...&gt;&gt; </td></tr>
<tr class="memitem:abf8dae3b87a03a409711691cd9c097b6"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#abf8dae3b87a03a409711691cd9c097b6">mlx::core::async_eval</a> (Arrays &amp;&amp;... outputs)</td></tr>
<tr class="separator:abf8dae3b87a03a409711691cd9c097b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
rebase
2024-10-15 23:12:17 +08:00
<tr class="memitem:a7d6e097d8effed52f4713672e471f299" id="r_a7d6e097d8effed52f4713672e471f299"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a7d6e097d8effed52f4713672e471f299">mlx::core::eval</a> (std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; outputs)</td></tr>
<tr class="separator:a7d6e097d8effed52f4713672e471f299"><td class="memSeparator" colspan="2">&#160;</td></tr>
rebase
2025-01-10 05:56:20 +08:00
<tr class="memitem:adb14f689c9f75f7901edb196c2bfb971" id="r_adb14f689c9f75f7901edb196c2bfb971"><td class="memTemplParams" colspan="2">template&lt;typename... Arrays, typename = enable_for_arrays_t&lt;Arrays...&gt;&gt; </td></tr>
rebase
2024-10-15 23:12:17 +08:00
<tr class="memitem:adb14f689c9f75f7901edb196c2bfb971"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#adb14f689c9f75f7901edb196c2bfb971">mlx::core::eval</a> (Arrays &amp;&amp;... outputs)</td></tr>
<tr class="separator:adb14f689c9f75f7901edb196c2bfb971"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b33e2c2e3471420490cf0be2de6de18" id="r_a1b33e2c2e3471420490cf0be2de6de18"><td class="memItemLeft" align="right" valign="top">std::pair&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;, std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a1b33e2c2e3471420490cf0be2de6de18">mlx::core::vjp</a> (const std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt; &amp;fun, const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;primals, const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;cotangents)</td></tr>
<tr class="memdesc:a1b33e2c2e3471420490cf0be2de6de18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the output and vector-Jacobian product (VJP) of a function. <br /></td></tr>
<tr class="separator:a1b33e2c2e3471420490cf0be2de6de18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2065a11249c3f4356ffd69b7a8c487ff" id="r_a2065a11249c3f4356ffd69b7a8c487ff"><td class="memItemLeft" align="right" valign="top">std::pair&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a>, <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a2065a11249c3f4356ffd69b7a8c487ff">mlx::core::vjp</a> (const std::function&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a>(const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;)&gt; &amp;fun, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;primal, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;cotangent)</td></tr>
<tr class="memdesc:a2065a11249c3f4356ffd69b7a8c487ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the output and vector-Jacobian product (VJP) of a unary function. <br /></td></tr>
<tr class="separator:a2065a11249c3f4356ffd69b7a8c487ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a179a632200366c223d6ab56d3e032592" id="r_a179a632200366c223d6ab56d3e032592"><td class="memItemLeft" align="right" valign="top">std::pair&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;, std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a179a632200366c223d6ab56d3e032592">mlx::core::jvp</a> (const std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt; &amp;fun, const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;primals, const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;tangents)</td></tr>
<tr class="memdesc:a179a632200366c223d6ab56d3e032592"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the output and Jacobian-vector product (JVP) of a function. <br /></td></tr>
<tr class="separator:a179a632200366c223d6ab56d3e032592"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af38e7582db29519bb39326f6fa531d20" id="r_af38e7582db29519bb39326f6fa531d20"><td class="memItemLeft" align="right" valign="top">std::pair&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a>, <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#af38e7582db29519bb39326f6fa531d20">mlx::core::jvp</a> (const std::function&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a>(const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;)&gt; &amp;fun, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;primal, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;tangent)</td></tr>
<tr class="memdesc:af38e7582db29519bb39326f6fa531d20"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the output and Jacobian-vector product (JVP) of a unary function. <br /></td></tr>
<tr class="separator:af38e7582db29519bb39326f6fa531d20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf49b337a00997231c0f7fd389efa8f3" id="r_abf49b337a00997231c0f7fd389efa8f3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacemlx_1_1core.html#ab79d66ddf1ec38b2f2c01234892a2230">ValueAndGradFn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#abf49b337a00997231c0f7fd389efa8f3">mlx::core::value_and_grad</a> (const std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt; &amp;fun, const std::vector&lt; int &gt; &amp;argnums)</td></tr>
<tr class="memdesc:abf49b337a00997231c0f7fd389efa8f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a function which computes the value and gradient of the input function with respect to a vector of input arrays. <br /></td></tr>
<tr class="separator:abf49b337a00997231c0f7fd389efa8f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b987f404b8699de00f9e0099ab6b1b0" id="r_a7b987f404b8699de00f9e0099ab6b1b0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacemlx_1_1core.html#ab79d66ddf1ec38b2f2c01234892a2230">ValueAndGradFn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a7b987f404b8699de00f9e0099ab6b1b0">mlx::core::value_and_grad</a> (const std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt; &amp;fun, int argnum=0)</td></tr>
<tr class="memdesc:a7b987f404b8699de00f9e0099ab6b1b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a function which computes the value and gradient of the input function with respect to a single input array. <br /></td></tr>
<tr class="separator:a7b987f404b8699de00f9e0099ab6b1b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a64dc878b29403d27e50bd7a288cc04" id="r_a5a64dc878b29403d27e50bd7a288cc04"><td class="memItemLeft" align="right" valign="top">std::function&lt; std::pair&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a>, <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a5a64dc878b29403d27e50bd7a288cc04">mlx::core::value_and_grad</a> (const std::function&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a>(const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;)&gt; &amp;fun)</td></tr>
<tr class="memdesc:a5a64dc878b29403d27e50bd7a288cc04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a function which computes the value and gradient of the unary input function. <br /></td></tr>
<tr class="separator:a5a64dc878b29403d27e50bd7a288cc04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7620f1ae298127cb6181db9162f012a7" id="r_a7620f1ae298127cb6181db9162f012a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacemlx_1_1core.html#a2689b8f1181648cb1685204fea9f3066">SimpleValueAndGradFn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a7620f1ae298127cb6181db9162f012a7">mlx::core::value_and_grad</a> (const std::function&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a>(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt; &amp;fun, const std::vector&lt; int &gt; &amp;argnums)</td></tr>
<tr class="separator:a7620f1ae298127cb6181db9162f012a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f69ffc30d66b1fca8f24b65be161a51" id="r_a2f69ffc30d66b1fca8f24b65be161a51"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacemlx_1_1core.html#a2689b8f1181648cb1685204fea9f3066">SimpleValueAndGradFn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a2f69ffc30d66b1fca8f24b65be161a51">mlx::core::value_and_grad</a> (const std::function&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a>(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt; &amp;fun, int argnum=0)</td></tr>
<tr class="separator:a2f69ffc30d66b1fca8f24b65be161a51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d2b2929ed4636e9e2b86e125b2e57d9" id="r_a3d2b2929ed4636e9e2b86e125b2e57d9"><td class="memItemLeft" align="right" valign="top">std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a3d2b2929ed4636e9e2b86e125b2e57d9">mlx::core::grad</a> (const std::function&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a>(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt; &amp;fun, const std::vector&lt; int &gt; &amp;argnums)</td></tr>
<tr class="memdesc:a3d2b2929ed4636e9e2b86e125b2e57d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a function which computes the gradient of the input function with respect to a vector of input arrays. <br /></td></tr>
<tr class="separator:a3d2b2929ed4636e9e2b86e125b2e57d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af482f6c64acd77c57ef5bb4b7be9726c" id="r_af482f6c64acd77c57ef5bb4b7be9726c"><td class="memItemLeft" align="right" valign="top">std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#af482f6c64acd77c57ef5bb4b7be9726c">mlx::core::grad</a> (const std::function&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a>(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt; &amp;fun, int argnum=0)</td></tr>
<tr class="memdesc:af482f6c64acd77c57ef5bb4b7be9726c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a function which computes the gradient of the input function with respect to a single input array. <br /></td></tr>
<tr class="separator:af482f6c64acd77c57ef5bb4b7be9726c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64bc619876b0f8cc81a2637ca81c99f7" id="r_a64bc619876b0f8cc81a2637ca81c99f7"><td class="memItemLeft" align="right" valign="top">std::function&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a>(const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a64bc619876b0f8cc81a2637ca81c99f7">mlx::core::grad</a> (const std::function&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a>(const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;)&gt; &amp;fun)</td></tr>
<tr class="memdesc:a64bc619876b0f8cc81a2637ca81c99f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a function which computes the gradient of the unary input function. <br /></td></tr>
<tr class="separator:a64bc619876b0f8cc81a2637ca81c99f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3caec2fa65375ed4c3bf1206177b84c" id="r_ac3caec2fa65375ed4c3bf1206177b84c"><td class="memItemLeft" align="right" valign="top">std::function&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a>(const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#ac3caec2fa65375ed4c3bf1206177b84c">mlx::core::vmap</a> (const std::function&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a>(const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;)&gt; &amp;fun, int in_axis=0, int out_axis=0)</td></tr>
<tr class="memdesc:ac3caec2fa65375ed4c3bf1206177b84c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Automatically vectorize a unary function over the requested axes. <br /></td></tr>
<tr class="separator:ac3caec2fa65375ed4c3bf1206177b84c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8481a3bb4c12c2b7dc6ba576c2be3d0d" id="r_a8481a3bb4c12c2b7dc6ba576c2be3d0d"><td class="memItemLeft" align="right" valign="top">std::function&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a>(const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a8481a3bb4c12c2b7dc6ba576c2be3d0d">mlx::core::vmap</a> (const std::function&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a>(const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;)&gt; &amp;fun, int in_axis_a=0, int in_axis_b=0, int out_axis=0)</td></tr>
<tr class="memdesc:a8481a3bb4c12c2b7dc6ba576c2be3d0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Automatically vectorize a binary function over the requested axes. <br /></td></tr>
<tr class="separator:a8481a3bb4c12c2b7dc6ba576c2be3d0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95a7757e8d18fced38acfc6a3e8d686a" id="r_a95a7757e8d18fced38acfc6a3e8d686a"><td class="memItemLeft" align="right" valign="top">std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a95a7757e8d18fced38acfc6a3e8d686a">mlx::core::vmap</a> (const std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt; &amp;fun, const std::vector&lt; int &gt; &amp;in_axes={}, const std::vector&lt; int &gt; &amp;out_axes={})</td></tr>
<tr class="memdesc:a95a7757e8d18fced38acfc6a3e8d686a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Automatically vectorize a function over the requested axes. <br /></td></tr>
<tr class="separator:a95a7757e8d18fced38acfc6a3e8d686a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d3ca5fbaecdb995660c24cde5aeebaf" id="r_a8d3ca5fbaecdb995660c24cde5aeebaf"><td class="memItemLeft" align="right" valign="top">std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a8d3ca5fbaecdb995660c24cde5aeebaf">mlx::core::custom_function</a> (std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt; fun, std::optional&lt; std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;, const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;, const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt; &gt; fun_vjp=std::nullopt, std::optional&lt; std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;, const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;, const std::vector&lt; int &gt; &amp;)&gt; &gt; fun_jvp=std::nullopt, std::optional&lt; std::function&lt; std::pair&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;, std::vector&lt; int &gt; &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;, const std::vector&lt; int &gt; &amp;)&gt; &gt; fun_vmap=std::nullopt)</td></tr>
<tr class="memdesc:a8d3ca5fbaecdb995660c24cde5aeebaf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Redefine the transformations of <code>fun</code> according to the provided functions. <br /></td></tr>
<tr class="separator:a8d3ca5fbaecdb995660c24cde5aeebaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9290596250fa308df4c69b44483bb8aa" id="r_a9290596250fa308df4c69b44483bb8aa"><td class="memItemLeft" align="right" valign="top">std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a9290596250fa308df4c69b44483bb8aa">mlx::core::custom_vjp</a> (std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt; fun, std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;, const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;, const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt; fun_vjp)</td></tr>
<tr class="memdesc:a9290596250fa308df4c69b44483bb8aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a function that behaves exactly like <code>fun</code> but if the vjp of the results is computed <code>fun_vjp</code> will be used instead of <code>vjp(fun, ...)</code> . <br /></td></tr>
<tr class="separator:a9290596250fa308df4c69b44483bb8aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42fa813d72c15132f76ef5fd1213ed71" id="r_a42fa813d72c15132f76ef5fd1213ed71"><td class="memItemLeft" align="right" valign="top">std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a42fa813d72c15132f76ef5fd1213ed71">mlx::core::checkpoint</a> (std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt; fun)</td></tr>
<tr class="memdesc:a42fa813d72c15132f76ef5fd1213ed71"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checkpoint the gradient of a function. <br /></td></tr>
<tr class="separator:a42fa813d72c15132f76ef5fd1213ed71"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
rebase
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>
<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>
rebase
2024-10-15 23:12:17 +08:00
</body>
</html>
Reference in New Issue Copy Permalink