mirror of
https://github.com/ml-explore/mlx.git
synced 2025-06-26 02:33:21 +08:00
177 lines
27 KiB
HTML
177 lines
27 KiB
HTML
<!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"/>
|
|
<meta name="generator" content="Doxygen 1.10.0"/>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.10.0 -->
|
|
<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" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- 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 id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_938ab0ecf10b8b860ff766c820f665fd.html">mlx</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#namespaces">Namespaces</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#func-members">Functions</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle"><div class="title">transforms.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include <optional></code><br />
|
|
<code>#include "<a class="el" href="array_8h_source.html">mlx/array.h</a>"</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:namespacemlx" id="r_namespacemlx"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx.html">mlx</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:namespacemlx_1_1core" id="r_namespacemlx_1_1core"><td class="memItemLeft" align="right" valign="top">namespace  </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"> </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 </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"> </td></tr>
|
|
<tr class="memitem:a2689b8f1181648cb1685204fea9f3066" id="r_a2689b8f1181648cb1685204fea9f3066"><td class="memItemLeft" align="right" valign="top">using </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"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a15dda19aa7fa1fc5fca35df5cf963297">mlx::core::async_eval</a> (std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > outputs)</td></tr>
|
|
<tr class="separator:a15dda19aa7fa1fc5fca35df5cf963297"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7d6e097d8effed52f4713672e471f299" id="r_a7d6e097d8effed52f4713672e471f299"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a7d6e097d8effed52f4713672e471f299">mlx::core::eval</a> (std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > outputs)</td></tr>
|
|
<tr class="separator:a7d6e097d8effed52f4713672e471f299"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adb14f689c9f75f7901edb196c2bfb971" id="r_adb14f689c9f75f7901edb196c2bfb971"><td class="memTemplParams" colspan="2">template<typename... Arrays, typename = enable_for_arrays_t<Arrays...>> </td></tr>
|
|
<tr class="memitem:adb14f689c9f75f7901edb196c2bfb971"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#adb14f689c9f75f7901edb196c2bfb971">mlx::core::eval</a> (Arrays &&... outputs)</td></tr>
|
|
<tr class="separator:adb14f689c9f75f7901edb196c2bfb971"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1b33e2c2e3471420490cf0be2de6de18" id="r_a1b33e2c2e3471420490cf0be2de6de18"><td class="memItemLeft" align="right" valign="top">std::pair< std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> >, std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a1b33e2c2e3471420490cf0be2de6de18">mlx::core::vjp</a> (const std::function< std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> >(const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &)> &fun, const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &primals, const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &cotangents)</td></tr>
|
|
<tr class="memdesc:a1b33e2c2e3471420490cf0be2de6de18"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:a2065a11249c3f4356ffd69b7a8c487ff" id="r_a2065a11249c3f4356ffd69b7a8c487ff"><td class="memItemLeft" align="right" valign="top">std::pair< <a class="el" href="classmlx_1_1core_1_1array.html">array</a>, <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a2065a11249c3f4356ffd69b7a8c487ff">mlx::core::vjp</a> (const std::function< <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> &)> &fun, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &primal, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &cotangent)</td></tr>
|
|
<tr class="memdesc:a2065a11249c3f4356ffd69b7a8c487ff"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:a179a632200366c223d6ab56d3e032592" id="r_a179a632200366c223d6ab56d3e032592"><td class="memItemLeft" align="right" valign="top">std::pair< std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> >, std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a179a632200366c223d6ab56d3e032592">mlx::core::jvp</a> (const std::function< std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> >(const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &)> &fun, const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &primals, const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &tangents)</td></tr>
|
|
<tr class="memdesc:a179a632200366c223d6ab56d3e032592"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:af38e7582db29519bb39326f6fa531d20" id="r_af38e7582db29519bb39326f6fa531d20"><td class="memItemLeft" align="right" valign="top">std::pair< <a class="el" href="classmlx_1_1core_1_1array.html">array</a>, <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#af38e7582db29519bb39326f6fa531d20">mlx::core::jvp</a> (const std::function< <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> &)> &fun, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &primal, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &tangent)</td></tr>
|
|
<tr class="memdesc:af38e7582db29519bb39326f6fa531d20"><td class="mdescLeft"> </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"> </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> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#abf49b337a00997231c0f7fd389efa8f3">mlx::core::value_and_grad</a> (const std::function< std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> >(const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &)> &fun, const std::vector< int > &argnums)</td></tr>
|
|
<tr class="memdesc:abf49b337a00997231c0f7fd389efa8f3"><td class="mdescLeft"> </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"> </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> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a7b987f404b8699de00f9e0099ab6b1b0">mlx::core::value_and_grad</a> (const std::function< std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> >(const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &)> &fun, int argnum=0)</td></tr>
|
|
<tr class="memdesc:a7b987f404b8699de00f9e0099ab6b1b0"><td class="mdescLeft"> </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"> </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> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a7620f1ae298127cb6181db9162f012a7">mlx::core::value_and_grad</a> (const std::function< <a class="el" href="classmlx_1_1core_1_1array.html">array</a>(const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &)> &fun, const std::vector< int > &argnums)</td></tr>
|
|
<tr class="separator:a7620f1ae298127cb6181db9162f012a7"><td class="memSeparator" colspan="2"> </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> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a2f69ffc30d66b1fca8f24b65be161a51">mlx::core::value_and_grad</a> (const std::function< <a class="el" href="classmlx_1_1core_1_1array.html">array</a>(const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &)> &fun, int argnum=0)</td></tr>
|
|
<tr class="separator:a2f69ffc30d66b1fca8f24b65be161a51"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af482f6c64acd77c57ef5bb4b7be9726c" id="r_af482f6c64acd77c57ef5bb4b7be9726c"><td class="memItemLeft" align="right" valign="top">std::function< std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> >(const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &)> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#af482f6c64acd77c57ef5bb4b7be9726c">mlx::core::grad</a> (const std::function< <a class="el" href="classmlx_1_1core_1_1array.html">array</a>(const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &)> &fun, int argnum=0)</td></tr>
|
|
<tr class="memdesc:af482f6c64acd77c57ef5bb4b7be9726c"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:a64bc619876b0f8cc81a2637ca81c99f7" id="r_a64bc619876b0f8cc81a2637ca81c99f7"><td class="memItemLeft" align="right" valign="top">std::function< <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> &)> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a64bc619876b0f8cc81a2637ca81c99f7">mlx::core::grad</a> (const std::function< <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> &)> &fun)</td></tr>
|
|
<tr class="memdesc:a64bc619876b0f8cc81a2637ca81c99f7"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:a8481a3bb4c12c2b7dc6ba576c2be3d0d" id="r_a8481a3bb4c12c2b7dc6ba576c2be3d0d"><td class="memItemLeft" align="right" valign="top">std::function< <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> &, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &)> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a8481a3bb4c12c2b7dc6ba576c2be3d0d">mlx::core::vmap</a> (const std::function< <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> &, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &)> &fun, int in_axis_a=0, int in_axis_b=0, int out_axis=0)</td></tr>
|
|
<tr class="memdesc:a8481a3bb4c12c2b7dc6ba576c2be3d0d"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:a95a7757e8d18fced38acfc6a3e8d686a" id="r_a95a7757e8d18fced38acfc6a3e8d686a"><td class="memItemLeft" align="right" valign="top">std::function< std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> >(const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &)> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a95a7757e8d18fced38acfc6a3e8d686a">mlx::core::vmap</a> (const std::function< std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> >(const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &)> &fun, const std::vector< int > &in_axes={}, const std::vector< int > &out_axes={})</td></tr>
|
|
<tr class="memdesc:a95a7757e8d18fced38acfc6a3e8d686a"><td class="mdescLeft"> </td><td class="mdescRight">Automatically vectorize a function over the requested axes. <br /></td></tr>
|
|
<tr class="separator:a95a7757e8d18fced38acfc6a3e8d686a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
<tr class="memitem:a36681ec79fbad0103f32ec06c2885638" id="r_a36681ec79fbad0103f32ec06c2885638"><td class="memItemLeft" align="right" valign="top">std::function< std::pair< <a class="el" href="classmlx_1_1core_1_1array.html">array</a>, <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> &) </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a36681ec79fbad0103f32ec06c2885638">mlx::core::value_and_grad</a> )(const std::function< <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> &)> &fun)</td></tr>
|
|
<tr class="memdesc:a36681ec79fbad0103f32ec06c2885638"><td class="mdescLeft"> </td><td class="mdescRight">Returns a function which computes the value and gradient of the unary input function. <br /></td></tr>
|
|
<tr class="separator:a36681ec79fbad0103f32ec06c2885638"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a99994806f81e83f98746c9e5ba4c3673" id="r_a99994806f81e83f98746c9e5ba4c3673"><td class="memItemLeft" align="right" valign="top">std::function< std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> >(const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &) </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a99994806f81e83f98746c9e5ba4c3673">mlx::core::grad</a> )(const std::function< <a class="el" href="classmlx_1_1core_1_1array.html">array</a>(const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &)> &fun, const std::vector< int > &argnums)</td></tr>
|
|
<tr class="memdesc:a99994806f81e83f98746c9e5ba4c3673"><td class="mdescLeft"> </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:a99994806f81e83f98746c9e5ba4c3673"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a933289d4688479e1c4d8ba04332c406b" id="r_a933289d4688479e1c4d8ba04332c406b"><td class="memItemLeft" align="right" valign="top">std::function< <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> &) </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a933289d4688479e1c4d8ba04332c406b">mlx::core::vmap</a> )(const std::function< <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> &)> &fun, int in_axis=0, int out_axis=0)</td></tr>
|
|
<tr class="memdesc:a933289d4688479e1c4d8ba04332c406b"><td class="mdescLeft"> </td><td class="mdescRight">Automatically vectorize a unary function over the requested axes. <br /></td></tr>
|
|
<tr class="separator:a933289d4688479e1c4d8ba04332c406b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a58c5b448f357b48e86599eb8eeea141d" id="r_a58c5b448f357b48e86599eb8eeea141d"><td class="memItemLeft" align="right" valign="top">std::function< std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> >(const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &) </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a58c5b448f357b48e86599eb8eeea141d">mlx::core::custom_function</a> )(std::function< std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> >(const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &)> fun, std::optional< std::function< std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> >(const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &, const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &, const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &)> > fun_vjp=std::nullopt, std::optional< std::function< std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> >(const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &, const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &, const std::vector< int > &)> > fun_jvp=std::nullopt, std::optional< std::function< std::pair< std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> >, std::vector< int > >(const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &, const std::vector< int > &)> > fun_vmap=std::nullopt)</td></tr>
|
|
<tr class="memdesc:a58c5b448f357b48e86599eb8eeea141d"><td class="mdescLeft"> </td><td class="mdescRight">Redefine the transformations of <code>fun</code> according to the provided functions. <br /></td></tr>
|
|
<tr class="separator:a58c5b448f357b48e86599eb8eeea141d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3fa1f0ad360f3e16c146384276b1c467" id="r_a3fa1f0ad360f3e16c146384276b1c467"><td class="memItemLeft" align="right" valign="top">std::function< std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> >(const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &) </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a3fa1f0ad360f3e16c146384276b1c467">mlx::core::custom_vjp</a> )(std::function< std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> >(const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &)> fun, std::function< std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> >(const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &, const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &, const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &)> fun_vjp)</td></tr>
|
|
<tr class="memdesc:a3fa1f0ad360f3e16c146384276b1c467"><td class="mdescLeft"> </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:a3fa1f0ad360f3e16c146384276b1c467"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a26127b71b2ec65c51d7627e71847083d" id="r_a26127b71b2ec65c51d7627e71847083d"><td class="memItemLeft" align="right" valign="top">std::function< std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> >(const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &) </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a26127b71b2ec65c51d7627e71847083d">mlx::core::checkpoint</a> )(std::function< std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> >(const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &)> fun)</td></tr>
|
|
<tr class="memdesc:a26127b71b2ec65c51d7627e71847083d"><td class="mdescLeft"> </td><td class="mdescRight">Checkpoint the gradient of a function. <br /></td></tr>
|
|
<tr class="separator:a26127b71b2ec65c51d7627e71847083d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
|
|
</small></address>
|
|
</body>
|
|
</html>
|